| blob | 245ad23f4147e1179cfa935a5f36f0bd7d158c2a |
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 ;;; Code:
30 "Execute BODY, then select the previously selected window.
31 The value returned is the value of the last form in BODY.
33 This macro saves and restores the selected window, as well as the
34 selected window in each frame. If the previously selected window
35 is no longer live, then whatever window is selected at the end of
36 BODY remains selected. If the previously selected window of some
37 frame is no longer live at the end of BODY, that frame's selected
38 window is left alone.
40 This macro saves and restores the current buffer, since otherwise
41 its normal operation could make a different buffer current. The
42 order of recently selected windows and the buffer list ordering
43 are not altered by this macro (unless they are altered in BODY)."
46 ;; It is necessary to save all of these, because calling
47 ;; select-window changes frame-selected-window for whatever
48 ;; frame that window is in.
62 ;; The following two functions are like `window-next' and `window-prev'
63 ;; but the WINDOW argument is _not_ optional (so they don't substitute
64 ;; the selected window for nil), and they return nil when WINDOW doesn't
65 ;; have a parent (like a frame's root window or a minibuffer window).
67 "Return WINDOW's right sibling.
68 Return nil if WINDOW is the root window of its frame. WINDOW can
69 be any window."
73 "Return WINDOW's left sibling.
74 Return nil if WINDOW is the root window of its frame. WINDOW can
75 be any window."
79 "Return WINDOW's first child window."
83 "Return number of WINDOW's child windows."
89 count))
92 "Return last child window of WINDOW."
96 window)
99 "Return t if OBJECT denotes a live or internal window."
102 t))
104 ;; The following four functions should probably go to subr.el.
106 "Return buffer specified by BUFFER-OR-NAME.
107 BUFFER-OR-NAME must be either a buffer or a string naming a live
108 buffer and defaults to the current buffer."
114 buffer-or-name
121 "Return frame specified by FRAME.
122 FRAME must be a live frame and defaults to the selected frame."
125 frame
130 "Return window specified by WINDOW.
131 WINDOW must be a window that has not been deleted and defaults to
132 the selected window."
135 window
140 "Return live window specified by WINDOW.
141 WINDOW must be a live window and defaults to the selected one."
144 window
149 "If non-nil, standard functions ignore window parameters.
150 The functions currently affected by this are `split-window',
151 `delete-window', `delete-other-windows' and `other-window'.
153 An application may bind this to a non-nil value around calls to
157 "The absolut minimum number of lines of a window.
161 "The minimum number of lines of any window.
162 The value has to accomodate a mode- or header-line if present. A
163 value less than `window-safe-min-height' is ignored. The value
164 of this variable is honored when windows are resized or split.
166 Applications should never rebind this variable. To resize a
167 window to a height less than the one specified here, an
168 application should instead call `resize-window' with a non-nil
169 IGNORE argument. In order to have `split-window' make a window
170 shorter, explictly specify the SIZE argument of that function."
176 "The absolut minimum number of columns of a window.
180 "The minimum number of columns of any window.
181 The value has to accomodate margins, fringes, or scrollbars if
182 present. A value less than `window-safe-min-width' is ignored.
183 The value of this variable is honored when windows are resized or
184 split.
186 Applications should never rebind this variable. To resize a
187 window to a width less than the one specified here, an
188 application should instead call `resize-window' with a non-nil
189 IGNORE argument. In order to have `split-window' make a window
190 narrower, explictly specify the SIZE argument of that function."
196 "If WINDOW is a vertical combination return WINDOW's first child.
197 WINDOW can be any window and defaults to the selected one.
198 Optional argument HORIZONTAL non-nil means return WINDOW's first
199 child if WINDOW is a horizontal combination."
206 "Return non-nil if and only if WINDOW is vertically combined.
207 WINDOW can be any window and defaults to the selected one.
208 Optional argument HORIZONTAL non-nil means return non-nil if and
209 only if WINDOW is horizontally combined."
215 "Return largest number of vertically arranged subwindows of WINDOW.
216 WINDOW can be any window and defaults to the selected one.
217 Optional argument HORIZONTAL non-nil means to return the largest
218 number of horizontally arranged subwindows of WINDOW."
222 ;; If WINDOW is live, return 1.
225 ;; If WINDOW is iso-combined, return the sum of the values for all
226 ;; subwindows of WINDOW.
232 count))
234 count))
236 ;; If WINDOW is not iso-combined, return the maximum value of any
237 ;; subwindow of WINDOW.
243 count))
245 count))))
248 "Helper function for `walk-window-tree' and `walk-window-subtree'."
266 "Run function PROC on each live window of FRAME.
267 PROC must be a function with one argument - a window. FRAME must
268 be a live frame and defaults to the selected one. ANY, if
269 non-nil means to run PROC on all live and internal windows of
270 FRAME.
272 This function performs a pre-order, depth-first traversal of the
273 window tree. If PROC changes the window tree, the result is
274 unpredictable."
280 "Run function PROC on each live subwindow of WINDOW.
281 WINDOW defaults to the selected window. PROC must be a function
282 with one argument - a window. ANY, if non-nil means to run PROC
283 on all live and internal subwindows of WINDOW.
285 This function performs a pre-order, depth-first traversal of the
286 window tree rooted at WINDOW. If PROC changes that window tree,
287 the result is unpredictable."
292 "Return a list of all windows on FRAME with PARAMETER non-nil.
293 FRAME defaults to the selected frame. Optional argument VALUE
294 non-nil means only return windows whose window-parameter value of
295 PARAMETER equals VALUE \(comparison is done using `equal').
296 Optional argument ANY non-nil means consider internal windows
297 too. Optional argument VALUES non-nil means return a list of cons
298 cells whose car is the value of the parameter and whose cdr is
299 the window."
309 frame any)
314 "Return first window on FRAME with PARAMETER non-nil.
315 FRAME defaults to the selected frame. Optional argument VALUE
316 non-nil means only return a window whose window-parameter value
317 for PARAMETER equals VALUE \(comparison is done with `equal').
318 Optional argument ANY non-nil means consider internal windows
319 too."
327 frame any))))
329 ;;; Atomic windows.
331 "Return root of atomic window WINDOW is a part of.
332 WINDOW can be any window and defaults to the selected one.
333 Return nil if WINDOW is not part of a atomic window."
339 root))
342 "Make WINDOW an atomic window.
343 WINDOW must be an internal window. Return WINDOW."
349 window t)
350 window))
353 "Subroutine of `window-atom-check'."
363 window t))
364 ;; count >= 1 must hold here. If there's no other
365 ;; window around dissovle this atomic window.
367 ;; Dissolve atomic window.
371 window t)))
372 ;; Check children.
376 ;; Check right sibling
380 "Check atomicity of all windows on FRAME.
381 FRAME defaults to the selected frame. If an atomic window is
382 wrongly configured, reset the atomicity of all its subwindows to
383 nil. An atomic window is wrongly configured if it has no
384 subwindows or one of its subwindows is not atomic."
387 ;; Side windows.
392 "If non-nil, left and right side windows are full height.
393 Otherwise, top and bottom side windows are full width."
399 "Maximum number of side window slots.
400 The value is a list of four elements specifying the number of
401 side window slots on \(in this order) the left, top, right and
402 bottom side of each frame. If an element is a number, this means
403 to display at most that many side windows on the corresponding
404 side. If an element is nil, this means there's no bound on the
405 number of slots on that side."
406 :risky t
407 :type
413 :value nil
420 :value nil
427 :value nil
434 :value nil
442 "Association list for side windows.
443 Each entry of this list must be a list whose first element is
444 either `left', `top', `right' or`bottom'. The second element of
445 each entry specifies the minimum size of windows on that side
446 \(either the default value, a number of lines or columns, or a
447 fraction of the frame size). The third element specifies the
448 desired size of windows on that side \(either the default value,
449 a number of lines or columns, or a fraction of the frame size).
450 The fourth element specifies the upper bound on the number of
451 slots on that side, nil if there's no bound."
452 :risky t
453 :type
455 ;;; :format "%v %t"
456 :inline t
457 ;; Left side window.
462 ;; Minimum width of left side windows.
466 :value nil
471 ;; Desired width of left side windows.
475 :value nil
480 ;; The maximum number of slots of left side windows.
484 :value nil
488 ;; Top side windows.
493 ;; Minimum height of top windows.
497 :value nil
502 ;; Desired size of left side windows.
506 :value nil
511 ;; The maximum number of slots of top windows.
515 :value nil
519 ;; Right side windows.
524 ;; Minimum width of right side windows.
528 :value nil
533 ;; Desired width of right side windows.
537 :value nil
542 ;; The maximum number of slots of right side windows.
546 :value nil
550 ;; Bottom side windows.
555 ;; Minimum height of bottom windows.
559 :value nil
564 ;; Desired height of bottom windows.
568 :value nil
573 ;; The maximum number of slots of bottom windows.
577 :value nil
585 "Check the window-side parameter of all windows on FRAME.
586 FRAME defaults to the selected frame. If the configuration is
587 invalid, reset all window-side parameters to nil.
589 A valid configuration has to preserve the following invariant:
591 - If a window has a non-nil window-side parameter, it must have a
592 parent window and the parent window's window-side parameter
593 must be either nil or the same as for window.
595 - If windows with non-nil window-side parameters exist, there
596 must be at most one window of each side and non-side with a
597 parent whose window-side parameter is nil and there must be no
598 leaf window whose window-side parameter is nil."
600 side parent parent-side code)
608 ;; The following `cond' seems a bit tedious, but I'd
609 ;; rather stick to using just the stack.
613 ;; A parent whose window-side is non-nil must
614 ;; have a child with the same window-side.
616 ;; Now check that there's more than one main window
617 ;; for any of none, left, top, right and bottom.
639 ;; A leaf window without window-side parameter,
640 ;; record its existence.
642 frame t))
644 ;; At least one non-side window exists, so there must
645 ;; be at least one side-window and no normal window.
647 ;; No non-side window exists, so there must be no side
648 ;; window either.
653 frame t))))
656 "Check atomic and side windows on FRAME.
657 FRAME defaults to the selected frame."
661 ;;; Window sizes.
663 "Non-nil in a buffer means windows displaying the buffer are fixed-size.
664 If the value is `height', then only the window's height is fixed.
665 If the value is `width', then only the window's width is fixed.
666 Any other non-nil value fixes both the width and the height.
668 Emacs won't change the size of any window displaying that buffer,
669 unless it has no other choice \(like when deleting a neighboring
674 "Return non-nil if IGNORE says to ignore size restrictions for WINDOW."
678 "Return the minimum number of lines of WINDOW.
679 WINDOW can be an arbitrary window and defaults to the selected
680 one. Optional argument HORIZONTAL non-nil means return the
681 minimum number of columns of WINDOW.
683 Optional argument IGNORE non-nil means ignore any restrictions
684 imposed by fixed size windows, `window-min-height' or
685 `window-min-width' settings. IGNORE equal `safe' means live
686 windows may get as small as `window-safe-min-height' lines and
687 `window-safe-min-width' columns. IGNORE a window means ignore
688 restrictions for that window only."
693 "Internal function of `window-min-size'."
697 ;; WINDOW is an internal window.
699 ;; The minimum size of an iso-combination is the sum of
700 ;; the minimum sizes of its subwindows.
705 ;; The minimum size of an ortho-combination is the maximum of
706 ;; the minimum sizes of its subwindows.
711 value)
716 ;; The minimum size of a fixed size window is its size.
719 ;; If IGNORE equals `safe' or WINDOW return the safe values.
722 ;; For the minimum width of a window take fringes and
723 ;; scroll-bars into account. This is questionable and should
724 ;; be removed as soon as we are able to split (and resize)
725 ;; windows such that the new (or resized) windows can get a
726 ;; size less than the user-specified `window-min-height' and
727 ;; `window-min-width'.
732 (+ window-safe-min-width
745 window-min-width
748 ;; For the minimum height of a window take any mode- or
749 ;; header-line into account.
755 window-min-height
759 "Return DELTA if DELTA lines can be added to WINDOW.
760 Optional argument HORIZONTAL non-nil means return DELTA if DELTA
761 columns can be added to WINDOW. A return value of zero means
762 that no lines (or columns) can be added to WINDOW.
764 This function looks only at WINDOW and its subwindows. The
765 function `window-resizable' looks at other windows as well.
767 DELTA positive means WINDOW shall be enlarged by DELTA lines or
768 columns. If WINDOW cannot be enlarged by DELTA lines or columns
769 return the maximum value in the range 0..DELTA by which WINDOW
770 can be enlarged.
772 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
773 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
774 return the minimum value in the range DELTA..0 by which WINDOW
775 can be shrunk.
777 Optional argument IGNORE non-nil means ignore any restrictions
778 imposed by fixed size windows, `window-min-height' or
779 `window-min-width' settings. IGNORE equal `safe' means live
780 windows may get as small as `window-safe-min-height' lines and
781 `window-safe-min-width' columns. IGNORE any window means ignore
782 restrictions for that window only."
788 delta))
790 delta)
793 0
794 delta))
798 "Return t if WINDOW can be resized by DELTA lines.
799 For the meaning of the arguments of this function see the
800 doc-string of `window-sizable'."
807 "Internal function for `window-size-fixed-p'."
811 ;; WINDOW is an internal window.
813 ;; An iso-combination is fixed size if all its subwindows
814 ;; are fixed-size.
818 ;; We found a non-fixed-size subwindow, so WINDOW's
819 ;; size is not fixed.
822 ;; All subwindows are fixed-size, so WINDOW's size is
823 ;; fixed.
825 ;; An ortho-combination is fixed-size if at least one of its
826 ;; subwindows is fixed-size.
829 ;; We found a fixed-size subwindow, so WINDOW's size is
830 ;; fixed.
833 ;; WINDOW is a live window.
840 "Return non-nil if WINDOW's height is fixed.
841 WINDOW can be an arbitrary window and defaults to the selected
842 window. Optional argument HORIZONTAL non-nil means return
843 non-nil if WINDOW's width is fixed.
845 If this function returns nil, this does not necessarily mean that
846 WINDOW can be resized in the desired direction. The functions
847 `window-resizable' and `window-resizable-p' will tell that."
852 "Internal function for `window-min-delta'."
854 ;; If we can't go up, return zero.
855 0
856 ;; Else try to find a non-fixed-size sibling of WINDOW.
861 ;; In an iso-combination throw DELTA if we find at least one
862 ;; subwindow and that subwindow is either not of fixed-size
863 ;; or we can ignore fixed-sizeness.
873 ;; We found a non-fixed-size subwindow.
876 ;; In an ortho-combination set DELTA to the minimum value by
877 ;; which other subwindows can shrink.
886 delta
890 "Return number of lines by which WINDOW can be shrunk.
891 WINDOW can be an arbitrary window and defaults to the selected
892 window. Return zero if WINDOW cannot be shrunk.
894 Optional argument HORIZONTAL non-nil means return number of
895 columns by which WINDOW can be shrunk.
897 Optional argument IGNORE non-nil means ignore any restrictions
898 imposed by fixed size windows, `window-min-height' or
899 `window-min-width' settings. IGNORE a window means ignore
900 restrictions for that window only. IGNORE equal `safe' means
901 live windows may get as small as `window-safe-min-height' lines
902 and `window-safe-min-width' columns.
904 Optional argument TRAIL `before' means only windows to the left
905 of or above WINDOW can be enlarged. Optional argument TRAIL
906 `after' means only windows to the right of or below WINDOW can be
907 enlarged.
909 Optional argument NOUP non-nil means don't go up in the window
910 tree but try to enlarge windows within WINDOW's combination only.
912 Optional argument NODOWN non-nil means don't check whether WINDOW
913 itself \(and its subwindows) can be shrunk; check only whether at
914 least one other windows can be enlarged appropriately."
920 ;; If NODOWN is t, try to recover the entire size of WINDOW.
923 ;; If NODOWN is nil and WINDOW's size is already at its minimum,
924 ;; there's nothing to recover.
927 ;; Otherwise, try to recover whatever WINDOW is larger than its
928 ;; minimum size.
933 "Internal function of `window-max-delta'."
935 ;; Can't go up. Return DELTA.
936 delta
941 ;; For an iso-combination calculate how much we can get from
942 ;; other subwindows.
951 (+ delta
955 ;; For an ortho-combination throw DELTA when at least one
956 ;; subwindow is fixed-size.
964 ;; When NOUP is nil, DELTA is all we can get.
965 delta
966 ;; Else try with parent of WINDOW, passing the DELTA we
967 ;; recovered so far.
971 "Return maximum number of lines WINDOW by which WINDOW can be enlarged.
972 WINDOW can be an arbitrary window and defaults to the selected
973 window. The return value is zero if WINDOW cannot be enlarged.
975 Optional argument HORIZONTAL non-nil means return maximum number
976 of columns by which WINDOW can be enlarged.
978 Optional argument IGNORE non-nil means ignore any restrictions
979 imposed by fixed size windows, `window-min-height' or
980 `window-min-width' settings. IGNORE a window means ignore
981 restrictions for that window only. IGNORE equal `safe' means
982 live windows may get as small as `window-safe-min-height' lines
983 and `window-safe-min-width' columns.
985 Optional argument TRAIL `before' means only windows to the left
986 of or below WINDOW can be shrunk. Optional argument TRAIL
987 `after' means only windows to the right of or above WINDOW can be
988 shrunk.
990 Optional argument NOUP non-nil means don't go up in the window
991 tree but try to obtain the entire space from windows within
992 WINDOW's combination.
994 Optional argument NODOWN non-nil means do not check whether
995 WINDOW itself \(and its subwindows) can be enlarged; check only
996 whether other windows can be shrunk appropriately."
1000 ;; With IGNORE and NOWDON nil return zero if WINDOW has fixed
1001 ;; size.
1002 0
1003 ;; WINDOW has no fixed size.
1006 ;; Make NOUP also inhibit the min-size check.
1008 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
1009 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
1010 can be resized horizontally by DELTA columns. A return value of
1011 zero means that WINDOW is not resizable.
1013 DELTA positive means WINDOW shall be enlarged by DELTA lines or
1014 columns. If WINDOW cannot be enlarged by DELTA lines or columns
1015 return the maximum value in the range 0..DELTA by which WINDOW
1016 can be enlarged.
1018 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
1019 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
1020 return the minimum value in the range DELTA..0 that can be used
1021 for shrinking WINDOW.
1023 Optional argument IGNORE non-nil means ignore any restrictions
1024 imposed by fixed size windows, `window-min-height' or
1025 `window-min-width' settings. IGNORE a window means ignore
1026 restrictions for that window only. IGNORE equal `safe' means
1027 live windows may get as small as `window-safe-min-height' lines
1028 and `window-safe-min-width' columns.
1030 Optional argument TRAIL `before' means only windows to the left
1031 of or below WINDOW can be shrunk. Optional argument TRAIL
1032 `after' means only windows to the right of or above WINDOW can be
1033 shrunk.
1035 Optional argument NOUP non-nil means don't go up in the window
1036 tree but try to distribute the space among the other windows
1037 within WINDOW's combination.
1039 Optional argument NODOWN non-nil means don't check whether WINDOW
1040 and its subwindows can be resized."
1045 delta))
1048 delta))
1052 "Return t if WINDOW can be resized vertically by DELTA lines.
1053 For the meaning of the arguments of this function see the
1054 doc-string of `window-resizable'."
1058 delta)
1060 delta)))
1063 "Return the total number of lines of WINDOW.
1064 WINDOW can be any window and defaults to the selected one. The
1065 return value includes WINDOW's mode line and header line, if any.
1066 If WINDOW is internal the return value is the sum of the total
1067 number of lines of WINDOW's child windows if these are vertically
1068 combined and the height of WINDOW's first child otherwise.
1070 Note: This function does not take into account the value of
1071 `line-spacing' when calculating the number of lines in WINDOW."
1074 ;; Eventually we should make `window-height' obsolete.
1077 ;; See discussion in bug#4543.
1079 "Return t if WINDOW is as high as the containing frame.
1080 More precisely, return t if and only if the total height of
1081 WINDOW equals the total height of the root window of WINDOW's
1082 frame. WINDOW can be any window and defaults to the selected
1083 one."
1089 "Return the total number of columns of WINDOW.
1090 WINDOW can be any window and defaults to the selected one. The
1091 return value includes any vertical dividers or scrollbars of
1092 WINDOW. If WINDOW is internal, the return value is the sum of
1093 the total number of columns of WINDOW's child windows if these
1094 are horizontally combined and the width of WINDOW's first child
1095 otherwise."
1099 "Return t if WINDOW is as wide as the containing frame.
1100 More precisely, return t if and only if the total width of WINDOW
1101 equals the total width of the root window of WINDOW's frame.
1102 WINDOW can be any window and defaults to the selected one."
1108 "Return the number of lines of WINDOW's body.
1109 WINDOW must be a live window and defaults to the selected one.
1111 The return value does not include WINDOW's mode line and header
1112 line, if any. If a line at the bottom of the window is only
1113 partially visible, that line is included in the return value. If
1114 you do not want to include a partially visible bottom line in the
1115 return value, use `window-text-height' instead."
1119 "Return the number of columns of WINDOW's body.
1120 WINDOW must be a live window and defaults to the selected one.
1122 The return value does not include any vertical dividers or scroll
1123 bars owned by WINDOW. On a window-system the return value does
1124 not include the number of columns used for WINDOW's fringes or
1125 display margins either."
1128 ;; Eventually we should make `window-height' obsolete.
1132 "Return the current scroll bar settings for WINDOW.
1133 WINDOW must be a live window and defaults to the selected one.
1135 The return value is a cons cell (VERTICAL . HORIZONTAL) where
1136 VERTICAL specifies the current location of the vertical scroll
1137 bars (`left', `right', or nil), and HORIZONTAL specifies the
1138 current location of the horizontal scroll bars (`top', `bottom',
1139 or nil).
1141 Unlike `window-scroll-bars', this function reports the scroll bar
1142 type actually used, once frame defaults and `scroll-bar-mode' are
1143 taken into account."
1156 "Cycle through all live windows, calling PROC for each one.
1157 PROC must specify a function with a window as its sole argument.
1158 The optional arguments MINIBUF and ALL-FRAMES specify the set of
1159 windows to include in the walk.
1161 MINIBUF t means include the minibuffer window even if the
1162 minibuffer is not active. MINIBUF nil or omitted means include
1163 the minibuffer window only if the minibuffer is active. Any
1164 other value means do not include the minibuffer window even if
1165 the minibuffer is active.
1167 ALL-FRAMES nil or omitted means consider all windows on the
1168 selected frame, plus the minibuffer window if specified by the
1169 MINIBUF argument. If the minibuffer counts, consider all windows
1170 on all frames that share that minibuffer too. The following
1171 non-nil values of ALL-FRAMES have special meanings:
1173 - t means consider all windows on all existing frames.
1175 - `visible' means consider all windows on all visible frames on
1176 the current terminal.
1178 - 0 (the number zero) means consider all windows on all visible
1179 and iconified frames on the current terminal.
1181 - A frame means consider all windows on that frame only.
1183 Anything else means consider all windows on the selected frame
1184 and no others.
1186 This function changes neither the order of recently selected
1187 windows nor the buffer list."
1188 ;; If we start from the minibuffer window, don't fail to come
1189 ;; back to it.
1192 ;; Make sure to not mess up the order of recently selected
1193 ;; windows. Use `save-selected-window' and `select-window'
1194 ;; with second argument non-nil for this purpose.
1202 "Support function for `window-in-direction'."
1214 "Return window in DIRECTION as seen from WINDOW.
1215 DIRECTION must be one of `above', `below', `left' or `right'.
1216 WINDOW must be a live window and defaults to the selected one.
1217 IGNORE, when non-nil means a window can be returned even if its
1218 `no-other-window' parameter is non-nil."
1231 ;; The column / row value of `posn-at-point' can be nil for the
1232 ;; mini-window, guard against that.
1243 best best-2 best-diff-2-new)
1250 ;; Ignore ourselves.
1252 ;; Ignore W unless IGNORE is non-nil.
1258 ;; W is to the left or right of WINDOW and covers POSN.
1268 ;; W is to the left or right of WINDOW but does not
1269 ;; cover POSN.
1284 ;; W is above or below WINDOW and covers POSN.
1294 ;; W is above or below WINDOW but does not cover POSN.
1309 all-frames default)
1310 "Return a live window satisfying PREDICATE.
1311 More precisely, cycle through all windows calling the function
1312 PREDICATE on each one of them with the window as its sole
1313 argument. Return the first window for which PREDICATE returns
1314 non-nil. If no window satisfies PREDICATE, return DEFAULT.
1316 ALL-FRAMES nil or omitted means consider all windows on the selected
1317 frame, plus the minibuffer window if specified by the MINIBUF
1318 argument. If the minibuffer counts, consider all windows on all
1319 frames that share that minibuffer too. The following non-nil
1320 values of ALL-FRAMES have special meanings:
1322 - t means consider all windows on all existing frames.
1324 - `visible' means consider all windows on all visible frames on
1325 the current terminal.
1327 - 0 (the number zero) means consider all windows on all visible
1328 and iconified frames on the current terminal.
1330 - A frame means consider all windows on that frame only.
1332 Anything else means consider all windows on the selected frame
1333 and no others."
1338 default))
1343 "Return the least recently used window on frames specified by ALL-FRAMES.
1344 Return a full-width window if possible. A minibuffer window is
1345 never a candidate. A dedicated window is never a candidate
1346 unless DEDICATED is non-nil, so if all windows are dedicated, the
1347 value is nil. Avoid returning the selected window if possible.
1349 The following non-nil values of the optional argument ALL-FRAMES
1350 have special meanings:
1352 - t means consider all windows on all existing frames.
1354 - `visible' means consider all windows on all visible frames on
1355 the current terminal.
1357 - 0 (the number zero) means consider all windows on all visible
1358 and iconified frames on the current terminal.
1360 - A frame means consider all windows on that frame only.
1362 Any other value of ALL-FRAMES means consider all windows on the
1363 selected frame and no others."
1379 "Return the most recently used window on frames specified by ALL-FRAMES.
1380 Do not return a minibuffer window.
1382 The following non-nil values of the optional argument ALL-FRAMES
1383 have special meanings:
1385 - t means consider all windows on all existing frames.
1387 - `visible' means consider all windows on all visible frames on
1388 the current terminal.
1390 - 0 (the number zero) means consider all windows on all visible
1391 and iconified frames on the current terminal.
1393 - A frame means consider all windows on that frame only.
1395 Any other value of ALL-FRAMES means consider all windows on the
1396 selected frame and no others."
1403 best-window))
1406 "Return the largest window on frames specified by ALL-FRAMES.
1407 A minibuffer window is never a candidate. A dedicated window is
1408 never a candidate unless DEDICATED is non-nil, so if all windows
1409 are dedicated, the value is nil.
1411 The following non-nil values of the optional argument ALL-FRAMES
1412 have special meanings:
1414 - t means consider all windows on all existing frames.
1416 - `visible' means consider all windows on all visible frames on
1417 the current terminal.
1419 - 0 (the number zero) means consider all windows on all visible
1420 and iconified frames on the current terminal.
1422 - A frame means consider all windows on that frame only.
1424 Any other value of ALL-FRAMES means consider all windows on the
1425 selected frame and no others."
1427 best-window size)
1435 best-window))
1437 ;; The following is what `get-buffer-window' would look like if it were
1438 ;; implemented in Elisp. Since this function is needed for dumping,
1439 ;; leave it in C.
1441 ;; (defun get-buffer-window (&optional buffer-or-name all-frames)
1442 ;; "Return a window currently displaying BUFFER-OR-NAME, or nil if none.
1443 ;; BUFFER-OR-NAME may be a buffer or a buffer name and defaults to
1444 ;; the current buffer.
1446 ;; The following non-nil values of the optional argument ALL-FRAMES
1447 ;; have special meanings:
1448 ;; - t means consider all windows on all existing frames.
1449 ;; - `visible' means consider all windows on all visible frames.
1450 ;; - 0 (the number zero) means consider all windows on all visible
1451 ;; and iconified frames.
1452 ;; - A frame means consider all windows on that frame only.
1453 ;; Any other value of ALL-FRAMES means consider all windows on the
1454 ;; selected frame and no others."
1455 ;; (let ((buffer (get-buffer buffer-or-name))
1456 ;; best-window)
1457 ;; (when (bufferp buffer)
1458 ;; (dolist (window (window-list-1 nil t all-frames))
1459 ;; (when (and (eq (window-buffer window) buffer)
1460 ;; ;; The following SHOULD have been handled by
1461 ;; ;; `window-list-1' already ...
1462 ;; (or (not (window-minibuffer-p window))
1463 ;; ;; Don't find any minibuffer window except the
1464 ;; ;; one that is currently in use.
1465 ;; (eq window (minibuffer-window)))
1466 ;; (or (not best-window)
1467 ;; ;; Prefer to return selected window.
1468 ;; (eq window (selected-window))
1469 ;; ;; Prefer windows on selected frame.
1470 ;; (eq (window-frame window) (selected-frame))))
1471 ;; (setq best-window window))))
1472 ;; best-window))
1475 "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
1476 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
1477 and defaults to the current buffer.
1479 Any windows showing BUFFER-OR-NAME on the selected frame are listed
1480 first.
1482 MINIBUF t means include the minibuffer window even if the
1483 minibuffer is not active. MINIBUF nil or omitted means include
1484 the minibuffer window only if the minibuffer is active. Any
1485 other value means do not include the minibuffer window even if
1486 the minibuffer is active.
1488 ALL-FRAMES nil or omitted means consider all windows on the
1489 selected frame, plus the minibuffer window if specified by the
1490 MINIBUF argument. If the minibuffer counts, consider all windows
1491 on all frames that share that minibuffer too. The following
1492 non-nil values of ALL-FRAMES have special meanings:
1494 - t means consider all windows on all existing frames.
1496 - `visible' means consider all windows on all visible frames on
1497 the current terminal.
1499 - 0 (the number zero) means consider all windows on all visible
1500 and iconified frames on the current terminal.
1502 - A frame means consider all windows on that frame only.
1504 Anything else means consider all windows on the selected frame
1505 and no others."
1507 windows)
1514 "Return t if WINDOW is the currently active minibuffer window."
1518 "Return the number of live windows on the selected frame.
1519 The optional argument MINIBUF specifies whether the minibuffer
1520 window shall be counted. See `walk-windows' for the precise
1521 meaning of this argument."
1523 \f
1524 ;;; Resizing windows.
1526 "Reset resize values for all windows on FRAME.
1527 FRAME defaults to the selected frame.
1529 This function stores the current value of `window-total-size' applied
1530 with argument HORIZONTAL in the new total size of all windows on
1531 FRAME. It also resets the new normal size of each of these
1532 windows."
1537 "Internal function of `resize-window-reset'."
1538 ;; Register old size in the new total size.
1540 ;; Reset new normal size.
1547 ;; The following routine is used to manually resize the minibuffer
1548 ;; window and is currently used, for example, by ispell.el.
1550 "Resize minibuffer window WINDOW by DELTA lines.
1551 If WINDOW cannot be resized by DELTA lines make it as large \(or
1552 as small) as possible but don't signal an error."
1560 ;; Sanitize DELTA.
1567 ;; Resize now.
1569 ;; Ideally we should be able to resize just the last subwindow of
1570 ;; root here. See the comment in `resize-root-window-vertically'
1571 ;; for why we do not do that.
1574 ;; The following routine catches the case where we want to resize
1575 ;; a minibuffer-only frame.
1579 "Resize WINDOW vertically by DELTA lines.
1580 WINDOW can be an arbitrary window and defaults to the selected
1581 one. An attempt to resize the root window of a frame will raise
1582 an error though.
1584 DELTA a positive number means WINDOW shall be enlarged by DELTA
1585 lines. DELTA negative means WINDOW shall be shrunk by -DELTA
1586 lines.
1588 Optional argument HORIZONTAL non-nil means resize WINDOW
1589 horizontally by DELTA columns. In this case a positive DELTA
1590 means enlarge WINDOW by DELTA columns. DELTA negative means
1591 WINDOW shall be shrunk by -DELTA columns.
1593 Optional argument IGNORE non-nil means ignore any restrictions
1594 imposed by fixed size windows, `window-min-height' or
1595 `window-min-width' settings. IGNORE any window means ignore
1596 restrictions for that window only. IGNORE equal `safe' means
1597 live windows may get as small as `window-safe-min-height' lines
1598 and `window-safe-min-width' columns.
1600 This function resizes other windows proportionally and never
1601 deletes any windows. If you want to move only the low (right)
1602 edge of WINDOW consider using `adjust-window-trailing-edge'
1603 instead."
1606 sibling)
1619 ;; If window-splits returns nil for WINDOW, WINDOW is part of
1620 ;; an iso-combination, and WINDOW's neighboring right or left
1621 ;; sibling can be resized as requested, resize that sibling.
1628 normal-delta))
1631 normal-delta)))
1632 ;; Otherwise, resize all other windows in the same combination.
1639 "Return non-nil if WINDOW shall be skipped by resizing routines."
1642 (defun resize-subwindows-normal (parent horizontal window this-delta &optional trail other-delta)
1643 "Set the new normal height of subwindows of window PARENT.
1644 HORIZONTAL non-nil means set the new normal width of these
1645 windows. WINDOW specifies a subwindow of PARENT that has been
1646 resized by THIS-DELTA lines \(columns).
1648 Optional argument TRAIL either 'before or 'after means set values
1649 for windows before or after WINDOW only. Optional argument
1650 OTHER-DELTA a number specifies that this many lines \(columns)
1651 have been obtained from \(or returned to) an ancestor window of
1652 PARENT in order to resize WINDOW."
1656 ;; When WINDOW gets deleted and we can return its entire
1657 ;; space to its siblings, use WINDOW's normal size as the
1658 ;; normal delta.
1660 ;; In any other case calculate the normal delta from the
1661 ;; relation of THIS-DELTA to the total size of PARENT.
1667 ;; Set parent-normal to the sum of the normal sizes of all
1668 ;; subwindows of PARENT that shall be resized, excluding only WINDOW
1669 ;; and any windows specified by the optional TRAIL argument.
1680 ;; Set the new normal size of all subwindows of PARENT from what
1681 ;; they should have contributed for recovering THIS-DELTA lines
1682 ;; (columns).
1696 delta-normal))
1697 ;; Don't drop below 0.
1702 ;; Set the new normal size of windows from what they should have
1703 ;; contributed for recovering OTHER-DELTA lines (columns).
1706 other-delta)))
1718 ;; Don't drop below 0.
1722 ;; Set the new normal size of WINDOW to what is left by the sum of
1723 ;; the normal sizes of its siblings.
1725 window
1736 ;; Don't get larger than 1 or smaller than 0.
1740 "Resize subwindows of window PARENT vertically by DELTA lines.
1741 PARENT must be a vertically combined internal window.
1743 Optional argument HORIZONTAL non-nil means resize subwindows of
1744 PARENT horizontally by DELTA columns. In this case PARENT must
1745 be a horizontally combined internal window.
1747 WINDOW, if specified, must denote a child window of PARENT that
1748 is resized by DELTA lines.
1750 Optional argument IGNORE non-nil means ignore any restrictions
1751 imposed by fixed size windows, `window-min-height' or
1752 `window-min-width' settings. IGNORE equal `safe' means live
1753 windows may get as small as `window-safe-min-height' lines and
1754 `window-safe-min-width' columns. IGNORE any window means ignore
1755 restrictions for that window only.
1757 Optional arguments TRAIL and EDGE, when non-nil, restrict the set
1758 of windows that shall be resized. If TRAIL equals `before',
1759 resize only windows on the left or above EDGE. If TRAIL equals
1760 `after', resize only windows on the right or below EDGE. Also,
1761 preferably only resize windows adjacent to EDGE.
1763 Return the symbol `normalized' if new normal sizes have been
1764 already set by this routine."
1768 best-window best-value)
1780 sub)
1785 edge)
1790 edge)
1793 ;; Resize only windows adjacent to EDGE.
1798 ;; Assign new normal sizes.
1806 ;; Return 'normalized to notify `resize-other-windows' that
1807 ;; normal sizes have been already set.
1809 ;; Resize all windows proportionally.
1814 ;; Ignore windows to skip and fixed-size subwindows - in
1815 ;; the latter case make it a window to skip.
1820 ;; When shrinking store the number of lines/cols we can get
1821 ;; from this window here together with the total/normal size
1822 ;; factor.
1824 sub
1826 ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
1829 parent-total)
1832 ;; When enlarging store the total/normal size factor only
1834 sub
1836 parent-total)
1843 ;; Shrink windows by delta.
1862 best-window
1867 parent-total)
1870 ;; Enlarge windows by delta.
1888 best-window
1890 parent-total)
1898 ;; Reset new normal size fields so `resize-window-apply'
1899 ;; won't use them to apply new sizes.
1903 ;; Resize this subwindow's subwindows (back-engineering
1904 ;; delta from sub's old and new total sizes).
1908 ;; For the TRAIL non-nil case we have to resize SUB
1909 ;; recursively even if it's size does not change.
1911 sub delta horizontal ignore nil trail edge))))
1915 "Resize other windows when WINDOW is resized vertically by DELTA lines.
1916 Optional argument HORIZONTAL non-nil means resize other windows
1917 when WINDOW is resized horizontally by DELTA columns. WINDOW
1918 itself is not resized by this function.
1920 Optional argument IGNORE non-nil means ignore any restrictions
1921 imposed by fixed size windows, `window-min-height' or
1922 `window-min-width' settings. IGNORE equal `safe' means live
1923 windows may get as small as `window-safe-min-height' lines and
1924 `window-safe-min-width' columns. IGNORE any window means ignore
1925 restrictions for that window only.
1927 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1928 of windows that shall be resized. If TRAIL equals `before',
1929 resize only windows on the left or above EDGE. If TRAIL equals
1930 `after', resize only windows on the right or below EDGE. Also,
1931 preferably only resize windows adjacent to EDGE."
1936 ;; In an iso-combination try to extract DELTA from WINDOW's
1937 ;; siblings.
1940 this-delta other-delta)
1941 ;; Decide which windows shall be left alone.
1945 ;; Make sure WINDOW is left alone when
1946 ;; resizing its siblings.
1950 ;; Make sure this sibling is left alone when
1951 ;; resizing its siblings.
1955 ;; Set this-delta to t to signal that we found a sibling
1956 ;; of WINDOW whose size is not fixed.
1961 ;; Set this-delta to what we can get from WINDOW's siblings.
1963 ;; A deletion, presumably. We must handle this case
1964 ;; specially since `window-resizable' can't be used.
1966 ;; There's at least one resizable sibling we can
1967 ;; give WINDOW's size to.
1969 ;; No resizable sibling exists.
1971 ;; Any other form of resizing.
1975 ;; Set other-delta to what we still have to get from
1976 ;; ancestor windows of parent.
1979 ;; Unless we got everything from WINDOW's siblings, PARENT
1980 ;; must be resized by other-delta lines or columns.
1984 ;; We haven't got anything from WINDOW's siblings but we
1985 ;; must update the normal sizes to respect other-delta.
1987 parent horizontal window this-delta trail other-delta)
1988 ;; We did get something from WINDOW's siblings which means
1989 ;; we have to resize their subwindows.
1991 window ignore trail edge)
1992 ;; `resize-subwindows' returning 'normalized,
1993 ;; means it has set the normal sizes already.
1995 ;; Set the normal sizes.
1997 parent horizontal window this-delta trail other-delta))
1998 ;; Set DELTA to what we still have to get from ancestor
1999 ;; windows.
2002 ;; In an ortho-combination all siblings of WINDOW must be
2003 ;; resized by DELTA.
2011 ;; "Go up."
2015 "Resize WINDOW vertically by DELTA lines.
2016 Optional argument HORIZONTAL non-nil means resize WINDOW
2017 horizontally by DELTA columns.
2019 Optional argument IGNORE non-nil means ignore any restrictions
2020 imposed by fixed size windows, `window-min-height' or
2021 `window-min-width' settings. IGNORE equal `safe' means live
2022 windows may get as small as `window-safe-min-height' lines and
2023 `window-safe-min-width' columns. IGNORE any window means ignore
2024 restrictions for that window only.
2026 Optional argument ADD non-nil means add DELTA to the new total
2027 size of WINDOW.
2029 Optional arguments TRAIL and EDGE, when non-nil, refine the set
2030 of windows that shall be resized. If TRAIL equals `before',
2031 resize only windows on the left or above EDGE. If TRAIL equals
2032 `after', resize only windows on the right or below EDGE. Also,
2033 preferably only resize windows adjacent to EDGE.
2035 This function recursively resizes WINDOW's subwindows to fit the
2036 new size. Make sure that WINDOW is `window-resizable' before
2037 calling this function. Note that this function does not resize
2038 siblings of WINDOW or WINDOW's parent window. You have to
2039 eventually call `resize-window-apply' in order to make resizing
2040 actually take effect."
2042 ;; Add DELTA to the new total size of WINDOW.
2049 ;; In an iso-combination resize subwindows according to their
2050 ;; normal sizes.
2052 ;; In an ortho-combination resize each subwindow by DELTA.
2059 "Resize root window WINDOW vertically by DELTA lines.
2060 HORIZONTAL non-nil means resize root window WINDOW horizontally
2061 by DELTA columns.
2063 IGNORE non-nil means ignore any restrictions imposed by fixed
2064 size windows, `window-min-height' or `window-min-width' settings.
2066 This function is only called by the frame resizing routines. It
2067 resizes windows proportionally and never deletes any windows."
2074 "Resize root window WINDOW vertically by DELTA lines.
2075 If DELTA is less than zero and we can't shrink WINDOW by DELTA
2076 lines, shrink it as much as possible. If DELTA is greater than
2077 zero, this function can resize fixed-size subwindows in order to
2078 recover the necessary lines.
2080 Return the number of lines that were recovered.
2082 This function is only called by the minibuffer window resizing
2083 routines. It resizes windows proportionally and never deletes
2084 any windows."
2095 ;; Ideally, we would resize just the last window in a combination
2096 ;; but that's not feasible for the following reason: If we grow
2097 ;; the minibuffer window and the last window cannot be shrunk any
2098 ;; more, we shrink another window instead. But if we then shrink
2099 ;; the minibuffer window again, the last window might get enlarged
2100 ;; and the state after shrinking is not the state before growing.
2101 ;; So, in practice, we'd need a history variable to record how to
2102 ;; proceed. But I'm not sure how such a variable could work with
2103 ;; repeated minibuffer window growing steps.
2105 delta)))
2108 "Move WINDOW's bottom edge by DELTA lines.
2109 Optional argument HORIZONTAL non-nil means move WINDOW's right
2110 edge by DELTA columns. WINDOW defaults to the selected window.
2112 If DELTA is greater zero, then move the edge downwards or to the
2113 right. If DELTA is less than zero, move the edge upwards or to
2114 the left. If the edge can't be moved by DELTA lines or columns,
2115 move it as far as possible in the desired direction."
2119 left this-delta min-delta max-delta failed)
2120 ;; Find the edge we want to move.
2133 ;; Set LEFT to the first resizable window on the left. This step is
2134 ;; needed to handle fixed-size windows.
2147 ;; Set RIGHT to the first resizable window on the right. This step
2148 ;; is needed to handle fixed-size windows.
2161 ;; LEFT and RIGHT (which might be both internal windows) are now the
2162 ;; two windows we want to resize.
2168 ;; We can't get the whole DELTA - move as far as possible.
2171 ;; Start resizing.
2173 ;; Try to enlarge LEFT first.
2177 left this-delta horizontal nil t 'before
2181 ;; Shrink windows on right of LEFT.
2183 left delta horizontal nil 'after
2191 ;; We can't get the whole DELTA - move as far as possible.
2194 ;; Start resizing.
2196 ;; Try to enlarge RIGHT.
2200 right this-delta horizontal nil t 'after
2204 ;; Shrink windows on left of RIGHT.
2211 ;; Don't report an error in the standard case.
2213 ;; But do report an error if applying the changes fails.
2217 "Make selected window DELTA lines taller.
2218 Interactively, if no argument is given, make the selected window
2219 one line taller. If optional argument HORIZONTAL is non-nil,
2220 make selected window wider by DELTA columns. If DELTA is
2221 negative, shrink selected window by -DELTA lines or columns.
2222 Return nil."
2227 "Make selected window DELTA lines smaller.
2228 Interactively, if no argument is given, make the selected window
2229 one line smaller. If optional argument HORIZONTAL is non-nil,
2230 make selected window narrower by DELTA columns. If DELTA is
2231 negative, enlarge selected window by -DELTA lines or columns.
2232 Return nil."
2237 "Maximize WINDOW.
2238 Make WINDOW as large as possible without deleting any windows.
2239 WINDOW can be any window and defaults to the selected window."
2246 "Minimize WINDOW.
2247 Make WINDOW as small as possible without deleting any windows.
2248 WINDOW can be any window and defaults to the selected window."
2253 \f
2255 "Return non-nil if WINDOW is the root window of its frame."
2259 "Return window tree rooted at WINDOW.
2260 Optional argument NEXT non-nil means include windows right
2261 siblings in the return value.
2263 See the documentation of `window-tree' for a description of the
2264 return value."
2277 list))
2282 "Return the window tree of frame FRAME.
2283 FRAME must be a live frame and defaults to the selected frame.
2284 The return value is a list of the form (ROOT MINI), where ROOT
2285 represents the window tree of the frame's root window, and MINI
2286 is the frame's minibuffer window.
2288 If the root window is not split, ROOT is the root window itself.
2289 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
2290 for a horizontal split, and t for a vertical split. EDGES gives
2291 the combined size and position of the subwindows in the split,
2292 and the rest of the elements are the subwindows in the split.
2293 Each of the subwindows may again be a window or a list
2294 representing a window split, and so on. EDGES is a list \(LEFT
2295 TOP RIGHT BOTTOM) as returned by `window-edges'."
2298 \f
2300 "Select another window in cyclic ordering of windows.
2301 COUNT specifies the number of windows to skip, starting with the
2302 selected window, before making the selection. If COUNT is
2303 positive, skip COUNT windows forwards. If COUNT is negative,
2304 skip -COUNT windows backwards. COUNT zero means do not skip any
2305 window, so select the selected window. In an interactive call,
2306 COUNT is the numeric prefix argument. Return nil.
2308 If the `other-window' parameter of WINDOW is a function and
2309 `ignore-window-parameters' is nil, call that function with the
2310 arguments COUNT and ALL-FRAMES.
2312 This function does not select a window whose `no-other-window'
2313 window parameter is non-nil.
2315 This function uses `next-window' for finding the window to
2316 select. The argument ALL-FRAMES has the same meaning as in
2317 `next-window', but the MINIBUF argument of `next-window' is
2318 always effectively nil."
2323 old-window old-count)
2326 ;; `next-window' and `previous-window' may return a window we are
2327 ;; not allowed to select. Hence we need an exit strategy in case
2328 ;; all windows are non-selectable.
2335 ;; Keep out of infinite loops. When COUNT has not changed
2336 ;; since we last looked at `window' we're probably in one.
2340 ;; The first non-selectable window `next-window' got us:
2341 ;; Remember it and the current value of COUNT.
2351 ;; Keep out of infinite loops. When COUNT has not changed
2352 ;; since we last looked at `window' we're probably in one.
2356 ;; The first non-selectable window `previous-window' got
2357 ;; us: Remember it and the current value of COUNT.
2364 ;; Always return nil.
2365 nil))))
2367 ;; This should probably return non-nil when the selected window is part
2368 ;; of an atomic window whose root is the frame's root window.
2370 "Return non-nil if the selected window is the only window.
2371 Optional arg NOMINI non-nil means don't count the minibuffer
2372 even if it is active. Otherwise, the minibuffer is counted
2373 when it is active.
2375 Optional argument ALL-FRAMES specifies the set of frames to
2376 consider, see also `next-window'. ALL-FRAMES nil or omitted
2377 means consider windows on the selected frame only, plus the
2378 minibuffer window if specified by the NOMINI argument. If the
2379 minibuffer counts, consider all windows on all frames that share
2380 that minibuffer too. The remaining non-nil values of ALL-FRAMES
2381 with a special meaning are:
2383 - t means consider all windows on all existing frames.
2385 - `visible' means consider all windows on all visible frames on
2386 the current terminal.
2388 - 0 (the number zero) means consider all windows on all visible
2389 and iconified frames on the current terminal.
2391 - A frame means consider all windows on that frame only.
2393 Anything else means consider all windows on the selected frame
2394 and no others."
2400 \f
2401 ;;; Deleting windows.
2403 "Return t if WINDOW can be safely deleted from its frame.
2404 Return `frame' if deleting WINDOW should delete its frame
2405 instead."
2408 ;; Handle atomicity.
2421 ;; WINDOW is the root window of its frame. Return `frame' but
2422 ;; only if WINDOW is (1) either dedicated or quit-restore's car
2423 ;; is new-frame and the window still displays the same buffer
2424 ;; and (2) there are other frames left.
2430 ;; Can't delete last main window.
2431 nil)
2435 "Return t if SUBWINDOW is either WINDOW or a subwindow of WINDOW."
2445 "Delete WINDOW.
2446 WINDOW can be an arbitrary window and defaults to the selected
2447 one. Return nil.
2449 If the variable `ignore-window-parameters' is non-nil or the
2450 `delete-window' parameter of WINDOW equals t, do not process any
2451 parameters of WINDOW. Otherwise, if the `delete-window'
2452 parameter of WINDOW specifies a function, call that function with
2453 WINDOW as its sole argument and return the value returned by that
2454 function.
2456 Otherwise, if WINDOW is part of an atomic window, call
2457 `delete-window' with the root of the atomic window as its
2458 argument. If WINDOW is the only window on its frame or the last
2459 non-side window, signal an error."
2465 atom-root)
2468 ;; Handle window parameters.
2470 ;; Ignore window parameters if `ignore-window-parameters' tells
2471 ;; us so or `delete-window' equals t.
2474 ;; The `delete-window' parameter specifies the function to call.
2475 ;; If that function is `ignore' nothing is done. It's up to the
2476 ;; function called here to avoid infinite recursion.
2493 ;; Emacs 23 preferably gives WINDOW's space to its left
2494 ;; sibling.
2500 ;; Resize WINDOW's sibling.
2506 ;; Can do without resizing fixed-size windows.
2509 ;; Can't do without resizing fixed-size windows.
2511 ;; Actually delete WINDOW.
2516 ;; `delete-window-internal' has selected a window that should
2517 ;; not be selected, fix this here.
2521 ;; Always return nil.
2522 nil))))
2525 "Make WINDOW fill its frame.
2526 WINDOW may be any window and defaults to the selected one.
2527 Return nil.
2529 If the variable `ignore-window-parameters' is non-nil or the
2530 `delete-other-windows' parameter of WINDOW equals t, do not
2531 process any parameters of WINDOW. Otherwise, if the
2532 `delete-other-windows' parameter of WINDOW specifies a function,
2533 call that function with WINDOW as its sole argument and return
2534 the value returned by that function.
2536 Otherwise, if WINDOW is part of an atomic window, call this
2537 function with the root of the atomic window as its argument. If
2538 WINDOW is a non-side window, make WINDOW the only non-side window
2539 on the frame. Side windows are not deleted. If WINDOW is a side
2540 window signal an error."
2546 atom-root side-main)
2550 ;; Ignore window parameters if `ignore-window-parameters' is t or
2551 ;; `delete-other-windows' is t.
2554 ;; The `delete-other-windows' parameter specifies the function
2555 ;; to call. If the function is `ignore' no windows are deleted.
2556 ;; It's up to the function called to avoid infinite recursion.
2563 ;; Set side-main to the major non-side window.
2567 ;; If WINDOW is the main non-side window, do nothing.
2572 ;; Always return nil.
2573 nil)))
2576 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
2578 if you often split windows horizontally."
2590 ;;; Windows and buffers.
2592 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
2593 ;; for (1) determining which buffer to show in the window when its
2594 ;; buffer shall be buried or killed and (2) which buffer to show for
2595 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2597 ;; `prev-buffers' consists of <buffer, window-start, window-point>
2598 ;; triples. The entries on this list are ordered by the time their
2599 ;; buffer has been removed from the window, the most recently removed
2600 ;; buffer's entry being first. The window-start and window-point
2601 ;; components are `window-start' and `window-point' at the time the
2602 ;; buffer was removed from the window which implies that the entry must
2603 ;; be added when `set-window-buffer' removes the buffer from the window.
2605 ;; `next-buffers' is the list of buffers that have been replaced
2606 ;; recently by `switch-to-prev-buffer'. These buffers are the least
2607 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
2608 ;; candidates of `switch-to-next-buffer' to switch to. This list is
2609 ;; reset to nil by any action changing the window's buffer with the
2610 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
2611 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
2612 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
2614 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
2615 ;; if such a buffer was killed while the window was hidden within a
2616 ;; window configuration. Such killed buffers get removed whenever
2617 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
2619 ;; The following function is called by `set-window-buffer' _before_ it
2620 ;; replaces the buffer of the argument window with the new buffer.
2622 "Record WINDOW's buffer.
2623 WINDOW must be a live window and defaults to the selected one."
2627 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
2628 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2632 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
2636 ;; Don't record insignificant buffers.
2638 ;; Add an entry for buffer to WINDOW's previous buffers.
2645 ;; We have an entry, update marker positions.
2648 ;; Make new markers.
2656 "Unrecord BUFFER in WINDOW.
2657 WINDOW must be a live window and defaults to the selected one.
2658 BUFFER must be a live buffer and defaults to the buffer of
2659 WINDOW."
2668 "Set WINDOW's buffer to BUFFER.
2669 Optional argument START non-nil means set WINDOW's start position
2670 to START. Optional argument POINT non-nil means set WINDOW's
2671 point to POINT. If WINDOW is selected this also sets BUFFER's
2672 `point' to POINT. If WINDOW is selected and the buffer it showed
2673 before was current this also makes BUFFER the current buffer."
2688 "In WINDOW switch to previous buffer.
2689 WINDOW must be a live window and defaults to the selected one.
2691 Optional argument BURY-OR-KILL non-nil means the buffer currently
2692 shown in WINDOW is about to be buried or killed and consequently
2693 shall not be switched to in future invocations of this command."
2697 ;; Save this since it's destroyed by `set-window-buffer'.
2699 entry new-buffer killed-buffers deletable visible)
2701 ;; When BURY-OR-KILL is non-nil, there's no previous buffer for
2702 ;; this window, and we can delete the window (or the frame) do
2703 ;; that.
2717 ;; Scan WINDOW's previous buffers first, skipping entries of next
2718 ;; buffers.
2730 ;; Scan reverted buffer list of WINDOW's frame next, skipping
2731 ;; entries of next buffers. Note that when we bury or kill a
2732 ;; buffer we don't reverse the global buffer list to avoid showing
2733 ;; a buried buffer instead. Otherwise, we must reverse the global
2734 ;; buffer list in order to make sure that switching to the
2735 ;; previous/next buffer traverse it in opposite directions.
2744 ;; Try to avoid showing a buffer visible in some other window.
2750 ;; Scan reverted next buffers last (must not use nreverse
2751 ;; here!).
2753 ;; Actually, buffer _must_ be live here since otherwise it
2754 ;; would have been caught in the scan of previous buffers.
2765 ;; Show a buffer visible in another window.
2771 ;; Remove `old-buffer' from WINDOW's previous and (restored list
2772 ;; of) next buffers.
2777 ;; Move `old-buffer' to head of WINDOW's restored list of next
2778 ;; buffers.
2782 ;; Remove killed buffers from WINDOW's previous and next buffers.
2790 ;; Return new-buffer.
2791 new-buffer))
2794 "In WINDOW switch to next buffer.
2795 WINDOW must be a live window and defaults to the selected one."
2800 new-buffer entry killed-buffers visible)
2805 ;; Scan WINDOW's next buffers first.
2816 ;; Scan the buffer list of WINDOW's frame next, skipping previous
2817 ;; buffers entries.
2823 ;; Try to avoid showing a buffer visible in some other window.
2828 ;; Scan WINDOW's reverted previous buffers last (must not use
2829 ;; nreverse here!)
2840 ;; Show a buffer visible in another window.
2845 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
2848 ;; Remove killed buffers from WINDOW's previous and next buffers.
2856 ;; Return new-buffer.
2857 new-buffer))
2860 "Search LIST for a valid buffer to display in FRAME.
2861 Return nil when all buffers in LIST are undesirable for display,
2862 otherwise return the first suitable buffer in LIST.
2864 Buffers not visible in windows are preferred to visible buffers,
2865 unless VISIBLE-OK is non-nil.
2866 If the optional argument FRAME is nil, it defaults to the selected frame.
2867 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
2868 ;; This logic is more or less copied from other-buffer.
2871 found buf)
2884 "Return the last buffer in FRAME's buffer list.
2885 If BUFFER is the last buffer, return the preceding buffer
2886 instead. Buffers not visible in windows are preferred to visible
2887 buffers, unless optional argument VISIBLE-OK is non-nil.
2888 Optional third argument FRAME nil or omitted means use the
2889 selected frame's buffer list. If no such buffer exists, return
2890 the buffer `*scratch*', creating it if necessary."
2893 buffer visible-ok frame)
2897 scratch)))
2900 "Put BUFFER-OR-NAME at the end of the list of all buffers.
2901 There it is the least likely candidate for `other-buffer' to
2903 select by default.
2905 You can specify a buffer name as BUFFER-OR-NAME, or an actual
2906 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
2907 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
2908 remove the current buffer from the selected window if it is
2909 displayed there."
2912 ;; If `buffer-or-name' is not on the selected frame we unrecord it
2913 ;; although it's not "here" (call it a feature).
2915 ;; Handle case where `buffer-or-name' is nil and the current buffer
2916 ;; is shown in the selected window.
2925 ;; Always return nil.
2926 nil))
2929 "Switch to the last buffer in the buffer list."
2934 "In selected window switch to next buffer."
2939 "In selected window switch to previous buffer."
2944 "Delete all windows showing BUFFER-OR-NAME.
2945 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2946 and defaults to the current buffer.
2948 The following non-nil values of the optional argument FRAME
2949 have special meanings:
2951 - t means consider all windows on the selected frame only.
2953 - `visible' means consider all windows on all visible frames on
2954 the current terminal.
2956 - 0 (the number zero) means consider all windows on all visible
2957 and iconified frames on the current terminal.
2959 - A frame means consider all windows on that frame only.
2961 Any other value of FRAME means consider all windows on all
2962 frames.
2964 When a window showing BUFFER-OR-NAME is dedicated and the only
2965 window of its frame, that frame is deleted when there are other
2966 frames left."
2969 ;; Handle the "inverted" meaning of the FRAME argument wrt other
2970 ;; `window-list-1' based function.
2977 ;; Delete frame.
2980 ;; Delete window only.
2983 ;; In window switch to previous buffer.
2986 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
2990 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
2991 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2992 and defaults to the current buffer.
2994 When a window showing BUFFER-OR-NAME is either dedicated, or the
2995 window has no previous buffer, that window is deleted. If that
2996 window is the only window on its frame, the frame is deleted too
2997 when there are other frames left. If there are no other frames
2998 left, some other buffer is displayed in that window.
3000 This function removes the buffer denoted by BUFFER-OR-NAME from
3001 all window-local buffer lists."
3008 ;; Delete frame.
3011 ;; Delete window.
3014 ;; Switch to another buffer in window.
3017 ;; Unrecord BUFFER in WINDOW.
3021 "Quit WINDOW in some way.
3022 WINDOW must be a live window and defaults to the selected window.
3023 Return nil.
3025 According to information stored in WINDOW's `quit-restore' window
3026 parameter either \(1) delete WINDOW and its frame, \(2) delete
3027 WINDOW, \(3) restore the buffer previously displayed in WINDOW,
3028 or \(4) make WINDOW display some other buffer than the present
3029 one. If non-nil, reset `quit-restore' parameter to nil.
3031 Optional argument KILL non-nil means in addition kill WINDOW's
3032 buffer. If KILL is nil, put WINDOW's buffer at the end of the
3033 buffer list. Interactively, KILL is the prefix argument."
3038 deletable resize)
3041 ;; Check that WINDOW's buffer is still the same.
3045 ;; WINDOW can be deleted.
3048 ;; WINDOW's frame can be deleted.
3050 ;; Just delete WINDOW.
3052 ;; If the previously selected window is still alive, select it.
3056 ;; The buffer currently shown in WINDOW must still be the
3057 ;; buffer shown when its `quit-restore' parameter was created
3058 ;; in the first place.
3061 ;; Unrecord buffer.
3064 ;; Display buffer stored in the quit-restore parameter.
3072 ;; Reset the quit-restore parameter.
3077 ;; Otherwise, show another buffer in WINDOW and reset the
3078 ;; quit-restore parameter.
3083 ;; Kill WINDOW's old-buffer if requested
3085 nil))
3086 \f
3087 ;;; Splitting windows.
3089 "Return minimum height of any window when splitting windows.
3090 Optional argument HORIZONTAL non-nil means return minimum width."
3096 "Make a new window adjacent to WINDOW.
3097 WINDOW can be any window and defaults to the selected one.
3098 Return the new window which is always a live window.
3100 Optional argument SIZE a positive number means make WINDOW SIZE
3101 lines or columns tall. If SIZE is negative, make the new window
3102 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
3103 absolute value can be less than `window-min-height' or
3104 `window-min-width'; so this command can make a new window as
3105 small as one line or two columns. SIZE defaults to half of
3106 WINDOW's size. Interactively, SIZE is the prefix argument.
3108 Optional third argument SIDE nil (or `below') specifies that the
3109 new window shall be located below WINDOW. SIDE `above' means the
3110 new window shall be located above WINDOW. In both cases SIZE
3111 specifies the new number of lines for WINDOW \(or the new window
3112 if SIZE is negative) including space reserved for the mode and/or
3113 header line.
3115 SIDE t (or `right') specifies that the new window shall be
3116 located on the right side of WINDOW. SIDE `left' means the new
3117 window shall be located on the left of WINDOW. In both cases
3118 SIZE specifies the new number of columns for WINDOW \(or the new
3119 window provided SIZE is negative) including space reserved for
3120 fringes and the scrollbar or a divider column. Any other non-nil
3121 value for SIDE is currently handled like t (or `right').
3123 If the variable `ignore-window-parameters' is non-nil or the
3124 `split-window' parameter of WINDOW equals t, do not process any
3125 parameters of WINDOW. Otherwise, if the `split-window' parameter
3126 of WINDOW specifies a function, call that function with all three
3127 arguments and return the value returned by that function.
3130 root of that atomic window. The new window does not become a
3131 member of that atomic window.
3133 If WINDOW is live, properties of the new window like margins and
3134 scrollbars are inherited from WINDOW. If WINDOW is an internal
3135 window, these properties as well as the buffer displayed in the
3136 new window are inherited from the window selected on WINDOW's
3137 frame. The selected window is not changed by this function."
3145 ;; Rebind `window-nest' since in some cases we may have to
3146 ;; override its value.
3148 atom-root)
3153 ;; Ignore window parameters if either `ignore-window-parameters'
3154 ;; is t or the `split-window' parameter equals t.
3157 ;; The `split-window' parameter specifies the function to call.
3158 ;; If that function is `ignore', do nothing.
3160 ;; If WINDOW is a subwindow of an atomic window, split the root
3161 ;; window of that atomic window instead.
3170 ;; WINDOW is a side root window. To make sure that a new parent
3171 ;; window gets created set `window-nest' to t.
3175 ;; If `window-splits' is non-nil and SIZE is a non-negative
3176 ;; integer, we cannot reasonably resize other windows. Rather
3177 ;; bind `window-nest' to t to make sure that subsequent window
3178 ;; deletions are handled correctly.
3182 ;; `parent-size' is the size of WINDOW's parent, provided
3183 ;; it has one.
3185 ;; `resize' non-nil means we are supposed to resize other
3186 ;; windows in WINDOW's combination.
3189 ;; Resize makes sense in iso-combinations only.
3191 ;; `old-size' is the current size of WINDOW.
3193 ;; `new-size' is the specified or calculated size of the
3194 ;; new window.
3200 ;; When resizing try to give the new window the
3201 ;; average size of a window in its combination.
3204 (/ parent-size
3206 parent horizontal))))
3207 ;; Else try to give the new window half the size
3208 ;; of WINDOW (plus an eventual odd line).
3211 ;; SIZE non-negative specifies the new size of WINDOW.
3213 ;; Note: Specifying a non-negative SIZE is practically
3214 ;; always done as workaround for making the new window
3215 ;; appear above or on the left of the new window (the
3216 ;; ispell window is a typical example of that). In all
3217 ;; these cases the SIDE argument should be set to 'above
3218 ;; or 'left in order to support the 'resize option.
3219 ;; Here we have to nest the windows instead, see above.
3222 ;; SIZE negative specifies the size of the new window.
3224 new-parent new-normal)
3226 ;; Check SIZE.
3231 ;; SIZE unspecified, resizing.
3233 ;; Try again with minimum split size.
3239 ;; SIZE unspecified, no resizing.
3244 window-safe-min-width
3245 window-safe-min-width))))
3246 ;; SIZE specified as new size of old window. If the new size
3247 ;; is larger than the old size or the size of the new window
3248 ;; would be less than the safe minimum, signal an error.
3251 ;; SIZE specified, resizing.
3253 ;; If we cannot resize the parent give up.
3259 ;; SIZE specification violates minimum size restrictions.
3265 ;; Make new-parent non-nil if we need a new parent window;
3266 ;; either because we want to nest or because WINDOW is not
3267 ;; iso-combined.
3270 ;; Make new-normal the normal size of the new window.
3278 ;; Try to get space from OLD's siblings. We could go "up" and
3279 ;; try getting additional space from surrounding windows but
3280 ;; we won't be able to return space to those windows when we
3281 ;; delete the one we create here. Hence we do not go up.
3290 ;; Get entire space from WINDOW.
3295 new-normal)))
3298 ;; Inherit window-side parameters, if any.
3305 ;; Always return the new window.
3306 new)))))
3308 ;; I think this should be the default; I think people will prefer it--rms.
3311 in both children.
3312 This is often more convenient for editing.
3313 If nil, adjust point in each of the two windows to minimize redisplay.
3314 This is convenient on slow terminals, but point can move strangely.
3316 This option applies only to `split-window-above-each-other' and
3317 functions that call it. `split-window' always keeps the original
3318 point in both children."
3323 "Split selected window into two windows, one above the other.
3324 The upper window gets SIZE lines and the lower one gets the rest.
3325 SIZE negative means the lower window gets -SIZE lines and the
3326 upper one the rest. With no argument, split windows equally or
3327 close to it. Both windows display the same buffer, now current.
3329 If the variable `split-window-keep-point' is non-nil, both new
3330 windows will get the same value of point as the selected window.
3331 This is often more convenient for editing. The upper window is
3332 the selected window.
3334 Otherwise, we choose window starts so as to minimize the amount of
3335 redisplay; this is convenient on slow terminals. The new selected
3336 window is the one that the current value of point appears in. The
3337 value of point can change if the text around point is hidden by the
3338 new mode line.
3340 Regardless of the value of `split-window-keep-point', the upper
3341 window is the original one and the return value is the new, lower
3342 window."
3347 moved-by-window-height moved new-window bottom)
3349 ;; `split-window' would not signal an error here.
3370 ;; Always copy quit-restore parameter in interactive use.
3374 new-window))
3379 "Split selected window into two windows side by side.
3380 The selected window becomes the left one and gets SIZE columns.
3381 SIZE negative means the right window gets -SIZE lines.
3383 SIZE includes the width of the window's scroll bar; if there are
3384 no scroll bars, it includes the width of the divider column to
3385 the window's right, if any. SIZE omitted or nil means split
3386 window equally.
3388 The selected window remains selected. Return the new window."
3392 new-window)
3394 ;; `split-window' would not signal an error here.
3397 ;; Always copy quit-restore parameter in interactive use.
3401 new-window))
3404 \f
3405 ;;; Balancing windows.
3407 ;; The following routine uses the recycled code from an old version of
3408 ;; `resize-subwindows'. It's not very pretty, but coding it the way the
3409 ;; new `resize-subwindows' code does would hardly make it any shorter or
3410 ;; more readable (FWIW we'd need three loops - one to calculate the
3411 ;; minimum sizes per window, one to enlarge or shrink windows until the
3412 ;; new parent-size matches, and one where we shrink the largest/enlarge
3413 ;; the smallest window).
3415 "Subroutine of `balance-windows-1'.
3416 WINDOW must be an iso-combination."
3422 found failed size sub-total sub-delta sub-amount rest)
3437 ;; Ignore subwindows that should be ignored or are stuck.
3444 ;; Register the new total size for this subwindow.
3449 ;; We failed and need a new round.
3455 ;; Fix rounding by trying to enlarge non-stuck windows by one line
3456 ;; (column) until `rest' is zero.
3464 ;; Fix rounding by trying to enlarge stuck windows by one line
3465 ;; (column) until `rest' equals zero.
3475 ;; Record new normal sizes.
3481 ;; Recursively balance each subwindow's subwindows.
3486 "Subroutine of `balance-windows'."
3498 "Balance the sizes of subwindows of WINDOW-OR-FRAME.
3499 WINDOW-OR-FRAME is optional and defaults to the selected frame.
3500 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
3501 subwindows of that frame's root window. If WINDOW-OR-FRAME
3502 denots a window, balance the sizes of all subwindows of that
3503 window."
3512 window-or-frame)
3516 ;; Balance vertically.
3520 ;; Balance horizontally.
3526 "Return t if WINDOW cannot be resized in DIRECTION.
3527 WINDOW defaults to the selected window. DIRECTION can be
3528 nil (i.e. any), `height' or `width'."
3535 ;;; A different solution to balance-windows.
3537 "Factor by which the window area should be over-estimated.
3538 This is used by `balance-windows-area'.
3543 "Wrapper around `resize-window' with error checking.
3544 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
3545 ;; `resize-window' may fail if delta is too large.
3552 ;;(message "adjust: %s" (error-message-string err))
3556 "Make all visible windows the same area (approximately).
3557 See also `window-area-factor' to change the relative size of
3558 specific buffers."
3561 ;; Remove fixed-size windows.
3566 next)
3567 ;; Resizing a window changes the size of surrounding windows in complex
3568 ;; ways, so it's difficult to balance them all. The introduction of
3569 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
3570 ;; very difficult to do. `balance-window' above takes an off-line
3571 ;; approach: get the whole window tree, then balance it, then try to
3572 ;; adjust the windows so they fit the result.
3573 ;; Here, instead, we take a "local optimization" approach, where we just
3574 ;; go through all the windows several times until nothing needs to be
3575 ;; changed. The main problem with this approach is that it's difficult
3576 ;; to make sure it terminates, so we use some heuristic to try and break
3577 ;; off infinite loops.
3578 ;; After a round without any change, we allow a second, to give a chance
3579 ;; to the carry to propagate a minor imbalance from the end back to
3580 ;; the beginning.
3582 ;; (message "New round")
3588 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
3606 ;; Maybe diff is actually closer to 1 than to 0.
3610 ;; Change things smoothly.
3613 ;; Make sure negligible differences don't accumulate to
3614 ;; become significant.
3616 ;; This used `adjust-window-trailing-edge' before and uses
3617 ;; `resize-window' now. Error wrapping is still needed.
3619 ;; (sit-for 0.5)
3621 ;; If the same change has been seen already for this window,
3622 ;; we're most likely in an endless loop, so don't count it as
3623 ;; a change.
3627 ;; We've now basically balanced all the windows.
3628 ;; But there may be some minor off-by-one imbalance left over,
3629 ;; so let's do some fine tuning.
3630 ;; (bw-finetune wins)
3631 ;; (message "Done in %d rounds" round)
3632 ))
3634 ;;; Window states, how to get them and how to put them in a window.
3636 "Like LIST but do not add nil elements of ARGS."
3643 "Helper function for `window-state-get'."
3653 type
3665 window-state-ignored-parameters)
3670 ;; All buffer related things go in here - make the buffer
3671 ;; current when retrieving `point' and `mark'.
3701 "Return state of WINDOW as a Lisp object.
3702 WINDOW can be any window and defaults to the root window of the
3703 selected frame.
3705 Optional argument MARKERS non-nil means use markers for sampling
3706 positions like `window-point' or `window-start'. MARKERS should
3707 be non-nil only if the value is used for putting the state back
3708 in the same session (note that markers slow down processing).
3710 The return value can be used as argument for `window-state-put'
3711 to put the state recorded here into an arbitrary window. The
3712 value can be also stored on disk and read back in a new session."
3716 window
3719 ;; The return value is a cons whose car specifies some constraints on
3720 ;; the size of WINDOW. The cdr lists the states of the subwindows of
3721 ;; WINDOW.
3723 ;; Frame related things would go into a function, say `frame-state',
3724 ;; calling `window-state-get' to insert the frame's root window.
3732 ;; These are probably not needed.
3741 "Helper function for `window-state-put'."
3746 ;; For a leaf window just add unprocessed entries to
3747 ;; `window-state-put-list'.
3754 size new)
3756 ;; Find the next child window. WINDOW always points to the
3757 ;; real window that we want to fill with what we find here.
3760 ;; The last child window. Below `window-state-put-1'
3761 ;; will put into it whatever ITEM has in store.
3763 ;; Not the last child window, prepare for splitting
3764 ;; WINDOW. SIZE is the new (and final) size of the old
3765 ;; window.
3768 ;; Use total size.
3770 ;; Use normalized size and round.
3774 item))))))
3776 ;; Use safe sizes, we try to resize later.
3778 window-safe-min-height
3779 window-safe-min-width)))
3783 ;; We must inherit the nesting, otherwise we might mess
3784 ;; up handling of atomic and side window.
3786 ;; Give up if we can't resize window down to safe sizes.
3791 ;; When creating the first child window add for parent
3792 ;; unprocessed entries to `window-state-put-list'.
3795 window-state-put-list))))
3797 ;; Now process the current window (either the one we've just
3798 ;; split or the last child of its parent).
3800 ;; Continue with the last window split off.
3804 "Helper function for `window-state-put'."
3812 ;; Put in clone-number.
3816 ;; Process parameters.
3820 ;; Process buffer related state.
3822 ;; We don't want to raise an error here so we create a buffer if
3823 ;; there's none.
3835 ;; Adjust vertically.
3837 ;; A fixed height window, try to restore the original size.
3840 window-size-fixed)
3843 ;; Else check whether the window is not high enough.
3849 ;; Adjust horizontally.
3851 ;; A fixed width window, try to restore the original size.
3854 window-size-fixed)
3857 ;; Else check whether the window is not wide enough.
3863 ;; Set dedicated status.
3865 ;; Install positions (maybe we should do this after all windows
3866 ;; have been created and sized).
3870 ;; I'm not sure whether we should set the mark here, but maybe
3871 ;; it can be used.
3874 ;; Select window if it's the selected one.
3879 "Put window state STATE into WINDOW.
3880 STATE should be the state of a window returned by an earlier
3881 invocation of `window-state-get'. Optional argument WINDOW must
3882 specify a live window and defaults to the selected one.
3884 Optional argument IGNORE non-nil means ignore minimum window
3885 sizes and fixed size restrictions. IGNORE equal `safe' means
3886 subwindows can get as small as `window-safe-min-height' and
3887 `window-safe-min-width'."
3891 ;; We check here (1) whether the total sizes of root window of
3892 ;; STATE and that of WINDOW are equal so we can avoid
3893 ;; calculating new sizes, and (2) if we do have to resize
3894 ;; whether we can do so without violating size restrictions.
3902 window-splits selected)
3920 (> min-width
3922 ;; The check above might not catch all errors due to rounding
3923 ;; issues - so IGNORE equal 'safe might not always produce the
3924 ;; minimum possible state. But such configurations hardly make
3925 ;; sense anyway.
3929 ;; Work on the windows of a temporary buffer to make sure that
3930 ;; splitting proceeds regardless of any buffer local values of
3931 ;; `window-size-fixed'. Release that buffer after the buffers of
3932 ;; all live windows have been set by `window-state-put-2'.
3938 \f
3939 ;;; Displaying buffers.
3941 "Displaying buffers in windows."
3953 "Buffer display default specifiers.
3954 The value specified here is used when no other specifiers have
3955 been specified by the user or the application. Consult the
3956 documentation of `display-buffer-alist' for a description of
3961 ;; Use the same window.
3964 ;; Avoid other frames.
3969 ;; Avoid selected window.
3975 ;; Avoid other frames and selected window.
3980 ;; Avoid selected frame.
3985 ;; The default specifiers.
3986 display-buffer-default-specifiers))
3992 pop-up-window
3994 pop-up-frame
3998 "List associating buffer identifiers with display specifiers.
3999 The car of each element of this list is built from a set of cons
4000 cells called buffer identifiers. `display-buffer' shows a buffer
4001 according to the display specifiers in the element's cdr
4002 \(elements are true lists) if at least one of the identifiers
4003 matches the first or third argument of `display-buffer'. Such a
4004 match occurs in one of the following three cases:
4006 - The car of the buffer identifier is the symbol `name' and its
4007 cdr is a string equalling the name of the buffer specified by
4008 the first \(BUFFER-OR-NAME) argument of `display-buffer'.
4010 - The car is the symbol `regexp' and the cdr is a regular
4011 expression matching the name of the buffer specified by the
4012 first \(BUFFER-OR-NAME) argument of `display-buffer'.
4014 - The car is the symbol `label' and the cdr is a symbol equalling
4015 the third \(LABEL) argument of `display-buffer'.
4017 Display specifiers are either symbols, cons cells, or lists.
4018 Five specifiers have been reserved to indicate the basic method
4019 for displaying the buffer: `reuse-window', `pop-up-window',
4020 `pop-up-frame', `use-side-window', and `fun-with-args'.
4022 A list whose car is the symbol `reuse-window' indicates that an
4023 existing window shall be reused for displaying the buffer. The
4024 second element of this list specifies the window to use and can
4025 be one of the following symbols:
4027 nil stands for any window.
4029 `same' stands for the selected window.
4031 `other' stands for any but the selected window.
4033 The third element specifies whether the buffer shown in a window
4034 that shall be reused must be the same buffer that shall be
4035 displayed or another buffer and can be one of the following:
4037 nil means to not care about the window's buffer.
4039 `same' means the window must show the buffer already.
4041 `other' means the window must not show the buffer yet.
4043 The fourth element specifies the set of frames to search for a
4044 suitable window and can be one of the following:
4046 nil to reuse a window on the selected frame.
4048 `visible' to search visible frames on the current terminal.
4050 `other' stands for any visible frame but the selected one.
4052 0 \(the number zero) to search visible and iconified frames on
4053 the current terminal.
4055 t to search arbitrary frames including invisible ones.
4057 If more than one window fits the constraints imposed by these
4058 elements, the least recently used candidate is chosen. A side
4059 window is never reused unless it already shows the buffer.
4061 The following two specifiers are useful when the method equals
4062 `reuse-window':
4064 - A cons cell whose car is the symbol `reuse-window-even-sizes'
4065 and whose cdr is non-nil means to even out the sizes of a
4066 reused window and the selected window provided they (1) appear
4067 adjacent to each other and (2) the selected window is larger
4068 than the window chosen. If the cdr is nil, this means that the
4069 window sizes are left alone.
4071 - A cons cell whose car is the symbol `reuse-window-dedicated'
4072 and whose cdr is non-nil means that a window can be reused even
4073 if it's weakly dedicated to its buffer. If the cdr is t, a
4074 strongly dedicated window can be reused to show the buffer.
4075 Any other non-nil value means only weakly dedicated windows can
4076 be reused. If the cdr is nil, dedicated windows are not
4077 reused.
4079 This specifier should be used in emergency cases only since
4080 windows are usually made dedicated in order to prevent
4081 `display-buffer' from reusing them.
4083 A list whose car is the symbol `pop-up-window' and whose cdr is
4084 built from cons cells representing window/side tuples indicates
4085 that a new window shall be made for displaying the buffer on the
4086 selected frame.
4088 Window/side tuples are cons cells. The car of such a tuple
4089 identifies the window that shall be split. Possible values are
4090 `largest', `lru', `selected', and `root' to split the largest,
4091 least recently used, selected or root window of the selected
4092 frame.
4094 If the frame has side windows, these values do allow to split
4095 only the selected frame's main window or one of its subwindows.
4096 Setting the car to one of `left', `top', `right' and `bottom'
4097 splits the corresponding side window, provided such a window
4098 exists.
4100 The cdr of each pair specifies on which side of the window to
4101 split the new window shall appear and can be one of `below',
4102 `right', `above', or `left' with the obvious meanings. If the
4103 cdr is nil, the window is split in a fashion suitable for its
4104 current dimensions. If the cdr specifies a function, that
4105 function is called with one argument - the window to split. The
4106 function is supposed to split that window and return the new
4107 window.
4109 `display-buffer' scans these tuples until it can either produce a
4110 suitable window or fails. The default value for
4111 `display-buffer-alist' contains the tuples \(largest . nil) and
4112 \(lru . nil) in order to split the largest window first and, if
4113 that fails, the least recently used one.
4115 The following specifiers are useful if the method specifier is
4116 `pop-up-window'.
4118 - A cons cell whose car is the symbol `pop-up-window-min-height'
4119 specifiies the minimum height of the new window. If the cdr is
4120 an integer number, it specifies the minimum number of lines of
4121 the window. A floating point number gives the minimum fraction
4122 of the window height with respect to the height of the frame's
4123 root window. A new window is created only if it can be made at
4124 least as high as specified by the number. If the cdr is nil,
4125 this means to use the value of `window-min-height'.
4127 - A cons cell whose car is the symbol `pop-up-window-min-width'
4128 specifies the minimum width of the new window. If the cdr is
4129 an integer number, it specifies the minimum number of columns
4130 of the window. A floating point number gives the minimum
4131 fraction of the window width with respect to the width of the
4132 frame's root window. A new window is created only if it can be
4133 made at least as wide as specified by the number. If the cdr
4134 is nil, this means to use the value of `window-min-width'.
4136 - A cons cell whose car is `pop-up-window-set-height' with
4137 the following interpretations for the cdr:
4139 - nil means leave the height of the new window alone.
4141 - A number specifies the desired height of the new window. An
4142 integer number specifies the number of lines of the window.
4143 A floating point number gives the fraction of the window
4144 height with respect to the height of the frame's root window.
4146 - If the cdr specifies a function, that function is called with
4147 one argument - the new window. The function is supposed to
4148 adjust the height of the window; its return value is ignored.
4149 Suitable functions are `shrink-window-if-larger-than-buffer'
4150 and `fit-window-to-buffer'.
4152 - A cons cell whose car equals `pop-up-window-set-width' with
4153 the following interpretations for the cdr:
4155 - nil means leave the width of the new window alone.
4157 - A number specifies the desired width of the new window. An
4158 integer number specifies the number of columns of the window.
4159 A floating point number gives the fraction of the window
4160 width with respect to the width of the frame's root window.
4162 - If the cdr specifies a function, that function is called with
4163 one argument - the new window. The function is supposed to
4164 adjust the width of the window; its return value is ignored.
4166 Observe that specifying `pop-up-window-set-height' or
4167 `pop-up-window-set-width' may override restrictions given by
4168 the `pop-up-window-min-height' and `pop-up-window-min-width'
4169 specifiers.
4171 - A cons cell whose car is `pop-up-window-split-unsplittable' and
4172 whose cdr is non-nil allows to make a new window on an
4173 unsplittable frame. If the cdr is nil, unsplittable frames are
4174 not split. This specifier should be used in special cases only
4175 since frames are usually made unsplittable in order to prevent
4176 `display-buffer' from splitting them.
4178 A list whose car is the symbol `pop-up-frame' specifies that a
4179 new frame shall be made for displaying the buffer. The second
4180 element, if non-nil, allows popping up a new frame on graphic
4181 displays only.
4183 The following specifiers are useful if the method specifier is
4184 `pop-up-frame'.
4186 - A list whose car is the symbol `pop-up-frame-function' together
4187 with a valid function as cdr specifies the function for
4188 creating a new frame. If the cdr is nil, the default function
4189 `make-frame' is called. The function is called with the
4190 parameters and values provided by the specifier described next.
4192 - A list whose car is the symbol `pop-up-frame-alist' followed by
4193 an arbitrary number of frame parameter/value tuples, each given
4194 as a cons cell, specifies the parameters passed to the pop-up
4195 frame function.
4197 A list of three elements whose car is the symbol
4198 `use-side-window' specifies that the buffer shall be displayed in
4199 a side window of the selected frame. The second element denotes
4200 the side of the frame where the window appears or shall be made.
4201 The third element denotes the slot used by the window. If a side
4202 window with the specified slot exists already, that window is
4203 reused. If no such window exists it is created.
4205 The following specifiers are useful in connection with the
4206 `use-side-window' method specifier: `reuse-window-dedicated',
4207 `pop-up-window-min-height', `pop-up-window-min-width',
4208 `pop-up-window-set-height' and `pop-up-window-set-width'.
4210 A list whose car is the symbol `fun-with-args' specifies that the
4211 function specified in the second element of the list is
4212 responsible for displaying the buffer. `display-buffer' calls
4213 this function with the buffer as first argument and the remaining
4214 elements of the list as second argument.
4216 The function should choose or create a window, display the buffer
4217 in it, and return the window. It is also responsible for giving
4218 the variable `display-buffer-window' and the `quit-restore'
4219 parameter of the window used a meaningful value.
4221 Within the body of this function avoid calling `display-buffer'
4222 with the same buffer as argument since this may lead to endless
4223 recursion.
4225 Instead of supplying basic method specifiers, it's sometimes more
4226 convenient to use macro specifiers. They provide some commonly
4227 used display methods but do not support the fine control provided
4228 by the basic method specifiers. Macro specifiers are symbols.
4229 The following macro specifiers are provided:
4231 `same-window' to display the buffer in the selected window.
4233 `same-frame' to display the buffer on the selected frame.
4235 `other-window' to display the buffer in any window but the
4236 selected one.
4238 `same-frame-other-window' as `other-window' but stay on the
4239 selected frame.
4241 `other-frame' to display the buffer on another visible
4242 frame.
4244 `default' to use the default value of `display-buffer-alist'.
4246 One specifier is useful with any method specifier: A list whose
4247 car is the symbol `dedicate' and whose cdr is non-nil will
4248 dedicate the window to its buffer. The following values are
4249 supported:
4251 - nil to not dedicate the window to the buffer.
4253 - `weak' to weakly dedicate the window to the buffer.
4255 - t to strongly dedicate the window to the buffer.
4257 Usually, applications are free to override the specifiers of
4258 `display-buffer-alist' by passing their own specifiers as second
4259 argument of `display-buffer'. For every `display-buffer-alist'
4260 entry you can, however, add a cons cell whose car is the symbol
4261 `override' and whose cdr is non-nil, to explicitly override any
4262 value supplied by the application.
4264 Overriding specifiers supplied by the calling application is, in
4265 general, not advisable. It permits, for example, to change the
4266 semantics of a function like `display-buffer-other-window' by
4267 using the location specifiers `same-window' or `other-frame'."
4268 :risky t
4269 :type
4272 ;; Associations of buffer identifiers and display specifiers.
4275 ;; Buffer identifiers.
4300 ;; Display specifiers.
4304 :inline t
4306 :inline t
4313 :inline t
4317 ;; Reuse window specifiers.
4324 :inline t
4325 ;; For customization purposes only.
4329 :inline t
4330 ;; The window to reuse.
4334 ;; The window type.
4338 :value nil
4343 ;; The window's buffer.
4347 :value t
4352 ;; The window's frame.
4356 :value nil
4363 ;; Whether window sizes should be evened out.
4371 :value t
4375 ;; Whether to reuse a dedicated window
4387 ;; Pop-up window specifiers.
4392 :inline t
4396 :inline t
4397 ;; Pop-up window list.
4404 :inline t
4410 :value largest
4423 :value nil
4432 ;; Minimum height of pop-up windows.
4442 ;; Minimum width of pop-up windows.
4452 ;; Desired height of pop-up windows.
4463 ;; Desired width of pop-up windows.
4474 ;; Split unsplittable frames.
4484 ;; Pop-up frame specifiers.
4492 :inline t
4496 :inline t
4497 ;; Pop-up frame.
4509 ;; Pop-up frame function
4515 :value nil
4520 :value make-frame
4523 ;; Pop-up frame alist.
4529 :inline t
4541 ;; Use side-window specifiers.
4546 :inline t
4547 ;; For customization purposes only.
4551 :inline t
4552 ;; Side and slot.
4557 ;; The side.
4561 :value bottom
4567 ;; The slot
4573 ;; Whether to reuse a dedicated side window
4584 ;; Minimum height of pop-up side windows.
4594 ;; Minimum width of pop-up windows.
4604 ;; Desired height of pop-up windows.
4615 ;; Desired width of pop-up windows.
4627 ;; Function with argument specifiers.
4632 :inline t
4633 ;; For customization purposes only.
4637 :inline t
4647 :inline t
4652 ;; Macro specifiers.
4656 :inline t
4661 :inline t
4666 :inline t
4671 :inline t
4676 :inline t
4681 :inline t
4682 ;; Dedicate window to buffer.
4692 ;; No other window.
4701 ;; Overriding.
4714 "If non-nil, function to call to display a buffer.
4715 `display-buffer' calls this function with two arguments, the
4716 buffer to display and a list of buffer display specifiers, see
4717 `display-buffer-alist'.
4719 The function is supposed to choose or create a window, display
4720 the specified buffer in it, and return the window. It is also
4721 responsible for giving the variable `display-buffer-window' and
4722 the `quit-restore' parameter of the window used a meaningful
4723 value.
4725 The function specified here overrides all specifiers of the
4726 variable `display-buffer-alist' any specifiers passed to
4727 `display-buffer'.
4729 If you call `display-buffer' within the body of the function,
4730 bind the value of `display-buffer-function' to nil around that
4731 call to avoid that the function recursively calls itself."
4737 ;; The following is a global variable which is used externally (by
4738 ;; help.el) to (1) know which window was used for displaying a buffer
4739 ;; and (2) whether the window was new or reused.
4741 "Window used by `display-buffer' and related information.
4742 After `display-buffer' displays a buffer in some window this
4743 variable is a cons cell whose car denotes the window used to
4744 display the buffer. The cdr is supposed to be one of the symbols
4745 `reuse-buffer-window', `reuse-other-window', `new-window' or
4746 `new-frame'.
4748 If the buffer display location specifier is one of 'same-window,
4749 'same-frame, or 'other-frame, the `display-buffer' routines
4750 assign the value of this variable. If the location specifier is
4751 a function, that function becomes responsible for assigning a
4752 meaningful value to this variable. See the functions
4753 `display-buffer-reuse-window', `display-buffer-pop-up-window' and
4757 "Even sizes of WINDOW and selected window according to SPECIFIERS.
4758 SPECIFIERS must be a list of buffer display specifiers, see the
4759 documentation of `display-buffer-alist' for a description.
4761 Sizes are evened out if and only if WINDOW and the selected
4762 window appear next to each other and the selected window is
4763 larger than WINDOW."
4766 ;; Don't resize minibuffer windows.
4768 ;; WINDOW must be adjacent to the selected one.
4772 ;; Resize iff the selected window is higher than WINDOW.
4774 ;; Don't throw an error if we can't even window heights for
4775 ;; whatever reason. In any case, enlarging the selected window
4776 ;; might fail anyway if there are other windows above or below
4777 ;; WINDOW and the selected one. But for a simple two windows
4778 ;; configuration the present behavior is good enough so why care?
4784 ;; Resize iff the selected window is wider than WINDOW.
4786 ;; Don't throw an error if we can't even window widths, see
4787 ;; comment above.
4794 "Adjust height of WINDOW according to SPECIFIERS.
4795 SPECIFIERS must be a list of buffer display specifiers, see the
4796 documentation of `display-buffer-alist' for a description."
4801 set-height
4804 set-height))))
4813 "Adjust width of WINDOW according to SPECIFIERS.
4814 SPECIFIERS must be a list of buffer display specifiers, see the
4815 documentation of `display-buffer-alist' for a description."
4820 set-width
4823 set-width))))
4831 ;; We have to work around the deficiency that the command loop does not
4832 ;; preserve the selected window when it is on a frame that hasn't been
4833 ;; raised or given input focus. So we have to (1) select the window
4834 ;; used for displaying a buffer and (2) raise its frame if necessary,
4835 ;; thus defeating one primary principle of `display-buffer' namely to
4836 ;; _not_ select the window chosen for displaying the buffer :-(
4838 "Select WINDOW and raise its frame if necessary."
4841 ;; Select WINDOW _before_ raising the frame to assure that the mouse
4842 ;; cursor moves into the correct window.
4848 "Display BUFFER in WINDOW and raise its frame if needed.
4849 WINDOW must be a live window and defaults to the selected one.
4850 Return WINDOW.
4852 SPECIFIERS must be a list of buffer display specifiers, see the
4853 documentation of `display-buffer-alist' for a description."
4860 ;; Show BUFFER in WINDOW.
4869 ;; Return window.
4870 window))
4873 "Display BUFFER in an existing window.
4874 METHOD must be a list in the form of the cdr of a `reuse-window'
4875 buffer display specifier, see `display-buffer-alist' for an
4876 explanation. The first element must specifiy the window to use,
4877 and can be either nil, `same', `other', or a live window. The
4878 second element must specify the window's buffer and can be either
4879 nil, `same', `other', or a live buffer. The third element is the
4880 frame to use - either nil, 0, `visible', `other', t, or a live
4881 frame.
4883 Optional argument SPECIFIERS must be a list of valid display
4884 specifiers. Return the window chosen to display BUFFER, nil if
4885 none was found."
4890 windows other-frame dedicated time best-window best-time)
4892 ;; `other' is not handled by `window-list-1'.
4898 ;; Don't reuse a side window.
4906 ;; Special case for applications that specifiy
4907 ;; the window explicitly.
4914 ;; Special case for applications that specifiy
4915 ;; the window's buffer explicitly.
4919 ;; Handle dedicatedness.
4921 ;; The window does not show the same buffer.
4923 ;; If the window is weakly dedicated to its
4924 ;; buffer, reuse-dedicated must be non-nil.
4926 ;; If the window is strongly dedicated to its
4927 ;; buffer, reuse-dedicated must be t.
4932 ;; When reusing a window on the same buffer use the lru one.
4938 ;; Otherwise, sort windows according to their use-time.
4945 ;; Try to get a full-width window (this is silly and can
4946 ;; get us to another frame but let's ignore these issues
4947 ;; for the moment).
4952 ;; If there's no full-width window return the lru window.
4957 ;; Never change the quit-restore parameter of a window here.
4964 ;; Don't overwrite an existing quit-restore entry.
4966 best-window 'quit-restore
4980 "Subroutine of `display-buffer-split-window'."
4985 ;; We either resize WINDOW or its parent.
4987 new-size)
4988 ;; We don't call split-window-vertically/-horizontally any more
4989 ;; here. If for some reason it's needed we can always do so
4990 ;; (provided we give it an optional SIDE argument).
4993 ;; When we resize a combination, the new window must be at least
4994 ;; MIN-SIZE large after the split.
4998 (/ old-size
4999 ;; Try to make the size of the new window
5000 ;; proportional to the number of iso-arranged
5001 ;; windows in the combination.
5007 ;; When WINDOW is live, the old _and_ the new window must be at
5008 ;; least MIN-SIZE large after the split.
5011 ;; Do an even split to make Stepan happy.
5014 ;; When WINDOW is internal, the new window must be at least
5015 ;; MIN-SIZE large after the split.
5018 (/ old-size
5019 ;; Try to make the size of the new window
5020 ;; proportional to the number of iso-arranged
5021 ;; subwindows of WINDOW.
5027 "Split WINDOW in a way suitable for `display-buffer'.
5028 Optional argument SIDE must be a side specifier \(one of the
5029 symbols below, right, above, left, or nil). SPECIFIERS must be a
5030 list of buffer display specifiers, see the documentation of
5031 `display-buffer-alist' for a description.
5033 Return the new window, nil if it could not be created."
5036 size)
5037 ;; Normalize min-height and min-width, we might need both.
5039 ;; If min-height is specified, it can be as small as
5040 ;; `window-safe-min-height'.
5044 min-height)
5052 height))))
5055 ;; If min-width is specified, it can be as small as
5056 ;; `window-safe-min-width'.
5060 min-width)
5068 width))))
5074 ;; If SIDE is nil and vertical splitting failed, we try again
5075 ;; splitting horizontally this time.
5079 ;; If WINDOW is live and the root window of its frame, try once
5080 ;; more splitting vertically, disregarding the min-height
5081 ;; specifier this time and using `window-min-height' instead.
5090 "Make WINDOW part of an atomic window."
5094 root new new-parent)
5096 ;; We are in an atomic window.
5098 ;; Split the root window.
5103 ;; WINDOW is or becomes atomic.
5108 window t))
5109 ;; New window and any new parent get their window-atom parameter
5110 ;; set too.
5113 new)))
5116 "Display BUFFER in a new window.
5117 Return the window displaying BUFFER, nil if popping up the window
5118 failed. METHODS must be a list of window/side tuples like those
5119 forming the cdr of the `pop-up-window' buffer display specifier.
5120 As a special case, the car of such a tuple can be also a live
5121 window.
5123 Optional argument SPECIFIERS must be a list of buffer display
5124 specifiers, see the doc-string of `display-buffer-alist' for a
5125 description."
5128 window side atomic)
5130 ;; Don't split an unsplittable frame unless
5131 ;; SPECIFIERS allow it.
5146 ;; If there are side windows, split the main
5147 ;; window else the frame root window.
5151 ;; This should gets us the "root" side
5152 ;; window if there exists more than one.
5155 ;; A window, directly specified.
5156 window)))
5157 ;; The window must be on the selected frame,
5159 ;; and must be neither a minibuffer window,
5161 ;; nor a side window.
5173 ;; Don't pass any specifiers to this function.
5178 ;; Adjust sizes if asked for.
5186 window))))
5189 "Make a new frame for displaying BUFFER.
5190 Return the window displaying BUFFER if creating the new frame was
5191 successful, nil otherwise. Optional argument GRAPHIC-ONLY
5192 non-nil means to make a new frame on graphic displays only.
5194 SPECIFIERS must be a list of buffer display specifiers, see the
5195 documentation of `display-buffer-alist' for a description."
5215 "Display BUFFER in a new window on SIDE of the selected frame.
5216 SLOT specifies the slot to use. SPECIFIERS must be a list of
5217 buffer display specifiers.
5219 Return the window displaying BUFFER, nil if popping up the window
5220 failed."
5228 main
5229 root))
5237 fun)
5242 ;; Make all main-or-root subwindows main windows.
5244 main-or-root t))
5245 ;; Make sure that parent's window-side is nil.
5247 ;; Initialize side.
5249 ;; Adjust sizes if asked for.
5252 ;; Set window parameters.
5259 window)))
5262 "Display BUFFER in a window on SIDE of the selected frame.
5263 SLOT, if non-nil, specifies the window slot where to display the
5264 BUFFER. SLOT zero or nil means use the central slot on SIDE.
5265 SLOT negative means use a slot preceding the central window.
5266 SLOT positive means use a slot following the central window.
5268 SPECIFIERS must be a list of buffer display specifiers."
5272 ;; `major' is the major window on SIDE, `windows' the life
5273 ;; windows on SIDE.
5282 window-sides-slots))
5284 window this-window this-slot prev-window next-window
5285 best-window best-slot abs-slot)
5290 ;; No suitable side window exists, make one.
5292 ;; Scan windows on SIDE.
5299 ;; Dedicatedness check.
5302 ;; Window with matching SLOT, use it.
5316 ;; `this-window' is the first window with the same SLOT.
5317 ;; `prev-window' is the window with the largest slot < SLOT. A new
5318 ;; window will be created after it.
5319 ;; `next-window' is the window with the smallest slot > SLOT. A new
5320 ;; window will be created before it.
5321 ;; `best-window' is the window with the smallest absolute difference
5322 ;; of its slot and SLOT.
5324 ;; Reuse this window.
5333 ;; Don't overwrite an existing quit-restore entry.
5335 window 'quit-restore
5341 ;; Make new window before next-window.
5345 next-window next-side specifiers))))
5347 ;; Make new window after prev-window.
5351 prev-window prev-side specifiers)))))
5356 window 'quit-restore
5359 window))
5362 ;; Reuse best window (the window nearest to SLOT).
5370 ;; Don't overwrite an existing quit-restore entry.
5372 window 'quit-restore
5376 window))
5380 ;; Don't change exisiting slot value.
5385 "Normalize BUFFER-OR-NAME argument for buffer display functions.
5386 If BUFFER-OR-NAME is nil, return the curent buffer. Else, if a
5387 buffer specified by BUFFER-OR-NAME exists, return that buffer.
5388 If no such buffer exists, create a buffer with the name
5389 BUFFER-OR-NAME and return that buffer."
5394 buffer))
5398 "Subroutine of `display-buffer-normalize-specifiers'."
5407 ;; Might be a macro specifier, try to expand it (the cdr is a
5408 ;; list and we have to reverse it later, so do it one at a
5409 ;; time).
5413 ;; Reverse list.
5415 ;; The two cases below must come from the SPECIFIERS argument of
5416 ;; `display-buffer'.
5418 ;; Historically t means "other window". Eventually we should get
5419 ;; rid of this.
5422 normalized))
5424 ;; We allow scalar specifiers in calls of `display-buffer'.
5428 normalized))
5431 "Return normalized specifiers for a buffer matching BUFFER-NAME or LABEL.
5432 BUFFER-NAME must be a string specifying a valid buffer name.
5433 SPECIFIERS and LABEL are the homonymous arguments of
5434 `display-buffer'.
5436 The method for displaying the buffer specified by BUFFER-NAME or
5437 LABEL is established by appending the following four lists of
5438 specifiers:
5440 - The specifiers in `display-buffer-alist' whose buffer
5441 identifier matches BUFFER-NAME or LABEL and whose 'override
5442 component is set.
5444 - SPECIFIERS.
5446 - The specifiers in `display-buffer-alist' whose buffer
5447 identifier matches BUFFER-NAME or LABEL and whose 'override
5448 component is not set.
5450 - `display-buffer-default-specifiers'."
5471 normalized))
5475 normalized))))))
5478 list-1
5480 list-2
5481 ;; Append the default specifiers.
5482 display-buffer-default-specifiers)))
5484 ;; Minibuffer-only frames should be documented better. They really
5485 ;; deserve a separate section in the manual. Also
5486 ;; `last-nonminibuffer-frame' is nowhere documented in the manual.
5488 "Return FRAME if it is live and not a minibuffer-only frame.
5489 Return the value of `last-nonminibuffer-frame' otherwise."
5492 ;; A not very nice way to get that information.
5494 frame
5498 "Make the buffer specified by BUFFER-OR-NAME appear in some window.
5499 Optional argument BUFFER-OR-NAME may be a buffer, a string \(a
5500 buffer name), or nil. If BUFFER-OR-NAME is a string not naming
5501 an existent buffer, create a buffer with that name. If
5502 BUFFER-OR-NAME is nil or omitted, display the current buffer.
5503 Interactively, prompt for the buffer name using the minibuffer.
5505 Return the window chosen to display the buffer or nil if no such
5506 window is found. Do not change the selected window unless the
5507 buffer is shown on a different frame than the selected one.
5509 Optional argument SPECIFIERS must be a list of buffer display
5510 specifiers, see the documentation of `display-buffer-alist' for a
5511 description.
5513 For convenience, SPECIFIERS may also consist of a single buffer
5514 display location specifier or t, where the latter means to
5515 display the buffer in any but the selected window. If SPECIFIERS
5516 is nil or omitted, this means to exclusively use the specifiers
5517 provided by `display-buffer-alist'. If the value of the latter
5518 is nil too, all specifiers are provided by the constant
5519 `display-buffer-default-specifiers'.
5521 As a special case, the `reuse-window' specifier allows to specify
5522 as second element an arbitrary window, as third element an
5523 arbitrary buffer, and as fourth element an arbitrary frame. As
5524 first element of a window/side pair of the `pop-up-window'
5525 specifier you can specifiy an arbitrary window.
5527 The optional third argument LABEL, if non-nil, must be a symbol
5528 specifiying the buffer display label. Applications should set
5529 this when the buffer shall be displayed in some special way but
5530 BUFFER-OR-NAME does not identify the buffer as special. Typical
5531 buffers that fit into this category are those whose names are
5532 derived from the name of the file they are visiting. A user can
5533 override SPECIFIERS by adding an entry to `display-buffer-alist'
5534 whose car contains LABEL and whose cdr specifies the preferred
5535 alternative display method.
5537 The method to display the buffer is derived by combining the
5538 values of `display-buffer-alist' and SPECIFIERS. Highest
5539 priority is given to overriding elements of
5540 `display-buffer-alist'. Next come the elements specified by
5541 SPECIFIERS, followed by the non-overriding elements of
5542 `display-buffer-alist'.
5544 The result must be a list of valid buffer display specifiers. If
5545 `display-buffer-function' is non-nil, call it with the buffer and
5546 this list as arguments."
5551 ;; Normalize specifiers.
5553 ;; Don't use a minibuffer frame.
5555 ;; `window' is the window we use for showing `buffer'.
5556 window specifier method)
5557 ;; Reset this.
5560 ;; Let `display-buffer-function' do the job.
5562 ;; Retrieve the next location specifier while there a specifiers
5563 ;; left and we don't have a valid window.
5585 ;; If we don't have a window yet, try a fallback method. All
5586 ;; specifiers have been used up by now.
5588 ;; Try reusing a window showing BUFFER on any visible or
5589 ;; iconfied frame.
5591 ;; Try reusing a window not showing BUFFER on any visible or
5592 ;; iconified frame.
5594 ;; Try making a new frame.
5596 ;; Try using weakly dedicated windows.
5599 ;; Try using strongly dedicated windows.
5604 "Display buffer specified by BUFFER-OR-NAME in the selected window.
5605 Another window will be used only if the buffer can't be shown in
5606 the selected window, usually because it is dedicated to another
5607 buffer. Optional argument BUFFER-OR-NAME and LABEL are as for
5608 `display-buffer'."
5613 "Display buffer specified by BUFFER-OR-NAME in a window on the same frame.
5614 Another frame will be used only if there is no other choice.
5615 Optional argument BUFFER-OR-NAME and LABEL are as for
5616 `display-buffer'."
5621 "Display buffer specified by BUFFER-OR-NAME in another window.
5622 The selected window will be used only if there is no other
5623 choice. Windows on the selected frame are preferred to windows
5624 on other frames. Optional argument BUFFER-OR-NAME and LABEL are as
5625 for `display-buffer'."
5630 "Display buffer specified by BUFFER-OR-NAME in another window on the same frame.
5631 The selected window or another frame will be used only if there
5632 is no other choice. Optional argument BUFFER-OR-NAME and LABEL are
5633 as for `display-buffer'."
5638 "Display buffer specified by BUFFER-OR-NAME and select the window used.
5639 Optional argument BUFFER-OR-NAME may be a buffer, a string \(a
5640 buffer name), or nil. If BUFFER-OR-NAME is a string not naming
5641 an existent buffer, create a buffer with that name. If
5642 BUFFER-OR-NAME is nil or omitted, display the current buffer.
5643 Interactively, prompt for the buffer name using the minibuffer.
5645 Optional second argument SPECIFIERS must be a list of buffer
5646 display specifiers, a single location specifier, `t' which means
5647 the latter means to display the buffer in any but the selected
5648 window, or nil which means to exclusively apply the specifiers
5649 customized by the user.
5651 Optional argument NORECORD non-nil means do not put the buffer
5652 specified by BUFFER-OR-NAME at the front of the buffer list and
5653 do not make the window displaying it the most recently selected
5654 one.
5656 The optional argument LABEL, if non-nil, is a symbol specifying the
5657 display purpose. Applications should set this when the buffer
5658 shall be displayed in a special way but BUFFER-OR-NAME does not
5659 identify the buffer as special. Buffers that typically fit into
5660 this category are those whose names have been derived from the
5661 name of the file they are visiting.
5663 Return the buffer specified by BUFFER-OR-NAME or nil if
5664 displaying the buffer failed.
5666 This uses the function `display-buffer' as a subroutine; see the
5667 documentations of `display-buffer' and `display-buffer-alist' for
5668 additional information."
5671 window)
5675 buffer)))
5678 "Pop to buffer specified by BUFFER-OR-NAME in the selected window.
5679 Another window will be used only if the buffer can't be shown in
5680 the selected window, usually because it is dedicated to another
5681 buffer. Optional arguments BUFFER-OR-NAME, NORECORD and LABEL are
5682 as for `pop-to-buffer'."
5687 "Pop to buffer specified by BUFFER-OR-NAME in a window on the selected frame.
5688 Another frame will be used only if there is no other choice.
5689 Optional arguments BUFFER-OR-NAME, NORECORD and LABEL are as for
5690 `pop-to-buffer'."
5695 "Pop to buffer specified by BUFFER-OR-NAME in another window.
5696 The selected window will be used only if there is no other
5697 choice. Windows on the selected frame are preferred to windows
5698 on other frames. Optional arguments BUFFER-OR-NAME, NORECORD and
5699 LABEL are as for `pop-to-buffer'."
5704 "Pop to buffer specified by BUFFER-OR-NAME in another window on the selected frame.
5705 The selected window or another frame will be used only if there
5706 is no other choice. Optional arguments BUFFER-OR-NAME, NORECORD
5707 and LABEL are as for `pop-to-buffer'."
5712 "Pop to buffer specified by BUFFER-OR-NAME on another frame.
5713 The selected frame will be used only if there's no other choice.
5714 Optional arguments BUFFER-OR-NAME, NORECORD and LABEL are as for
5715 `pop-to-buffer'."
5720 "Read the name of a buffer to switch to, prompting with PROMPT.
5721 Return the neame of the buffer as a string.
5723 This function is intended for the `switch-to-buffer' family of
5724 commands since these need to omit the name of the current buffer
5725 from the list of completions and default values."
5730 ;; Since rbts-completion-table is built dynamically, we
5731 ;; can't just add it to the default value of
5732 ;; icomplete-with-completion-tables, so we add it
5733 ;; here manually.
5738 icomplete-with-completion-tables))))
5743 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
5744 If BUFFER-OR-NAME is nil, return the buffer returned by
5745 `other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
5746 exists, return that buffer. If no such buffer exists, create a
5747 buffer with the name BUFFER-OR-NAME and return that buffer."
5752 buffer))
5756 "Switch to buffer BUFFER-OR-NAME in the selected window.
5757 If called interactively, prompt for the buffer name using the
5758 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5759 determines whether to request confirmation before creating a new
5760 buffer.
5762 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
5763 nil. If BUFFER-OR-NAME is a string that does not identify an
5764 existing buffer, create a buffer with that name. If
5765 BUFFER-OR-NAME is nil, switch to the buffer returned by
5766 `other-buffer'.
5768 Optional argument NORECORD non-nil means do not put the buffer
5769 specified by BUFFER-OR-NAME at the front of the buffer list and
5770 do not make the window displaying it the most recently selected
5771 one. Return the buffer switched to.
5773 This function is intended for interactive use only. Lisp
5774 functions should call `pop-to-buffer-same-window' instead."
5780 ;; Cannot switch to another buffer in a minibuffer or strongly
5781 ;; dedicated window that does not show the buffer already. Call
5782 ;; `pop-to-buffer' instead.
5785 ;; I'm not sure why we should NOT call `set-window-buffer' here,
5786 ;; but let's keep things as they are (otherwise we could always
5787 ;; call `pop-to-buffer-same-window' here).
5794 "Switch to buffer BUFFER-OR-NAME in a window on the selected frame.
5795 Another frame will be used only if there is no other choice.
5796 Optional arguments BUFFER-OR-NAME and NORECORD have the same
5797 meaning as for `switch-to-buffer'.
5799 This function is intended for interactive use only. Lisp
5800 functions should call `pop-to-buffer-same-frame' instead."
5807 "Switch to buffer BUFFER-OR-NAME in another window.
5808 The selected window will be used only if there is no other
5809 choice. Windows on the selected frame are preferred to windows
5810 on other frames. Optional arguments BUFFER-OR-NAME and NORECORD
5811 have the same meaning as for `switch-to-buffer'.
5813 This function is intended for interactive use only. Lisp
5814 functions should call `pop-to-buffer-other-window' instead."
5821 "Switch to buffer BUFFER-OR-NAME in another window on the selected frame.
5822 The selected window or another frame will be used only if there
5823 is no other choice. Optional arguments BUFFER-OR-NAME and
5824 NORECORD have the same meaning as for `switch-to-buffer'.
5826 This function is intended for interactive use only. Lisp
5827 functions should call `pop-to-buffer-other-window-same-frame'
5828 instead."
5835 "Switch to buffer BUFFER-OR-NAME on another frame.
5836 The same frame will be used only if there is no other choice.
5837 Optional arguments BUFFER-OR-NAME and NORECORD have the same
5838 meaning as for `switch-to-buffer'.
5840 This function is intended for interactive use only. Lisp
5841 functions should call `pop-to-buffer-other-frame' instead."
5847 ;;; Obsolete definitions of `display-buffer' below.
5849 "Alist of parameters for automatically generated new frames.
5850 You can set this in your init file; for example,
5852 (setq pop-up-frame-alist '((width . 80) (height . 20)))
5854 If non-nil, the value you specify here is used by the default
5855 `pop-up-frame-function' for the creation of new frames.
5857 Since `pop-up-frame-function' is used by `display-buffer' for
5858 making new frames, any value specified here by default affects
5859 the automatic generation of new frames via `display-buffer' and
5860 all functions based on it. The behavior of `make-frame' is not
5861 affected by this variable."
5867 'pop-up-frame-alist
5868 "use `display-buffer-alist' or 2nd arg of `display-buffer' instead."
5873 "Function used by `display-buffer' for creating a new frame.
5874 This function is called with no arguments and should return a new
5875 frame. The default value calls `make-frame' with the argument
5876 `pop-up-frame-alist'."
5880 'pop-up-frame-function
5881 "use `display-buffer-alist' or 2nd arg of `display-buffer' instead."
5886 "Alist of parameters for special frames.
5887 Special frames are used for buffers whose names are listed in
5888 `special-display-buffer-names' and for buffers whose names match
5889 one of the regular expressions in `special-display-regexps'.
5891 This variable can be set in your init file, like this:
5893 (setq special-display-frame-alist '((width . 80) (height . 20)))
5895 These supersede the values given in `default-frame-alist'."
5901 'special-display-frame-alist
5902 "use `display-buffer-alist' or 2nd arg of `display-buffer' instead."
5906 "Display BUFFER in a special frame and return the window chosen.
5907 If BUFFER is already displayed in a visible or iconified frame,
5908 raise that frame. Otherwise, display BUFFER in a way as
5909 specified by optional argument ARGS.
5911 If ARGS is an alist, use it as a list of frame parameters. If
5912 these parameters contain \(same-window . t), display BUFFER in
5913 the selected window. If they contain \(same-frame . t), display
5914 BUFFER in a window on the selected frame.
5916 If ARGS is a list whose car is a symbol, use (car ARGS) as a
5917 function to do the work. Pass it BUFFER as first argument,
5918 and (cdr ARGS) as second."
5923 ;; If we have a window already, make it visible.
5928 window))
5929 ;; Reuse the current window if the user requested it.
5933 ;; Stay on the same frame if requested.
5940 ;; If no window yet, make one in a new frame.
5945 special-display-frame-alist))))))
5950 'special-display-popup-frame
5951 "use `display-buffer-alist' or 2nd arg of `display-buffer' instead."
5955 "List of names of buffers that should be displayed specially.
5956 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
5957 its name is in this list, displays the buffer in a way specified
5958 by `special-display-function'. `special-display-popup-frame'
5959 \(the default for `special-display-function') usually displays
5960 the buffer in a separate frame made with the parameters specified
5961 by `special-display-frame-alist'. If `special-display-function'
5962 has been set to some other function, that function is called with
5963 the buffer as first, and nil as second argument.
5965 Alternatively, an element of this list can be specified as
5966 \(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
5967 name and FRAME-PARAMETERS an alist of \(PARAMETER . VALUE) pairs.
5968 `special-display-popup-frame' will interpret such pairs as frame
5969 parameters when it creates a special frame, overriding the
5970 corresponding values from `special-display-frame-alist'.
5972 As a special case, if FRAME-PARAMETERS contains (same-window . t)
5973 `special-display-popup-frame' displays that buffer in the
5974 selected window. If FRAME-PARAMETERS contains (same-frame . t),
5975 it displays that buffer in a window on the selected frame.
5977 If `special-display-function' specifies some other function than
5978 `special-display-popup-frame', that function is called with the
5979 buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
5980 argument.
5982 Finally, an element of this list can be also specified as
5983 \(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
5984 `special-display-popup-frame' will call FUNCTION with the buffer
5985 named BUFFER-NAME as first argument, and OTHER-ARGS as the
5986 second. If `special-display-function' specifies some other
5987 function, that function is called with the buffer named
5988 BUFFER-NAME as first, and the element's cdr as second argument.
5991 name to it but the corresponding buffer is displayed in the
5992 selected window, look at the values of `same-window-buffer-names'
5993 and `same-window-regexps'. Those variables take precedence over
5994 this one.
5996 See also `special-display-regexps'."
6018 'special-display-buffer-names
6019 "use `display-buffer-alist' or 2nd arg of `display-buffer' instead."
6022 ;;;###autoload
6026 "List of regexps saying which buffers should be displayed specially.
6027 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
6028 any regexp in this list matches its name, displays it specially
6029 using `special-display-function'.
6031 The function `special-display-popup-frame' \(the default for
6032 `special-display-function') usually displays the buffer in a
6033 separate frame made with the parameters specified by
6034 `special-display-frame-alist'. If `special-display-function' has
6035 been set to some other function, that function is called with the
6036 buffer as first, and nil as second argument.
6038 Alternatively, an element of this list can be specified as
6039 \(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
6040 FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
6041 `special-display-popup-frame' will then interpret these pairs as
6042 frame parameters when creating a special frame for a buffer whose
6043 name matches REGEXP, overriding the corresponding values from
6044 `special-display-frame-alist'.
6046 As a special case, if FRAME-PARAMETERS contains (same-window . t)
6047 `special-display-popup-frame' displays buffers matching REGEXP in
6048 the selected window. \(same-frame . t) in FRAME-PARAMETERS means
6049 to display such buffers in a window on the selected frame.
6051 If `special-display-function' specifies some other function than
6052 `special-display-popup-frame', that function is called with the
6053 buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
6054 as second argument.
6056 Finally, an element of this list can be also specified as
6057 \(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
6058 will then call FUNCTION with the buffer whose name matched
6059 REGEXP as first, and OTHER-ARGS as second argument. If
6060 `special-display-function' specifies some other function, that
6061 function is called with the buffer whose name matched REGEXP
6062 as first, and the element's cdr as second argument.
6065 name to it but the corresponding buffer is displayed in the
6066 selected window, look at the values of `same-window-buffer-names'
6067 and `same-window-regexps'. Those variables take precedence over
6068 this one.
6070 See also `special-display-buffer-names'."
6092 'special-display-regexps
6093 "use `display-buffer-alist' or 2nd arg of `display-buffer' instead."
6097 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
6098 More precisely, return t if `special-display-buffer-names' or
6099 `special-display-regexps' contain a string entry equaling or
6100 matching BUFFER-NAME. If `special-display-buffer-names' or
6101 `special-display-regexps' contain a list entry whose car equals
6102 or matches BUFFER-NAME, the return value is the cdr of that
6103 entry."
6106 tmp)
6110 t)
6125 "Function to call for displaying special buffers.
6126 This function is called with two arguments - the buffer and,
6127 optionally, a list - and should return a window displaying that
6128 buffer. The default value usually makes a separate frame for the
6129 buffer using `special-display-frame-alist' to specify the frame
6130 parameters. See the definition of `special-display-popup-frame'
6131 for how to specify such a function.
6133 A buffer is special when its name is either listed in
6134 `special-display-buffer-names' or matches a regexp in
6135 `special-display-regexps'."
6139 'special-display-function
6140 "use `display-buffer-alist' or 2nd arg of `display-buffer' instead."
6145 `display-buffer' and `pop-to-buffer' show a buffer whose name is
6146 on this list in the selected rather than some other window.
6148 An element of this list can be a cons cell instead of just a
6149 string. In that case, the cell's car must be a string specifying
6150 the buffer name. This is for compatibility with
6151 `special-display-buffer-names'; the cdr of the cons cell is
6152 ignored.
6154 See also `same-window-regexps'."
6158 'same-window-buffer-names
6159 "use `display-buffer-alist' or 2nd arg of `display-buffer' instead."
6164 `display-buffer' and `pop-to-buffer' show a buffer whose name
6165 matches a regexp on this list in the selected rather than some
6166 other window.
6168 An element of this list can be a cons cell instead of just a
6169 string. In that case, the cell's car must be a regexp matching
6170 the buffer name. This is for compatibility with
6171 `special-display-regexps'; the cdr of the cons cell is ignored.
6173 See also `same-window-buffer-names'."
6177 'same-window-regexps
6178 "use `display-buffer-alist' or 2nd arg of `display-buffer' instead."
6183 This function returns non-nil if `display-buffer' or
6184 `pop-to-buffer' would show a buffer named BUFFER-NAME in the
6185 selected rather than \(as usual\) some other window. See
6186 `same-window-buffer-names' and `same-window-regexps'."
6191 ;; The elements of `same-window-buffer-names' can be buffer
6192 ;; names or cons cells whose cars are buffer names.
6197 ;; The elements of `same-window-regexps' can be regexps
6198 ;; or cons cells whose cars are regexps.
6207 "Whether `display-buffer' should make a separate frame.
6208 If nil, never make a separate frame.
6209 If the value is `graphic-only', make a separate frame
6210 on graphic displays only.
6211 Any other non-nil value means always make a separate frame."
6219 'pop-up-frames
6220 "use `display-buffer-alist' or 2nd arg of `display-buffer' instead."
6224 "Non-nil means `display-buffer' should reuse frames.
6225 If the buffer in question is already displayed in a frame, raise
6226 that frame."
6232 'display-buffer-reuse-frames
6233 "use `display-buffer-alist' or 2nd arg of `display-buffer' instead."
6237 "Non-nil means `display-buffer' is allowed to make a new window.
6238 A non-empty list specifies the windows `display-buffer' will
6239 consider for splitting. The following entries are supported
6242 largest ...... largest window
6243 lru .......... least recently used window
6244 selected ..... frame's selected window
6245 root ......... frame's root window
6247 The default value t stands for the list `(largest lru)'. This
6248 means that `display-buffer' will first try to split the largest
6249 window and, if that fails, the least recently used window."
6261 'pop-up-windows
6262 "use `display-buffer-alist' or 2nd arg of `display-buffer' instead."
6266 "Function called by `display-buffer' to split a window.
6267 This function is called with a window as single argument and is
6268 supposed to split that window and return the new window. If the
6269 window can (or shall) not be split, it is supposed to return nil.
6271 The default is to call the function `split-window-sensibly' which
6272 tries to split the window in a way which seems most suitable.
6273 You can customize the options `split-height-threshold' and/or
6274 `split-width-threshold' in order to have `split-window-sensibly'
6275 prefer either vertical or horizontal splitting.
6277 If you set this to any other function, bear in mind that
6278 `display-buffer' may call that function repeatedly; the option
6279 `pop-up-windows' controls which windows may become the argument
6280 of this function.
6282 The window selected at the time `display-buffer' was invoked is
6283 still selected when this function is called. Hence you can
6284 compare the window argument with the value of `selected-window'
6285 if you intend to split the selected window instead or if you do
6286 not want to split the selected window."
6291 'split-window-preferred-function
6292 "use `display-buffer-alist' or 2nd arg of `display-buffer' instead."
6296 "Minimum height for splitting a window to display a buffer.
6297 If this is an integer, `display-buffer' can split a window
6298 vertically only if it has at least this many lines. If this is
6299 nil, `display-buffer' does not split windows vertically. If a
6300 window is the only window on its frame, `display-buffer' may
6301 split it vertically disregarding the value of this variable."
6306 'split-height-threshold
6307 "use `display-buffer-alist' or 2nd arg of `display-buffer' instead."
6311 "Minimum width for splitting a window to display a buffer.
6312 If this is an integer, `display-buffer' can split a window
6313 horizontally only if it has at least this many columns. If this
6314 is nil, `display-buffer' cannot split windows horizontally."
6319 'split-width-threshold
6320 "use `display-buffer-alist' or 2nd arg of `display-buffer' instead."
6324 "If non-nil `display-buffer' will try to even window heights.
6325 Otherwise `display-buffer' will leave the window configuration
6326 alone. Heights are evened only when `display-buffer' reuses a
6327 window that appears above or below the selected window."
6331 'even-window-heights
6332 "use `display-buffer-alist' or 2nd arg of `display-buffer' instead."
6336 "If non-nil, `display-buffer' marks the windows it creates as dedicated.
6337 The actual non-nil value of this variable will be copied to the
6340 'display-buffer-mark-dedicated
6341 "use `display-buffer-alist' or 2nd arg of `display-buffer' instead."
6344 ;; Functions for converting Emacs 23 buffer display options to buffer
6345 ;; display specifiers.
6347 "Helper function for `display-buffer-alist-set'."
6357 'display-buffer-alist
6361 "Set `display-buffer-alist' from Emacs 23 buffer display options.
6362 Optional argument NO-CUSTOM nil means use `customize-set-variable'
6363 to set the value of `display-buffer-alist'. NO-CUSTOM non-nil
6364 means to use `setq' instead.
6366 Optional argument ADD nil means to replace the actual value of
6367 `display-buffer-alist' with the value calculated here. ADD
6368 non-nil means prepend the value calculated here to the current
6369 value of `display-buffer-alist'."
6375 ;; Disable warnings, there are too many obsolete options here.
6377 ;; `pop-up-windows'
6379 nil
6382 ;; `split-window-sensibly' has been merged into the
6383 ;; `display-buffer-split-window' code as `nil'.
6384 split-window-preferred-function))
6388 ;; Undocumented hack.
6393 ;; Undocumented hack.
6396 'pop-up-window
6399 'pop-up-window
6404 no-custom)
6406 ;; `pop-up-frames'
6408 nil
6410 'pop-up-frame
6416 no-custom)
6418 ;; `special-display-buffer-names'
6422 ;; Plain string.
6426 'fun-with-args
6428 special-display-frame-alist))
6429 no-custom))
6435 ;; A function.
6439 'fun-with-args
6440 ;; Weary.
6442 no-custom))
6444 ;; A list of parameters.
6452 no-custom))
6460 'fun-with-args
6462 special-display-frame-alist))
6463 no-custom)))))))))
6465 ;; `special-display-regexps'
6469 ;; Plain string.
6473 'fun-with-args
6475 special-display-frame-alist))
6476 no-custom))
6482 ;; A function.
6486 'fun-with-args
6487 ;; Weary.
6489 no-custom))
6491 ;; A list of parameters.
6499 no-custom))
6507 'fun-with-args
6509 special-display-frame-alist))
6510 no-custom)))))))))
6512 ;; `same-window-regexps'
6519 no-custom))
6524 no-custom))))
6526 ;; `same-window-buffer-names'
6533 no-custom))
6538 no-custom))))
6540 ;; `reuse-window'
6542 nil
6544 'reuse-window
6546 ;; "0" (all visible and iconified frames) is hardcoded in
6547 ;; Emacs 23.
6551 no-custom))
6553 display-buffer-alist)
6554 \f
6556 "Set the height in lines of the text display area of WINDOW to HEIGHT.
6557 WINDOW must be a live window. HEIGHT doesn't include the mode
6558 line or header line, if any, or any partial-height lines in the
6559 text display area.
6561 Note that the current implementation of this function cannot
6562 always set the height exactly, but attempts to be conservative,
6563 by allocating more lines than are actually needed in the case
6564 where some error may be present."
6568 ;; Setting window-min-height to a value like 1 can lead to very
6569 ;; bizarre displays because it also allows Emacs to make *other*
6570 ;; windows 1-line tall, which means that there's no more space for
6571 ;; the modeline.
6576 "Make selected window DELTA wider.
6577 Interactively, if no argument is given, make selected window one
6578 column wider."
6583 "Make selected window DELTA narrower.
6584 Interactively, if no argument is given, make selected window one
6585 column narrower."
6590 "Return the number of screen lines in the region.
6591 The number of screen lines may be different from the number of actual lines,
6592 due to line breaking, display table, etc.
6594 Optional arguments BEG and END default to `point-min' and `point-max'
6595 respectively.
6597 If region ends with a newline, ignore it unless optional third argument
6598 COUNT-FINAL-NEWLINE is non-nil.
6600 The optional fourth argument WINDOW specifies the window used for obtaining
6601 parameters such as width, horizontal scrolling, and so on. The default is
6602 to use the selected window's parameters.
6604 Like `vertical-motion', `count-screen-lines' always uses the current buffer,
6605 regardless of which buffer is displayed in WINDOW. This makes possible to use
6606 `count-screen-lines' in any buffer, whether or not it is currently displayed
6607 in some window."
6613 0
6626 "Return the height (in screen lines) of the buffer that WINDOW is displaying."
6630 ;; If buffer ends with a newline, ignore it when
6631 ;; counting height unless point is after it.
6633 window))))
6635 ;;; Resizing buffers to fit their contents exactly.
6637 "Adjust height of WINDOW to display its buffer's contents exactly.
6638 WINDOW can be any live window and defaults to the selected one.
6640 Optional argument MAX-HEIGHT specifies the maximum height of
6641 WINDOW and defaults to the height of WINDOW's frame. Optional
6642 argument MIN-HEIGHT specifies the minimum height of WINDOW and
6643 defaults to `window-min-height'. Both, MAX-HEIGHT and MIN-HEIGHT
6644 are specified in lines and include the mode line and header line,
6645 if any.
6647 Optional argument OVERRIDE non-nil means override restrictions
6648 imposed by `window-min-height' and `window-min-width' on the size
6649 of WINDOW.
6651 Return the number of lines by which WINDOW was enlarged or
6652 shrunk. If an error occurs during resizing, return nil but don't
6653 signal an error.
6655 Note that even if this function makes WINDOW large enough to show
6656 _all_ lines of its buffer you might not see the first lines when
6657 WINDOW was scrolled."
6659 ;; Do all the work in WINDOW and its buffer and restore the selected
6660 ;; window and the current buffer when we're done.
6662 ;; Can't resize a full height or fixed-size window.
6665 ;; `with-selected-window' should orderly restore the current buffer.
6667 ;; We are in WINDOW's buffer now.
6673 window-safe-min-height)))
6676 ;; Adjust MAX-HEIGHT.
6679 max-window-height
6681 ;; Make `desired-height' the height necessary to show
6682 ;; all of WINDOW's buffer, constrained by MIN-HEIGHT
6683 ;; and MAX-HEIGHT.
6688 ;; For non-minibuffers count the mode line, if any.
6690 mode-line-format)
6691 1
6693 ;; Count the header line, if any.
6695 max-height)
6696 min-height))
6705 ;; This `condition-case' shouldn't be necessary, but who knows?
6708 ;; Return zero if DELTA became zero in the proces.
6709 0
6710 ;; Don't try to redisplay with the cursor at the end on its
6711 ;; own line--that would force a scroll and spoil things.
6713 ;; It's silly to put `point' at the end of the previous
6714 ;; line and so maybe force horizontal scrolling.
6716 ;; Call `resize-window' with OVERRIDE argument equal WINDOW.
6718 ;; Check if the last line is surely fully visible. If
6719 ;; not, enlarge the window.
6723 ;; Don't include final newline.
6726 ;; If line-wrapping is turned off, test the
6727 ;; beginning of the last line for
6728 ;; visibility instead of the end, as the
6729 ;; end of the line could be invisible by
6730 ;; virtue of extending past the edge of the
6731 ;; window.
6735 ;; This loop might in some rare pathological cases raise
6736 ;; an error - another reason for the `condition-case'.
6743 delta))))
6746 "Shrink height of WINDOW if its buffer doesn't need so many lines.
6747 More precisely, shrink WINDOW vertically to be as small as
6748 possible, while still showing the full contents of its buffer.
6749 WINDOW defaults to the selected window.
6751 Do not shrink WINDOW to less than `window-min-height' lines. Do
6752 nothing if the buffer contains more lines than the present window
6753 height, or if some of the window's contents are scrolled out of
6754 view, or if shrinking this window would also shrink another
6755 window, or if the window is the only window of its frame.
6757 Return non-nil if the window was shrunk, nil otherwise."
6760 ;; Make sure that WINDOW is vertically combined and `point-min' is
6761 ;; visible (for whatever reason that's needed). The remaining issues
6762 ;; should be taken care of by `fit-window-to-buffer'.
6766 \f
6768 "Kill the current buffer and delete the selected window."
6777 ;; If `delete-window' failed before, we rerun it to regenerate
6778 ;; the error so it can be seen in the echo area.
6781 ;; If the buffer is not dead for some reason (probably because
6782 ;; of a `quit' signal), remove the hook again.
6788 "Quit WINDOW and bury its buffer.
6789 With a prefix argument, kill the buffer instead. WINDOW defaults
6790 to the selected window.
6792 If WINDOW is non-nil, dedicated, or a minibuffer window, delete
6793 it and, if it's alone on its frame, its frame too. Otherwise, or
6794 if deleting WINDOW fails in any of the preceding cases, display
6795 another buffer in WINDOW using `switch-to-buffer'.
6797 Optional argument KILL non-nil means kill WINDOW's buffer.
6798 Otherwise, bury WINDOW's buffer, see `bury-buffer'."
6804 ;; WINDOW is either non-nil, a minibuffer window, or dedicated;
6805 ;; try to delete it.
6809 ;; WINDOW is alone on its frame.
6811 ;; There are other windows on its frame, delete WINDOW.
6813 ;; Otherwise, switch to another buffer in the selected window.
6816 ;; Deal with the buffer.
6822 "Indicates the last recenter operation performed.
6826 "Cycling order for `recenter-top-bottom'.
6827 A list of elements with possible values `top', `middle', `bottom',
6828 integer or float numbers that define the cycling order for
6829 the command `recenter-top-bottom'.
6831 Top and bottom destinations are `scroll-margin' lines the from true
6832 window top and bottom. Middle redraws the frame and centers point
6833 vertically within the window. Integer number moves current line to
6834 the specified absolute window-line. Float number between 0.0 and 1.0
6835 means the percentage of the screen space from the top. The default
6836 cycling order is middle -> top -> bottom."
6847 "Move current buffer line to the specified window line.
6848 With no prefix argument, successive calls place point according
6849 to the cycling order defined by `recenter-positions'.
6851 A prefix argument is handled like `recenter':
6852 With numeric prefix ARG, move current line to window-line ARG.
6853 With plain `C-u', move current line to window center."
6861 recenter-positions))
6880 "Position point relative to window.
6882 With a prefix argument ARG, acts like `move-to-window-line'.
6884 With no argument, positions point at center of window.
6885 Successive calls position point at positions defined
6886 by `recenter-positions'."
6894 recenter-positions))
6911 \f
6912 ;;; Scrolling commands.
6914 ;;; Scrolling commands which does not signal errors at top/bottom
6915 ;;; of buffer at first key-press (instead moves to top/bottom
6916 ;;; of buffer).
6919 "Move point to top/bottom of buffer before signalling a scrolling error.
6920 A value of nil means just signal an error if no more scrolling possible.
6921 A value of t means point moves to the beginning or the end of the buffer
6922 \(depending on scrolling direction) when no more scrolling possible.
6923 When point is already on that position, then signal an error."
6929 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
6930 If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
6931 scroll window further, move cursor to the bottom line.
6932 When point is already on that position, then signal an error.
6933 A near full screen is `next-screen-context-lines' less than a full screen.
6934 Negative ARG means scroll downward.
6935 If ARG is the atom `-', scroll downward by nearly full screen."
6951 ;; When scrolling by ARG lines can't be done,
6952 ;; move by ARG lines instead.
6954 ;; When ARG is nil for full-screen scrolling,
6955 ;; move to the bottom of the buffer.
6961 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
6962 If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
6963 scroll window further, move cursor to the top line.
6964 When point is already on that position, then signal an error.
6965 A near full screen is `next-screen-context-lines' less than a full screen.
6966 Negative ARG means scroll upward.
6967 If ARG is the atom `-', scroll upward by nearly full screen."
6983 ;; When scrolling by ARG lines can't be done,
6984 ;; move by ARG lines instead.
6986 ;; When ARG is nil for full-screen scrolling,
6987 ;; move to the top of the buffer.
6992 ;;; Scrolling commands which scroll a line instead of full screen.
6995 "Scroll text of selected window upward ARG lines; or one line if no ARG.
6996 If ARG is omitted or nil, scroll upward by one line.
6997 This is different from `scroll-up-command' that scrolls a full screen."
7004 "Scroll text of selected window down ARG lines; or one line if no ARG.
7005 If ARG is omitted or nil, scroll down by one line.
7006 This is different from `scroll-down-command' that scrolls a full screen."
7012 \f
7015 For more details, see the documentation for `scroll-other-window'."
7018 ;; Just invert the argument's meaning.
7019 ;; We can do that without knowing which window it will be.
7025 "Move point to the beginning of the buffer in the other window.
7026 Leave mark at previous position.
7027 With arg N, put point N/10 of the way from the true beginning."
7031 ;; We use unwind-protect rather than save-window-excursion
7032 ;; because the latter would preserve the things we want to change.
7036 ;; Set point and mark in that window's buffer.
7039 ;; Set point accordingly.
7044 "Move point to the end of the buffer in the other window.
7045 Leave mark at previous position.
7046 With arg N, put point N/10 of the way from the true end."
7048 ;; See beginning-of-buffer-other-window for comments.
7058 \f
7069 "When non-nil, special state of delayed window autoselection.
7070 Possible values are `suspend' \(suspend autoselection after a menu or
7071 scrollbar interaction\) and `select' \(the next invocation of
7075 "Cancel delayed window autoselection.
7076 Optional argument FORCE means cancel unconditionally."
7078 ;; Don't cancel for select-window or select-frame events
7079 ;; or when the user drags a scroll bar.
7091 "Start delayed window autoselection.
7092 MOUSE-POSITION is the last position where the mouse was seen as returned
7093 by `mouse-position'. Optional argument WINDOW non-nil denotes the
7094 window where the mouse was seen. Optional argument SUSPEND non-nil
7095 means suspend autoselection."
7096 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
7100 ;; Install timer which runs `mouse-autoselect-window-select' after
7101 ;; `mouse-autoselect-window' seconds.
7107 "Select window with delayed window autoselection.
7108 If the mouse position has stabilized in a non-selected window, select
7109 that window. The minibuffer window is selected only if the minibuffer is
7110 active. This function is run by `mouse-autoselect-window-timer'."
7121 ;; A menu / popup dialog is active or the mouse is on the scroll-bar
7122 ;; of WINDOW, temporarily suspend delayed autoselection.
7125 ;; Delayed autoselection was temporarily suspended, reenable it.
7130 ;; If `mouse-autoselect-window' is positive, select
7131 ;; window if the window is the same as before.
7133 ;; Otherwise select window if the mouse is at the same
7134 ;; position as before. Observe that the first test after
7135 ;; starting autoselection usually fails since the value of
7136 ;; `mouse-autoselect-window-position' recorded there is the
7137 ;; position where the mouse has entered the new window and
7138 ;; not necessarily where the mouse has stopped moving.
7140 ;; The minibuffer is a candidate window if it's active.
7143 ;; Mouse position has stabilized in non-selected window: Cancel
7144 ;; delayed autoselection and try to select that window.
7146 ;; Select window where mouse appears unless the selected window is the
7147 ;; minibuffer. Use `unread-command-events' in order to execute pre-
7148 ;; and post-command hooks and trigger idle timers. To avoid delaying
7149 ;; autoselection again, set `mouse-autoselect-window-state'."
7154 unread-command-events))))
7158 ;; Mouse position has either stabilized in the selected window or at
7159 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
7162 ;; Mouse position has not stabilized yet, resume delayed
7163 ;; autoselection.
7167 "Handle select-window events."
7171 ;; Don't switch if we're currently in the minibuffer.
7172 ;; This tries to work around problems where the
7173 ;; minibuffer gets unselected unexpectedly, and where
7174 ;; you then have to move your mouse all the way down to
7175 ;; the minibuffer to select it.
7177 ;; Don't switch to minibuffer window unless it's active.
7180 ;; Don't switch when autoselection shall be delayed.
7185 ;; Cancel any delayed autoselection.
7187 ;; Start delayed autoselection from current mouse
7188 ;; position and window.
7190 ;; Executing a command cancels delayed autoselection.
7194 ;; Reset state of delayed autoselection.
7196 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
7201 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
7202 WINDOW defaults to the selected window.
7203 Return nil if WINDOW is not a partial-width window
7204 (regardless of the value of `truncate-lines').
7205 Otherwise, consult the value of `truncate-partial-width-windows'
7206 for the buffer shown in WINDOW."
7214 t-p-w-w))))
7215 \f
7229 ;;; window.el ends here