| blob | 3242f1fd04f8b0fb428ad8e43ee2b807b9d42649 |
1 ;;; window.el --- GNU Emacs window commands aside from those written in C
3 ;; Copyright (C) 1985, 1989, 1992-1994, 2000-2011
4 ;; Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: internal
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; Window tree functions.
29 ;;; Code:
34 "Execute BODY, then select the previously selected window.
35 The value returned is the value of the last form in BODY.
37 This macro saves and restores the selected window, as well as the
38 selected window in each frame. If the previously selected window
39 is no longer live, then whatever window is selected at the end of
40 BODY remains selected. If the previously selected window of some
41 frame is no longer live at the end of BODY, that frame's selected
42 window is left alone.
44 This macro saves and restores the current buffer, since otherwise
45 its normal operation could make a different buffer current. The
46 order of recently selected windows and the buffer list ordering
47 are not altered by this macro (unless they are altered in BODY)."
50 ;; It is necessary to save all of these, because calling
51 ;; select-window changes frame-selected-window for whatever
52 ;; frame that window is in.
66 ;; The following two functions are like `window-next-sibling' and
67 ;; `window-prev-sibling' but the WINDOW argument is _not_ optional (so
68 ;; they don't substitute the selected window for nil), and they return
69 ;; nil when WINDOW doesn't have a parent (like a frame's root window or
70 ;; a minibuffer window).
72 "Return WINDOW's right sibling.
73 Return nil if WINDOW is the root window of its frame. WINDOW can
74 be any window."
78 "Return WINDOW's left sibling.
79 Return nil if WINDOW is the root window of its frame. WINDOW can
80 be any window."
84 "Return WINDOW's first child window."
88 "Return number of WINDOW's child windows."
94 count))
97 "Return last child window of WINDOW."
101 window)
104 "Return t if OBJECT denotes a live window or internal window.
105 Otherwise, return nil; this includes the case where OBJECT is a
106 deleted window."
109 t))
112 "Return buffer specified by BUFFER-OR-NAME.
113 BUFFER-OR-NAME must be either a buffer or a string naming a live
114 buffer and defaults to the current buffer."
120 buffer-or-name
127 "Return frame specified by FRAME.
128 FRAME must be a live frame and defaults to the selected frame."
131 frame
136 "Return window specified by WINDOW.
137 If WINDOW is nil, return `selected-window'.
138 If WINDOW is a live window or internal window, return WINDOW;
139 if LIVE-ONLY is non-nil, return WINDOW for a live window only.
140 Otherwise, signal an error."
145 window
148 window
152 "If non-nil, standard functions ignore window parameters.
153 The functions currently affected by this are `split-window',
154 `delete-window', `delete-other-windows' and `other-window'.
156 An application may bind this to a non-nil value around calls to
160 "The absolute minimum number of lines of a window.
164 "The minimum number of lines of any window.
165 The value has to accommodate a mode- or header-line if present.
166 A value less than `window-safe-min-height' is ignored. The value
167 of this variable is honored when windows are resized or split.
169 Applications should never rebind this variable. To resize a
170 window to a height less than the one specified here, an
171 application should instead call `window-resize' with a non-nil
172 IGNORE argument. In order to have `split-window' make a window
173 shorter, explictly specify the SIZE argument of that function."
179 "The absolute minimum number of columns of a window.
183 "The minimum number of columns of any window.
184 The value has to accommodate margins, fringes, or scrollbars if
185 present. A value less than `window-safe-min-width' is ignored.
186 The value of this variable is honored when windows are resized or
187 split.
189 Applications should never rebind this variable. To resize a
190 window to a width less than the one specified here, an
191 application should instead call `window-resize' with a non-nil
192 IGNORE argument. In order to have `split-window' make a window
193 narrower, explictly specify the SIZE argument of that function."
199 "Return non-nil if WINDOW has siblings in a given direction.
200 If WINDOW is omitted or nil, it defaults to the selected window.
202 HORIZONTAL determines a direction for the window combination.
203 If HORIZONTAL is omitted or nil, return non-nil if WINDOW is part
204 of a vertical window combination.
205 If HORIZONTAL is non-nil, return non-nil if WINDOW is part of a
206 horizontal window combination."
215 "Return largest number of windows vertically arranged within WINDOW.
216 If WINDOW is omitted or nil, it defaults to the selected window.
217 If HORIZONTAL is non-nil, return the largest number of
218 windows horizontally arranged within WINDOW."
222 ;; If WINDOW is live, return 1.
227 ;; If WINDOW is iso-combined, return the sum of the values for all
228 ;; child windows of WINDOW.
234 count))
236 count))
238 ;; If WINDOW is not iso-combined, return the maximum value of any
239 ;; child window of WINDOW.
245 count))
247 count))))
250 "Helper function for `walk-window-tree' and `walk-window-subtree'."
268 "Run function PROC on each live window of FRAME.
269 PROC must be a function with one argument - a window. FRAME must
270 be a live frame and defaults to the selected one. ANY, if
271 non-nil means to run PROC on all live and internal windows of
272 FRAME.
274 This function performs a pre-order, depth-first traversal of the
275 window tree. If PROC changes the window tree, the result is
276 unpredictable."
282 "Run function PROC on the subtree of windows rooted at WINDOW.
283 WINDOW defaults to the selected window. PROC must be a function
284 with one argument - a window. By default, run PROC only on live
285 windows of the subtree. If the optional argument ANY is non-nil,
286 run PROC on all live and internal windows of the subtree. If
287 WINDOW is live, run PROC on WINDOW only.
289 This function performs a pre-order, depth-first traversal of the
290 subtree rooted at WINDOW. If PROC changes that tree, the result
291 is unpredictable."
296 "Return a list of all windows on FRAME with PARAMETER non-nil.
297 FRAME defaults to the selected frame. Optional argument VALUE
298 non-nil means only return windows whose window-parameter value of
299 PARAMETER equals VALUE \(comparison is done using `equal').
300 Optional argument ANY non-nil means consider internal windows
301 too. Optional argument VALUES non-nil means return a list of cons
302 cells whose car is the value of the parameter and whose cdr is
303 the window."
313 frame any)
318 "Return first window on FRAME with PARAMETER non-nil.
319 FRAME defaults to the selected frame. Optional argument VALUE
320 non-nil means only return a window whose window-parameter value
321 for PARAMETER equals VALUE \(comparison is done with `equal').
322 Optional argument ANY non-nil means consider internal windows
323 too."
331 frame any))))
333 ;;; Atomic windows.
335 "Return root of atomic window WINDOW is a part of.
336 WINDOW can be any window and defaults to the selected one.
337 Return nil if WINDOW is not part of a atomic window."
343 root))
346 "Make WINDOW an atomic window.
347 WINDOW must be an internal window. Return WINDOW."
353 window t)
354 window))
357 "Subroutine of `window-atom-check'."
367 window t))
368 ;; count >= 1 must hold here. If there's no other
369 ;; window around dissolve this atomic window.
371 ;; Dissolve atomic window.
375 window t)))
376 ;; Check children.
380 ;; Check right sibling
384 "Check atomicity of all windows on FRAME.
385 FRAME defaults to the selected frame. If an atomic window is
386 wrongly configured, reset the atomicity of all its windows on
387 FRAME to nil. An atomic window is wrongly configured if it has
388 no child windows or one of its child windows is not atomic."
391 ;; Side windows.
396 "If non-nil, left and right side windows are full height.
397 Otherwise, top and bottom side windows are full width."
403 "Maximum number of side window slots.
404 The value is a list of four elements specifying the number of
405 side window slots on \(in this order) the left, top, right and
406 bottom side of each frame. If an element is a number, this means
407 to display at most that many side windows on the corresponding
408 side. If an element is nil, this means there's no bound on the
409 number of slots on that side."
410 :risky t
411 :type
417 :value nil
424 :value nil
431 :value nil
438 :value nil
445 "Check the window-side parameter of all windows on FRAME.
446 FRAME defaults to the selected frame. If the configuration is
447 invalid, reset all window-side parameters to nil.
449 A valid configuration has to preserve the following invariant:
451 - If a window has a non-nil window-side parameter, it must have a
452 parent window and the parent window's window-side parameter
453 must be either nil or the same as for window.
455 - If windows with non-nil window-side parameters exist, there
456 must be at most one window of each side and non-side with a
457 parent whose window-side parameter is nil and there must be no
458 leaf window whose window-side parameter is nil."
460 side parent parent-side code)
468 ;; The following `cond' seems a bit tedious, but I'd
469 ;; rather stick to using just the stack.
473 ;; A parent whose window-side is non-nil must
474 ;; have a child with the same window-side.
476 ;; Now check that there's more than one main window
477 ;; for any of none, left, top, right and bottom.
499 ;; A leaf window without window-side parameter,
500 ;; record its existence.
502 frame t))
504 ;; At least one non-side window exists, so there must
505 ;; be at least one side-window and no normal window.
507 ;; No non-side window exists, so there must be no side
508 ;; window either.
513 frame t))))
516 "Check atomic and side windows on FRAME.
517 FRAME defaults to the selected frame."
521 ;;; Window sizes.
523 "Non-nil in a buffer means windows displaying the buffer are fixed-size.
524 If the value is `height', then only the window's height is fixed.
525 If the value is `width', then only the window's width is fixed.
526 Any other non-nil value fixes both the width and the height.
528 Emacs won't change the size of any window displaying that buffer,
529 unless it has no other choice \(like when deleting a neighboring
534 "Return non-nil if IGNORE says to ignore size restrictions for WINDOW."
538 "Return the minimum number of lines of WINDOW.
539 WINDOW can be an arbitrary window and defaults to the selected
540 one. Optional argument HORIZONTAL non-nil means return the
541 minimum number of columns of WINDOW.
543 Optional argument IGNORE non-nil means ignore any restrictions
544 imposed by fixed size windows, `window-min-height' or
545 `window-min-width' settings. IGNORE equal `safe' means live
546 windows may get as small as `window-safe-min-height' lines and
547 `window-safe-min-width' columns. IGNORE a window means ignore
548 restrictions for that window only."
553 "Internal function of `window-min-size'."
557 ;; WINDOW is an internal window.
559 ;; The minimum size of an iso-combination is the sum of
560 ;; the minimum sizes of its child windows.
565 ;; The minimum size of an ortho-combination is the maximum of
566 ;; the minimum sizes of its child windows.
571 value)
576 ;; The minimum size of a fixed size window is its size.
579 ;; If IGNORE equals `safe' or WINDOW return the safe values.
582 ;; For the minimum width of a window take fringes and
583 ;; scroll-bars into account. This is questionable and should
584 ;; be removed as soon as we are able to split (and resize)
585 ;; windows such that the new (or resized) windows can get a
586 ;; size less than the user-specified `window-min-height' and
587 ;; `window-min-width'.
592 (+ window-safe-min-width
605 window-min-width
608 ;; For the minimum height of a window take any mode- or
609 ;; header-line into account.
615 window-min-height
619 "Return DELTA if DELTA lines can be added to WINDOW.
620 Optional argument HORIZONTAL non-nil means return DELTA if DELTA
621 columns can be added to WINDOW. A return value of zero means
622 that no lines (or columns) can be added to WINDOW.
624 This function looks only at WINDOW and, recursively, its child
625 windows. The function `window-resizable' looks at other windows
626 as well.
628 DELTA positive means WINDOW shall be enlarged by DELTA lines or
629 columns. If WINDOW cannot be enlarged by DELTA lines or columns
630 return the maximum value in the range 0..DELTA by which WINDOW
631 can be enlarged.
633 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
634 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
635 return the minimum value in the range DELTA..0 by which WINDOW
636 can be shrunk.
638 Optional argument IGNORE non-nil means ignore any restrictions
639 imposed by fixed size windows, `window-min-height' or
640 `window-min-width' settings. IGNORE equal `safe' means live
641 windows may get as small as `window-safe-min-height' lines and
642 `window-safe-min-width' columns. IGNORE any window means ignore
643 restrictions for that window only."
649 delta))
651 delta)
654 0
655 delta))
659 "Return t if WINDOW can be resized by DELTA lines.
660 For the meaning of the arguments of this function see the
661 doc-string of `window-sizable'."
668 "Internal function for `window-size-fixed-p'."
672 ;; WINDOW is an internal window.
674 ;; An iso-combination is fixed size if all its child
675 ;; windows are fixed-size.
679 ;; We found a non-fixed-size child window, so
680 ;; WINDOW's size is not fixed.
683 ;; All child windows are fixed-size, so WINDOW's size is
684 ;; fixed.
686 ;; An ortho-combination is fixed-size if at least one of its
687 ;; child windows is fixed-size.
690 ;; We found a fixed-size child window, so WINDOW's size
691 ;; is fixed.
694 ;; WINDOW is a live window.
701 "Return non-nil if WINDOW's height is fixed.
702 WINDOW can be an arbitrary window and defaults to the selected
703 window. Optional argument HORIZONTAL non-nil means return
704 non-nil if WINDOW's width is fixed.
706 If this function returns nil, this does not necessarily mean that
707 WINDOW can be resized in the desired direction. The functions
708 `window-resizable' and `window-resizable-p' will tell that."
713 "Internal function for `window-min-delta'."
715 ;; If we can't go up, return zero.
716 0
717 ;; Else try to find a non-fixed-size sibling of WINDOW.
722 ;; In an iso-combination throw DELTA if we find at least one
723 ;; child window and that window is either not fixed-size or
724 ;; we can ignore fixed-sizeness.
734 ;; We found a non-fixed-size child window.
737 ;; In an ortho-combination set DELTA to the minimum value by
738 ;; which other child windows can shrink.
747 delta
751 "Return number of lines by which WINDOW can be shrunk.
752 WINDOW can be an arbitrary window and defaults to the selected
753 window. Return zero if WINDOW cannot be shrunk.
755 Optional argument HORIZONTAL non-nil means return number of
756 columns by which WINDOW can be shrunk.
758 Optional argument IGNORE non-nil means ignore any restrictions
759 imposed by fixed size windows, `window-min-height' or
760 `window-min-width' settings. IGNORE a window means ignore
761 restrictions for that window only. IGNORE equal `safe' means
762 live windows may get as small as `window-safe-min-height' lines
763 and `window-safe-min-width' columns.
765 Optional argument TRAIL `before' means only windows to the left
766 of or above WINDOW can be enlarged. Optional argument TRAIL
767 `after' means only windows to the right of or below WINDOW can be
768 enlarged.
770 Optional argument NOUP non-nil means don't go up in the window
771 tree but try to enlarge windows within WINDOW's combination only.
773 Optional argument NODOWN non-nil means don't check whether WINDOW
774 itself \(and its child windows) can be shrunk; check only whether
775 at least one other windows can be enlarged appropriately."
781 ;; If NODOWN is t, try to recover the entire size of WINDOW.
784 ;; If NODOWN is nil and WINDOW's size is already at its minimum,
785 ;; there's nothing to recover.
788 ;; Otherwise, try to recover whatever WINDOW is larger than its
789 ;; minimum size.
794 "Internal function of `window-max-delta'."
796 ;; Can't go up. Return DELTA.
797 delta
802 ;; For an iso-combination calculate how much we can get from
803 ;; other child windows.
812 (+ delta
816 ;; For an ortho-combination throw DELTA when at least one
817 ;; child window is fixed-size.
825 ;; When NOUP is nil, DELTA is all we can get.
826 delta
827 ;; Else try with parent of WINDOW, passing the DELTA we
828 ;; recovered so far.
832 "Return maximum number of lines WINDOW by which WINDOW can be enlarged.
833 WINDOW can be an arbitrary window and defaults to the selected
834 window. The return value is zero if WINDOW cannot be enlarged.
836 Optional argument HORIZONTAL non-nil means return maximum number
837 of columns by which WINDOW can be enlarged.
839 Optional argument IGNORE non-nil means ignore any restrictions
840 imposed by fixed size windows, `window-min-height' or
841 `window-min-width' settings. IGNORE a window means ignore
842 restrictions for that window only. IGNORE equal `safe' means
843 live windows may get as small as `window-safe-min-height' lines
844 and `window-safe-min-width' columns.
846 Optional argument TRAIL `before' means only windows to the left
847 of or below WINDOW can be shrunk. Optional argument TRAIL
848 `after' means only windows to the right of or above WINDOW can be
849 shrunk.
851 Optional argument NOUP non-nil means don't go up in the window
852 tree but try to obtain the entire space from windows within
853 WINDOW's combination.
855 Optional argument NODOWN non-nil means do not check whether
856 WINDOW itself \(and its child windows) can be enlarged; check
857 only whether other windows can be shrunk appropriately."
861 ;; With IGNORE and NOWDON nil return zero if WINDOW has fixed
862 ;; size.
863 0
864 ;; WINDOW has no fixed size.
867 ;; Make NOUP also inhibit the min-size check.
869 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
870 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
871 can be resized horizontally by DELTA columns. A return value of
872 zero means that WINDOW is not resizable.
874 DELTA positive means WINDOW shall be enlarged by DELTA lines or
875 columns. If WINDOW cannot be enlarged by DELTA lines or columns
876 return the maximum value in the range 0..DELTA by which WINDOW
877 can be enlarged.
879 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
880 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
881 return the minimum value in the range DELTA..0 that can be used
882 for shrinking WINDOW.
884 Optional argument IGNORE non-nil means ignore any restrictions
885 imposed by fixed size windows, `window-min-height' or
886 `window-min-width' settings. IGNORE a window means ignore
887 restrictions for that window only. IGNORE equal `safe' means
888 live windows may get as small as `window-safe-min-height' lines
889 and `window-safe-min-width' columns.
891 Optional argument TRAIL `before' means only windows to the left
892 of or below WINDOW can be shrunk. Optional argument TRAIL
893 `after' means only windows to the right of or above WINDOW can be
894 shrunk.
896 Optional argument NOUP non-nil means don't go up in the window
897 tree but try to distribute the space among the other windows
898 within WINDOW's combination.
900 Optional argument NODOWN non-nil means don't check whether WINDOW
901 and its child windows can be resized."
906 delta))
909 delta))
913 "Return t if WINDOW can be resized vertically by DELTA lines.
914 For the meaning of the arguments of this function see the
915 doc-string of `window-resizable'."
919 delta)
921 delta)))
924 "Return the total height or width of window WINDOW.
925 If WINDOW is omitted or nil, it defaults to the selected window.
927 If HORIZONTAL is omitted or nil, return the total height of
928 WINDOW, in lines, like `window-total-height'. Otherwise return
929 the total width, in columns, like `window-total-width'."
934 ;; Eventually we should make `window-height' obsolete.
937 ;; See discussion in bug#4543.
939 "Return t if WINDOW is as high as the containing frame.
940 More precisely, return t if and only if the total height of
941 WINDOW equals the total height of the root window of WINDOW's
942 frame. WINDOW can be any window and defaults to the selected
943 one."
949 "Return t if WINDOW is as wide as the containing frame.
950 More precisely, return t if and only if the total width of WINDOW
951 equals the total width of the root window of WINDOW's frame.
952 WINDOW can be any window and defaults to the selected one."
958 "Return the height or width of WINDOW's text area.
959 If WINDOW is omitted or nil, it defaults to the selected window.
960 Signal an error if the window is not live.
962 If HORIZONTAL is omitted or nil, return the height of the text
963 area, like `window-body-height'. Otherwise, return the width of
964 the text area, like `window-body-width'."
969 ;; Eventually we should make `window-height' obsolete.
973 "Return the current scroll bar settings for WINDOW.
974 WINDOW must be a live window and defaults to the selected one.
976 The return value is a cons cell (VERTICAL . HORIZONTAL) where
977 VERTICAL specifies the current location of the vertical scroll
978 bars (`left', `right', or nil), and HORIZONTAL specifies the
979 current location of the horizontal scroll bars (`top', `bottom',
980 or nil).
982 Unlike `window-scroll-bars', this function reports the scroll bar
983 type actually used, once frame defaults and `scroll-bar-mode' are
984 taken into account."
997 "Cycle through all live windows, calling PROC for each one.
998 PROC must specify a function with a window as its sole argument.
999 The optional arguments MINIBUF and ALL-FRAMES specify the set of
1000 windows to include in the walk.
1002 MINIBUF t means include the minibuffer window even if the
1003 minibuffer is not active. MINIBUF nil or omitted means include
1004 the minibuffer window only if the minibuffer is active. Any
1005 other value means do not include the minibuffer window even if
1006 the minibuffer is active.
1008 ALL-FRAMES nil or omitted means consider all windows on the
1009 selected frame, plus the minibuffer window if specified by the
1010 MINIBUF argument. If the minibuffer counts, consider all windows
1011 on all frames that share that minibuffer too. The following
1012 non-nil values of ALL-FRAMES have special meanings:
1014 - t means consider all windows on all existing frames.
1016 - `visible' means consider all windows on all visible frames on
1017 the current terminal.
1019 - 0 (the number zero) means consider all windows on all visible
1020 and iconified frames on the current terminal.
1022 - A frame means consider all windows on that frame only.
1024 Anything else means consider all windows on the selected frame
1025 and no others.
1027 This function changes neither the order of recently selected
1028 windows nor the buffer list."
1029 ;; If we start from the minibuffer window, don't fail to come
1030 ;; back to it.
1033 ;; Make sure to not mess up the order of recently selected
1034 ;; windows. Use `save-selected-window' and `select-window'
1035 ;; with second argument non-nil for this purpose.
1043 "Return value of WINDOW's point.
1044 WINDOW can be any live window and defaults to the selected one.
1046 This function is like `window-point' with one exception: If
1047 WINDOW is selected, it returns the value of `point' of WINDOW's
1048 buffer regardless of whether that buffer is current or not."
1056 "Set value of WINDOW's point to POS.
1057 WINDOW can be any live window and defaults to the selected one.
1059 This function is like `set-window-point' with one exception: If
1060 WINDOW is selected, it moves `point' of WINDOW's buffer to POS
1061 regardless of whether that buffer is current or not."
1069 "Return t if WINDOW is at SIDE of its containing frame.
1070 WINDOW can be any window and defaults to the selected one. SIDE
1071 can be any of the symbols `left', `top', `right' or `bottom'.
1072 The default value nil is handled like `bottom'."
1084 "Return list of all windows on SIDE of FRAME.
1085 FRAME must be a live frame and defaults to the selected frame.
1086 SIDE can be any of the symbols `left', `top', `right' or
1087 `bottom'. The default value nil is handled like `bottom'."
1094 frame)
1098 "Support function for `window-in-direction'."
1110 "Return window in DIRECTION as seen from WINDOW.
1111 DIRECTION must be one of `above', `below', `left' or `right'.
1112 WINDOW must be a live window and defaults to the selected one.
1113 IGNORE, when non-nil means a window can be returned even if its
1114 `no-other-window' parameter is non-nil."
1127 ;; The column / row value of `posn-at-point' can be nil for the
1128 ;; mini-window, guard against that.
1139 best best-2 best-diff-2-new)
1146 ;; Ignore ourselves.
1148 ;; Ignore W unless IGNORE is non-nil.
1154 ;; W is to the left or right of WINDOW and covers POSN.
1164 ;; W is to the left or right of WINDOW but does not
1165 ;; cover POSN.
1180 ;; W is above or below WINDOW and covers POSN.
1190 ;; W is above or below WINDOW but does not cover POSN.
1205 "Return a live window satisfying PREDICATE.
1206 More precisely, cycle through all windows calling the function
1207 PREDICATE on each one of them with the window as its sole
1208 argument. Return the first window for which PREDICATE returns
1209 non-nil. Windows are scanned starting with the window following
1210 the selcted window. If no window satisfies PREDICATE, return
1211 DEFAULT.
1213 MINIBUF t means include the minibuffer window even if the
1214 minibuffer is not active. MINIBUF nil or omitted means include
1215 the minibuffer window only if the minibuffer is active. Any
1216 other value means do not include the minibuffer window even if
1217 the minibuffer is active.
1219 ALL-FRAMES nil or omitted means consider all windows on the selected
1220 frame, plus the minibuffer window if specified by the MINIBUF
1221 argument. If the minibuffer counts, consider all windows on all
1222 frames that share that minibuffer too. The following non-nil
1223 values of ALL-FRAMES have special meanings:
1225 - t means consider all windows on all existing frames.
1227 - `visible' means consider all windows on all visible frames on
1228 the current terminal.
1230 - 0 (the number zero) means consider all windows on all visible
1231 and iconified frames on the current terminal.
1233 - A frame means consider all windows on that frame only.
1235 Anything else means consider all windows on the selected frame
1236 and no others."
1240 minibuf all-frames))
1243 default))
1248 "Return the least recently used window on frames specified by ALL-FRAMES.
1249 Return a full-width window if possible. A minibuffer window is
1250 never a candidate. A dedicated window is never a candidate
1251 unless DEDICATED is non-nil, so if all windows are dedicated, the
1252 value is nil. Avoid returning the selected window if possible.
1254 The following non-nil values of the optional argument ALL-FRAMES
1255 have special meanings:
1257 - t means consider all windows on all existing frames.
1259 - `visible' means consider all windows on all visible frames on
1260 the current terminal.
1262 - 0 (the number zero) means consider all windows on all visible
1263 and iconified frames on the current terminal.
1265 - A frame means consider all windows on that frame only.
1267 Any other value of ALL-FRAMES means consider all windows on the
1268 selected frame and no others."
1284 "Return the most recently used window on frames specified by ALL-FRAMES.
1285 Do not return a minibuffer window.
1287 The following non-nil values of the optional argument ALL-FRAMES
1288 have special meanings:
1290 - t means consider all windows on all existing frames.
1292 - `visible' means consider all windows on all visible frames on
1293 the current terminal.
1295 - 0 (the number zero) means consider all windows on all visible
1296 and iconified frames on the current terminal.
1298 - A frame means consider all windows on that frame only.
1300 Any other value of ALL-FRAMES means consider all windows on the
1301 selected frame and no others."
1308 best-window))
1311 "Return the largest window on frames specified by ALL-FRAMES.
1312 A minibuffer window is never a candidate. A dedicated window is
1313 never a candidate unless DEDICATED is non-nil, so if all windows
1314 are dedicated, the value is nil.
1316 The following non-nil values of the optional argument ALL-FRAMES
1317 have special meanings:
1319 - t means consider all windows on all existing frames.
1321 - `visible' means consider all windows on all visible frames on
1322 the current terminal.
1324 - 0 (the number zero) means consider all windows on all visible
1325 and iconified frames on the current terminal.
1327 - A frame means consider all windows on that frame only.
1329 Any other value of ALL-FRAMES means consider all windows on the
1330 selected frame and no others."
1332 best-window size)
1340 best-window))
1343 "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
1344 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
1345 and defaults to the current buffer. Windows are scanned starting
1346 with the selected window.
1348 MINIBUF t means include the minibuffer window even if the
1349 minibuffer is not active. MINIBUF nil or omitted means include
1350 the minibuffer window only if the minibuffer is active. Any
1351 other value means do not include the minibuffer window even if
1352 the minibuffer is active.
1354 ALL-FRAMES nil or omitted means consider all windows on the
1355 selected frame, plus the minibuffer window if specified by the
1356 MINIBUF argument. If the minibuffer counts, consider all windows
1357 on all frames that share that minibuffer too. The following
1358 non-nil values of ALL-FRAMES have special meanings:
1360 - t means consider all windows on all existing frames.
1362 - `visible' means consider all windows on all visible frames on
1363 the current terminal.
1365 - 0 (the number zero) means consider all windows on all visible
1366 and iconified frames on the current terminal.
1368 - A frame means consider all windows on that frame only.
1370 Anything else means consider all windows on the selected frame
1371 and no others."
1373 windows)
1380 "Return t if WINDOW is the currently active minibuffer window."
1384 "Return the number of live windows on the selected frame.
1385 The optional argument MINIBUF specifies whether the minibuffer
1386 window shall be counted. See `walk-windows' for the precise
1387 meaning of this argument."
1389 \f
1390 ;;; Resizing windows.
1392 "Reset resize values for all windows on FRAME.
1393 FRAME defaults to the selected frame.
1395 This function stores the current value of `window-total-size' applied
1396 with argument HORIZONTAL in the new total size of all windows on
1397 FRAME. It also resets the new normal size of each of these
1398 windows."
1403 "Internal function of `window--resize-reset'."
1404 ;; Register old size in the new total size.
1406 ;; Reset new normal size.
1413 ;; The following routine is used to manually resize the minibuffer
1414 ;; window and is currently used, for example, by ispell.el.
1416 "Resize minibuffer window WINDOW by DELTA lines.
1417 If WINDOW cannot be resized by DELTA lines make it as large \(or
1418 as small) as possible but don't signal an error."
1426 ;; Sanitize DELTA.
1433 ;; Resize now.
1435 ;; Ideally we should be able to resize just the last child of root
1436 ;; here. See the comment in `resize-root-window-vertically' for
1437 ;; why we do not do that.
1440 ;; The following routine catches the case where we want to resize
1441 ;; a minibuffer-only frame.
1445 "Resize WINDOW vertically by DELTA lines.
1446 WINDOW can be an arbitrary window and defaults to the selected
1447 one. An attempt to resize the root window of a frame will raise
1448 an error though.
1450 DELTA a positive number means WINDOW shall be enlarged by DELTA
1451 lines. DELTA negative means WINDOW shall be shrunk by -DELTA
1452 lines.
1454 Optional argument HORIZONTAL non-nil means resize WINDOW
1455 horizontally by DELTA columns. In this case a positive DELTA
1456 means enlarge WINDOW by DELTA columns. DELTA negative means
1457 WINDOW shall be shrunk by -DELTA columns.
1459 Optional argument IGNORE non-nil means ignore any restrictions
1460 imposed by fixed size windows, `window-min-height' or
1461 `window-min-width' settings. IGNORE any window means ignore
1462 restrictions for that window only. IGNORE equal `safe' means
1463 live windows may get as small as `window-safe-min-height' lines
1464 and `window-safe-min-width' columns.
1466 This function resizes other windows proportionally and never
1467 deletes any windows. If you want to move only the low (right)
1468 edge of WINDOW consider using `adjust-window-trailing-edge'
1469 instead."
1472 sibling)
1485 ;; If window-splits returns nil for WINDOW, WINDOW is part of
1486 ;; an iso-combination, and WINDOW's neighboring right or left
1487 ;; sibling can be resized as requested, resize that sibling.
1494 normal-delta))
1497 normal-delta)))
1498 ;; Otherwise, resize all other windows in the same combination.
1505 "Return non-nil if WINDOW shall be skipped by resizing routines."
1508 (defun window--resize-child-windows-normal (parent horizontal window this-delta &optional trail other-delta)
1509 "Recursively set new normal height of child windows of window PARENT.
1510 HORIZONTAL non-nil means set the new normal width of these
1511 windows. WINDOW specifies a child window of PARENT that has been
1512 resized by THIS-DELTA lines \(columns).
1514 Optional argument TRAIL either 'before or 'after means set values
1515 for windows before or after WINDOW only. Optional argument
1516 OTHER-DELTA a number specifies that this many lines \(columns)
1517 have been obtained from \(or returned to) an ancestor window of
1518 PARENT in order to resize WINDOW."
1522 ;; When WINDOW gets deleted and we can return its entire
1523 ;; space to its siblings, use WINDOW's normal size as the
1524 ;; normal delta.
1526 ;; In any other case calculate the normal delta from the
1527 ;; relation of THIS-DELTA to the total size of PARENT.
1533 ;; Set parent-normal to the sum of the normal sizes of all child
1534 ;; windows of PARENT that shall be resized, excluding only WINDOW
1535 ;; and any windows specified by the optional TRAIL argument.
1546 ;; Set the new normal size of all child windows of PARENT from what
1547 ;; they should have contributed for recovering THIS-DELTA lines
1548 ;; (columns).
1562 delta-normal))
1563 ;; Don't drop below 0.
1568 ;; Set the new normal size of windows from what they should have
1569 ;; contributed for recovering OTHER-DELTA lines (columns).
1572 other-delta)))
1584 ;; Don't drop below 0.
1588 ;; Set the new normal size of WINDOW to what is left by the sum of
1589 ;; the normal sizes of its siblings.
1591 window
1602 ;; Don't get larger than 1 or smaller than 0.
1605 (defun window--resize-child-windows (parent delta &optional horizontal window ignore trail edge)
1606 "Resize child windows of window PARENT vertically by DELTA lines.
1607 PARENT must be a vertically combined internal window.
1609 Optional argument HORIZONTAL non-nil means resize child windows of
1610 PARENT horizontally by DELTA columns. In this case PARENT must
1611 be a horizontally combined internal window.
1613 WINDOW, if specified, must denote a child window of PARENT that
1614 is resized by DELTA lines.
1616 Optional argument IGNORE non-nil means ignore any restrictions
1617 imposed by fixed size windows, `window-min-height' or
1618 `window-min-width' settings. IGNORE equal `safe' means live
1619 windows may get as small as `window-safe-min-height' lines and
1620 `window-safe-min-width' columns. IGNORE any window means ignore
1621 restrictions for that window only.
1623 Optional arguments TRAIL and EDGE, when non-nil, restrict the set
1624 of windows that shall be resized. If TRAIL equals `before',
1625 resize only windows on the left or above EDGE. If TRAIL equals
1626 `after', resize only windows on the right or below EDGE. Also,
1627 preferably only resize windows adjacent to EDGE.
1629 Return the symbol `normalized' if new normal sizes have been
1630 already set by this routine."
1634 best-window best-value)
1646 sub)
1651 edge)
1656 edge)
1659 ;; Resize only windows adjacent to EDGE.
1662 sub delta horizontal ignore t trail edge)
1665 ;; Assign new normal sizes.
1674 ;; Return 'normalized to notify `window--resize-siblings' that
1675 ;; normal sizes have been already set.
1677 ;; Resize all windows proportionally.
1682 ;; Ignore windows to skip and fixed-size child windows -
1683 ;; in the latter case make it a window to skip.
1688 ;; When shrinking store the number of lines/cols we can get
1689 ;; from this window here together with the total/normal size
1690 ;; factor.
1692 sub
1694 ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
1697 parent-total)
1700 ;; When enlarging store the total/normal size factor only
1702 sub
1704 parent-total)
1711 ;; Shrink windows by delta.
1730 best-window
1735 parent-total)
1738 ;; Enlarge windows by delta.
1756 best-window
1758 parent-total)
1766 ;; Reset new normal size fields so `window-resize-apply'
1767 ;; won't use them to apply new sizes.
1771 ;; Resize this window's child windows (back-engineering
1772 ;; delta from sub's old and new total sizes).
1776 ;; For the TRAIL non-nil case we have to resize SUB
1777 ;; recursively even if it's size does not change.
1779 sub delta horizontal ignore nil trail edge))))
1783 "Resize other windows when WINDOW is resized vertically by DELTA lines.
1784 Optional argument HORIZONTAL non-nil means resize other windows
1785 when WINDOW is resized horizontally by DELTA columns. WINDOW
1786 itself is not resized by this function.
1788 Optional argument IGNORE non-nil means ignore any restrictions
1789 imposed by fixed size windows, `window-min-height' or
1790 `window-min-width' settings. IGNORE equal `safe' means live
1791 windows may get as small as `window-safe-min-height' lines and
1792 `window-safe-min-width' columns. IGNORE any window means ignore
1793 restrictions for that window only.
1795 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1796 of windows that shall be resized. If TRAIL equals `before',
1797 resize only windows on the left or above EDGE. If TRAIL equals
1798 `after', resize only windows on the right or below EDGE. Also,
1799 preferably only resize windows adjacent to EDGE."
1804 ;; In an iso-combination try to extract DELTA from WINDOW's
1805 ;; siblings.
1808 this-delta other-delta)
1809 ;; Decide which windows shall be left alone.
1813 ;; Make sure WINDOW is left alone when
1814 ;; resizing its siblings.
1818 ;; Make sure this sibling is left alone when
1819 ;; resizing its siblings.
1823 ;; Set this-delta to t to signal that we found a sibling
1824 ;; of WINDOW whose size is not fixed.
1829 ;; Set this-delta to what we can get from WINDOW's siblings.
1831 ;; A deletion, presumably. We must handle this case
1832 ;; specially since `window-resizable' can't be used.
1834 ;; There's at least one resizable sibling we can
1835 ;; give WINDOW's size to.
1837 ;; No resizable sibling exists.
1839 ;; Any other form of resizing.
1843 ;; Set other-delta to what we still have to get from
1844 ;; ancestor windows of parent.
1847 ;; Unless we got everything from WINDOW's siblings, PARENT
1848 ;; must be resized by other-delta lines or columns.
1852 ;; We haven't got anything from WINDOW's siblings but we
1853 ;; must update the normal sizes to respect other-delta.
1855 parent horizontal window this-delta trail other-delta)
1856 ;; We did get something from WINDOW's siblings which means
1857 ;; we have to resize their child windows.
1860 window ignore trail edge)
1861 ;; If `window--resize-child-windows' returns
1862 ;; 'normalized, this means it has set the
1863 ;; normal sizes already.
1865 ;; Set the normal sizes.
1867 parent horizontal window this-delta trail other-delta))
1868 ;; Set DELTA to what we still have to get from ancestor
1869 ;; windows.
1872 ;; In an ortho-combination all siblings of WINDOW must be
1873 ;; resized by DELTA.
1881 ;; "Go up."
1883 parent delta horizontal ignore trail edge)))))
1886 "Resize WINDOW vertically by DELTA lines.
1887 Optional argument HORIZONTAL non-nil means resize WINDOW
1888 horizontally by DELTA columns.
1890 Optional argument IGNORE non-nil means ignore any restrictions
1891 imposed by fixed size windows, `window-min-height' or
1892 `window-min-width' settings. IGNORE equal `safe' means live
1893 windows may get as small as `window-safe-min-height' lines and
1894 `window-safe-min-width' columns. IGNORE any window means ignore
1895 restrictions for that window only.
1897 Optional argument ADD non-nil means add DELTA to the new total
1898 size of WINDOW.
1900 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1901 of windows that shall be resized. If TRAIL equals `before',
1902 resize only windows on the left or above EDGE. If TRAIL equals
1903 `after', resize only windows on the right or below EDGE. Also,
1904 preferably only resize windows adjacent to EDGE.
1906 This function recursively resizes WINDOW's child windows to fit the
1907 new size. Make sure that WINDOW is `window-resizable' before
1908 calling this function. Note that this function does not resize
1909 siblings of WINDOW or WINDOW's parent window. You have to
1910 eventually call `window-resize-apply' in order to make resizing
1911 actually take effect."
1913 ;; Add DELTA to the new total size of WINDOW.
1920 ;; In an iso-combination resize child windows according to their
1921 ;; normal sizes.
1923 window delta horizontal nil ignore trail edge))
1924 ;; In an ortho-combination resize each child window by DELTA.
1928 sub delta horizontal ignore t trail edge)
1932 "Resize root window WINDOW vertically by DELTA lines.
1933 HORIZONTAL non-nil means resize root window WINDOW horizontally
1934 by DELTA columns.
1936 IGNORE non-nil means ignore any restrictions imposed by fixed
1937 size windows, `window-min-height' or `window-min-width' settings.
1939 This function is only called by the frame resizing routines. It
1940 resizes windows proportionally and never deletes any windows."
1947 "Resize root window WINDOW vertically by DELTA lines.
1948 If DELTA is less than zero and we can't shrink WINDOW by DELTA
1949 lines, shrink it as much as possible. If DELTA is greater than
1950 zero, this function can resize fixed-size windows in order to
1951 recover the necessary lines.
1953 Return the number of lines that were recovered.
1955 This function is only called by the minibuffer window resizing
1956 routines. It resizes windows proportionally and never deletes
1957 any windows."
1968 ;; Ideally, we would resize just the last window in a combination
1969 ;; but that's not feasible for the following reason: If we grow
1970 ;; the minibuffer window and the last window cannot be shrunk any
1971 ;; more, we shrink another window instead. But if we then shrink
1972 ;; the minibuffer window again, the last window might get enlarged
1973 ;; and the state after shrinking is not the state before growing.
1974 ;; So, in practice, we'd need a history variable to record how to
1975 ;; proceed. But I'm not sure how such a variable could work with
1976 ;; repeated minibuffer window growing steps.
1978 delta)))
1981 "Move WINDOW's bottom edge by DELTA lines.
1982 Optional argument HORIZONTAL non-nil means move WINDOW's right
1983 edge by DELTA columns. WINDOW defaults to the selected window.
1985 If DELTA is greater zero, then move the edge downwards or to the
1986 right. If DELTA is less than zero, move the edge upwards or to
1987 the left. If the edge can't be moved by DELTA lines or columns,
1988 move it as far as possible in the desired direction."
1992 left this-delta min-delta max-delta failed)
1993 ;; Find the edge we want to move.
2006 ;; Set LEFT to the first resizable window on the left. This step is
2007 ;; needed to handle fixed-size windows.
2020 ;; Set RIGHT to the first resizable window on the right. This step
2021 ;; is needed to handle fixed-size windows.
2034 ;; LEFT and RIGHT (which might be both internal windows) are now the
2035 ;; two windows we want to resize.
2041 ;; We can't get the whole DELTA - move as far as possible.
2044 ;; Start resizing.
2046 ;; Try to enlarge LEFT first.
2050 left this-delta horizontal nil t 'before
2054 ;; Shrink windows on right of LEFT.
2056 left delta horizontal nil 'after
2064 ;; We can't get the whole DELTA - move as far as possible.
2067 ;; Start resizing.
2069 ;; Try to enlarge RIGHT.
2073 right this-delta horizontal nil t 'after
2077 ;; Shrink windows on left of RIGHT.
2084 ;; Don't report an error in the standard case.
2086 ;; But do report an error if applying the changes fails.
2090 "Make selected window DELTA lines taller.
2091 Interactively, if no argument is given, make the selected window
2092 one line taller. If optional argument HORIZONTAL is non-nil,
2093 make selected window wider by DELTA columns. If DELTA is
2094 negative, shrink selected window by -DELTA lines or columns.
2095 Return nil."
2108 horizontal))))
2111 "Make selected window DELTA lines smaller.
2112 Interactively, if no argument is given, make the selected window
2113 one line smaller. If optional argument HORIZONTAL is non-nil,
2114 make selected window narrower by DELTA columns. If DELTA is
2115 negative, enlarge selected window by -DELTA lines or columns.
2116 Return nil."
2129 horizontal))))
2132 "Maximize WINDOW.
2133 Make WINDOW as large as possible without deleting any windows.
2134 WINDOW can be any window and defaults to the selected window."
2141 "Minimize WINDOW.
2142 Make WINDOW as small as possible without deleting any windows.
2143 WINDOW can be any window and defaults to the selected window."
2148 \f
2150 "Return non-nil if WINDOW is the root window of its frame."
2154 "Return window tree rooted at WINDOW.
2155 Optional argument NEXT non-nil means include windows right
2156 siblings in the return value.
2158 See the documentation of `window-tree' for a description of the
2159 return value."
2172 list))
2177 "Return the window tree of frame FRAME.
2178 FRAME must be a live frame and defaults to the selected frame.
2179 The return value is a list of the form (ROOT MINI), where ROOT
2180 represents the window tree of the frame's root window, and MINI
2181 is the frame's minibuffer window.
2183 If the root window is not split, ROOT is the root window itself.
2184 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
2185 for a horizontal split, and t for a vertical split. EDGES gives
2186 the combined size and position of the child windows in the split,
2187 and the rest of the elements are the child windows in the split.
2188 Each of the child windows may again be a window or a list
2189 representing a window split, and so on. EDGES is a list \(LEFT
2190 TOP RIGHT BOTTOM) as returned by `window-edges'."
2193 \f
2195 "Select another window in cyclic ordering of windows.
2196 COUNT specifies the number of windows to skip, starting with the
2197 selected window, before making the selection. If COUNT is
2198 positive, skip COUNT windows forwards. If COUNT is negative,
2199 skip -COUNT windows backwards. COUNT zero means do not skip any
2200 window, so select the selected window. In an interactive call,
2201 COUNT is the numeric prefix argument. Return nil.
2203 If the `other-window' parameter of WINDOW is a function and
2204 `ignore-window-parameters' is nil, call that function with the
2205 arguments COUNT and ALL-FRAMES.
2207 This function does not select a window whose `no-other-window'
2208 window parameter is non-nil.
2210 This function uses `next-window' for finding the window to
2211 select. The argument ALL-FRAMES has the same meaning as in
2212 `next-window', but the MINIBUF argument of `next-window' is
2213 always effectively nil."
2218 old-window old-count)
2221 ;; `next-window' and `previous-window' may return a window we are
2222 ;; not allowed to select. Hence we need an exit strategy in case
2223 ;; all windows are non-selectable.
2230 ;; Keep out of infinite loops. When COUNT has not changed
2231 ;; since we last looked at `window' we're probably in one.
2235 ;; The first non-selectable window `next-window' got us:
2236 ;; Remember it and the current value of COUNT.
2246 ;; Keep out of infinite loops. When COUNT has not changed
2247 ;; since we last looked at `window' we're probably in one.
2251 ;; The first non-selectable window `previous-window' got
2252 ;; us: Remember it and the current value of COUNT.
2259 ;; Always return nil.
2260 nil))))
2262 ;; This should probably return non-nil when the selected window is part
2263 ;; of an atomic window whose root is the frame's root window.
2265 "Return non-nil if the selected window is the only window.
2266 Optional arg NOMINI non-nil means don't count the minibuffer
2267 even if it is active. Otherwise, the minibuffer is counted
2268 when it is active.
2270 Optional argument ALL-FRAMES specifies the set of frames to
2271 consider, see also `next-window'. ALL-FRAMES nil or omitted
2272 means consider windows on the selected frame only, plus the
2273 minibuffer window if specified by the NOMINI argument. If the
2274 minibuffer counts, consider all windows on all frames that share
2275 that minibuffer too. The remaining non-nil values of ALL-FRAMES
2276 with a special meaning are:
2278 - t means consider all windows on all existing frames.
2280 - `visible' means consider all windows on all visible frames on
2281 the current terminal.
2283 - 0 (the number zero) means consider all windows on all visible
2284 and iconified frames on the current terminal.
2286 - A frame means consider all windows on that frame only.
2288 Anything else means consider all windows on the selected frame
2289 and no others."
2295 \f
2296 ;;; Deleting windows.
2298 "Return t if WINDOW can be safely deleted from its frame.
2299 Return `frame' if deleting WINDOW should also delete its
2300 frame."
2304 ;; Handle atomicity.
2313 ;; WINDOW's frame can be deleted only if there are other frames
2314 ;; on the same terminal.
2320 ;; WINDOW can be deleted unless it is the main window of its
2321 ;; frame.
2322 t))))
2325 "Return t if WINDOW is either ROOT or a member of ROOT's subtree."
2335 "Delete WINDOW.
2336 WINDOW can be an arbitrary window and defaults to the selected
2337 one. Return nil.
2339 If the variable `ignore-window-parameters' is non-nil or the
2340 `delete-window' parameter of WINDOW equals t, do not process any
2341 parameters of WINDOW. Otherwise, if the `delete-window'
2342 parameter of WINDOW specifies a function, call that function with
2343 WINDOW as its sole argument and return the value returned by that
2344 function.
2346 Otherwise, if WINDOW is part of an atomic window, call
2347 `delete-window' with the root of the atomic window as its
2348 argument. If WINDOW is the only window on its frame or the last
2349 non-side window, signal an error."
2355 atom-root)
2358 ;; Handle window parameters.
2360 ;; Ignore window parameters if `ignore-window-parameters' tells
2361 ;; us so or `delete-window' equals t.
2364 ;; The `delete-window' parameter specifies the function to call.
2365 ;; If that function is `ignore' nothing is done. It's up to the
2366 ;; function called here to avoid infinite recursion.
2383 ;; Emacs 23 preferably gives WINDOW's space to its left
2384 ;; sibling.
2390 ;; Resize WINDOW's sibling.
2396 ;; Can do without resizing fixed-size windows.
2399 ;; Can't do without resizing fixed-size windows.
2401 ;; Actually delete WINDOW.
2406 ;; `delete-window-internal' has selected a window that should
2407 ;; not be selected, fix this here.
2411 ;; Always return nil.
2412 nil))))
2415 "Make WINDOW fill its frame.
2416 WINDOW may be any window and defaults to the selected one.
2417 Return nil.
2419 If the variable `ignore-window-parameters' is non-nil or the
2420 `delete-other-windows' parameter of WINDOW equals t, do not
2421 process any parameters of WINDOW. Otherwise, if the
2422 `delete-other-windows' parameter of WINDOW specifies a function,
2423 call that function with WINDOW as its sole argument and return
2424 the value returned by that function.
2426 Otherwise, if WINDOW is part of an atomic window, call this
2427 function with the root of the atomic window as its argument. If
2428 WINDOW is a non-side window, make WINDOW the only non-side window
2429 on the frame. Side windows are not deleted. If WINDOW is a side
2430 window signal an error."
2436 atom-root side-main)
2440 ;; Ignore window parameters if `ignore-window-parameters' is t or
2441 ;; `delete-other-windows' is t.
2444 ;; The `delete-other-windows' parameter specifies the function
2445 ;; to call. If the function is `ignore' no windows are deleted.
2446 ;; It's up to the function called to avoid infinite recursion.
2453 ;; Set side-main to the major non-side window.
2457 ;; If WINDOW is the main non-side window, do nothing.
2462 ;; Always return nil.
2463 nil)))
2466 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
2468 if you often split windows horizontally."
2480 ;;; Windows and buffers.
2482 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
2483 ;; for (1) determining which buffer to show in the window when its
2484 ;; buffer shall be buried or killed and (2) which buffer to show for
2485 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2487 ;; `prev-buffers' consists of <buffer, window-start, window-point>
2488 ;; triples. The entries on this list are ordered by the time their
2489 ;; buffer has been removed from the window, the most recently removed
2490 ;; buffer's entry being first. The window-start and window-point
2491 ;; components are `window-start' and `window-point' at the time the
2492 ;; buffer was removed from the window which implies that the entry must
2493 ;; be added when `set-window-buffer' removes the buffer from the window.
2495 ;; `next-buffers' is the list of buffers that have been replaced
2496 ;; recently by `switch-to-prev-buffer'. These buffers are the least
2497 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
2498 ;; candidates of `switch-to-next-buffer' to switch to. This list is
2499 ;; reset to nil by any action changing the window's buffer with the
2500 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
2501 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
2502 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
2504 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
2505 ;; if such a buffer was killed while the window was hidden within a
2506 ;; window configuration. Such killed buffers get removed whenever
2507 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
2509 ;; The following function is called by `set-window-buffer' _before_ it
2510 ;; replaces the buffer of the argument window with the new buffer.
2512 "Record WINDOW's buffer.
2513 WINDOW must be a live window and defaults to the selected one."
2517 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
2518 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2522 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
2526 ;; Don't record insignificant buffers.
2528 ;; Add an entry for buffer to WINDOW's previous buffers.
2535 ;; We have an entry, update marker positions.
2538 ;; Make new markers.
2546 "Unrecord BUFFER in WINDOW.
2547 WINDOW must be a live window and defaults to the selected one.
2548 BUFFER must be a live buffer and defaults to the buffer of
2549 WINDOW."
2558 "Set WINDOW's buffer to BUFFER.
2559 Optional argument START non-nil means set WINDOW's start position
2560 to START. Optional argument POINT non-nil means set WINDOW's
2561 point to POINT. If WINDOW is selected this also sets BUFFER's
2562 `point' to POINT. If WINDOW is selected and the buffer it showed
2563 before was current this also makes BUFFER the current buffer."
2570 ;; Don't force window-start here (even if POINT is nil).
2576 "In WINDOW switch to previous buffer.
2577 WINDOW must be a live window and defaults to the selected one.
2579 Optional argument BURY-OR-KILL non-nil means the buffer currently
2580 shown in WINDOW is about to be buried or killed and consequently
2581 shall not be switched to in future invocations of this command."
2585 ;; Save this since it's destroyed by `set-window-buffer'.
2587 entry new-buffer killed-buffers visible)
2592 ;; Scan WINDOW's previous buffers first, skipping entries of next
2593 ;; buffers.
2605 ;; Scan reverted buffer list of WINDOW's frame next, skipping
2606 ;; entries of next buffers. Note that when we bury or kill a
2607 ;; buffer we don't reverse the global buffer list to avoid showing
2608 ;; a buried buffer instead. Otherwise, we must reverse the global
2609 ;; buffer list in order to make sure that switching to the
2610 ;; previous/next buffer traverse it in opposite directions.
2619 ;; Try to avoid showing a buffer visible in some other window.
2625 ;; Scan reverted next buffers last (must not use nreverse
2626 ;; here!).
2628 ;; Actually, buffer _must_ be live here since otherwise it
2629 ;; would have been caught in the scan of previous buffers.
2640 ;; Show a buffer visible in another window.
2646 ;; Remove `old-buffer' from WINDOW's previous and (restored list
2647 ;; of) next buffers.
2652 ;; Move `old-buffer' to head of WINDOW's restored list of next
2653 ;; buffers.
2657 ;; Remove killed buffers from WINDOW's previous and next buffers.
2665 ;; Return new-buffer.
2666 new-buffer))
2669 "In WINDOW switch to next buffer.
2670 WINDOW must be a live window and defaults to the selected one."
2675 new-buffer entry killed-buffers visible)
2680 ;; Scan WINDOW's next buffers first.
2691 ;; Scan the buffer list of WINDOW's frame next, skipping previous
2692 ;; buffers entries.
2698 ;; Try to avoid showing a buffer visible in some other window.
2703 ;; Scan WINDOW's reverted previous buffers last (must not use
2704 ;; nreverse here!)
2715 ;; Show a buffer visible in another window.
2720 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
2723 ;; Remove killed buffers from WINDOW's previous and next buffers.
2731 ;; Return new-buffer.
2732 new-buffer))
2735 "Search LIST for a valid buffer to display in FRAME.
2736 Return nil when all buffers in LIST are undesirable for display,
2737 otherwise return the first suitable buffer in LIST.
2739 Buffers not visible in windows are preferred to visible buffers,
2740 unless VISIBLE-OK is non-nil.
2741 If the optional argument FRAME is nil, it defaults to the selected frame.
2742 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
2743 ;; This logic is more or less copied from other-buffer.
2746 found buf)
2759 "Return the last buffer in FRAME's buffer list.
2760 If BUFFER is the last buffer, return the preceding buffer
2761 instead. Buffers not visible in windows are preferred to visible
2762 buffers, unless optional argument VISIBLE-OK is non-nil.
2763 Optional third argument FRAME nil or omitted means use the
2764 selected frame's buffer list. If no such buffer exists, return
2765 the buffer `*scratch*', creating it if necessary."
2768 buffer visible-ok frame)
2772 scratch)))
2775 "Function called to automatically hide frames.
2776 The function is called with one argument - a frame.
2778 Functions affected by this option are those that bury a buffer
2779 shown in a separate frame like `quit-window' and `bury-buffer'."
2783 function)
2789 "Delete WINDOW if possible.
2790 WINDOW must be a live window and defaults to the selected one.
2791 Optional argument DEDICATED-ONLY non-nil means to delete WINDOW
2792 only if it's dedicated to its buffer. Optional argument KILL
2793 means the buffer shown in window will be killed. Return non-nil
2794 if WINDOW gets deleted or its frame is auto-hidden."
2810 t)))))
2813 "Put BUFFER-OR-NAME at the end of the list of all buffers.
2814 There it is the least likely candidate for `other-buffer' to
2816 select by default.
2818 You can specify a buffer name as BUFFER-OR-NAME, or an actual
2819 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
2820 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
2821 remove the current buffer from the selected window if it is
2822 displayed there."
2825 ;; If `buffer-or-name' is not on the selected frame we unrecord it
2826 ;; although it's not "here" (call it a feature).
2828 ;; Handle case where `buffer-or-name' is nil and the current buffer
2829 ;; is shown in the selected window.
2834 ;; Switch to another buffer in window.
2838 ;; Always return nil.
2839 nil))
2842 "Switch to the last buffer in the buffer list."
2847 "In selected window switch to next buffer."
2854 "In selected window switch to previous buffer."
2861 "Delete all windows showing BUFFER-OR-NAME.
2862 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2863 and defaults to the current buffer.
2865 The following non-nil values of the optional argument FRAME
2866 have special meanings:
2868 - t means consider all windows on the selected frame only.
2870 - `visible' means consider all windows on all visible frames on
2871 the current terminal.
2873 - 0 (the number zero) means consider all windows on all visible
2874 and iconified frames on the current terminal.
2876 - A frame means consider all windows on that frame only.
2878 Any other value of FRAME means consider all windows on all
2879 frames.
2881 When a window showing BUFFER-OR-NAME is dedicated and the only
2882 window of its frame, that frame is deleted when there are other
2883 frames left."
2886 ;; Handle the "inverted" meaning of the FRAME argument wrt other
2887 ;; `window-list-1' based function.
2894 ;; Delete frame if and only if window is dedicated.
2897 ;; Delete window.
2900 ;; In window switch to previous buffer.
2903 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
2907 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
2908 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2909 and defaults to the current buffer.
2911 When a window showing BUFFER-OR-NAME is dedicated, that window is
2912 deleted. If that window is the only window on its frame, the
2913 frame is deleted too when there are other frames left. If there
2914 are no other frames left, some other buffer is displayed in that
2915 window.
2917 This function removes the buffer denoted by BUFFER-OR-NAME from
2918 all window-local buffer lists."
2923 ;; Switch to another buffer in window.
2926 ;; Unrecord BUFFER in WINDOW.
2930 "Quit WINDOW and bury its buffer.
2931 WINDOW must be a live window and defaults to the selected one.
2932 With prefix argument KILL non-nil, kill the buffer instead of
2933 burying it.
2935 According to information stored in WINDOW's `quit-restore' window
2936 parameter either \(1) delete WINDOW and its frame, \(2) delete
2937 WINDOW, \(3) restore the buffer previously displayed in WINDOW,
2938 or \(4) make WINDOW display some other buffer than the present
2939 one. If non-nil, reset `quit-restore' parameter to nil."
2950 buffer))))
2951 prev-buffer)))
2952 quad resize)
2957 ;; Delete WINDOW if possible.
2959 ;; If the previously selected window is still alive, select it.
2965 ;; Show another buffer stored in quit-restore parameter.
2971 ;; Try to resize WINDOW to its old height but don't signal an
2972 ;; error.
2976 ;; Restore WINDOW's previous buffer, start and point position.
2979 ;; Unrecord WINDOW's buffer here (Bug#9937) to make sure it's not
2980 ;; re-recorded by `set-window-buffer'.
2982 ;; Reset the quit-restore parameter.
2984 ;; Select old window.
2988 ;; Show some other buffer in WINDOW and reset the quit-restore
2989 ;; parameter.
2991 ;; Make sure that WINDOW is no more dedicated.
2995 ;; Kill WINDOW's old-buffer if requested
3001 "Quit all windows showing BUFFER-OR-NAME.
3002 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
3003 and defaults to the current buffer. Optional argument KILL
3004 non-nil means to kill BUFFER-OR-NAME. KILL nil means to bury
3005 BUFFER-OR-NAME. Optional argument FRAME is handled as by
3006 `delete-windows-on'.
3008 This function calls `quit-window' on all candidate windows
3009 showing BUFFER-OR-NAME."
3012 ;; Handle the "inverted" meaning of the FRAME argument wrt other
3013 ;; `window-list-1' based function.
3018 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
3020 \f
3021 ;;; Splitting windows.
3023 "Return minimum height of any window when splitting windows.
3024 Optional argument HORIZONTAL non-nil means return minimum width."
3030 "Make a new window adjacent to WINDOW.
3031 WINDOW can be any window and defaults to the selected one.
3032 Return the new window which is always a live window.
3034 Optional argument SIZE a positive number means make WINDOW SIZE
3035 lines or columns tall. If SIZE is negative, make the new window
3036 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
3037 absolute value can be less than `window-min-height' or
3038 `window-min-width'; so this command can make a new window as
3039 small as one line or two columns. SIZE defaults to half of
3040 WINDOW's size. Interactively, SIZE is the prefix argument.
3042 Optional third argument SIDE nil (or `below') specifies that the
3043 new window shall be located below WINDOW. SIDE `above' means the
3044 new window shall be located above WINDOW. In both cases SIZE
3045 specifies the new number of lines for WINDOW \(or the new window
3046 if SIZE is negative) including space reserved for the mode and/or
3047 header line.
3049 SIDE t (or `right') specifies that the new window shall be
3050 located on the right side of WINDOW. SIDE `left' means the new
3051 window shall be located on the left of WINDOW. In both cases
3052 SIZE specifies the new number of columns for WINDOW \(or the new
3053 window provided SIZE is negative) including space reserved for
3054 fringes and the scrollbar or a divider column. Any other non-nil
3055 value for SIDE is currently handled like t (or `right').
3057 If the variable `ignore-window-parameters' is non-nil or the
3058 `split-window' parameter of WINDOW equals t, do not process any
3059 parameters of WINDOW. Otherwise, if the `split-window' parameter
3060 of WINDOW specifies a function, call that function with all three
3061 arguments and return the value returned by that function.
3064 root of that atomic window. The new window does not become a
3065 member of that atomic window.
3067 If WINDOW is live, properties of the new window like margins and
3068 scrollbars are inherited from WINDOW. If WINDOW is an internal
3069 window, these properties as well as the buffer displayed in the
3070 new window are inherited from the window selected on WINDOW's
3071 frame. The selected window is not changed by this function."
3083 ;; Rebind `window-nest' since in some cases we may have to
3084 ;; override its value.
3086 atom-root)
3091 ;; Ignore window parameters if either `ignore-window-parameters'
3092 ;; is t or the `split-window' parameter equals t.
3095 ;; The `split-window' parameter specifies the function to call.
3096 ;; If that function is `ignore', do nothing.
3098 ;; If WINDOW is part of an atomic window, split the root window
3099 ;; of that atomic window instead.
3108 ;; WINDOW is a side root window. To make sure that a new parent
3109 ;; window gets created set `window-nest' to t.
3113 ;; If `window-splits' is non-nil and SIZE is a non-negative
3114 ;; integer, we cannot reasonably resize other windows. Rather
3115 ;; bind `window-nest' to t to make sure that subsequent window
3116 ;; deletions are handled correctly.
3120 ;; `parent-size' is the size of WINDOW's parent, provided
3121 ;; it has one.
3123 ;; `resize' non-nil means we are supposed to resize other
3124 ;; windows in WINDOW's combination.
3127 ;; Resize makes sense in iso-combinations only.
3129 ;; `old-size' is the current size of WINDOW.
3131 ;; `new-size' is the specified or calculated size of the
3132 ;; new window.
3138 ;; When resizing try to give the new window the
3139 ;; average size of a window in its combination.
3142 (/ parent-size
3144 parent horizontal))))
3145 ;; Else try to give the new window half the size
3146 ;; of WINDOW (plus an eventual odd line).
3149 ;; SIZE non-negative specifies the new size of WINDOW.
3151 ;; Note: Specifying a non-negative SIZE is practically
3152 ;; always done as workaround for making the new window
3153 ;; appear above or on the left of the new window (the
3154 ;; ispell window is a typical example of that). In all
3155 ;; these cases the SIDE argument should be set to 'above
3156 ;; or 'left in order to support the 'resize option.
3157 ;; Here we have to nest the windows instead, see above.
3160 ;; SIZE negative specifies the size of the new window.
3162 new-parent new-normal)
3164 ;; Check SIZE.
3169 ;; SIZE unspecified, resizing.
3171 ;; Try again with minimum split size.
3177 ;; SIZE unspecified, no resizing.
3182 window-safe-min-width
3183 window-safe-min-width))))
3184 ;; SIZE specified as new size of old window. If the new size
3185 ;; is larger than the old size or the size of the new window
3186 ;; would be less than the safe minimum, signal an error.
3189 ;; SIZE specified, resizing.
3191 ;; If we cannot resize the parent give up.
3197 ;; SIZE specification violates minimum size restrictions.
3203 ;; Make new-parent non-nil if we need a new parent window;
3204 ;; either because we want to nest or because WINDOW is not
3205 ;; iso-combined.
3208 ;; Make new-normal the normal size of the new window.
3216 ;; Try to get space from OLD's siblings. We could go "up" and
3217 ;; try getting additional space from surrounding windows but
3218 ;; we won't be able to return space to those windows when we
3219 ;; delete the one we create here. Hence we do not go up.
3228 ;; Get entire space from WINDOW.
3233 new-normal)))
3236 ;; Inherit window-side parameters, if any.
3243 ;; Always return the new window.
3244 new)))))
3246 ;; I think this should be the default; I think people will prefer it--rms.
3249 If nil, adjust point in the two windows to minimize redisplay.
3250 This option applies only to `split-window-below' and functions
3251 that call it. The low-level `split-window' function always keeps
3252 the original point in both windows."
3257 "Split the selected window into two windows, one above the other.
3258 The selected window is above. The newly split-off window is
3259 below, and displays the same buffer. Return the new window.
3261 If optional argument SIZE is omitted or nil, both windows get the
3262 same height, or close to it. If SIZE is positive, the upper
3263 \(selected) window gets SIZE lines. If SIZE is negative, the
3264 lower (new) window gets -SIZE lines.
3266 If the variable `split-window-keep-point' is non-nil, both
3267 windows get the same value of point as the selected window.
3268 Otherwise, the window starts are chosen so as to minimize the
3269 amount of redisplay; this is convenient on slow terminals."
3274 moved-by-window-height moved new-window bottom)
3276 ;; `split-window' would not signal an error here.
3297 ;; Always copy quit-restore parameter in interactive use.
3301 new-window))
3306 "Split the selected window into two side-by-side windows.
3307 The selected window is on the left. The newly split-off window
3308 is on the right, and displays the same buffer. Return the new
3309 window.
3311 If optional argument SIZE is omitted or nil, both windows get the
3312 same width, or close to it. If SIZE is positive, the left-hand
3313 \(selected) window gets SIZE columns. If SIZE is negative, the
3314 right-hand (new) window gets -SIZE columns. Here, SIZE includes
3315 the width of the window's scroll bar; if there are no scroll
3316 bars, it includes the width of the divider column to the window's
3317 right, if any."
3321 new-window)
3323 ;; `split-window' would not signal an error here.
3326 ;; Always copy quit-restore parameter in interactive use.
3330 new-window))
3333 \f
3334 ;;; Balancing windows.
3336 ;; The following routine uses the recycled code from an old version of
3337 ;; `window--resize-child-windows'. It's not very pretty, but coding it the way the
3338 ;; new `window--resize-child-windows' code does would hardly make it any shorter or
3339 ;; more readable (FWIW we'd need three loops - one to calculate the
3340 ;; minimum sizes per window, one to enlarge or shrink windows until the
3341 ;; new parent-size matches, and one where we shrink the largest/enlarge
3342 ;; the smallest window).
3344 "Subroutine of `balance-windows-1'.
3345 WINDOW must be a vertical combination (horizontal if HORIZONTAL
3346 is non-nil."
3352 found failed size sub-total sub-delta sub-amount rest)
3367 ;; Ignore child windows that should be ignored or are stuck.
3374 ;; Register the new total size for this child window.
3379 ;; We failed and need a new round.
3385 ;; Fix rounding by trying to enlarge non-stuck windows by one line
3386 ;; (column) until `rest' is zero.
3394 ;; Fix rounding by trying to enlarge stuck windows by one line
3395 ;; (column) until `rest' equals zero.
3405 ;; Record new normal sizes.
3411 ;; Recursively balance each window's child windows.
3416 "Subroutine of `balance-windows'."
3428 "Balance the sizes of windows of WINDOW-OR-FRAME.
3429 WINDOW-OR-FRAME is optional and defaults to the selected frame.
3430 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
3431 windows of that frame. If WINDOW-OR-FRAME denots a window,
3432 recursively balance the sizes of all child windows of that
3433 window."
3442 window-or-frame)
3446 ;; Balance vertically.
3450 ;; Balance horizontally.
3456 "Return t if WINDOW cannot be resized in DIRECTION.
3457 WINDOW defaults to the selected window. DIRECTION can be
3458 nil (i.e. any), `height' or `width'."
3465 ;;; A different solution to balance-windows.
3467 "Factor by which the window area should be over-estimated.
3468 This is used by `balance-windows-area'.
3473 "Wrapper around `window-resize' with error checking.
3474 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
3475 ;; `window-resize' may fail if delta is too large.
3482 ;;(message "adjust: %s" (error-message-string err))
3486 "Make all visible windows the same area (approximately).
3487 See also `window-area-factor' to change the relative size of
3488 specific buffers."
3491 ;; Remove fixed-size windows.
3496 next)
3497 ;; Resizing a window changes the size of surrounding windows in complex
3498 ;; ways, so it's difficult to balance them all. The introduction of
3499 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
3500 ;; very difficult to do. `balance-window' above takes an off-line
3501 ;; approach: get the whole window tree, then balance it, then try to
3502 ;; adjust the windows so they fit the result.
3503 ;; Here, instead, we take a "local optimization" approach, where we just
3504 ;; go through all the windows several times until nothing needs to be
3505 ;; changed. The main problem with this approach is that it's difficult
3506 ;; to make sure it terminates, so we use some heuristic to try and break
3507 ;; off infinite loops.
3508 ;; After a round without any change, we allow a second, to give a chance
3509 ;; to the carry to propagate a minor imbalance from the end back to
3510 ;; the beginning.
3512 ;; (message "New round")
3518 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
3536 ;; Maybe diff is actually closer to 1 than to 0.
3540 ;; Change things smoothly.
3543 ;; Make sure negligible differences don't accumulate to
3544 ;; become significant.
3546 ;; This used `adjust-window-trailing-edge' before and uses
3547 ;; `window-resize' now. Error wrapping is still needed.
3549 ;; (sit-for 0.5)
3551 ;; If the same change has been seen already for this window,
3552 ;; we're most likely in an endless loop, so don't count it as
3553 ;; a change.
3557 ;; We've now basically balanced all the windows.
3558 ;; But there may be some minor off-by-one imbalance left over,
3559 ;; so let's do some fine tuning.
3560 ;; (bw-finetune wins)
3561 ;; (message "Done in %d rounds" round)
3562 ))
3564 ;;; Window states, how to get them and how to put them in a window.
3569 "Helper function for `window-state-get'."
3578 `(,type
3589 window-state-ignored-parameters)
3592 ;; Make a clone-of parameter.
3597 ;; All buffer related things go in here - make the buffer
3598 ;; current when retrieving `point' and `mark'.
3630 "Return state of WINDOW as a Lisp object.
3631 WINDOW can be any window and defaults to the root window of the
3632 selected frame.
3634 Optional argument MARKERS non-nil means use markers for sampling
3635 positions like `window-point' or `window-start'. MARKERS should
3636 be non-nil only if the value is used for putting the state back
3637 in the same session (note that markers slow down processing).
3639 The return value can be used as argument for `window-state-put'
3640 to put the state recorded here into an arbitrary window. The
3641 value can be also stored on disk and read back in a new session."
3645 window
3648 ;; The return value is a cons whose car specifies some constraints on
3649 ;; the size of WINDOW. The cdr lists the states of the child windows
3650 ;; of WINDOW.
3652 ;; Frame related things would go into a function, say `frame-state',
3653 ;; calling `window-state-get' to insert the frame's root window.
3660 ;; These are probably not needed.
3669 "Helper function for `window-state-put'."
3674 ;; For a leaf window just add unprocessed entries to
3675 ;; `window-state-put-list'.
3682 size new)
3684 ;; Find the next child window. WINDOW always points to the
3685 ;; real window that we want to fill with what we find here.
3688 ;; The last child window. Below `window-state-put-1'
3689 ;; will put into it whatever ITEM has in store.
3691 ;; Not the last child window, prepare for splitting
3692 ;; WINDOW. SIZE is the new (and final) size of the old
3693 ;; window.
3696 ;; Use total size.
3698 ;; Use normalized size and round.
3702 item))))))
3704 ;; Use safe sizes, we try to resize later.
3706 window-safe-min-height
3707 window-safe-min-width)))
3711 ;; We must inherit the nesting, otherwise we might mess
3712 ;; up handling of atomic and side window.
3714 ;; Give up if we can't resize window down to safe sizes.
3719 ;; When creating the first child window add for parent
3720 ;; unprocessed entries to `window-state-put-list'.
3723 window-state-put-list))))
3725 ;; Now process the current window (either the one we've just
3726 ;; split or the last child of its parent).
3728 ;; Continue with the last window split off.
3732 "Helper function for `window-state-put'."
3741 ;; Process parameters.
3745 ;; Process buffer related state.
3747 ;; We don't want to raise an error here so we create a buffer if
3748 ;; there's none.
3760 ;; Adjust vertically.
3762 ;; A fixed height window, try to restore the original size.
3765 window-size-fixed)
3768 ;; Else check whether the window is not high enough.
3774 ;; Adjust horizontally.
3776 ;; A fixed width window, try to restore the original size.
3779 window-size-fixed)
3782 ;; Else check whether the window is not wide enough.
3788 ;; Set dedicated status.
3790 ;; Install positions (maybe we should do this after all windows
3791 ;; have been created and sized).
3795 ;; I'm not sure whether we should set the mark here, but maybe
3796 ;; it can be used.
3799 ;; Select window if it's the selected one.
3804 "Put window state STATE into WINDOW.
3805 STATE should be the state of a window returned by an earlier
3806 invocation of `window-state-get'. Optional argument WINDOW must
3807 specify a live window and defaults to the selected one.
3809 Optional argument IGNORE non-nil means ignore minimum window
3810 sizes and fixed size restrictions. IGNORE equal `safe' means
3811 windows can get as small as `window-safe-min-height' and
3812 `window-safe-min-width'."
3816 ;; We check here (1) whether the total sizes of root window of
3817 ;; STATE and that of WINDOW are equal so we can avoid
3818 ;; calculating new sizes, and (2) if we do have to resize
3819 ;; whether we can do so without violating size restrictions.
3827 window-splits selected)
3845 (> min-width
3847 ;; The check above might not catch all errors due to rounding
3848 ;; issues - so IGNORE equal 'safe might not always produce the
3849 ;; minimum possible state. But such configurations hardly make
3850 ;; sense anyway.
3854 ;; Work on the windows of a temporary buffer to make sure that
3855 ;; splitting proceeds regardless of any buffer local values of
3856 ;; `window-size-fixed'. Release that buffer after the buffers of
3857 ;; all live windows have been set by `window-state-put-2'.
3863 \f
3865 "Record information for window used by `display-buffer'.
3866 TYPE specifies the type of the calling operation and must be one
3867 of the symbols 'reuse \(when WINDOW existed already and was
3868 reused for displaying BUFFER), 'window \(when WINDOW was created
3869 on an already existing frame), or 'frame \(when WINDOW was
3870 created on a new frame). WINDOW is the window used for or created
3871 by the `display-buffer' routines. BUFFER is the buffer that
3872 shall be displayed.
3874 This function installs or updates the quit-restore parameter of
3875 WINDOW. The quit-restore parameter is a list of four elements:
3876 The first element is one of the symbols 'window, 'frame, 'same or
3877 'other. The second element is either one of the symbols 'window
3878 or 'frame or a list whose elements are the buffer previously
3879 shown in the window, that buffer's window start and window point,
3880 and the window's height. The third element is the window
3881 selected at the time the parameter was created. The fourth
3882 element is BUFFER."
3886 ;; WINDOW shows BUFFER already.
3888 ;; If WINDOW has a quit-restore parameter, reset its car.
3890 ;; WINDOW shows another buffer.
3892 window 'quit-restore
3894 ;; A quadruple of WINDOW's buffer, start, point and height.
3899 ;; WINDOW has been created on an existing frame.
3901 window 'quit-restore
3904 ;; WINDOW has been created on a new frame.
3906 window 'quit-restore
3910 "If non-nil, function to call to handle `display-buffer'.
3911 It will receive two args, the buffer and a flag which if non-nil
3912 means that the currently selected window is not acceptable. It
3913 should choose or create a window, display the specified buffer in
3914 it, and return the window.
3916 The specified function should call `display-buffer-record-window'
3917 with corresponding arguments to set up the quit-restore parameter
3918 of the window used."
3925 "Alist of parameters for automatically generated new frames.
3926 You can set this in your init file; for example,
3928 (setq pop-up-frame-alist '((width . 80) (height . 20)))
3930 If non-nil, the value you specify here is used by the default
3931 `pop-up-frame-function' for the creation of new frames.
3933 Since `pop-up-frame-function' is used by `display-buffer' for
3934 making new frames, any value specified here by default affects
3935 the automatic generation of new frames via `display-buffer' and
3936 all functions based on it. The behavior of `make-frame' is not
3937 affected by this variable."
3945 "Function used by `display-buffer' for creating a new frame.
3946 This function is called with no arguments and should return a new
3947 frame. The default value calls `make-frame' with the argument
3948 `pop-up-frame-alist'."
3953 "List of names of buffers that should be displayed specially.
3954 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
3955 its name is in this list, displays the buffer in a way specified
3956 by `special-display-function'. `special-display-popup-frame'
3957 \(the default for `special-display-function') usually displays
3958 the buffer in a separate frame made with the parameters specified
3959 by `special-display-frame-alist'. If `special-display-function'
3960 has been set to some other function, that function is called with
3961 the buffer as first, and nil as second argument.
3963 Alternatively, an element of this list can be specified as
3964 \(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
3965 name and FRAME-PARAMETERS an alist of \(PARAMETER . VALUE) pairs.
3966 `special-display-popup-frame' will interpret such pairs as frame
3967 parameters when it creates a special frame, overriding the
3968 corresponding values from `special-display-frame-alist'.
3970 As a special case, if FRAME-PARAMETERS contains (same-window . t)
3971 `special-display-popup-frame' displays that buffer in the
3972 selected window. If FRAME-PARAMETERS contains (same-frame . t),
3973 it displays that buffer in a window on the selected frame.
3975 If `special-display-function' specifies some other function than
3976 `special-display-popup-frame', that function is called with the
3977 buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
3978 argument.
3980 Finally, an element of this list can be also specified as
3981 \(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
3982 `special-display-popup-frame' will call FUNCTION with the buffer
3983 named BUFFER-NAME as first argument, and OTHER-ARGS as the
3984 second.
3986 Any alternative function specified here is responsible for
3987 setting up the quit-restore parameter of the window used.
3990 name to it but the corresponding buffer is displayed in the
3991 selected window, look at the values of `same-window-buffer-names'
3992 and `same-window-regexps'. Those variables take precedence over
3993 this one.
3995 See also `special-display-regexps'."
4017 ;;;###autoload
4021 "List of regexps saying which buffers should be displayed specially.
4022 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
4023 any regexp in this list matches its name, displays it specially
4024 using `special-display-function'. `special-display-popup-frame'
4025 \(the default for `special-display-function') usually displays
4026 the buffer in a separate frame made with the parameters specified
4027 by `special-display-frame-alist'. If `special-display-function'
4028 has been set to some other function, that function is called with
4029 the buffer as first, and nil as second argument.
4031 Alternatively, an element of this list can be specified as
4032 \(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
4033 FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
4034 `special-display-popup-frame' will then interpret these pairs as
4035 frame parameters when creating a special frame for a buffer whose
4036 name matches REGEXP, overriding the corresponding values from
4037 `special-display-frame-alist'.
4039 As a special case, if FRAME-PARAMETERS contains (same-window . t)
4040 `special-display-popup-frame' displays buffers matching REGEXP in
4041 the selected window. \(same-frame . t) in FRAME-PARAMETERS means
4042 to display such buffers in a window on the selected frame.
4044 If `special-display-function' specifies some other function than
4045 `special-display-popup-frame', that function is called with the
4046 buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
4047 as second argument.
4049 Finally, an element of this list can be also specified as
4050 \(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
4051 will then call FUNCTION with the buffer whose name matched
4052 REGEXP as first, and OTHER-ARGS as second argument.
4054 Any alternative function specified here is responsible for
4055 setting up the quit-restore parameter of the window used.
4058 name to it but the corresponding buffer is displayed in the
4059 selected window, look at the values of `same-window-buffer-names'
4060 and `same-window-regexps'. Those variables take precedence over
4061 this one.
4063 See also `special-display-buffer-names'."
4086 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
4087 More precisely, return t if `special-display-buffer-names' or
4088 `special-display-regexps' contain a string entry equaling or
4089 matching BUFFER-NAME. If `special-display-buffer-names' or
4090 `special-display-regexps' contain a list entry whose car equals
4091 or matches BUFFER-NAME, the return value is the cdr of that
4092 entry."
4097 t)
4112 "Alist of parameters for special frames.
4113 Special frames are used for buffers whose names are listed in
4114 `special-display-buffer-names' and for buffers whose names match
4115 one of the regular expressions in `special-display-regexps'.
4117 This variable can be set in your init file, like this:
4119 (setq special-display-frame-alist '((width . 80) (height . 20)))
4121 These supersede the values given in `default-frame-alist'."
4128 "Display BUFFER and return the window chosen.
4129 If BUFFER is already displayed in a visible or iconified frame,
4130 raise that frame. Otherwise, display BUFFER in a new frame.
4132 Optional argument ARGS is a list specifying additional
4133 information.
4135 If ARGS is an alist, use it as a list of frame parameters. If
4136 these parameters contain \(same-window . t), display BUFFER in
4137 the selected window. If they contain \(same-frame . t), display
4138 BUFFER in a window of the selected frame.
4140 If ARGS is a list whose car is a symbol, use (car ARGS) as a
4141 function to do the work. Pass it BUFFER as first argument,
4142 and (cdr ARGS) as second."
4147 ;; If we have a window already, make it visible.
4153 window))
4154 ;; Reuse the current window if the user requested it.
4159 ;; Stay on the same frame if requested.
4162 pop-up-frames
4163 special-display-buffer-names special-display-regexps)
4165 ;; If no window yet, make one in a new frame.
4171 ;; FIXME: Use window--display-buffer-2?
4173 ;; Reset list of WINDOW's previous buffers to nil.
4176 window)))))
4179 "Function to call for displaying special buffers.
4180 This function is called with two arguments - the buffer and,
4181 optionally, a list - and should return a window displaying that
4182 buffer. The default value usually makes a separate frame for the
4183 buffer using `special-display-frame-alist' to specify the frame
4184 parameters. See the definition of `special-display-popup-frame'
4185 for how to specify such a function.
4187 A buffer is special when its name is either listed in
4188 `special-display-buffer-names' or matches a regexp in
4189 `special-display-regexps'.
4191 The specified function should call `display-buffer-record-window'
4192 with corresponding arguments to set up the quit-restore parameter
4193 of the window used."
4199 `display-buffer' and `pop-to-buffer' show a buffer whose name is
4200 on this list in the selected rather than some other window.
4202 An element of this list can be a cons cell instead of just a
4203 string. In that case, the cell's car must be a string specifying
4204 the buffer name. This is for compatibility with
4205 `special-display-buffer-names'; the cdr of the cons cell is
4206 ignored.
4208 See also `same-window-regexps'."
4214 `display-buffer' and `pop-to-buffer' show a buffer whose name
4215 matches a regexp on this list in the selected rather than some
4216 other window.
4218 An element of this list can be a cons cell instead of just a
4219 string. In that case, the cell's car must be a regexp matching
4220 the buffer name. This is for compatibility with
4221 `special-display-regexps'; the cdr of the cons cell is ignored.
4223 See also `same-window-buffer-names'."
4229 This function returns non-nil if `display-buffer' or
4230 `pop-to-buffer' would show a buffer named BUFFER-NAME in the
4231 selected rather than \(as usual\) some other window. See
4232 `same-window-buffer-names' and `same-window-regexps'."
4235 ;; The elements of `same-window-buffer-names' can be buffer
4236 ;; names or cons cells whose cars are buffer names.
4241 ;; The elements of `same-window-regexps' can be regexps
4242 ;; or cons cells whose cars are regexps.
4250 "Whether `display-buffer' should make a separate frame.
4251 If nil, never make a separate frame.
4252 If the value is `graphic-only', make a separate frame
4253 on graphic displays only.
4254 Any other non-nil value means always make a separate frame."
4262 "Non-nil means `display-buffer' should reuse frames.
4263 If the buffer in question is already displayed in a frame, raise
4264 that frame."
4270 "Non-nil means `display-buffer' should make a new window."
4275 "Function called by `display-buffer' routines to split a window.
4276 This function is called with a window as single argument and is
4277 supposed to split that window and return the new window. If the
4278 window can (or shall) not be split, it is supposed to return nil.
4279 The default is to call the function `split-window-sensibly' which
4280 tries to split the window in a way which seems most suitable.
4281 You can customize the options `split-height-threshold' and/or
4282 `split-width-threshold' in order to have `split-window-sensibly'
4283 prefer either vertical or horizontal splitting.
4285 If you set this to any other function, bear in mind that the
4286 `display-buffer' routines may call this function two times. The
4287 argument of the first call is the largest window on its frame.
4288 If that call fails to return a live window, the function is
4289 called again with the least recently used window as argument. If
4290 that call fails too, `display-buffer' will use an existing window
4291 to display its buffer.
4293 The window selected at the time `display-buffer' was invoked is
4294 still selected when this function is called. Hence you can
4295 compare the window argument with the value of `selected-window'
4296 if you intend to split the selected window instead or if you do
4297 not want to split the selected window."
4303 "Minimum height for splitting windows sensibly.
4304 If this is an integer, `split-window-sensibly' may split a window
4305 vertically only if it has at least this many lines. If this is
4306 nil, `split-window-sensibly' is not allowed to split a window
4307 vertically. If, however, a window is the only window on its
4308 frame, `split-window-sensibly' may split it vertically
4309 disregarding the value of this variable."
4315 "Minimum width for splitting windows sensibly.
4316 If this is an integer, `split-window-sensibly' may split a window
4317 horizontally only if it has at least this many columns. If this
4318 is nil, `split-window-sensibly' is not allowed to split a window
4319 horizontally."
4325 "Return non-nil if `split-window-sensibly' may split WINDOW.
4326 Optional argument HORIZONTAL nil or omitted means check whether
4327 `split-window-sensibly' may split WINDOW vertically. HORIZONTAL
4328 non-nil means check whether WINDOW may be split horizontally.
4330 WINDOW may be split vertically when the following conditions
4331 hold:
4332 - `window-size-fixed' is either nil or equals `width' for the
4333 buffer of WINDOW.
4334 - `split-height-threshold' is an integer and WINDOW is at least as
4335 high as `split-height-threshold'.
4336 - When WINDOW is split evenly, the emanating windows are at least
4337 `window-min-height' lines tall and can accommodate at least one
4338 line plus - if WINDOW has one - a mode line.
4340 WINDOW may be split horizontally when the following conditions
4341 hold:
4342 - `window-size-fixed' is either nil or equals `height' for the
4343 buffer of WINDOW.
4344 - `split-width-threshold' is an integer and WINDOW is at least as
4345 wide as `split-width-threshold'.
4346 - When WINDOW is split evenly, the emanating windows are at least
4347 `window-min-width' or two (whichever is larger) columns wide."
4351 ;; A window can be split horizontally when its width is not
4352 ;; fixed, it is at least `split-width-threshold' columns wide
4353 ;; and at least twice as wide as `window-min-width' and 2 (the
4354 ;; latter value is hardcoded).
4356 ;; Testing `window-full-width-p' here hardly makes any
4357 ;; sense nowadays. This can be done more intuitively by
4358 ;; setting up `split-width-threshold' appropriately.
4363 ;; A window can be split vertically when its height is not
4364 ;; fixed, it is at least `split-height-threshold' lines high,
4365 ;; and it is at least twice as high as `window-min-height' and 2
4366 ;; if it has a modeline or 1.
4375 "Split WINDOW in a way suitable for `display-buffer'.
4376 If `split-height-threshold' specifies an integer, WINDOW is at
4377 least `split-height-threshold' lines tall and can be split
4378 vertically, split WINDOW into two windows one above the other and
4379 return the lower window. Otherwise, if `split-width-threshold'
4380 specifies an integer, WINDOW is at least `split-width-threshold'
4381 columns wide and can be split horizontally, split WINDOW into two
4382 windows side by side and return the window on the right. If this
4383 can't be done either and WINDOW is the only window on its frame,
4384 try to split WINDOW vertically disregarding any value specified
4385 by `split-height-threshold'. If that succeeds, return the lower
4386 window. Return nil otherwise.
4388 By default `display-buffer' routines call this function to split
4389 the largest or least recently used window. To change the default
4390 customize the option `split-window-preferred-function'.
4392 You can enforce this function to not split WINDOW horizontally,
4393 by setting \(or binding) the variable `split-width-threshold' to
4394 nil. If, in addition, you set `split-height-threshold' to zero,
4395 chances increase that this function does split WINDOW vertically.
4397 In order to not split WINDOW vertically, set \(or bind) the
4398 variable `split-height-threshold' to nil. Additionally, you can
4399 set `split-width-threshold' to zero to make a horizontal split
4400 more likely to occur.
4402 Have a look at the function `window-splittable-p' if you want to
4403 know how `split-window-sensibly' determines whether WINDOW can be
4404 split."
4406 ;; Split window vertically.
4410 ;; Split window horizontally.
4415 ;; If WINDOW is the only window on its frame and is not the
4416 ;; minibuffer window, try to split it vertically disregarding
4417 ;; the value of `split-height-threshold'.
4424 "Try to split WINDOW.
4425 Return value returned by `split-window-preferred-function' if it
4426 represents a live window, nil otherwise."
4430 ;; Since `split-window-preferred-function' might
4431 ;; throw an error use `condition-case'.
4438 "Return FRAME if it can be used to display a buffer."
4441 ;; `frame-root-window' may be an internal window which is considered
4442 ;; "dead" by `window-live-p'. Hence if `window' is not live we
4443 ;; implicitly know that `frame' has a visible window we can use.
4446 ;; If the window is soft-dedicated, the frame is usable.
4447 ;; Actually, even if the window is really dedicated,
4448 ;; the frame is still usable by splitting it.
4449 ;; At least Emacs-22 allowed it, and it is desirable
4450 ;; when displaying same-frame windows.
4451 nil ; (eq t (window-dedicated-p window))
4452 ))
4453 frame))))
4456 "If non-nil `display-buffer' will try to even window heights.
4457 Otherwise `display-buffer' will leave the window configuration
4458 alone. Heights are evened only when `display-buffer' chooses a
4459 window that appears above or below the selected window."
4464 "Even heights of WINDOW and selected window.
4465 Do this only if these windows are vertically adjacent to each
4466 other, `even-window-heights' is non-nil, and the selected window
4467 is higher than WINDOW."
4470 ;; Don't resize minibuffer windows.
4481 ;; Don't throw an error if we can't even window heights for
4482 ;; whatever reason.
4488 "Raise the frame containing WINDOW.
4489 Do not raise the selected frame. Return WINDOW."
4493 ;; Assume the selected frame is already visible enough.
4495 ;; Assume the frame from which we invoked the minibuffer
4496 ;; is visible.
4500 window))
4503 "Display BUFFER in WINDOW and make its frame visible.
4504 Set `window-dedicated-p' to DEDICATED if non-nil.
4505 Return WINDOW."
4513 "If non-nil, `display-buffer' marks the windows it creates as dedicated.
4514 The actual non-nil value of this variable will be copied to the
4518 "Normalize BUFFER-OR-NAME argument for buffer display functions.
4519 If BUFFER-OR-NAME is nil, return the curent buffer. Else, if a
4520 buffer specified by BUFFER-OR-NAME exists, return that buffer.
4521 If no such buffer exists, create a buffer with the name
4522 BUFFER-OR-NAME and return that buffer."
4527 buffer))
4544 ,display-buffer--action-function-custom-type
4549 :key-type symbol
4554 "Overriding action to perform to display a buffer.
4555 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4556 function or a list of functions. Each function should accept 2
4557 arguments: a buffer to display and an alist similar to ALIST.
4562 "Alist of conditional actions for `display-buffer'.
4563 This is a list of elements (CONDITION . ACTION), where:
4565 CONDITION is either a regexp matching buffer names, or a function
4566 that takes a buffer and returns a boolean.
4568 ACTION is a cons cell (FUNCTION . ALIST), where FUNCTION is a
4569 function or a list of functions. Each such function should
4570 accept 2 arguments: a buffer to display and an alist of the
4571 same form as ALIST. See `display-buffer' for details."
4574 regexp
4577 :risky t
4582 "User-specified default action for `display-buffer'.
4583 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4584 function or a list of functions. Each function should accept 2
4585 arguments: a buffer to display and an alist similar to ALIST.
4586 See `display-buffer' for details."
4587 :type display-buffer--action-custom-type
4588 :risky t
4594 display-buffer-reuse-window
4595 display-buffer--maybe-pop-up-frame-or-window
4596 display-buffer-use-some-window
4597 ;; If all else fails, pop up a new frame.
4598 display-buffer-pop-up-frame))
4599 "Default fallback action for `display-buffer'.
4600 This is the action used by `display-buffer' if no other actions
4601 specified, e.g. by the user options `display-buffer-alist' or
4606 "Retrieve ALIST entry corresponding to BUFFER-NAME."
4625 display-buffer-pop-up-frame)
4632 "Display BUFFER-OR-NAME in some window, without selecting it.
4633 BUFFER-OR-NAME must be a buffer or the name of an existing
4634 buffer. Return the window chosen for displaying BUFFER-OR-NAME,
4635 or nil if no such window is found.
4637 Optional argument ACTION should have the form (FUNCTION . ALIST).
4638 FUNCTION is either a function or a list of functions. Each such
4639 function is called with 2 arguments: the buffer to display and an
4640 alist. It should either display the buffer and return the
4641 window, or return nil if unable to display the buffer.
4643 The `display-buffer' function builds a function list and an alist
4644 from `display-buffer-overriding-action', `display-buffer-alist',
4645 the ACTION argument, `display-buffer-base-action', and
4646 `display-buffer-fallback-action' (in that order). Then it calls
4647 each function in the combined function list in turn, passing the
4648 buffer as the first argument and the combined alist as the second
4649 argument, until one of the functions returns non-nil.
4651 Available action functions include:
4652 `display-buffer-same-window'
4653 `display-buffer-reuse-window'
4654 `display-buffer-pop-up-frame'
4655 `display-buffer-pop-up-window'
4656 `display-buffer-use-some-window'
4658 Recognized alist entries include:
4660 `inhibit-same-window' -- A non-nil value prevents the same
4661 window from being used for display.
4663 `reusable-frames' -- Value specifies frame(s) to search for a
4664 window that already displays the buffer.
4665 See `display-buffer-reuse-window'.
4667 The ACTION argument to `display-buffer' can also have a non-nil
4668 and non-list value. This means to display the buffer in a window
4669 other than the selected one, even if it is already displayed in
4670 the selected window. If called interactively with a prefix
4671 argument, ACTION is t.
4673 Optional argument FRAME, if non-nil, acts like an additional
4674 ALIST entry (reusable-frames . FRAME), specifying the frame(s) to
4675 search for a window that is already displaying the buffer. See
4676 `display-buffer-reuse-window'."
4680 ;; Handle the old form of the first argument.
4684 ;; If `display-buffer-function' is defined, let it do the job.
4686 ;; Otherwise, use the defined actions.
4689 display-buffer-alist))
4691 ;; Extra actions from the arguments to this function:
4697 ;; Construct action function list and action alist.
4699 user-action special-action action extra-action
4700 display-buffer-base-action
4701 display-buffer-fallback-action))
4706 actions)))
4708 window)
4714 window))))
4717 "Display buffer BUFFER in another frame.
4718 This uses the function `display-buffer' as a subroutine; see
4719 its documentation for additional customization information."
4723 ;;; `display-buffer' action functions:
4726 "Display BUFFER in the selected window.
4727 This fails if ALIST has a non-nil `inhibit-same-window' entry, or
4728 if the selected window is a minibuffer window or is dedicated to
4729 another buffer; in that case, return nil. Otherwise, return the
4730 selected window."
4738 "Conditionally display BUFFER in the selected window.
4739 If `same-window-p' returns non-nil for BUFFER's name, call
4740 `display-buffer-same-window' and return its value. Otherwise,
4741 return nil."
4746 "Return a window that is already displaying BUFFER.
4747 Return nil if no usable window is found.
4749 If ALIST has a non-nil `inhibit-same-window' entry, the selected
4750 window is not eligible for reuse.
4752 If ALIST contains a `reusable-frames' entry, its value determines
4753 which frames to search for a reusable window:
4754 nil -- the selected frame (actually the last non-minibuffer frame)
4755 A frame -- just that frame
4756 `visible' -- all visible frames
4757 0 -- all frames on the current terminal
4758 t -- all frames.
4760 If ALIST contains no `reusable-frames' entry, search just the
4761 selected frame if `display-buffer-reuse-frames' and
4762 `pop-up-frames' are both nil; search all frames on the current
4763 terminal if either of those variables is non-nil."
4768 pop-up-frames)
4777 frames))))))
4783 "Try to display BUFFER using `special-display-function'.
4784 Call `special-display-p' on BUFFER's name, and if that returns
4785 non-nil, call `special-display-function' on BUFFER."
4787 ;; `special-display-p' returns either t or a list of frame
4788 ;; parameters to pass to `special-display-function'.
4797 "Display BUFFER in a new frame.
4798 This works by calling `pop-up-frame-function'. If successful,
4799 return the window used; otherwise return nil."
4801 frame window)
4807 ;; Reset list of WINDOW's previous buffers to nil.
4809 window)))
4812 "Display BUFFER by popping up a new window.
4813 The new window is created on the selected frame, or in
4814 `last-nonminibuffer-frame' if no windows can be created there.
4815 If sucessful, return the new window; otherwise return nil."
4818 window)
4820 ;; If the selected frame cannot be split, look at
4821 ;; `last-nonminibuffer-frame'.
4826 ;; Attempt to split largest or least recently used window.
4833 ;; Reset list of WINDOW's previous buffers to nil.
4835 window)))
4838 "Try displaying BUFFER based on `pop-up-frames' or `pop-up-windows'.
4840 If `pop-up-frames' is non-nil (and not `graphic-only' on a
4841 text-only terminal), try with `display-buffer-pop-up-frame'.
4843 If that cannot be done, and `pop-up-windows' is non-nil, try
4844 again with `display-buffer-pop-up-window'."
4847 pop-up-frames)
4853 "Display BUFFER in an existing window.
4854 Search for a usable window, set that window to the buffer, and
4855 return the window. If no suitable window is found, return nil."
4858 ;; When NOT-THIS-WINDOW is non-nil, temporarily dedicate the
4859 ;; selected window to its buffer, to prevent any of the
4860 ;; `get-' routines below from choosing it. (Bug#1415)
4866 window)
4869 ;; Reuse an existing window.
4874 window))
4879 window))
4882 ;; Restore dedicated status of selected window.
4889 ;;; Display + selection commands:
4892 "Select buffer BUFFER in some window, preferably a different one.
4893 BUFFER may be a buffer, a string (a buffer name), or nil. If it
4894 is a string not naming an existent buffer, create a buffer with
4895 that name. If BUFFER is nil, choose some other buffer. Return
4896 the buffer.
4898 This uses `display-buffer' as a subroutine. The optional ACTION
4899 argument is passed to `display-buffer' as its ACTION argument.
4900 See `display-buffer' for more information. ACTION is t if called
4901 interactively with a prefix argument, which means to pop to a
4902 window other than the selected one even if the buffer is already
4903 displayed in the selected window.
4905 If the window to show BUFFER is not on the selected
4906 frame, raise that window's frame and give it input focus.
4908 Optional third arg NORECORD non-nil means do not put this buffer
4909 at the front of the list of recently selected ones."
4918 ;; If we chose another frame, make sure it gets input focus.
4921 ;; Make sure new window is selected (Bug#8615), (Bug#6954).
4923 buffer))
4926 "Select buffer BUFFER in some window, preferably the same one.
4927 This function behaves much like `switch-to-buffer', except it
4928 displays with `special-display-function' if BUFFER has a match in
4929 `special-display-buffer-names' or `special-display-regexps'.
4931 Unlike `pop-to-buffer', this function prefers using the selected
4932 window over popping up a new window or frame.
4934 BUFFER may be a buffer, a string (a buffer name), or nil. If it
4935 is a string not naming an existent buffer, create a buffer with
4936 that name. If BUFFER is nil, choose some other buffer. Return
4937 the buffer.
4939 NORECORD, if non-nil means do not put this buffer at the front of
4940 the list of recently selected ones."
4944 norecord))
4947 "Read the name of a buffer to switch to, prompting with PROMPT.
4948 Return the neame of the buffer as a string.
4950 This function is intended for the `switch-to-buffer' family of
4951 commands since these need to omit the name of the current buffer
4952 from the list of completions and default values."
4957 ;; Since rbts-completion-table is built dynamically, we
4958 ;; can't just add it to the default value of
4959 ;; icomplete-with-completion-tables, so we add it
4960 ;; here manually.
4965 icomplete-with-completion-tables))))
4970 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
4971 If BUFFER-OR-NAME is nil, return the buffer returned by
4972 `other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
4973 exists, return that buffer. If no such buffer exists, create a
4974 buffer with the name BUFFER-OR-NAME and return that buffer."
4979 buffer))
4983 "Switch to buffer BUFFER-OR-NAME in the selected window.
4984 If called interactively, prompt for the buffer name using the
4985 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
4986 determines whether to request confirmation before creating a new
4987 buffer.
4989 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
4990 nil. If BUFFER-OR-NAME is a string that does not identify an
4991 existing buffer, create a buffer with that name. If
4992 BUFFER-OR-NAME is nil, switch to the buffer returned by
4993 `other-buffer'.
4995 Optional argument NORECORD non-nil means do not put the buffer
4996 specified by BUFFER-OR-NAME at the front of the buffer list and
4997 do not make the window displaying it the most recently selected
4998 one.
5000 If FORCE-SAME-WINDOW is non-nil, BUFFER-OR-NAME must be displayed
5001 in the selected window; signal an error if that is
5002 impossible (e.g. if the selected window is minibuffer-only). If
5003 nil, BUFFER-OR-NAME may be displayed in another window.
5005 Return the buffer switched to."
5012 ;; Don't call set-window-buffer if it's not needed since it
5013 ;; might signal an error (e.g. if the window is dedicated).
5026 "Select the buffer specified by BUFFER-OR-NAME in another window.
5027 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
5028 nil. Return the buffer switched to.
5030 If called interactively, prompt for the buffer name using the
5031 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5032 determines whether to request confirmation before creating a new
5033 buffer.
5035 If BUFFER-OR-NAME is a string and does not identify an existing
5036 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5037 nil, switch to the buffer returned by `other-buffer'.
5039 Optional second argument NORECORD non-nil means do not put this
5040 buffer at the front of the list of recently selected ones.
5042 This uses the function `display-buffer' as a subroutine; see its
5043 documentation for additional customization information."
5050 "Switch to buffer BUFFER-OR-NAME in another frame.
5051 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
5052 nil. Return the buffer switched to.
5054 If called interactively, prompt for the buffer name using the
5055 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5056 determines whether to request confirmation before creating a new
5057 buffer.
5059 If BUFFER-OR-NAME is a string and does not identify an existing
5060 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5061 nil, switch to the buffer returned by `other-buffer'.
5063 Optional second arg NORECORD non-nil means do not put this
5064 buffer at the front of the list of recently selected ones.
5066 This uses the function `display-buffer' as a subroutine; see its
5067 documentation for additional customization information."
5071 \f
5073 "Set the height in lines of the text display area of WINDOW to HEIGHT.
5074 WINDOW must be a live window. HEIGHT doesn't include the mode
5075 line or header line, if any, or any partial-height lines in the
5076 text display area.
5078 Note that the current implementation of this function cannot
5079 always set the height exactly, but attempts to be conservative,
5080 by allocating more lines than are actually needed in the case
5081 where some error may be present."
5085 ;; Setting window-min-height to a value like 1 can lead to very
5086 ;; bizarre displays because it also allows Emacs to make *other*
5087 ;; windows 1-line tall, which means that there's no more space for
5088 ;; the modeline.
5093 "Make selected window DELTA columns wider.
5094 Interactively, if no argument is given, make selected window one
5095 column wider."
5100 "Make selected window DELTA columns narrower.
5101 Interactively, if no argument is given, make selected window one
5102 column narrower."
5107 "Return the number of screen lines in the region.
5108 The number of screen lines may be different from the number of actual lines,
5109 due to line breaking, display table, etc.
5111 Optional arguments BEG and END default to `point-min' and `point-max'
5112 respectively.
5114 If region ends with a newline, ignore it unless optional third argument
5115 COUNT-FINAL-NEWLINE is non-nil.
5117 The optional fourth argument WINDOW specifies the window used for obtaining
5118 parameters such as width, horizontal scrolling, and so on. The default is
5119 to use the selected window's parameters.
5121 Like `vertical-motion', `count-screen-lines' always uses the current buffer,
5122 regardless of which buffer is displayed in WINDOW. This makes possible to use
5123 `count-screen-lines' in any buffer, whether or not it is currently displayed
5124 in some window."
5130 0
5143 "Return the height (in screen lines) of the buffer that WINDOW is displaying."
5147 ;; If buffer ends with a newline, ignore it when
5148 ;; counting height unless point is after it.
5150 window))))
5152 ;;; Resizing buffers to fit their contents exactly.
5154 "Adjust height of WINDOW to display its buffer's contents exactly.
5155 WINDOW can be any live window and defaults to the selected one.
5157 Optional argument MAX-HEIGHT specifies the maximum height of
5158 WINDOW and defaults to the height of WINDOW's frame. Optional
5159 argument MIN-HEIGHT specifies the minimum height of WINDOW and
5160 defaults to `window-min-height'. Both, MAX-HEIGHT and MIN-HEIGHT
5161 are specified in lines and include the mode line and header line,
5162 if any.
5164 Optional argument OVERRIDE non-nil means override restrictions
5165 imposed by `window-min-height' and `window-min-width' on the size
5166 of WINDOW.
5168 Return the number of lines by which WINDOW was enlarged or
5169 shrunk. If an error occurs during resizing, return nil but don't
5170 signal an error.
5172 Note that even if this function makes WINDOW large enough to show
5173 _all_ lines of its buffer you might not see the first lines when
5174 WINDOW was scrolled."
5176 ;; Do all the work in WINDOW and its buffer and restore the selected
5177 ;; window and the current buffer when we're done.
5179 ;; Can't resize a full height or fixed-size window.
5182 ;; `with-selected-window' should orderly restore the current buffer.
5184 ;; We are in WINDOW's buffer now.
5190 window-safe-min-height)))
5193 ;; Adjust MAX-HEIGHT.
5196 max-window-height
5198 ;; Make `desired-height' the height necessary to show
5199 ;; all of WINDOW's buffer, constrained by MIN-HEIGHT
5200 ;; and MAX-HEIGHT.
5205 ;; For non-minibuffers count the mode line, if any.
5207 mode-line-format)
5208 1
5210 ;; Count the header line, if any.
5212 max-height)
5213 min-height))
5222 ;; This `condition-case' shouldn't be necessary, but who knows?
5225 ;; Return zero if DELTA became zero in the proces.
5226 0
5227 ;; Don't try to redisplay with the cursor at the end on its
5228 ;; own line--that would force a scroll and spoil things.
5230 ;; It's silly to put `point' at the end of the previous
5231 ;; line and so maybe force horizontal scrolling.
5233 ;; Call `window-resize' with OVERRIDE argument equal WINDOW.
5235 ;; Check if the last line is surely fully visible. If
5236 ;; not, enlarge the window.
5240 ;; Don't include final newline.
5243 ;; If line-wrapping is turned off, test the
5244 ;; beginning of the last line for
5245 ;; visibility instead of the end, as the
5246 ;; end of the line could be invisible by
5247 ;; virtue of extending past the edge of the
5248 ;; window.
5252 ;; This loop might in some rare pathological cases raise
5253 ;; an error - another reason for the `condition-case'.
5260 delta))))
5263 "Return t if WINDOW can be shrunk without shrinking other windows.
5264 WINDOW defaults to the selected window."
5271 "Shrink height of WINDOW if its buffer doesn't need so many lines.
5272 More precisely, shrink WINDOW vertically to be as small as
5273 possible, while still showing the full contents of its buffer.
5274 WINDOW defaults to the selected window.
5276 Do not shrink WINDOW to less than `window-min-height' lines. Do
5277 nothing if the buffer contains more lines than the present window
5278 height, or if some of the window's contents are scrolled out of
5279 view, or if shrinking this window would also shrink another
5280 window, or if the window is the only window of its frame.
5282 Return non-nil if the window was shrunk, nil otherwise."
5285 ;; Make sure that WINDOW is vertically combined and `point-min' is
5286 ;; visible (for whatever reason that's needed). The remaining issues
5287 ;; should be taken care of by `fit-window-to-buffer'.
5291 \f
5293 "Kill the current buffer and delete the selected window."
5302 ;; If `delete-window' failed before, we rerun it to regenerate
5303 ;; the error so it can be seen in the echo area.
5306 ;; If the buffer is not dead for some reason (probably because
5307 ;; of a `quit' signal), remove the hook again.
5312 \f
5314 "Indicates the last recenter operation performed.
5318 "Cycling order for `recenter-top-bottom'.
5319 A list of elements with possible values `top', `middle', `bottom',
5320 integer or float numbers that define the cycling order for
5321 the command `recenter-top-bottom'.
5323 Top and bottom destinations are `scroll-margin' lines the from true
5324 window top and bottom. Middle redraws the frame and centers point
5325 vertically within the window. Integer number moves current line to
5326 the specified absolute window-line. Float number between 0.0 and 1.0
5327 means the percentage of the screen space from the top. The default
5328 cycling order is middle -> top -> bottom."
5339 "Move current buffer line to the specified window line.
5340 With no prefix argument, successive calls place point according
5341 to the cycling order defined by `recenter-positions'.
5343 A prefix argument is handled like `recenter':
5344 With numeric prefix ARG, move current line to window-line ARG.
5345 With plain `C-u', move current line to window center."
5353 recenter-positions))
5372 "Position point relative to window.
5374 With a prefix argument ARG, acts like `move-to-window-line'.
5376 With no argument, positions point at center of window.
5377 Successive calls position point at positions defined
5378 by `recenter-positions'."
5386 recenter-positions))
5403 \f
5404 ;;; Scrolling commands.
5406 ;;; Scrolling commands which do not signal errors at top/bottom
5407 ;;; of buffer at first key-press (instead move to top/bottom
5408 ;;; of buffer).
5411 "Move point to top/bottom of buffer before signalling a scrolling error.
5412 A value of nil means just signal an error if no more scrolling possible.
5413 A value of t means point moves to the beginning or the end of the buffer
5414 \(depending on scrolling direction) when no more scrolling possible.
5415 When point is already on that position, then signal an error."
5421 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
5422 If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
5423 scroll window further, move cursor to the bottom line.
5424 When point is already on that position, then signal an error.
5425 A near full screen is `next-screen-context-lines' less than a full screen.
5426 Negative ARG means scroll downward.
5427 If ARG is the atom `-', scroll downward by nearly full screen."
5443 ;; When scrolling by ARG lines can't be done,
5444 ;; move by ARG lines instead.
5446 ;; When ARG is nil for full-screen scrolling,
5447 ;; move to the bottom of the buffer.
5453 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
5454 If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
5455 scroll window further, move cursor to the top line.
5456 When point is already on that position, then signal an error.
5457 A near full screen is `next-screen-context-lines' less than a full screen.
5458 Negative ARG means scroll upward.
5459 If ARG is the atom `-', scroll upward by nearly full screen."
5475 ;; When scrolling by ARG lines can't be done,
5476 ;; move by ARG lines instead.
5478 ;; When ARG is nil for full-screen scrolling,
5479 ;; move to the top of the buffer.
5484 ;;; Scrolling commands which scroll a line instead of full screen.
5487 "Scroll text of selected window upward ARG lines; or one line if no ARG.
5488 If ARG is omitted or nil, scroll upward by one line.
5489 This is different from `scroll-up-command' that scrolls a full screen."
5496 "Scroll text of selected window down ARG lines; or one line if no ARG.
5497 If ARG is omitted or nil, scroll down by one line.
5498 This is different from `scroll-down-command' that scrolls a full screen."
5504 \f
5507 For more details, see the documentation for `scroll-other-window'."
5510 ;; Just invert the argument's meaning.
5511 ;; We can do that without knowing which window it will be.
5517 "Move point to the beginning of the buffer in the other window.
5518 Leave mark at previous position.
5519 With arg N, put point N/10 of the way from the true beginning."
5523 ;; We use unwind-protect rather than save-window-excursion
5524 ;; because the latter would preserve the things we want to change.
5528 ;; Set point and mark in that window's buffer.
5531 ;; Set point accordingly.
5536 "Move point to the end of the buffer in the other window.
5537 Leave mark at previous position.
5538 With arg N, put point N/10 of the way from the true end."
5540 ;; See beginning-of-buffer-other-window for comments.
5550 \f
5561 "When non-nil, special state of delayed window autoselection.
5562 Possible values are `suspend' \(suspend autoselection after a menu or
5563 scrollbar interaction\) and `select' \(the next invocation of
5567 "Cancel delayed window autoselection.
5568 Optional argument FORCE means cancel unconditionally."
5570 ;; Don't cancel for select-window or select-frame events
5571 ;; or when the user drags a scroll bar.
5583 "Start delayed window autoselection.
5584 MOUSE-POSITION is the last position where the mouse was seen as returned
5585 by `mouse-position'. Optional argument WINDOW non-nil denotes the
5586 window where the mouse was seen. Optional argument SUSPEND non-nil
5587 means suspend autoselection."
5588 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
5592 ;; Install timer which runs `mouse-autoselect-window-select' after
5593 ;; `mouse-autoselect-window' seconds.
5599 "Select window with delayed window autoselection.
5600 If the mouse position has stabilized in a non-selected window, select
5601 that window. The minibuffer window is selected only if the minibuffer is
5602 active. This function is run by `mouse-autoselect-window-timer'."
5613 ;; A menu / popup dialog is active or the mouse is on the scroll-bar
5614 ;; of WINDOW, temporarily suspend delayed autoselection.
5617 ;; Delayed autoselection was temporarily suspended, reenable it.
5622 ;; If `mouse-autoselect-window' is positive, select
5623 ;; window if the window is the same as before.
5625 ;; Otherwise select window if the mouse is at the same
5626 ;; position as before. Observe that the first test after
5627 ;; starting autoselection usually fails since the value of
5628 ;; `mouse-autoselect-window-position' recorded there is the
5629 ;; position where the mouse has entered the new window and
5630 ;; not necessarily where the mouse has stopped moving.
5632 ;; The minibuffer is a candidate window if it's active.
5635 ;; Mouse position has stabilized in non-selected window: Cancel
5636 ;; delayed autoselection and try to select that window.
5638 ;; Select window where mouse appears unless the selected window is the
5639 ;; minibuffer. Use `unread-command-events' in order to execute pre-
5640 ;; and post-command hooks and trigger idle timers. To avoid delaying
5641 ;; autoselection again, set `mouse-autoselect-window-state'."
5646 unread-command-events))))
5650 ;; Mouse position has either stabilized in the selected window or at
5651 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
5654 ;; Mouse position has not stabilized yet, resume delayed
5655 ;; autoselection.
5659 "Handle select-window events."
5663 ;; Don't switch if we're currently in the minibuffer.
5664 ;; This tries to work around problems where the
5665 ;; minibuffer gets unselected unexpectedly, and where
5666 ;; you then have to move your mouse all the way down to
5667 ;; the minibuffer to select it.
5669 ;; Don't switch to minibuffer window unless it's active.
5672 ;; Don't switch when autoselection shall be delayed.
5677 ;; Cancel any delayed autoselection.
5679 ;; Start delayed autoselection from current mouse
5680 ;; position and window.
5682 ;; Executing a command cancels delayed autoselection.
5686 ;; Reset state of delayed autoselection.
5688 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
5693 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
5694 WINDOW defaults to the selected window.
5695 Return nil if WINDOW is not a partial-width window
5696 (regardless of the value of `truncate-lines').
5697 Otherwise, consult the value of `truncate-partial-width-windows'
5698 for the buffer shown in WINDOW."
5706 t-p-w-w))))
5707 \f
5708 ;; Some of these are in tutorial--default-keys, so update that if you
5709 ;; change these.
5722 ;;; window.el ends here