| blob | fb74c4392470dc66f4a2ad972f8f096327c2bf37 |
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 "Support function for `window-in-direction'."
1074 "Return window in DIRECTION as seen from WINDOW.
1075 DIRECTION must be one of `above', `below', `left' or `right'.
1076 WINDOW must be a live window and defaults to the selected one.
1077 IGNORE, when non-nil means a window can be returned even if its
1078 `no-other-window' parameter is non-nil."
1091 ;; The column / row value of `posn-at-point' can be nil for the
1092 ;; mini-window, guard against that.
1103 best best-2 best-diff-2-new)
1110 ;; Ignore ourselves.
1112 ;; Ignore W unless IGNORE is non-nil.
1118 ;; W is to the left or right of WINDOW and covers POSN.
1128 ;; W is to the left or right of WINDOW but does not
1129 ;; cover POSN.
1144 ;; W is above or below WINDOW and covers POSN.
1154 ;; W is above or below WINDOW but does not cover POSN.
1169 "Return a live window satisfying PREDICATE.
1170 More precisely, cycle through all windows calling the function
1171 PREDICATE on each one of them with the window as its sole
1172 argument. Return the first window for which PREDICATE returns
1173 non-nil. Windows are scanned starting with the window following
1174 the selcted window. If no window satisfies PREDICATE, return
1175 DEFAULT.
1177 MINIBUF t means include the minibuffer window even if the
1178 minibuffer is not active. MINIBUF nil or omitted means include
1179 the minibuffer window only if the minibuffer is active. Any
1180 other value means do not include the minibuffer window even if
1181 the minibuffer is active.
1183 ALL-FRAMES nil or omitted means consider all windows on the selected
1184 frame, plus the minibuffer window if specified by the MINIBUF
1185 argument. If the minibuffer counts, consider all windows on all
1186 frames that share that minibuffer too. The following non-nil
1187 values of ALL-FRAMES have special meanings:
1189 - t means consider all windows on all existing frames.
1191 - `visible' means consider all windows on all visible frames on
1192 the current terminal.
1194 - 0 (the number zero) means consider all windows on all visible
1195 and iconified frames on the current terminal.
1197 - A frame means consider all windows on that frame only.
1199 Anything else means consider all windows on the selected frame
1200 and no others."
1204 minibuf all-frames))
1207 default))
1212 "Return the least recently used window on frames specified by ALL-FRAMES.
1213 Return a full-width window if possible. A minibuffer window is
1214 never a candidate. A dedicated window is never a candidate
1215 unless DEDICATED is non-nil, so if all windows are dedicated, the
1216 value is nil. Avoid returning the selected window if possible.
1218 The following non-nil values of the optional argument ALL-FRAMES
1219 have special meanings:
1221 - t means consider all windows on all existing frames.
1223 - `visible' means consider all windows on all visible frames on
1224 the current terminal.
1226 - 0 (the number zero) means consider all windows on all visible
1227 and iconified frames on the current terminal.
1229 - A frame means consider all windows on that frame only.
1231 Any other value of ALL-FRAMES means consider all windows on the
1232 selected frame and no others."
1248 "Return the most recently used window on frames specified by ALL-FRAMES.
1249 Do not return a minibuffer window.
1251 The following non-nil values of the optional argument ALL-FRAMES
1252 have special meanings:
1254 - t means consider all windows on all existing frames.
1256 - `visible' means consider all windows on all visible frames on
1257 the current terminal.
1259 - 0 (the number zero) means consider all windows on all visible
1260 and iconified frames on the current terminal.
1262 - A frame means consider all windows on that frame only.
1264 Any other value of ALL-FRAMES means consider all windows on the
1265 selected frame and no others."
1272 best-window))
1275 "Return the largest window on frames specified by ALL-FRAMES.
1276 A minibuffer window is never a candidate. A dedicated window is
1277 never a candidate unless DEDICATED is non-nil, so if all windows
1278 are dedicated, the value is nil.
1280 The following non-nil values of the optional argument ALL-FRAMES
1281 have special meanings:
1283 - t means consider all windows on all existing frames.
1285 - `visible' means consider all windows on all visible frames on
1286 the current terminal.
1288 - 0 (the number zero) means consider all windows on all visible
1289 and iconified frames on the current terminal.
1291 - A frame means consider all windows on that frame only.
1293 Any other value of ALL-FRAMES means consider all windows on the
1294 selected frame and no others."
1296 best-window size)
1304 best-window))
1307 "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
1308 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
1309 and defaults to the current buffer. Windows are scanned starting
1310 with the selected window.
1312 MINIBUF t means include the minibuffer window even if the
1313 minibuffer is not active. MINIBUF nil or omitted means include
1314 the minibuffer window only if the minibuffer is active. Any
1315 other value means do not include the minibuffer window even if
1316 the minibuffer is active.
1318 ALL-FRAMES nil or omitted means consider all windows on the
1319 selected frame, plus the minibuffer window if specified by the
1320 MINIBUF argument. If the minibuffer counts, consider all windows
1321 on all frames that share that minibuffer too. The following
1322 non-nil values of ALL-FRAMES have special meanings:
1324 - t means consider all windows on all existing frames.
1326 - `visible' means consider all windows on all visible frames on
1327 the current terminal.
1329 - 0 (the number zero) means consider all windows on all visible
1330 and iconified frames on the current terminal.
1332 - A frame means consider all windows on that frame only.
1334 Anything else means consider all windows on the selected frame
1335 and no others."
1337 windows)
1344 "Return t if WINDOW is the currently active minibuffer window."
1348 "Return the number of live windows on the selected frame.
1349 The optional argument MINIBUF specifies whether the minibuffer
1350 window shall be counted. See `walk-windows' for the precise
1351 meaning of this argument."
1353 \f
1354 ;;; Resizing windows.
1356 "Reset resize values for all windows on FRAME.
1357 FRAME defaults to the selected frame.
1359 This function stores the current value of `window-total-size' applied
1360 with argument HORIZONTAL in the new total size of all windows on
1361 FRAME. It also resets the new normal size of each of these
1362 windows."
1367 "Internal function of `window--resize-reset'."
1368 ;; Register old size in the new total size.
1370 ;; Reset new normal size.
1377 ;; The following routine is used to manually resize the minibuffer
1378 ;; window and is currently used, for example, by ispell.el.
1380 "Resize minibuffer window WINDOW by DELTA lines.
1381 If WINDOW cannot be resized by DELTA lines make it as large \(or
1382 as small) as possible but don't signal an error."
1390 ;; Sanitize DELTA.
1397 ;; Resize now.
1399 ;; Ideally we should be able to resize just the last subwindow of
1400 ;; root here. See the comment in `resize-root-window-vertically'
1401 ;; for why we do not do that.
1404 ;; The following routine catches the case where we want to resize
1405 ;; a minibuffer-only frame.
1409 "Resize WINDOW vertically by DELTA lines.
1410 WINDOW can be an arbitrary window and defaults to the selected
1411 one. An attempt to resize the root window of a frame will raise
1412 an error though.
1414 DELTA a positive number means WINDOW shall be enlarged by DELTA
1415 lines. DELTA negative means WINDOW shall be shrunk by -DELTA
1416 lines.
1418 Optional argument HORIZONTAL non-nil means resize WINDOW
1419 horizontally by DELTA columns. In this case a positive DELTA
1420 means enlarge WINDOW by DELTA columns. DELTA negative means
1421 WINDOW shall be shrunk by -DELTA columns.
1423 Optional argument IGNORE non-nil means ignore any restrictions
1424 imposed by fixed size windows, `window-min-height' or
1425 `window-min-width' settings. IGNORE any window means ignore
1426 restrictions for that window only. IGNORE equal `safe' means
1427 live windows may get as small as `window-safe-min-height' lines
1428 and `window-safe-min-width' columns.
1430 This function resizes other windows proportionally and never
1431 deletes any windows. If you want to move only the low (right)
1432 edge of WINDOW consider using `adjust-window-trailing-edge'
1433 instead."
1436 sibling)
1449 ;; If window-splits returns nil for WINDOW, WINDOW is part of
1450 ;; an iso-combination, and WINDOW's neighboring right or left
1451 ;; sibling can be resized as requested, resize that sibling.
1458 normal-delta))
1461 normal-delta)))
1462 ;; Otherwise, resize all other windows in the same combination.
1469 "Return non-nil if WINDOW shall be skipped by resizing routines."
1472 (defun window--resize-subwindows-normal (parent horizontal window this-delta &optional trail other-delta)
1473 "Set the new normal height of subwindows of window PARENT.
1474 HORIZONTAL non-nil means set the new normal width of these
1475 windows. WINDOW specifies a subwindow of PARENT that has been
1476 resized by THIS-DELTA lines \(columns).
1478 Optional argument TRAIL either 'before or 'after means set values
1479 for windows before or after WINDOW only. Optional argument
1480 OTHER-DELTA a number specifies that this many lines \(columns)
1481 have been obtained from \(or returned to) an ancestor window of
1482 PARENT in order to resize WINDOW."
1486 ;; When WINDOW gets deleted and we can return its entire
1487 ;; space to its siblings, use WINDOW's normal size as the
1488 ;; normal delta.
1490 ;; In any other case calculate the normal delta from the
1491 ;; relation of THIS-DELTA to the total size of PARENT.
1497 ;; Set parent-normal to the sum of the normal sizes of all
1498 ;; subwindows of PARENT that shall be resized, excluding only WINDOW
1499 ;; and any windows specified by the optional TRAIL argument.
1510 ;; Set the new normal size of all subwindows of PARENT from what
1511 ;; they should have contributed for recovering THIS-DELTA lines
1512 ;; (columns).
1526 delta-normal))
1527 ;; Don't drop below 0.
1532 ;; Set the new normal size of windows from what they should have
1533 ;; contributed for recovering OTHER-DELTA lines (columns).
1536 other-delta)))
1548 ;; Don't drop below 0.
1552 ;; Set the new normal size of WINDOW to what is left by the sum of
1553 ;; the normal sizes of its siblings.
1555 window
1566 ;; Don't get larger than 1 or smaller than 0.
1570 "Resize subwindows of window PARENT vertically by DELTA lines.
1571 PARENT must be a vertically combined internal window.
1573 Optional argument HORIZONTAL non-nil means resize subwindows of
1574 PARENT horizontally by DELTA columns. In this case PARENT must
1575 be a horizontally combined internal window.
1577 WINDOW, if specified, must denote a child window of PARENT that
1578 is resized by DELTA lines.
1580 Optional argument IGNORE non-nil means ignore any restrictions
1581 imposed by fixed size windows, `window-min-height' or
1582 `window-min-width' settings. IGNORE equal `safe' means live
1583 windows may get as small as `window-safe-min-height' lines and
1584 `window-safe-min-width' columns. IGNORE any window means ignore
1585 restrictions for that window only.
1587 Optional arguments TRAIL and EDGE, when non-nil, restrict the set
1588 of windows that shall be resized. If TRAIL equals `before',
1589 resize only windows on the left or above EDGE. If TRAIL equals
1590 `after', resize only windows on the right or below EDGE. Also,
1591 preferably only resize windows adjacent to EDGE.
1593 Return the symbol `normalized' if new normal sizes have been
1594 already set by this routine."
1598 best-window best-value)
1610 sub)
1615 edge)
1620 edge)
1623 ;; Resize only windows adjacent to EDGE.
1626 sub delta horizontal ignore t trail edge)
1629 ;; Assign new normal sizes.
1638 ;; Return 'normalized to notify `window--resize-siblings' that
1639 ;; normal sizes have been already set.
1641 ;; Resize all windows proportionally.
1646 ;; Ignore windows to skip and fixed-size subwindows - in
1647 ;; the latter case make it a window to skip.
1652 ;; When shrinking store the number of lines/cols we can get
1653 ;; from this window here together with the total/normal size
1654 ;; factor.
1656 sub
1658 ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
1661 parent-total)
1664 ;; When enlarging store the total/normal size factor only
1666 sub
1668 parent-total)
1675 ;; Shrink windows by delta.
1694 best-window
1699 parent-total)
1702 ;; Enlarge windows by delta.
1720 best-window
1722 parent-total)
1730 ;; Reset new normal size fields so `window-resize-apply'
1731 ;; won't use them to apply new sizes.
1735 ;; Resize this subwindow's subwindows (back-engineering
1736 ;; delta from sub's old and new total sizes).
1740 ;; For the TRAIL non-nil case we have to resize SUB
1741 ;; recursively even if it's size does not change.
1743 sub delta horizontal ignore nil trail edge))))
1747 "Resize other windows when WINDOW is resized vertically by DELTA lines.
1748 Optional argument HORIZONTAL non-nil means resize other windows
1749 when WINDOW is resized horizontally by DELTA columns. WINDOW
1750 itself is not resized by this function.
1752 Optional argument IGNORE non-nil means ignore any restrictions
1753 imposed by fixed size windows, `window-min-height' or
1754 `window-min-width' settings. IGNORE equal `safe' means live
1755 windows may get as small as `window-safe-min-height' lines and
1756 `window-safe-min-width' columns. IGNORE any window means ignore
1757 restrictions for that window only.
1759 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1760 of windows that shall be resized. If TRAIL equals `before',
1761 resize only windows on the left or above EDGE. If TRAIL equals
1762 `after', resize only windows on the right or below EDGE. Also,
1763 preferably only resize windows adjacent to EDGE."
1768 ;; In an iso-combination try to extract DELTA from WINDOW's
1769 ;; siblings.
1772 this-delta other-delta)
1773 ;; Decide which windows shall be left alone.
1777 ;; Make sure WINDOW is left alone when
1778 ;; resizing its siblings.
1782 ;; Make sure this sibling is left alone when
1783 ;; resizing its siblings.
1787 ;; Set this-delta to t to signal that we found a sibling
1788 ;; of WINDOW whose size is not fixed.
1793 ;; Set this-delta to what we can get from WINDOW's siblings.
1795 ;; A deletion, presumably. We must handle this case
1796 ;; specially since `window-resizable' can't be used.
1798 ;; There's at least one resizable sibling we can
1799 ;; give WINDOW's size to.
1801 ;; No resizable sibling exists.
1803 ;; Any other form of resizing.
1807 ;; Set other-delta to what we still have to get from
1808 ;; ancestor windows of parent.
1811 ;; Unless we got everything from WINDOW's siblings, PARENT
1812 ;; must be resized by other-delta lines or columns.
1816 ;; We haven't got anything from WINDOW's siblings but we
1817 ;; must update the normal sizes to respect other-delta.
1819 parent horizontal window this-delta trail other-delta)
1820 ;; We did get something from WINDOW's siblings which means
1821 ;; we have to resize their subwindows.
1824 window ignore trail edge)
1825 ;; If `window--resize-subwindows' returns
1826 ;; 'normalized, this means it has set the
1827 ;; normal sizes already.
1829 ;; Set the normal sizes.
1831 parent horizontal window this-delta trail other-delta))
1832 ;; Set DELTA to what we still have to get from ancestor
1833 ;; windows.
1836 ;; In an ortho-combination all siblings of WINDOW must be
1837 ;; resized by DELTA.
1845 ;; "Go up."
1847 parent delta horizontal ignore trail edge)))))
1850 "Resize WINDOW vertically by DELTA lines.
1851 Optional argument HORIZONTAL non-nil means resize WINDOW
1852 horizontally by DELTA columns.
1854 Optional argument IGNORE non-nil means ignore any restrictions
1855 imposed by fixed size windows, `window-min-height' or
1856 `window-min-width' settings. IGNORE equal `safe' means live
1857 windows may get as small as `window-safe-min-height' lines and
1858 `window-safe-min-width' columns. IGNORE any window means ignore
1859 restrictions for that window only.
1861 Optional argument ADD non-nil means add DELTA to the new total
1862 size of WINDOW.
1864 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1865 of windows that shall be resized. If TRAIL equals `before',
1866 resize only windows on the left or above EDGE. If TRAIL equals
1867 `after', resize only windows on the right or below EDGE. Also,
1868 preferably only resize windows adjacent to EDGE.
1870 This function recursively resizes WINDOW's subwindows to fit the
1871 new size. Make sure that WINDOW is `window-resizable' before
1872 calling this function. Note that this function does not resize
1873 siblings of WINDOW or WINDOW's parent window. You have to
1874 eventually call `window-resize-apply' in order to make resizing
1875 actually take effect."
1877 ;; Add DELTA to the new total size of WINDOW.
1884 ;; In an iso-combination resize subwindows according to their
1885 ;; normal sizes.
1887 window delta horizontal nil ignore trail edge))
1888 ;; In an ortho-combination resize each subwindow by DELTA.
1892 sub delta horizontal ignore t trail edge)
1896 "Resize root window WINDOW vertically by DELTA lines.
1897 HORIZONTAL non-nil means resize root window WINDOW horizontally
1898 by DELTA columns.
1900 IGNORE non-nil means ignore any restrictions imposed by fixed
1901 size windows, `window-min-height' or `window-min-width' settings.
1903 This function is only called by the frame resizing routines. It
1904 resizes windows proportionally and never deletes any windows."
1911 "Resize root window WINDOW vertically by DELTA lines.
1912 If DELTA is less than zero and we can't shrink WINDOW by DELTA
1913 lines, shrink it as much as possible. If DELTA is greater than
1914 zero, this function can resize fixed-size subwindows in order to
1915 recover the necessary lines.
1917 Return the number of lines that were recovered.
1919 This function is only called by the minibuffer window resizing
1920 routines. It resizes windows proportionally and never deletes
1921 any windows."
1932 ;; Ideally, we would resize just the last window in a combination
1933 ;; but that's not feasible for the following reason: If we grow
1934 ;; the minibuffer window and the last window cannot be shrunk any
1935 ;; more, we shrink another window instead. But if we then shrink
1936 ;; the minibuffer window again, the last window might get enlarged
1937 ;; and the state after shrinking is not the state before growing.
1938 ;; So, in practice, we'd need a history variable to record how to
1939 ;; proceed. But I'm not sure how such a variable could work with
1940 ;; repeated minibuffer window growing steps.
1942 delta)))
1945 "Move WINDOW's bottom edge by DELTA lines.
1946 Optional argument HORIZONTAL non-nil means move WINDOW's right
1947 edge by DELTA columns. WINDOW defaults to the selected window.
1949 If DELTA is greater zero, then move the edge downwards or to the
1950 right. If DELTA is less than zero, move the edge upwards or to
1951 the left. If the edge can't be moved by DELTA lines or columns,
1952 move it as far as possible in the desired direction."
1956 left this-delta min-delta max-delta failed)
1957 ;; Find the edge we want to move.
1970 ;; Set LEFT to the first resizable window on the left. This step is
1971 ;; needed to handle fixed-size windows.
1984 ;; Set RIGHT to the first resizable window on the right. This step
1985 ;; is needed to handle fixed-size windows.
1998 ;; LEFT and RIGHT (which might be both internal windows) are now the
1999 ;; two windows we want to resize.
2005 ;; We can't get the whole DELTA - move as far as possible.
2008 ;; Start resizing.
2010 ;; Try to enlarge LEFT first.
2014 left this-delta horizontal nil t 'before
2018 ;; Shrink windows on right of LEFT.
2020 left delta horizontal nil 'after
2028 ;; We can't get the whole DELTA - move as far as possible.
2031 ;; Start resizing.
2033 ;; Try to enlarge RIGHT.
2037 right this-delta horizontal nil t 'after
2041 ;; Shrink windows on left of RIGHT.
2048 ;; Don't report an error in the standard case.
2050 ;; But do report an error if applying the changes fails.
2054 "Make selected window DELTA lines taller.
2055 Interactively, if no argument is given, make the selected window
2056 one line taller. If optional argument HORIZONTAL is non-nil,
2057 make selected window wider by DELTA columns. If DELTA is
2058 negative, shrink selected window by -DELTA lines or columns.
2059 Return nil."
2072 horizontal))))
2075 "Make selected window DELTA lines smaller.
2076 Interactively, if no argument is given, make the selected window
2077 one line smaller. If optional argument HORIZONTAL is non-nil,
2078 make selected window narrower by DELTA columns. If DELTA is
2079 negative, enlarge selected window by -DELTA lines or columns.
2080 Return nil."
2093 horizontal))))
2096 "Maximize WINDOW.
2097 Make WINDOW as large as possible without deleting any windows.
2098 WINDOW can be any window and defaults to the selected window."
2105 "Minimize WINDOW.
2106 Make WINDOW as small as possible without deleting any windows.
2107 WINDOW can be any window and defaults to the selected window."
2112 \f
2114 "Return non-nil if WINDOW is the root window of its frame."
2118 "Return window tree rooted at WINDOW.
2119 Optional argument NEXT non-nil means include windows right
2120 siblings in the return value.
2122 See the documentation of `window-tree' for a description of the
2123 return value."
2136 list))
2141 "Return the window tree of frame FRAME.
2142 FRAME must be a live frame and defaults to the selected frame.
2143 The return value is a list of the form (ROOT MINI), where ROOT
2144 represents the window tree of the frame's root window, and MINI
2145 is the frame's minibuffer window.
2147 If the root window is not split, ROOT is the root window itself.
2148 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
2149 for a horizontal split, and t for a vertical split. EDGES gives
2150 the combined size and position of the subwindows in the split,
2151 and the rest of the elements are the subwindows in the split.
2152 Each of the subwindows may again be a window or a list
2153 representing a window split, and so on. EDGES is a list \(LEFT
2154 TOP RIGHT BOTTOM) as returned by `window-edges'."
2157 \f
2159 "Select another window in cyclic ordering of windows.
2160 COUNT specifies the number of windows to skip, starting with the
2161 selected window, before making the selection. If COUNT is
2162 positive, skip COUNT windows forwards. If COUNT is negative,
2163 skip -COUNT windows backwards. COUNT zero means do not skip any
2164 window, so select the selected window. In an interactive call,
2165 COUNT is the numeric prefix argument. Return nil.
2167 If the `other-window' parameter of WINDOW is a function and
2168 `ignore-window-parameters' is nil, call that function with the
2169 arguments COUNT and ALL-FRAMES.
2171 This function does not select a window whose `no-other-window'
2172 window parameter is non-nil.
2174 This function uses `next-window' for finding the window to
2175 select. The argument ALL-FRAMES has the same meaning as in
2176 `next-window', but the MINIBUF argument of `next-window' is
2177 always effectively nil."
2182 old-window old-count)
2185 ;; `next-window' and `previous-window' may return a window we are
2186 ;; not allowed to select. Hence we need an exit strategy in case
2187 ;; all windows are non-selectable.
2194 ;; Keep out of infinite loops. When COUNT has not changed
2195 ;; since we last looked at `window' we're probably in one.
2199 ;; The first non-selectable window `next-window' got us:
2200 ;; Remember it and the current value of COUNT.
2210 ;; Keep out of infinite loops. When COUNT has not changed
2211 ;; since we last looked at `window' we're probably in one.
2215 ;; The first non-selectable window `previous-window' got
2216 ;; us: Remember it and the current value of COUNT.
2223 ;; Always return nil.
2224 nil))))
2226 ;; This should probably return non-nil when the selected window is part
2227 ;; of an atomic window whose root is the frame's root window.
2229 "Return non-nil if the selected window is the only window.
2230 Optional arg NOMINI non-nil means don't count the minibuffer
2231 even if it is active. Otherwise, the minibuffer is counted
2232 when it is active.
2234 Optional argument ALL-FRAMES specifies the set of frames to
2235 consider, see also `next-window'. ALL-FRAMES nil or omitted
2236 means consider windows on the selected frame only, plus the
2237 minibuffer window if specified by the NOMINI argument. If the
2238 minibuffer counts, consider all windows on all frames that share
2239 that minibuffer too. The remaining non-nil values of ALL-FRAMES
2240 with a special meaning are:
2242 - t means consider all windows on all existing frames.
2244 - `visible' means consider all windows on all visible frames on
2245 the current terminal.
2247 - 0 (the number zero) means consider all windows on all visible
2248 and iconified frames on the current terminal.
2250 - A frame means consider all windows on that frame only.
2252 Anything else means consider all windows on the selected frame
2253 and no others."
2259 \f
2260 ;;; Deleting windows.
2262 "Return t if WINDOW can be safely deleted from its frame.
2263 Return `frame' if deleting WINDOW should also delete its
2264 frame."
2268 ;; Handle atomicity.
2277 ;; WINDOW's frame can be deleted only if there are other frames
2278 ;; on the same terminal.
2284 ;; WINDOW can be deleted unless it is the main window of its
2285 ;; frame.
2286 t))))
2289 "Return t if SUBWINDOW is either WINDOW or a subwindow of WINDOW."
2299 "Delete WINDOW.
2300 WINDOW can be an arbitrary window and defaults to the selected
2301 one. Return nil.
2303 If the variable `ignore-window-parameters' is non-nil or the
2304 `delete-window' parameter of WINDOW equals t, do not process any
2305 parameters of WINDOW. Otherwise, if the `delete-window'
2306 parameter of WINDOW specifies a function, call that function with
2307 WINDOW as its sole argument and return the value returned by that
2308 function.
2310 Otherwise, if WINDOW is part of an atomic window, call
2311 `delete-window' with the root of the atomic window as its
2312 argument. If WINDOW is the only window on its frame or the last
2313 non-side window, signal an error."
2319 atom-root)
2322 ;; Handle window parameters.
2324 ;; Ignore window parameters if `ignore-window-parameters' tells
2325 ;; us so or `delete-window' equals t.
2328 ;; The `delete-window' parameter specifies the function to call.
2329 ;; If that function is `ignore' nothing is done. It's up to the
2330 ;; function called here to avoid infinite recursion.
2347 ;; Emacs 23 preferably gives WINDOW's space to its left
2348 ;; sibling.
2354 ;; Resize WINDOW's sibling.
2360 ;; Can do without resizing fixed-size windows.
2363 ;; Can't do without resizing fixed-size windows.
2365 ;; Actually delete WINDOW.
2370 ;; `delete-window-internal' has selected a window that should
2371 ;; not be selected, fix this here.
2375 ;; Always return nil.
2376 nil))))
2379 "Make WINDOW fill its frame.
2380 WINDOW may be any window and defaults to the selected one.
2381 Return nil.
2383 If the variable `ignore-window-parameters' is non-nil or the
2384 `delete-other-windows' parameter of WINDOW equals t, do not
2385 process any parameters of WINDOW. Otherwise, if the
2386 `delete-other-windows' parameter of WINDOW specifies a function,
2387 call that function with WINDOW as its sole argument and return
2388 the value returned by that function.
2390 Otherwise, if WINDOW is part of an atomic window, call this
2391 function with the root of the atomic window as its argument. If
2392 WINDOW is a non-side window, make WINDOW the only non-side window
2393 on the frame. Side windows are not deleted. If WINDOW is a side
2394 window signal an error."
2400 atom-root side-main)
2404 ;; Ignore window parameters if `ignore-window-parameters' is t or
2405 ;; `delete-other-windows' is t.
2408 ;; The `delete-other-windows' parameter specifies the function
2409 ;; to call. If the function is `ignore' no windows are deleted.
2410 ;; It's up to the function called to avoid infinite recursion.
2417 ;; Set side-main to the major non-side window.
2421 ;; If WINDOW is the main non-side window, do nothing.
2426 ;; Always return nil.
2427 nil)))
2430 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
2432 if you often split windows horizontally."
2444 ;;; Windows and buffers.
2446 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
2447 ;; for (1) determining which buffer to show in the window when its
2448 ;; buffer shall be buried or killed and (2) which buffer to show for
2449 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2451 ;; `prev-buffers' consists of <buffer, window-start, window-point>
2452 ;; triples. The entries on this list are ordered by the time their
2453 ;; buffer has been removed from the window, the most recently removed
2454 ;; buffer's entry being first. The window-start and window-point
2455 ;; components are `window-start' and `window-point' at the time the
2456 ;; buffer was removed from the window which implies that the entry must
2457 ;; be added when `set-window-buffer' removes the buffer from the window.
2459 ;; `next-buffers' is the list of buffers that have been replaced
2460 ;; recently by `switch-to-prev-buffer'. These buffers are the least
2461 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
2462 ;; candidates of `switch-to-next-buffer' to switch to. This list is
2463 ;; reset to nil by any action changing the window's buffer with the
2464 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
2465 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
2466 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
2468 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
2469 ;; if such a buffer was killed while the window was hidden within a
2470 ;; window configuration. Such killed buffers get removed whenever
2471 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
2473 ;; The following function is called by `set-window-buffer' _before_ it
2474 ;; replaces the buffer of the argument window with the new buffer.
2476 "Record WINDOW's buffer.
2477 WINDOW must be a live window and defaults to the selected one."
2481 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
2482 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2486 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
2490 ;; Don't record insignificant buffers.
2492 ;; Add an entry for buffer to WINDOW's previous buffers.
2499 ;; We have an entry, update marker positions.
2502 ;; Make new markers.
2510 "Unrecord BUFFER in WINDOW.
2511 WINDOW must be a live window and defaults to the selected one.
2512 BUFFER must be a live buffer and defaults to the buffer of
2513 WINDOW."
2522 "Set WINDOW's buffer to BUFFER.
2523 Optional argument START non-nil means set WINDOW's start position
2524 to START. Optional argument POINT non-nil means set WINDOW's
2525 point to POINT. If WINDOW is selected this also sets BUFFER's
2526 `point' to POINT. If WINDOW is selected and the buffer it showed
2527 before was current this also makes BUFFER the current buffer."
2534 ;; Don't force window-start here (even if POINT is nil).
2543 "In WINDOW switch to previous buffer.
2544 WINDOW must be a live window and defaults to the selected one.
2546 Optional argument BURY-OR-KILL non-nil means the buffer currently
2547 shown in WINDOW is about to be buried or killed and consequently
2548 shall not be switched to in future invocations of this command."
2552 ;; Save this since it's destroyed by `set-window-buffer'.
2554 entry new-buffer killed-buffers visible)
2559 ;; Scan WINDOW's previous buffers first, skipping entries of next
2560 ;; buffers.
2572 ;; Scan reverted buffer list of WINDOW's frame next, skipping
2573 ;; entries of next buffers. Note that when we bury or kill a
2574 ;; buffer we don't reverse the global buffer list to avoid showing
2575 ;; a buried buffer instead. Otherwise, we must reverse the global
2576 ;; buffer list in order to make sure that switching to the
2577 ;; previous/next buffer traverse it in opposite directions.
2586 ;; Try to avoid showing a buffer visible in some other window.
2592 ;; Scan reverted next buffers last (must not use nreverse
2593 ;; here!).
2595 ;; Actually, buffer _must_ be live here since otherwise it
2596 ;; would have been caught in the scan of previous buffers.
2607 ;; Show a buffer visible in another window.
2613 ;; Remove `old-buffer' from WINDOW's previous and (restored list
2614 ;; of) next buffers.
2619 ;; Move `old-buffer' to head of WINDOW's restored list of next
2620 ;; buffers.
2624 ;; Remove killed buffers from WINDOW's previous and next buffers.
2632 ;; Return new-buffer.
2633 new-buffer))
2636 "In WINDOW switch to next buffer.
2637 WINDOW must be a live window and defaults to the selected one."
2642 new-buffer entry killed-buffers visible)
2647 ;; Scan WINDOW's next buffers first.
2658 ;; Scan the buffer list of WINDOW's frame next, skipping previous
2659 ;; buffers entries.
2665 ;; Try to avoid showing a buffer visible in some other window.
2670 ;; Scan WINDOW's reverted previous buffers last (must not use
2671 ;; nreverse here!)
2682 ;; Show a buffer visible in another window.
2687 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
2690 ;; Remove killed buffers from WINDOW's previous and next buffers.
2698 ;; Return new-buffer.
2699 new-buffer))
2702 "Search LIST for a valid buffer to display in FRAME.
2703 Return nil when all buffers in LIST are undesirable for display,
2704 otherwise return the first suitable buffer in LIST.
2706 Buffers not visible in windows are preferred to visible buffers,
2707 unless VISIBLE-OK is non-nil.
2708 If the optional argument FRAME is nil, it defaults to the selected frame.
2709 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
2710 ;; This logic is more or less copied from other-buffer.
2713 found buf)
2726 "Return the last buffer in FRAME's buffer list.
2727 If BUFFER is the last buffer, return the preceding buffer
2728 instead. Buffers not visible in windows are preferred to visible
2729 buffers, unless optional argument VISIBLE-OK is non-nil.
2730 Optional third argument FRAME nil or omitted means use the
2731 selected frame's buffer list. If no such buffer exists, return
2732 the buffer `*scratch*', creating it if necessary."
2735 buffer visible-ok frame)
2739 scratch)))
2742 "Put BUFFER-OR-NAME at the end of the list of all buffers.
2743 There it is the least likely candidate for `other-buffer' to
2745 select by default.
2747 You can specify a buffer name as BUFFER-OR-NAME, or an actual
2748 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
2749 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
2750 remove the current buffer from the selected window if it is
2751 displayed there."
2754 ;; If `buffer-or-name' is not on the selected frame we unrecord it
2755 ;; although it's not "here" (call it a feature).
2757 ;; Handle case where `buffer-or-name' is nil and the current buffer
2758 ;; is shown in the selected window.
2764 ;; Don't iconify if it's the only frame.
2770 ;; Always return nil.
2771 nil))
2774 "Switch to the last buffer in the buffer list."
2779 "In selected window switch to next buffer."
2786 "In selected window switch to previous buffer."
2793 "Delete all windows showing BUFFER-OR-NAME.
2794 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2795 and defaults to the current buffer.
2797 The following non-nil values of the optional argument FRAME
2798 have special meanings:
2800 - t means consider all windows on the selected frame only.
2802 - `visible' means consider all windows on all visible frames on
2803 the current terminal.
2805 - 0 (the number zero) means consider all windows on all visible
2806 and iconified frames on the current terminal.
2808 - A frame means consider all windows on that frame only.
2810 Any other value of FRAME means consider all windows on all
2811 frames.
2813 When a window showing BUFFER-OR-NAME is dedicated and the only
2814 window of its frame, that frame is deleted when there are other
2815 frames left."
2818 ;; Handle the "inverted" meaning of the FRAME argument wrt other
2819 ;; `window-list-1' based function.
2826 ;; Delete frame if and only if window is dedicated.
2829 ;; Delete window.
2832 ;; In window switch to previous buffer.
2835 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
2839 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
2840 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2841 and defaults to the current buffer.
2843 When a window showing BUFFER-OR-NAME is either dedicated, or the
2844 window has no previous buffer, that window is deleted. If that
2845 window is the only window on its frame, the frame is deleted too
2846 when there are other frames left. If there are no other frames
2847 left, some other buffer is displayed in that window.
2849 This function removes the buffer denoted by BUFFER-OR-NAME from
2850 all window-local buffer lists."
2858 ;; Delete frame.
2861 ;; Delete window.
2864 ;; Switch to another buffer in window.
2867 ;; Unrecord BUFFER in WINDOW.
2871 "Quit WINDOW and bury its buffer.
2872 WINDOW must be a live window and defaults to the selected one.
2873 With prefix argument KILL non-nil, kill the buffer instead of
2874 burying it.
2876 According to information stored in WINDOW's `quit-restore' window
2877 parameter either \(1) delete WINDOW and its frame, \(2) delete
2878 WINDOW, \(3) restore the buffer previously displayed in WINDOW,
2879 or \(4) make WINDOW display some other buffer than the present
2880 one. If non-nil, reset `quit-restore' parameter to nil."
2891 buffer))))
2892 prev-buffer)))
2893 quad resize)
2899 ;; WINDOW's frame can be deleted.
2901 ;; If the previously selected window is still alive, select it.
2908 ;; WINDOW can be deleted.
2910 ;; If the previously selected window is still alive, select it.
2916 ;; Show another buffer stored in quit-restore parameter.
2923 ;; Try to resize WINDOW to its old height but don't signal an
2924 ;; error.
2928 ;; Restore WINDOW's previous buffer, window start and point.
2931 ;; Reset the quit-restore parameter.
2933 ;; Select old window.
2937 ;; Show some other buffer in WINDOW and reset the quit-restore
2938 ;; parameter.
2940 ;; Make sure that WINDOW is no more dedicated.
2944 ;; Kill WINDOW's old-buffer if requested
2948 \f
2949 ;;; Splitting windows.
2951 "Return minimum height of any window when splitting windows.
2952 Optional argument HORIZONTAL non-nil means return minimum width."
2958 "Make a new window adjacent to WINDOW.
2959 WINDOW can be any window and defaults to the selected one.
2960 Return the new window which is always a live window.
2962 Optional argument SIZE a positive number means make WINDOW SIZE
2963 lines or columns tall. If SIZE is negative, make the new window
2964 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
2965 absolute value can be less than `window-min-height' or
2966 `window-min-width'; so this command can make a new window as
2967 small as one line or two columns. SIZE defaults to half of
2968 WINDOW's size. Interactively, SIZE is the prefix argument.
2970 Optional third argument SIDE nil (or `below') specifies that the
2971 new window shall be located below WINDOW. SIDE `above' means the
2972 new window shall be located above WINDOW. In both cases SIZE
2973 specifies the new number of lines for WINDOW \(or the new window
2974 if SIZE is negative) including space reserved for the mode and/or
2975 header line.
2977 SIDE t (or `right') specifies that the new window shall be
2978 located on the right side of WINDOW. SIDE `left' means the new
2979 window shall be located on the left of WINDOW. In both cases
2980 SIZE specifies the new number of columns for WINDOW \(or the new
2981 window provided SIZE is negative) including space reserved for
2982 fringes and the scrollbar or a divider column. Any other non-nil
2983 value for SIDE is currently handled like t (or `right').
2985 If the variable `ignore-window-parameters' is non-nil or the
2986 `split-window' parameter of WINDOW equals t, do not process any
2987 parameters of WINDOW. Otherwise, if the `split-window' parameter
2988 of WINDOW specifies a function, call that function with all three
2989 arguments and return the value returned by that function.
2992 root of that atomic window. The new window does not become a
2993 member of that atomic window.
2995 If WINDOW is live, properties of the new window like margins and
2996 scrollbars are inherited from WINDOW. If WINDOW is an internal
2997 window, these properties as well as the buffer displayed in the
2998 new window are inherited from the window selected on WINDOW's
2999 frame. The selected window is not changed by this function."
3011 ;; Rebind `window-nest' since in some cases we may have to
3012 ;; override its value.
3014 atom-root)
3019 ;; Ignore window parameters if either `ignore-window-parameters'
3020 ;; is t or the `split-window' parameter equals t.
3023 ;; The `split-window' parameter specifies the function to call.
3024 ;; If that function is `ignore', do nothing.
3026 ;; If WINDOW is a subwindow of an atomic window, split the root
3027 ;; window of that atomic window instead.
3036 ;; WINDOW is a side root window. To make sure that a new parent
3037 ;; window gets created set `window-nest' to t.
3041 ;; If `window-splits' is non-nil and SIZE is a non-negative
3042 ;; integer, we cannot reasonably resize other windows. Rather
3043 ;; bind `window-nest' to t to make sure that subsequent window
3044 ;; deletions are handled correctly.
3048 ;; `parent-size' is the size of WINDOW's parent, provided
3049 ;; it has one.
3051 ;; `resize' non-nil means we are supposed to resize other
3052 ;; windows in WINDOW's combination.
3055 ;; Resize makes sense in iso-combinations only.
3057 ;; `old-size' is the current size of WINDOW.
3059 ;; `new-size' is the specified or calculated size of the
3060 ;; new window.
3066 ;; When resizing try to give the new window the
3067 ;; average size of a window in its combination.
3070 (/ parent-size
3072 parent horizontal))))
3073 ;; Else try to give the new window half the size
3074 ;; of WINDOW (plus an eventual odd line).
3077 ;; SIZE non-negative specifies the new size of WINDOW.
3079 ;; Note: Specifying a non-negative SIZE is practically
3080 ;; always done as workaround for making the new window
3081 ;; appear above or on the left of the new window (the
3082 ;; ispell window is a typical example of that). In all
3083 ;; these cases the SIDE argument should be set to 'above
3084 ;; or 'left in order to support the 'resize option.
3085 ;; Here we have to nest the windows instead, see above.
3088 ;; SIZE negative specifies the size of the new window.
3090 new-parent new-normal)
3092 ;; Check SIZE.
3097 ;; SIZE unspecified, resizing.
3099 ;; Try again with minimum split size.
3105 ;; SIZE unspecified, no resizing.
3110 window-safe-min-width
3111 window-safe-min-width))))
3112 ;; SIZE specified as new size of old window. If the new size
3113 ;; is larger than the old size or the size of the new window
3114 ;; would be less than the safe minimum, signal an error.
3117 ;; SIZE specified, resizing.
3119 ;; If we cannot resize the parent give up.
3125 ;; SIZE specification violates minimum size restrictions.
3131 ;; Make new-parent non-nil if we need a new parent window;
3132 ;; either because we want to nest or because WINDOW is not
3133 ;; iso-combined.
3136 ;; Make new-normal the normal size of the new window.
3144 ;; Try to get space from OLD's siblings. We could go "up" and
3145 ;; try getting additional space from surrounding windows but
3146 ;; we won't be able to return space to those windows when we
3147 ;; delete the one we create here. Hence we do not go up.
3156 ;; Get entire space from WINDOW.
3161 new-normal)))
3164 ;; Inherit window-side parameters, if any.
3171 ;; Always return the new window.
3172 new)))))
3174 ;; I think this should be the default; I think people will prefer it--rms.
3177 in both children.
3178 This is often more convenient for editing.
3179 If nil, adjust point in each of the two windows to minimize redisplay.
3180 This is convenient on slow terminals, but point can move strangely.
3182 This option applies only to `split-window-above-each-other' and
3183 functions that call it. `split-window' always keeps the original
3184 point in both children."
3189 "Split selected window into two windows, one above the other.
3190 The upper window gets SIZE lines and the lower one gets the rest.
3191 SIZE negative means the lower window gets -SIZE lines and the
3192 upper one the rest. With no argument, split windows equally or
3193 close to it. Both windows display the same buffer, now current.
3195 If the variable `split-window-keep-point' is non-nil, both new
3196 windows will get the same value of point as the selected window.
3197 This is often more convenient for editing. The upper window is
3198 the selected window.
3200 Otherwise, we choose window starts so as to minimize the amount of
3201 redisplay; this is convenient on slow terminals. The new selected
3202 window is the one that the current value of point appears in. The
3203 value of point can change if the text around point is hidden by the
3204 new mode line.
3206 Regardless of the value of `split-window-keep-point', the upper
3207 window is the original one and the return value is the new, lower
3208 window."
3213 moved-by-window-height moved new-window bottom)
3215 ;; `split-window' would not signal an error here.
3236 ;; Always copy quit-restore parameter in interactive use.
3240 new-window))
3245 "Split selected window into two windows side by side.
3246 The selected window becomes the left one and gets SIZE columns.
3247 SIZE negative means the right window gets -SIZE columns.
3249 SIZE includes the width of the window's scroll bar; if there are
3250 no scroll bars, it includes the width of the divider column to
3251 the window's right, if any. SIZE omitted or nil means split
3252 window equally.
3254 The selected window remains selected. Return the new window."
3258 new-window)
3260 ;; `split-window' would not signal an error here.
3263 ;; Always copy quit-restore parameter in interactive use.
3267 new-window))
3270 \f
3271 ;;; Balancing windows.
3273 ;; The following routine uses the recycled code from an old version of
3274 ;; `window--resize-subwindows'. It's not very pretty, but coding it the way the
3275 ;; new `window--resize-subwindows' code does would hardly make it any shorter or
3276 ;; more readable (FWIW we'd need three loops - one to calculate the
3277 ;; minimum sizes per window, one to enlarge or shrink windows until the
3278 ;; new parent-size matches, and one where we shrink the largest/enlarge
3279 ;; the smallest window).
3281 "Subroutine of `balance-windows-1'.
3282 WINDOW must be an iso-combination."
3288 found failed size sub-total sub-delta sub-amount rest)
3303 ;; Ignore subwindows that should be ignored or are stuck.
3310 ;; Register the new total size for this subwindow.
3315 ;; We failed and need a new round.
3321 ;; Fix rounding by trying to enlarge non-stuck windows by one line
3322 ;; (column) until `rest' is zero.
3330 ;; Fix rounding by trying to enlarge stuck windows by one line
3331 ;; (column) until `rest' equals zero.
3341 ;; Record new normal sizes.
3347 ;; Recursively balance each subwindow's subwindows.
3352 "Subroutine of `balance-windows'."
3364 "Balance the sizes of subwindows of WINDOW-OR-FRAME.
3365 WINDOW-OR-FRAME is optional and defaults to the selected frame.
3366 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
3367 subwindows of that frame's root window. If WINDOW-OR-FRAME
3368 denots a window, balance the sizes of all subwindows of that
3369 window."
3378 window-or-frame)
3382 ;; Balance vertically.
3386 ;; Balance horizontally.
3392 "Return t if WINDOW cannot be resized in DIRECTION.
3393 WINDOW defaults to the selected window. DIRECTION can be
3394 nil (i.e. any), `height' or `width'."
3401 ;;; A different solution to balance-windows.
3403 "Factor by which the window area should be over-estimated.
3404 This is used by `balance-windows-area'.
3409 "Wrapper around `window-resize' with error checking.
3410 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
3411 ;; `window-resize' may fail if delta is too large.
3418 ;;(message "adjust: %s" (error-message-string err))
3422 "Make all visible windows the same area (approximately).
3423 See also `window-area-factor' to change the relative size of
3424 specific buffers."
3427 ;; Remove fixed-size windows.
3432 next)
3433 ;; Resizing a window changes the size of surrounding windows in complex
3434 ;; ways, so it's difficult to balance them all. The introduction of
3435 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
3436 ;; very difficult to do. `balance-window' above takes an off-line
3437 ;; approach: get the whole window tree, then balance it, then try to
3438 ;; adjust the windows so they fit the result.
3439 ;; Here, instead, we take a "local optimization" approach, where we just
3440 ;; go through all the windows several times until nothing needs to be
3441 ;; changed. The main problem with this approach is that it's difficult
3442 ;; to make sure it terminates, so we use some heuristic to try and break
3443 ;; off infinite loops.
3444 ;; After a round without any change, we allow a second, to give a chance
3445 ;; to the carry to propagate a minor imbalance from the end back to
3446 ;; the beginning.
3448 ;; (message "New round")
3454 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
3472 ;; Maybe diff is actually closer to 1 than to 0.
3476 ;; Change things smoothly.
3479 ;; Make sure negligible differences don't accumulate to
3480 ;; become significant.
3482 ;; This used `adjust-window-trailing-edge' before and uses
3483 ;; `window-resize' now. Error wrapping is still needed.
3485 ;; (sit-for 0.5)
3487 ;; If the same change has been seen already for this window,
3488 ;; we're most likely in an endless loop, so don't count it as
3489 ;; a change.
3493 ;; We've now basically balanced all the windows.
3494 ;; But there may be some minor off-by-one imbalance left over,
3495 ;; so let's do some fine tuning.
3496 ;; (bw-finetune wins)
3497 ;; (message "Done in %d rounds" round)
3498 ))
3500 ;;; Window states, how to get them and how to put them in a window.
3502 "Like LIST but do not add nil elements of ARGS."
3509 "Helper function for `window-state-get'."
3519 type
3530 window-state-ignored-parameters)
3533 ;; Make a clone-of parameter.
3538 ;; All buffer related things go in here - make the buffer
3539 ;; current when retrieving `point' and `mark'.
3569 "Return state of WINDOW as a Lisp object.
3570 WINDOW can be any window and defaults to the root window of the
3571 selected frame.
3573 Optional argument MARKERS non-nil means use markers for sampling
3574 positions like `window-point' or `window-start'. MARKERS should
3575 be non-nil only if the value is used for putting the state back
3576 in the same session (note that markers slow down processing).
3578 The return value can be used as argument for `window-state-put'
3579 to put the state recorded here into an arbitrary window. The
3580 value can be also stored on disk and read back in a new session."
3584 window
3587 ;; The return value is a cons whose car specifies some constraints on
3588 ;; the size of WINDOW. The cdr lists the states of the subwindows of
3589 ;; WINDOW.
3591 ;; Frame related things would go into a function, say `frame-state',
3592 ;; calling `window-state-get' to insert the frame's root window.
3600 ;; These are probably not needed.
3609 "Helper function for `window-state-put'."
3614 ;; For a leaf window just add unprocessed entries to
3615 ;; `window-state-put-list'.
3622 size new)
3624 ;; Find the next child window. WINDOW always points to the
3625 ;; real window that we want to fill with what we find here.
3628 ;; The last child window. Below `window-state-put-1'
3629 ;; will put into it whatever ITEM has in store.
3631 ;; Not the last child window, prepare for splitting
3632 ;; WINDOW. SIZE is the new (and final) size of the old
3633 ;; window.
3636 ;; Use total size.
3638 ;; Use normalized size and round.
3642 item))))))
3644 ;; Use safe sizes, we try to resize later.
3646 window-safe-min-height
3647 window-safe-min-width)))
3651 ;; We must inherit the nesting, otherwise we might mess
3652 ;; up handling of atomic and side window.
3654 ;; Give up if we can't resize window down to safe sizes.
3659 ;; When creating the first child window add for parent
3660 ;; unprocessed entries to `window-state-put-list'.
3663 window-state-put-list))))
3665 ;; Now process the current window (either the one we've just
3666 ;; split or the last child of its parent).
3668 ;; Continue with the last window split off.
3672 "Helper function for `window-state-put'."
3681 ;; Process parameters.
3685 ;; Process buffer related state.
3687 ;; We don't want to raise an error here so we create a buffer if
3688 ;; there's none.
3700 ;; Adjust vertically.
3702 ;; A fixed height window, try to restore the original size.
3705 window-size-fixed)
3708 ;; Else check whether the window is not high enough.
3714 ;; Adjust horizontally.
3716 ;; A fixed width window, try to restore the original size.
3719 window-size-fixed)
3722 ;; Else check whether the window is not wide enough.
3728 ;; Set dedicated status.
3730 ;; Install positions (maybe we should do this after all windows
3731 ;; have been created and sized).
3735 ;; I'm not sure whether we should set the mark here, but maybe
3736 ;; it can be used.
3739 ;; Select window if it's the selected one.
3744 "Put window state STATE into WINDOW.
3745 STATE should be the state of a window returned by an earlier
3746 invocation of `window-state-get'. Optional argument WINDOW must
3747 specify a live window and defaults to the selected one.
3749 Optional argument IGNORE non-nil means ignore minimum window
3750 sizes and fixed size restrictions. IGNORE equal `safe' means
3751 subwindows can get as small as `window-safe-min-height' and
3752 `window-safe-min-width'."
3756 ;; We check here (1) whether the total sizes of root window of
3757 ;; STATE and that of WINDOW are equal so we can avoid
3758 ;; calculating new sizes, and (2) if we do have to resize
3759 ;; whether we can do so without violating size restrictions.
3767 window-splits selected)
3785 (> min-width
3787 ;; The check above might not catch all errors due to rounding
3788 ;; issues - so IGNORE equal 'safe might not always produce the
3789 ;; minimum possible state. But such configurations hardly make
3790 ;; sense anyway.
3794 ;; Work on the windows of a temporary buffer to make sure that
3795 ;; splitting proceeds regardless of any buffer local values of
3796 ;; `window-size-fixed'. Release that buffer after the buffers of
3797 ;; all live windows have been set by `window-state-put-2'.
3803 \f
3805 "Record information for window used by `display-buffer'.
3806 TYPE specifies the type of the calling operation and must be one
3807 of the symbols 'reuse \(when WINDOW existed already and was
3808 reused for displaying BUFFER), 'window \(when WINDOW was created
3809 on an already existing frame), or 'frame \(when WINDOW was
3810 created on a new frame). WINDOW is the window used for or created
3811 by the `display-buffer' routines. BUFFER is the buffer that
3812 shall be displayed.
3814 This function installs or updates the quit-restore parameter of
3815 WINDOW. The quit-restore parameter is a list of four elements:
3816 The first element is one of the symbols 'window, 'frame, 'same or
3817 'other. The second element is either one of the symbols 'window
3818 or 'frame or a list whose elements are the buffer previously
3819 shown in the window, that buffer's window start and window point,
3820 and the window's height. The third element is the window
3821 selected at the time the parameter was created. The fourth
3822 element is BUFFER."
3826 ;; WINDOW shows BUFFER already.
3828 ;; If WINDOW has a quit-restore parameter, reset its car.
3830 ;; WINDOW shows another buffer.
3832 window 'quit-restore
3834 ;; A quadruple of WINDOW's buffer, start, point and height.
3839 ;; WINDOW has been created on an existing frame.
3841 window 'quit-restore
3844 ;; WINDOW has been created on a new frame.
3846 window 'quit-restore
3850 "If non-nil, function to call to handle `display-buffer'.
3851 It will receive two args, the buffer and a flag which if non-nil
3852 means that the currently selected window is not acceptable. It
3853 should choose or create a window, display the specified buffer in
3854 it, and return the window.
3856 The function specified here is responsible for setting the
3857 quit-restore and help-setup parameters of the window used."
3864 "Alist of parameters for automatically generated new frames.
3865 You can set this in your init file; for example,
3867 (setq pop-up-frame-alist '((width . 80) (height . 20)))
3869 If non-nil, the value you specify here is used by the default
3870 `pop-up-frame-function' for the creation of new frames.
3872 Since `pop-up-frame-function' is used by `display-buffer' for
3873 making new frames, any value specified here by default affects
3874 the automatic generation of new frames via `display-buffer' and
3875 all functions based on it. The behavior of `make-frame' is not
3876 affected by this variable."
3884 "Function used by `display-buffer' for creating a new frame.
3885 This function is called with no arguments and should return a new
3886 frame. The default value calls `make-frame' with the argument
3887 `pop-up-frame-alist'."
3892 "List of names of buffers that should be displayed specially.
3893 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
3894 its name is in this list, displays the buffer in a way specified
3895 by `special-display-function'. `special-display-popup-frame'
3896 \(the default for `special-display-function') usually displays
3897 the buffer in a separate frame made with the parameters specified
3898 by `special-display-frame-alist'. If `special-display-function'
3899 has been set to some other function, that function is called with
3900 the buffer as first, and nil as second argument.
3902 Alternatively, an element of this list can be specified as
3903 \(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
3904 name and FRAME-PARAMETERS an alist of \(PARAMETER . VALUE) pairs.
3905 `special-display-popup-frame' will interpret such pairs as frame
3906 parameters when it creates a special frame, overriding the
3907 corresponding values from `special-display-frame-alist'.
3909 As a special case, if FRAME-PARAMETERS contains (same-window . t)
3910 `special-display-popup-frame' displays that buffer in the
3911 selected window. If FRAME-PARAMETERS contains (same-frame . t),
3912 it displays that buffer in a window on the selected frame.
3914 If `special-display-function' specifies some other function than
3915 `special-display-popup-frame', that function is called with the
3916 buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
3917 argument.
3919 Finally, an element of this list can be also specified as
3920 \(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
3921 `special-display-popup-frame' will call FUNCTION with the buffer
3922 named BUFFER-NAME as first argument, and OTHER-ARGS as the
3923 second. If `special-display-function' specifies some other
3924 function, that function is called with the buffer named
3925 BUFFER-NAME as first, and the element's cdr as second argument.
3926 In any case, that function is responsible for setting the value
3927 The function specified here is responsible for setting the
3928 quit-restore and help-setup parameters of the window used.
3931 name to it but the corresponding buffer is displayed in the
3932 selected window, look at the values of `same-window-buffer-names'
3933 and `same-window-regexps'. Those variables take precedence over
3934 this one.
3936 See also `special-display-regexps'."
3958 ;;;###autoload
3962 "List of regexps saying which buffers should be displayed specially.
3963 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
3964 any regexp in this list matches its name, displays it specially
3965 using `special-display-function'. `special-display-popup-frame'
3966 \(the default for `special-display-function') usually displays
3967 the buffer in a separate frame made with the parameters specified
3968 by `special-display-frame-alist'. If `special-display-function'
3969 has been set to some other function, that function is called with
3970 the buffer as first, and nil as second argument.
3972 Alternatively, an element of this list can be specified as
3973 \(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
3974 FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
3975 `special-display-popup-frame' will then interpret these pairs as
3976 frame parameters when creating a special frame for a buffer whose
3977 name matches REGEXP, overriding the corresponding values from
3978 `special-display-frame-alist'.
3980 As a special case, if FRAME-PARAMETERS contains (same-window . t)
3981 `special-display-popup-frame' displays buffers matching REGEXP in
3982 the selected window. \(same-frame . t) in FRAME-PARAMETERS means
3983 to display such buffers in a window on the selected frame.
3985 If `special-display-function' specifies some other function than
3986 `special-display-popup-frame', that function is called with the
3987 buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
3988 as second argument.
3990 Finally, an element of this list can be also specified as
3991 \(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
3992 will then call FUNCTION with the buffer whose name matched
3993 REGEXP as first, and OTHER-ARGS as second argument. If
3994 `special-display-function' specifies some other function, that
3995 function is called with the buffer whose name matched REGEXP
3996 as first, and the element's cdr as second argument.
3999 name to it but the corresponding buffer is displayed in the
4000 selected window, look at the values of `same-window-buffer-names'
4001 and `same-window-regexps'. Those variables take precedence over
4002 this one.
4004 See also `special-display-buffer-names'."
4027 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
4028 More precisely, return t if `special-display-buffer-names' or
4029 `special-display-regexps' contain a string entry equaling or
4030 matching BUFFER-NAME. If `special-display-buffer-names' or
4031 `special-display-regexps' contain a list entry whose car equals
4032 or matches BUFFER-NAME, the return value is the cdr of that
4033 entry."
4038 t)
4053 "Alist of parameters for special frames.
4054 Special frames are used for buffers whose names are listed in
4055 `special-display-buffer-names' and for buffers whose names match
4056 one of the regular expressions in `special-display-regexps'.
4058 This variable can be set in your init file, like this:
4060 (setq special-display-frame-alist '((width . 80) (height . 20)))
4062 These supersede the values given in `default-frame-alist'."
4069 "Display BUFFER and return the window chosen.
4070 If BUFFER is already displayed in a visible or iconified frame,
4071 raise that frame. Otherwise, display BUFFER in a new frame.
4073 Optional argument ARGS is a list specifying additional
4074 information.
4076 If ARGS is an alist, use it as a list of frame parameters. If
4077 these parameters contain \(same-window . t), display BUFFER in
4078 the selected window. If they contain \(same-frame . t), display
4079 BUFFER in a window of the selected frame.
4081 If ARGS is a list whose car is a symbol, use (car ARGS) as a
4082 function to do the work. Pass it BUFFER as first argument,
4083 and (cdr ARGS) as second."
4088 ;; If we have a window already, make it visible.
4094 window))
4095 ;; Reuse the current window if the user requested it.
4100 ;; Stay on the same frame if requested.
4103 pop-up-frames
4104 special-display-buffer-names special-display-regexps)
4106 ;; If no window yet, make one in a new frame.
4113 ;; Reset list of WINDOW's previous buffers to nil.
4116 window)))))
4119 "Function to call for displaying special buffers.
4120 This function is called with two arguments - the buffer and,
4121 optionally, a list - and should return a window displaying that
4122 buffer. The default value usually makes a separate frame for the
4123 buffer using `special-display-frame-alist' to specify the frame
4124 parameters. See the definition of `special-display-popup-frame'
4125 for how to specify such a function.
4127 A buffer is special when its name is either listed in
4128 `special-display-buffer-names' or matches a regexp in
4129 `special-display-regexps'.
4131 The function specified here is responsible for setting the
4132 quit-restore and help-setup parameters of the window used."
4138 `display-buffer' and `pop-to-buffer' show a buffer whose name is
4139 on this list in the selected rather than some other window.
4141 An element of this list can be a cons cell instead of just a
4142 string. In that case, the cell's car must be a string specifying
4143 the buffer name. This is for compatibility with
4144 `special-display-buffer-names'; the cdr of the cons cell is
4145 ignored.
4147 See also `same-window-regexps'."
4153 `display-buffer' and `pop-to-buffer' show a buffer whose name
4154 matches a regexp on this list in the selected rather than some
4155 other window.
4157 An element of this list can be a cons cell instead of just a
4158 string. In that case, the cell's car must be a regexp matching
4159 the buffer name. This is for compatibility with
4160 `special-display-regexps'; the cdr of the cons cell is ignored.
4162 See also `same-window-buffer-names'."
4168 This function returns non-nil if `display-buffer' or
4169 `pop-to-buffer' would show a buffer named BUFFER-NAME in the
4170 selected rather than \(as usual\) some other window. See
4171 `same-window-buffer-names' and `same-window-regexps'."
4174 ;; The elements of `same-window-buffer-names' can be buffer
4175 ;; names or cons cells whose cars are buffer names.
4180 ;; The elements of `same-window-regexps' can be regexps
4181 ;; or cons cells whose cars are regexps.
4189 "Whether `display-buffer' should make a separate frame.
4190 If nil, never make a separate frame.
4191 If the value is `graphic-only', make a separate frame
4192 on graphic displays only.
4193 Any other non-nil value means always make a separate frame."
4201 "Non-nil means `display-buffer' should reuse frames.
4202 If the buffer in question is already displayed in a frame, raise
4203 that frame."
4209 "Non-nil means `display-buffer' should make a new window."
4214 "Function called by `display-buffer' routines to split a window.
4215 This function is called with a window as single argument and is
4216 supposed to split that window and return the new window. If the
4217 window can (or shall) not be split, it is supposed to return nil.
4218 The default is to call the function `split-window-sensibly' which
4219 tries to split the window in a way which seems most suitable.
4220 You can customize the options `split-height-threshold' and/or
4221 `split-width-threshold' in order to have `split-window-sensibly'
4222 prefer either vertical or horizontal splitting.
4224 If you set this to any other function, bear in mind that the
4225 `display-buffer' routines may call this function two times. The
4226 argument of the first call is the largest window on its frame.
4227 If that call fails to return a live window, the function is
4228 called again with the least recently used window as argument. If
4229 that call fails too, `display-buffer' will use an existing window
4230 to display its buffer.
4232 The window selected at the time `display-buffer' was invoked is
4233 still selected when this function is called. Hence you can
4234 compare the window argument with the value of `selected-window'
4235 if you intend to split the selected window instead or if you do
4236 not want to split the selected window."
4242 "Minimum height for splitting windows sensibly.
4243 If this is an integer, `split-window-sensibly' may split a window
4244 vertically only if it has at least this many lines. If this is
4245 nil, `split-window-sensibly' is not allowed to split a window
4246 vertically. If, however, a window is the only window on its
4247 frame, `split-window-sensibly' may split it vertically
4248 disregarding the value of this variable."
4254 "Minimum width for splitting windows sensibly.
4255 If this is an integer, `split-window-sensibly' may split a window
4256 horizontally only if it has at least this many columns. If this
4257 is nil, `split-window-sensibly' is not allowed to split a window
4258 horizontally."
4264 "Return non-nil if `split-window-sensibly' may split WINDOW.
4265 Optional argument HORIZONTAL nil or omitted means check whether
4266 `split-window-sensibly' may split WINDOW vertically. HORIZONTAL
4267 non-nil means check whether WINDOW may be split horizontally.
4269 WINDOW may be split vertically when the following conditions
4270 hold:
4271 - `window-size-fixed' is either nil or equals `width' for the
4272 buffer of WINDOW.
4273 - `split-height-threshold' is an integer and WINDOW is at least as
4274 high as `split-height-threshold'.
4275 - When WINDOW is split evenly, the emanating windows are at least
4276 `window-min-height' lines tall and can accommodate at least one
4277 line plus - if WINDOW has one - a mode line.
4279 WINDOW may be split horizontally when the following conditions
4280 hold:
4281 - `window-size-fixed' is either nil or equals `height' for the
4282 buffer of WINDOW.
4283 - `split-width-threshold' is an integer and WINDOW is at least as
4284 wide as `split-width-threshold'.
4285 - When WINDOW is split evenly, the emanating windows are at least
4286 `window-min-width' or two (whichever is larger) columns wide."
4290 ;; A window can be split horizontally when its width is not
4291 ;; fixed, it is at least `split-width-threshold' columns wide
4292 ;; and at least twice as wide as `window-min-width' and 2 (the
4293 ;; latter value is hardcoded).
4295 ;; Testing `window-full-width-p' here hardly makes any
4296 ;; sense nowadays. This can be done more intuitively by
4297 ;; setting up `split-width-threshold' appropriately.
4302 ;; A window can be split vertically when its height is not
4303 ;; fixed, it is at least `split-height-threshold' lines high,
4304 ;; and it is at least twice as high as `window-min-height' and 2
4305 ;; if it has a modeline or 1.
4314 "Split WINDOW in a way suitable for `display-buffer'.
4315 If `split-height-threshold' specifies an integer, WINDOW is at
4316 least `split-height-threshold' lines tall and can be split
4317 vertically, split WINDOW into two windows one above the other and
4318 return the lower window. Otherwise, if `split-width-threshold'
4319 specifies an integer, WINDOW is at least `split-width-threshold'
4320 columns wide and can be split horizontally, split WINDOW into two
4321 windows side by side and return the window on the right. If this
4322 can't be done either and WINDOW is the only window on its frame,
4323 try to split WINDOW vertically disregarding any value specified
4324 by `split-height-threshold'. If that succeeds, return the lower
4325 window. Return nil otherwise.
4327 By default `display-buffer' routines call this function to split
4328 the largest or least recently used window. To change the default
4329 customize the option `split-window-preferred-function'.
4331 You can enforce this function to not split WINDOW horizontally,
4332 by setting \(or binding) the variable `split-width-threshold' to
4333 nil. If, in addition, you set `split-height-threshold' to zero,
4334 chances increase that this function does split WINDOW vertically.
4336 In order to not split WINDOW vertically, set \(or bind) the
4337 variable `split-height-threshold' to nil. Additionally, you can
4338 set `split-width-threshold' to zero to make a horizontal split
4339 more likely to occur.
4341 Have a look at the function `window-splittable-p' if you want to
4342 know how `split-window-sensibly' determines whether WINDOW can be
4343 split."
4345 ;; Split window vertically.
4349 ;; Split window horizontally.
4354 ;; If WINDOW is the only window on its frame and is not the
4355 ;; minibuffer window, try to split it vertically disregarding
4356 ;; the value of `split-height-threshold'.
4363 "Try to split WINDOW.
4364 Return value returned by `split-window-preferred-function' if it
4365 represents a live window, nil otherwise."
4369 ;; Since `split-window-preferred-function' might
4370 ;; throw an error use `condition-case'.
4377 "Return FRAME if it can be used to display a buffer."
4380 ;; `frame-root-window' may be an internal window which is considered
4381 ;; "dead" by `window-live-p'. Hence if `window' is not live we
4382 ;; implicitly know that `frame' has a visible window we can use.
4385 ;; If the window is soft-dedicated, the frame is usable.
4386 ;; Actually, even if the window is really dedicated,
4387 ;; the frame is still usable by splitting it.
4388 ;; At least Emacs-22 allowed it, and it is desirable
4389 ;; when displaying same-frame windows.
4390 nil ; (eq t (window-dedicated-p window))
4391 ))
4392 frame))))
4395 "If non-nil `display-buffer' will try to even window heights.
4396 Otherwise `display-buffer' will leave the window configuration
4397 alone. Heights are evened only when `display-buffer' chooses a
4398 window that appears above or below the selected window."
4403 "Even heights of WINDOW and selected window.
4404 Do this only if these windows are vertically adjacent to each
4405 other, `even-window-heights' is non-nil, and the selected window
4406 is higher than WINDOW."
4409 ;; Don't resize minibuffer windows.
4420 ;; Don't throw an error if we can't even window heights for
4421 ;; whatever reason.
4427 "Raise the frame containing WINDOW.
4428 Do not raise the selected frame. Return WINDOW."
4432 ;; Assume the selected frame is already visible enough.
4434 ;; Assume the frame from which we invoked the minibuffer
4435 ;; is visible.
4439 window))
4442 "Display BUFFER in WINDOW and make its frame visible.
4443 Set `window-dedicated-p' to DEDICATED if non-nil.
4444 Return WINDOW."
4452 "If non-nil, `display-buffer' marks the windows it creates as dedicated.
4453 The actual non-nil value of this variable will be copied to the
4457 "Normalize BUFFER-OR-NAME argument for buffer display functions.
4458 If BUFFER-OR-NAME is nil, return the curent buffer. Else, if a
4459 buffer specified by BUFFER-OR-NAME exists, return that buffer.
4460 If no such buffer exists, create a buffer with the name
4461 BUFFER-OR-NAME and return that buffer."
4466 buffer))
4483 ,display-buffer--action-function-custom-type
4488 :key-type symbol
4493 "Overriding action to perform to display a buffer.
4494 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4495 function or a list of functions. Each function should accept 2
4496 arguments: a buffer to display and an alist similar to ALIST.
4501 "Alist of conditional actions for `display-buffer'.
4502 This is a list of elements (CONDITION . ACTION), where:
4504 CONDITION is either a regexp matching buffer names, or a function
4505 that takes a buffer and returns a boolean.
4507 ACTION is a cons cell (FUNCTION . ALIST), where FUNCTION is a
4508 function or a list of functions. Each such function should
4509 accept 2 arguments: a buffer to display and an alist of the
4510 same form as ALIST. See `display-buffer' for details."
4513 regexp
4516 :risky t
4521 "User-specified default action for `display-buffer'.
4522 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4523 function or a list of functions. Each function should accept 2
4524 arguments: a buffer to display and an alist similar to ALIST.
4525 See `display-buffer' for details."
4526 :type display-buffer--action-custom-type
4527 :risky t
4533 display-buffer-reuse-window
4534 display-buffer--special
4535 display-buffer--maybe-pop-up-frame-or-window
4536 display-buffer-use-some-window
4537 ;; If all else fails, pop up a new frame.
4538 display-buffer-pop-up-frame))
4539 "Default fallback action for `display-buffer'.
4540 This is the action used by `display-buffer' if no other actions
4541 specified, e.g. by the user options `display-buffer-alist' or
4546 "Retrieve ALIST entry corresponding to BUFFER-NAME."
4565 display-buffer--special
4566 display-buffer-pop-up-frame)
4573 "Display BUFFER-OR-NAME in some window, without selecting it.
4574 BUFFER-OR-NAME must be a buffer or the name of an existing
4575 buffer. Return the window chosen for displaying BUFFER-OR-NAME,
4576 or nil if no such window is found.
4578 Optional argument ACTION should have the form (FUNCTION . ALIST).
4579 FUNCTION is either a function or a list of functions. Each such
4580 function is called with 2 arguments: the buffer to display and an
4581 alist. It should either display the buffer and return the
4582 window, or return nil if unable to display the buffer.
4584 The `display-buffer' function builds a function list and an alist
4585 from `display-buffer-overriding-action', `display-buffer-alist',
4586 the ACTION argument, `display-buffer-base-action', and
4587 `display-buffer-fallback-action' (in that order). Then it calls
4588 each function in the combined function list in turn, passing the
4589 buffer as the first argument and the combined alist as the second
4590 argument, until one of the functions returns non-nil.
4592 Available action functions include:
4593 `display-buffer-same-window'
4594 `display-buffer-reuse-window'
4595 `display-buffer-pop-up-frame'
4596 `display-buffer-pop-up-window'
4597 `display-buffer-use-some-window'
4599 Recognized alist entries include:
4601 `inhibit-same-window' -- A non-nil value prevents the same
4602 window from being used for display.
4604 `reusable-frames' -- Value specifies frame(s) to search for a
4605 window that already displays the buffer.
4606 See `display-buffer-reuse-window'.
4608 The ACTION argument to `display-buffer' can also have a non-nil
4609 and non-list value. This means to display the buffer in a window
4610 other than the selected one, even if it is already displayed in
4611 the selected window. If called interactively with a prefix
4612 argument, ACTION is t.
4614 Optional argument FRAME, if non-nil, acts like an additional
4615 ALIST entry (reusable-frames . FRAME), specifying the frame(s) to
4616 search for a window that is already displaying the buffer. See
4617 `display-buffer-reuse-window'."
4621 ;; Handle the old form of the first argument.
4625 ;; If `display-buffer-function' is defined, let it do the job.
4627 ;; Otherwise, use the defined actions.
4630 display-buffer-alist))
4631 ;; Extra actions from the arguments to this function:
4637 ;; Construct action function list and action alist.
4639 user-action action extra-action
4640 display-buffer-base-action
4641 display-buffer-fallback-action))
4646 actions)))
4648 window)
4654 window))))
4657 "Display buffer BUFFER in another frame.
4658 This uses the function `display-buffer' as a subroutine; see
4659 its documentation for additional customization information."
4663 ;;; `display-buffer' action functions:
4666 "Display BUFFER in the selected window.
4667 This fails if ALIST has a non-nil `inhibit-same-window' entry, or
4668 if the selected window is a minibuffer window or is dedicated to
4669 another buffer; in that case, return nil. Otherwise, return the
4670 selected window."
4678 "Conditionally display BUFFER in the selected window.
4679 If `same-window-p' returns non-nil for BUFFER's name, call
4680 `display-buffer-same-window' and return its value. Otherwise,
4681 return nil."
4686 "Return a window that is already displaying BUFFER.
4687 Return nil if no usable window is found.
4689 If ALIST has a non-nil `inhibit-same-window' entry, the selected
4690 window is not eligible for reuse.
4692 If ALIST contains a `reusable-frames' entry, its value determines
4693 which frames to search for a reusable window:
4694 nil -- the selected frame (actually the last non-minibuffer frame)
4695 A frame -- just that frame
4696 `visible' -- all visible frames
4697 0 -- all frames on the current terminal
4698 t -- all frames.
4700 If ALIST contains no `reusable-frames' entry, search just the
4701 selected frame if `display-buffer-reuse-frames' and
4702 `pop-up-frames' are both nil; search all frames on the current
4703 terminal if either of those variables is non-nil."
4708 pop-up-frames)
4717 frames))))))
4723 "Try to display BUFFER using `special-display-function'.
4724 Call `special-display-p' on BUFFER's name, and if that returns
4725 non-nil, call `special-display-function' on BUFFER."
4727 ;; `special-display-p' returns either t or a list of frame
4728 ;; parameters to pass to `special-display-function'.
4735 "Display BUFFER in a new frame.
4736 This works by calling `pop-up-frame-function'. If successful,
4737 return the window used; otherwise return nil."
4739 frame window)
4745 ;; Reset list of WINDOW's previous buffers to nil.
4747 window)))
4750 "Display BUFFER by popping up a new window.
4751 The new window is created on the selected frame, or in
4752 `last-nonminibuffer-frame' if no windows can be created there.
4753 If sucessful, return the new window; otherwise return nil."
4756 window)
4758 ;; If the selected frame cannot be split, look at
4759 ;; `last-nonminibuffer-frame'.
4764 ;; Attempt to split largest or least recently used window.
4771 ;; Reset list of WINDOW's previous buffers to nil.
4773 window)))
4776 "Try displaying BUFFER based on `pop-up-frames' or `pop-up-windows'.
4778 If `pop-up-frames' is non-nil (and not `graphic-only' on a
4779 text-only terminal), try with `display-buffer-pop-up-frame'.
4781 If that cannot be done, and `pop-up-windows' is non-nil, try
4782 again with `display-buffer-pop-up-window'."
4785 pop-up-frames)
4791 "Display BUFFER in an existing window.
4792 Search for a usable window, set that window to the buffer, and
4793 return the window. If no suitable window is found, return nil."
4796 ;; When NOT-THIS-WINDOW is non-nil, temporarily dedicate the
4797 ;; selected window to its buffer, to prevent any of the
4798 ;; `get-' routines below from choosing it. (Bug#1415)
4804 window)
4807 ;; Reuse an existing window.
4812 window))
4817 window))
4820 ;; Restore dedicated status of selected window.
4827 ;;; Display + selection commands:
4830 "Select buffer BUFFER in some window, preferably a different one.
4831 BUFFER may be a buffer, a string (a buffer name), or nil. If it
4832 is a string not naming an existent buffer, create a buffer with
4833 that name. If BUFFER is nil, choose some other buffer. Return
4834 the buffer.
4836 This uses `display-buffer' as a subroutine. The optional ACTION
4837 argument is passed to `display-buffer' as its ACTION argument.
4838 See `display-buffer' for more information. ACTION is t if called
4839 interactively with a prefix argument, which means to pop to a
4840 window other than the selected one even if the buffer is already
4841 displayed in the selected window.
4843 If the window to show BUFFER is not on the selected
4844 frame, raise that window's frame and give it input focus.
4846 Optional third arg NORECORD non-nil means do not put this buffer
4847 at the front of the list of recently selected ones."
4857 ;; Make sure new window is selected (Bug#8615), (Bug#6954).
4859 ;; If `display-buffer' has chosen another frame, make sure it
4860 ;; gets input focus.
4862 buffer))
4865 "Select buffer BUFFER in some window, preferably the same one.
4866 This function behaves much like `switch-to-buffer', except it
4867 displays with `special-display-function' if BUFFER has a match in
4868 `special-display-buffer-names' or `special-display-regexps'.
4870 Unlike `pop-to-buffer', this function prefers using the selected
4871 window over popping up a new window or frame.
4873 BUFFER may be a buffer, a string (a buffer name), or nil. If it
4874 is a string not naming an existent buffer, create a buffer with
4875 that name. If BUFFER is nil, choose some other buffer. Return
4876 the buffer.
4878 NORECORD, if non-nil means do not put this buffer at the front of
4879 the list of recently selected ones."
4882 display-buffer-same-window)
4884 norecord))
4887 "Read the name of a buffer to switch to, prompting with PROMPT.
4888 Return the neame of the buffer as a string.
4890 This function is intended for the `switch-to-buffer' family of
4891 commands since these need to omit the name of the current buffer
4892 from the list of completions and default values."
4897 ;; Since rbts-completion-table is built dynamically, we
4898 ;; can't just add it to the default value of
4899 ;; icomplete-with-completion-tables, so we add it
4900 ;; here manually.
4905 icomplete-with-completion-tables))))
4910 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
4911 If BUFFER-OR-NAME is nil, return the buffer returned by
4912 `other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
4913 exists, return that buffer. If no such buffer exists, create a
4914 buffer with the name BUFFER-OR-NAME and return that buffer."
4919 buffer))
4923 "Switch to buffer BUFFER-OR-NAME in the selected window.
4924 If called interactively, prompt for the buffer name using the
4925 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
4926 determines whether to request confirmation before creating a new
4927 buffer.
4929 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
4930 nil. If BUFFER-OR-NAME is a string that does not identify an
4931 existing buffer, create a buffer with that name. If
4932 BUFFER-OR-NAME is nil, switch to the buffer returned by
4933 `other-buffer'.
4935 Optional argument NORECORD non-nil means do not put the buffer
4936 specified by BUFFER-OR-NAME at the front of the buffer list and
4937 do not make the window displaying it the most recently selected
4938 one.
4940 If FORCE-SAME-WINDOW is non-nil, BUFFER-OR-NAME must be displayed
4941 in the currently selected window; signal an error if that is
4942 impossible (e.g. if the selected window is minibuffer-only).
4943 If non-nil, BUFFER-OR-NAME may be displayed in another window.
4945 Return the buffer switched to."
4952 ;; Don't call set-window-buffer if it's not needed since it
4953 ;; might signal an error (e.g. if the window is dedicated).
4966 "Select the buffer specified by BUFFER-OR-NAME in another window.
4967 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
4968 nil. Return the buffer switched to.
4970 If called interactively, prompt for the buffer name using the
4971 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
4972 determines whether to request confirmation before creating a new
4973 buffer.
4975 If BUFFER-OR-NAME is a string and does not identify an existing
4976 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
4977 nil, switch to the buffer returned by `other-buffer'.
4979 Optional second argument NORECORD non-nil means do not put this
4980 buffer at the front of the list of recently selected ones.
4982 This uses the function `display-buffer' as a subroutine; see its
4983 documentation for additional customization information."
4990 "Switch to buffer BUFFER-OR-NAME in another frame.
4991 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
4992 nil. Return the buffer switched to.
4994 If called interactively, prompt for the buffer name using the
4995 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
4996 determines whether to request confirmation before creating a new
4997 buffer.
4999 If BUFFER-OR-NAME is a string and does not identify an existing
5000 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5001 nil, switch to the buffer returned by `other-buffer'.
5003 Optional second arg NORECORD non-nil means do not put this
5004 buffer at the front of the list of recently selected ones.
5006 This uses the function `display-buffer' as a subroutine; see its
5007 documentation for additional customization information."
5011 \f
5013 "Set the height in lines of the text display area of WINDOW to HEIGHT.
5014 WINDOW must be a live window. HEIGHT doesn't include the mode
5015 line or header line, if any, or any partial-height lines in the
5016 text display area.
5018 Note that the current implementation of this function cannot
5019 always set the height exactly, but attempts to be conservative,
5020 by allocating more lines than are actually needed in the case
5021 where some error may be present."
5025 ;; Setting window-min-height to a value like 1 can lead to very
5026 ;; bizarre displays because it also allows Emacs to make *other*
5027 ;; windows 1-line tall, which means that there's no more space for
5028 ;; the modeline.
5033 "Make selected window DELTA columns wider.
5034 Interactively, if no argument is given, make selected window one
5035 column wider."
5040 "Make selected window DELTA columns narrower.
5041 Interactively, if no argument is given, make selected window one
5042 column narrower."
5047 "Return the number of screen lines in the region.
5048 The number of screen lines may be different from the number of actual lines,
5049 due to line breaking, display table, etc.
5051 Optional arguments BEG and END default to `point-min' and `point-max'
5052 respectively.
5054 If region ends with a newline, ignore it unless optional third argument
5055 COUNT-FINAL-NEWLINE is non-nil.
5057 The optional fourth argument WINDOW specifies the window used for obtaining
5058 parameters such as width, horizontal scrolling, and so on. The default is
5059 to use the selected window's parameters.
5061 Like `vertical-motion', `count-screen-lines' always uses the current buffer,
5062 regardless of which buffer is displayed in WINDOW. This makes possible to use
5063 `count-screen-lines' in any buffer, whether or not it is currently displayed
5064 in some window."
5070 0
5083 "Return the height (in screen lines) of the buffer that WINDOW is displaying."
5087 ;; If buffer ends with a newline, ignore it when
5088 ;; counting height unless point is after it.
5090 window))))
5092 ;;; Resizing buffers to fit their contents exactly.
5094 "Adjust height of WINDOW to display its buffer's contents exactly.
5095 WINDOW can be any live window and defaults to the selected one.
5097 Optional argument MAX-HEIGHT specifies the maximum height of
5098 WINDOW and defaults to the height of WINDOW's frame. Optional
5099 argument MIN-HEIGHT specifies the minimum height of WINDOW and
5100 defaults to `window-min-height'. Both, MAX-HEIGHT and MIN-HEIGHT
5101 are specified in lines and include the mode line and header line,
5102 if any.
5104 Optional argument OVERRIDE non-nil means override restrictions
5105 imposed by `window-min-height' and `window-min-width' on the size
5106 of WINDOW.
5108 Return the number of lines by which WINDOW was enlarged or
5109 shrunk. If an error occurs during resizing, return nil but don't
5110 signal an error.
5112 Note that even if this function makes WINDOW large enough to show
5113 _all_ lines of its buffer you might not see the first lines when
5114 WINDOW was scrolled."
5116 ;; Do all the work in WINDOW and its buffer and restore the selected
5117 ;; window and the current buffer when we're done.
5119 ;; Can't resize a full height or fixed-size window.
5122 ;; `with-selected-window' should orderly restore the current buffer.
5124 ;; We are in WINDOW's buffer now.
5130 window-safe-min-height)))
5133 ;; Adjust MAX-HEIGHT.
5136 max-window-height
5138 ;; Make `desired-height' the height necessary to show
5139 ;; all of WINDOW's buffer, constrained by MIN-HEIGHT
5140 ;; and MAX-HEIGHT.
5145 ;; For non-minibuffers count the mode line, if any.
5147 mode-line-format)
5148 1
5150 ;; Count the header line, if any.
5152 max-height)
5153 min-height))
5162 ;; This `condition-case' shouldn't be necessary, but who knows?
5165 ;; Return zero if DELTA became zero in the proces.
5166 0
5167 ;; Don't try to redisplay with the cursor at the end on its
5168 ;; own line--that would force a scroll and spoil things.
5170 ;; It's silly to put `point' at the end of the previous
5171 ;; line and so maybe force horizontal scrolling.
5173 ;; Call `window-resize' with OVERRIDE argument equal WINDOW.
5175 ;; Check if the last line is surely fully visible. If
5176 ;; not, enlarge the window.
5180 ;; Don't include final newline.
5183 ;; If line-wrapping is turned off, test the
5184 ;; beginning of the last line for
5185 ;; visibility instead of the end, as the
5186 ;; end of the line could be invisible by
5187 ;; virtue of extending past the edge of the
5188 ;; window.
5192 ;; This loop might in some rare pathological cases raise
5193 ;; an error - another reason for the `condition-case'.
5200 delta))))
5203 "Return t if WINDOW can be shrunk without shrinking other windows.
5204 WINDOW defaults to the selected window."
5207 ;; The following doesn't satisfy the doc-string's claim when
5208 ;; window and previous-/next-window are not part of the same
5209 ;; combination but still share a common edge. Using
5210 ;; `window-iso-combined-p' instead should handle that.
5213 ;; (make-obsolete
5214 ;; 'window-safely-shrinkable-p "use `window-iso-combined-p' instead." "24.1")
5217 "Shrink height of WINDOW if its buffer doesn't need so many lines.
5218 More precisely, shrink WINDOW vertically to be as small as
5219 possible, while still showing the full contents of its buffer.
5220 WINDOW defaults to the selected window.
5222 Do not shrink WINDOW to less than `window-min-height' lines. Do
5223 nothing if the buffer contains more lines than the present window
5224 height, or if some of the window's contents are scrolled out of
5225 view, or if shrinking this window would also shrink another
5226 window, or if the window is the only window of its frame.
5228 Return non-nil if the window was shrunk, nil otherwise."
5231 ;; Make sure that WINDOW is vertically combined and `point-min' is
5232 ;; visible (for whatever reason that's needed). The remaining issues
5233 ;; should be taken care of by `fit-window-to-buffer'.
5237 \f
5239 "Kill the current buffer and delete the selected window."
5248 ;; If `delete-window' failed before, we rerun it to regenerate
5249 ;; the error so it can be seen in the echo area.
5252 ;; If the buffer is not dead for some reason (probably because
5253 ;; of a `quit' signal), remove the hook again.
5258 \f
5260 "Indicates the last recenter operation performed.
5264 "Cycling order for `recenter-top-bottom'.
5265 A list of elements with possible values `top', `middle', `bottom',
5266 integer or float numbers that define the cycling order for
5267 the command `recenter-top-bottom'.
5269 Top and bottom destinations are `scroll-margin' lines the from true
5270 window top and bottom. Middle redraws the frame and centers point
5271 vertically within the window. Integer number moves current line to
5272 the specified absolute window-line. Float number between 0.0 and 1.0
5273 means the percentage of the screen space from the top. The default
5274 cycling order is middle -> top -> bottom."
5285 "Move current buffer line to the specified window line.
5286 With no prefix argument, successive calls place point according
5287 to the cycling order defined by `recenter-positions'.
5289 A prefix argument is handled like `recenter':
5290 With numeric prefix ARG, move current line to window-line ARG.
5291 With plain `C-u', move current line to window center."
5299 recenter-positions))
5318 "Position point relative to window.
5320 With a prefix argument ARG, acts like `move-to-window-line'.
5322 With no argument, positions point at center of window.
5323 Successive calls position point at positions defined
5324 by `recenter-positions'."
5332 recenter-positions))
5349 \f
5350 ;;; Scrolling commands.
5352 ;;; Scrolling commands which does not signal errors at top/bottom
5353 ;;; of buffer at first key-press (instead moves to top/bottom
5354 ;;; of buffer).
5357 "Move point to top/bottom of buffer before signalling a scrolling error.
5358 A value of nil means just signal an error if no more scrolling possible.
5359 A value of t means point moves to the beginning or the end of the buffer
5360 \(depending on scrolling direction) when no more scrolling possible.
5361 When point is already on that position, then signal an error."
5367 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
5368 If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
5369 scroll window further, move cursor to the bottom line.
5370 When point is already on that position, then signal an error.
5371 A near full screen is `next-screen-context-lines' less than a full screen.
5372 Negative ARG means scroll downward.
5373 If ARG is the atom `-', scroll downward by nearly full screen."
5389 ;; When scrolling by ARG lines can't be done,
5390 ;; move by ARG lines instead.
5392 ;; When ARG is nil for full-screen scrolling,
5393 ;; move to the bottom of the buffer.
5399 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
5400 If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
5401 scroll window further, move cursor to the top line.
5402 When point is already on that position, then signal an error.
5403 A near full screen is `next-screen-context-lines' less than a full screen.
5404 Negative ARG means scroll upward.
5405 If ARG is the atom `-', scroll upward by nearly full screen."
5421 ;; When scrolling by ARG lines can't be done,
5422 ;; move by ARG lines instead.
5424 ;; When ARG is nil for full-screen scrolling,
5425 ;; move to the top of the buffer.
5430 ;;; Scrolling commands which scroll a line instead of full screen.
5433 "Scroll text of selected window upward ARG lines; or one line if no ARG.
5434 If ARG is omitted or nil, scroll upward by one line.
5435 This is different from `scroll-up-command' that scrolls a full screen."
5442 "Scroll text of selected window down ARG lines; or one line if no ARG.
5443 If ARG is omitted or nil, scroll down by one line.
5444 This is different from `scroll-down-command' that scrolls a full screen."
5450 \f
5453 For more details, see the documentation for `scroll-other-window'."
5456 ;; Just invert the argument's meaning.
5457 ;; We can do that without knowing which window it will be.
5463 "Move point to the beginning of the buffer in the other window.
5464 Leave mark at previous position.
5465 With arg N, put point N/10 of the way from the true beginning."
5469 ;; We use unwind-protect rather than save-window-excursion
5470 ;; because the latter would preserve the things we want to change.
5474 ;; Set point and mark in that window's buffer.
5477 ;; Set point accordingly.
5482 "Move point to the end of the buffer in the other window.
5483 Leave mark at previous position.
5484 With arg N, put point N/10 of the way from the true end."
5486 ;; See beginning-of-buffer-other-window for comments.
5496 \f
5507 "When non-nil, special state of delayed window autoselection.
5508 Possible values are `suspend' \(suspend autoselection after a menu or
5509 scrollbar interaction\) and `select' \(the next invocation of
5513 "Cancel delayed window autoselection.
5514 Optional argument FORCE means cancel unconditionally."
5516 ;; Don't cancel for select-window or select-frame events
5517 ;; or when the user drags a scroll bar.
5529 "Start delayed window autoselection.
5530 MOUSE-POSITION is the last position where the mouse was seen as returned
5531 by `mouse-position'. Optional argument WINDOW non-nil denotes the
5532 window where the mouse was seen. Optional argument SUSPEND non-nil
5533 means suspend autoselection."
5534 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
5538 ;; Install timer which runs `mouse-autoselect-window-select' after
5539 ;; `mouse-autoselect-window' seconds.
5545 "Select window with delayed window autoselection.
5546 If the mouse position has stabilized in a non-selected window, select
5547 that window. The minibuffer window is selected only if the minibuffer is
5548 active. This function is run by `mouse-autoselect-window-timer'."
5559 ;; A menu / popup dialog is active or the mouse is on the scroll-bar
5560 ;; of WINDOW, temporarily suspend delayed autoselection.
5563 ;; Delayed autoselection was temporarily suspended, reenable it.
5568 ;; If `mouse-autoselect-window' is positive, select
5569 ;; window if the window is the same as before.
5571 ;; Otherwise select window if the mouse is at the same
5572 ;; position as before. Observe that the first test after
5573 ;; starting autoselection usually fails since the value of
5574 ;; `mouse-autoselect-window-position' recorded there is the
5575 ;; position where the mouse has entered the new window and
5576 ;; not necessarily where the mouse has stopped moving.
5578 ;; The minibuffer is a candidate window if it's active.
5581 ;; Mouse position has stabilized in non-selected window: Cancel
5582 ;; delayed autoselection and try to select that window.
5584 ;; Select window where mouse appears unless the selected window is the
5585 ;; minibuffer. Use `unread-command-events' in order to execute pre-
5586 ;; and post-command hooks and trigger idle timers. To avoid delaying
5587 ;; autoselection again, set `mouse-autoselect-window-state'."
5592 unread-command-events))))
5596 ;; Mouse position has either stabilized in the selected window or at
5597 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
5600 ;; Mouse position has not stabilized yet, resume delayed
5601 ;; autoselection.
5605 "Handle select-window events."
5609 ;; Don't switch if we're currently in the minibuffer.
5610 ;; This tries to work around problems where the
5611 ;; minibuffer gets unselected unexpectedly, and where
5612 ;; you then have to move your mouse all the way down to
5613 ;; the minibuffer to select it.
5615 ;; Don't switch to minibuffer window unless it's active.
5618 ;; Don't switch when autoselection shall be delayed.
5623 ;; Cancel any delayed autoselection.
5625 ;; Start delayed autoselection from current mouse
5626 ;; position and window.
5628 ;; Executing a command cancels delayed autoselection.
5632 ;; Reset state of delayed autoselection.
5634 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
5639 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
5640 WINDOW defaults to the selected window.
5641 Return nil if WINDOW is not a partial-width window
5642 (regardless of the value of `truncate-lines').
5643 Otherwise, consult the value of `truncate-partial-width-windows'
5644 for the buffer shown in WINDOW."
5652 t-p-w-w))))
5653 \f
5654 ;; Some of these are in tutorial--default-keys, so update that if you
5655 ;; change these.
5668 ;;; window.el ends here