| blob | c9bddba942c6435693ad935cfdb0ac3ca0a84db8 |
1 ;;; window.el --- GNU Emacs window commands aside from those written in C
3 ;; Copyright (C) 1985, 1989, 1992-1994, 2000-2012
4 ;; Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: internal
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; Window tree functions.
29 ;;; Code:
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, explicitly 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, explicitly 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 FUN on each live window of FRAME.
269 FUN 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 FUN 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 FUN changes the window tree, the result is
276 unpredictable."
282 "Run function FUN on the subtree of windows rooted at WINDOW.
283 WINDOW defaults to the selected window. FUN must be a function
284 with one argument - a window. By default, run FUN only on live
285 windows of the subtree. If the optional argument ANY is non-nil,
286 run FUN on all live and internal windows of the subtree. If
287 WINDOW is live, run FUN on WINDOW only.
289 This function performs a pre-order, depth-first traversal of the
290 subtree rooted at WINDOW. If FUN changes that tree, the result
291 is unpredictable."
296 "Return first window on FRAME with PARAMETER non-nil.
297 FRAME defaults to the selected frame. Optional argument VALUE
298 non-nil means only return a window whose window-parameter value
299 for PARAMETER equals VALUE (comparison is done with `equal').
300 Optional argument ANY non-nil means consider internal windows
301 too."
309 frame any))))
311 ;;; Atomic windows.
313 "Return root of atomic window WINDOW is a part of.
314 WINDOW can be any window and defaults to the selected one.
315 Return nil if WINDOW is not part of an atomic window."
321 root))
324 "Make WINDOW an atomic window.
325 WINDOW must be an internal window. Return WINDOW."
331 window t)
332 window))
335 "Subroutine of `window--atom-check'."
345 window t))
346 ;; count >= 1 must hold here. If there's no other
347 ;; window around dissolve this atomic window.
349 ;; Dissolve atomic window.
353 window t)))
354 ;; Check children.
358 ;; Check right sibling
362 "Check atomicity of all windows on FRAME.
363 FRAME defaults to the selected frame. If an atomic window is
364 wrongly configured, reset the atomicity of all its windows on
365 FRAME to nil. An atomic window is wrongly configured if it has
366 no child windows or one of its child windows is not atomic."
369 ;; Side windows.
374 "If non-nil, left and right side windows are full height.
375 Otherwise, top and bottom side windows are full width."
381 "Maximum number of side window slots.
382 The value is a list of four elements specifying the number of
383 side window slots on (in this order) the left, top, right and
384 bottom side of each frame. If an element is a number, this means
385 to display at most that many side windows on the corresponding
386 side. If an element is nil, this means there's no bound on the
387 number of slots on that side."
388 :risky t
389 :type
395 :value nil
402 :value nil
409 :value nil
416 :value nil
423 "Check the window-side parameter of all windows on FRAME.
424 FRAME defaults to the selected frame. If the configuration is
425 invalid, reset all window-side parameters to nil.
427 A valid configuration has to preserve the following invariant:
429 - If a window has a non-nil window-side parameter, it must have a
430 parent window and the parent window's window-side parameter
431 must be either nil or the same as for window.
433 - If windows with non-nil window-side parameters exist, there
434 must be at most one window of each side and non-side with a
435 parent whose window-side parameter is nil and there must be no
436 leaf window whose window-side parameter is nil."
438 side parent parent-side)
446 ;; The following `cond' seems a bit tedious, but I'd
447 ;; rather stick to using just the stack.
451 ;; A parent whose window-side is non-nil must
452 ;; have a child with the same window-side.
454 ;; Now check that there's more than one main window
455 ;; for any of none, left, top, right and bottom.
477 ;; A leaf window without window-side parameter,
478 ;; record its existence.
480 frame t))
482 ;; At least one non-side window exists, so there must
483 ;; be at least one side-window and no normal window.
485 ;; No non-side window exists, so there must be no side
486 ;; window either.
491 frame t))))
494 "Check atomic and side windows on FRAME.
495 FRAME defaults to the selected frame."
499 ;;; Window sizes.
501 "Non-nil in a buffer means windows displaying the buffer are fixed-size.
502 If the value is `height', then only the window's height is fixed.
503 If the value is `width', then only the window's width is fixed.
504 Any other non-nil value fixes both the width and the height.
506 Emacs won't change the size of any window displaying that buffer,
507 unless it has no other choice (like when deleting a neighboring
512 "Return non-nil if IGNORE says to ignore size restrictions for WINDOW."
516 "Return the minimum number of lines of WINDOW.
517 WINDOW can be an arbitrary window and defaults to the selected
518 one. Optional argument HORIZONTAL non-nil means return the
519 minimum number of columns of WINDOW.
521 Optional argument IGNORE non-nil means ignore any restrictions
522 imposed by fixed size windows, `window-min-height' or
523 `window-min-width' settings. IGNORE equal `safe' means live
524 windows may get as small as `window-safe-min-height' lines and
525 `window-safe-min-width' columns. IGNORE a window means ignore
526 restrictions for that window only."
531 "Internal function of `window-min-size'."
535 ;; WINDOW is an internal window.
537 ;; The minimum size of an iso-combination is the sum of
538 ;; the minimum sizes of its child windows.
543 ;; The minimum size of an ortho-combination is the maximum of
544 ;; the minimum sizes of its child windows.
549 value)
554 ;; The minimum size of a fixed size window is its size.
557 ;; If IGNORE equals `safe' or WINDOW return the safe values.
560 ;; For the minimum width of a window take fringes and
561 ;; scroll-bars into account. This is questionable and should
562 ;; be removed as soon as we are able to split (and resize)
563 ;; windows such that the new (or resized) windows can get a
564 ;; size less than the user-specified `window-min-height' and
565 ;; `window-min-width'.
570 (+ window-safe-min-width
583 window-min-width
586 ;; For the minimum height of a window take any mode- or
587 ;; header-line into account.
593 window-min-height
597 "Return DELTA if DELTA lines can be added to WINDOW.
598 Optional argument HORIZONTAL non-nil means return DELTA if DELTA
599 columns can be added to WINDOW. A return value of zero means
600 that no lines (or columns) can be added to WINDOW.
602 This function looks only at WINDOW and, recursively, its child
603 windows. The function `window-resizable' looks at other windows
604 as well.
606 DELTA positive means WINDOW shall be enlarged by DELTA lines or
607 columns. If WINDOW cannot be enlarged by DELTA lines or columns
608 return the maximum value in the range 0..DELTA by which WINDOW
609 can be enlarged.
611 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
612 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
613 return the minimum value in the range DELTA..0 by which WINDOW
614 can be shrunk.
616 Optional argument IGNORE non-nil means ignore any restrictions
617 imposed by fixed size windows, `window-min-height' or
618 `window-min-width' settings. IGNORE equal `safe' means live
619 windows may get as small as `window-safe-min-height' lines and
620 `window-safe-min-width' columns. IGNORE any window means ignore
621 restrictions for that window only."
627 delta))
629 delta)
632 0
633 delta))
637 "Return t if WINDOW can be resized by DELTA lines.
638 For the meaning of the arguments of this function see the
639 doc-string of `window-sizable'."
646 "Internal function for `window-size-fixed-p'."
650 ;; WINDOW is an internal window.
652 ;; An iso-combination is fixed size if all its child
653 ;; windows are fixed-size.
657 ;; We found a non-fixed-size child window, so
658 ;; WINDOW's size is not fixed.
661 ;; All child windows are fixed-size, so WINDOW's size is
662 ;; fixed.
664 ;; An ortho-combination is fixed-size if at least one of its
665 ;; child windows is fixed-size.
668 ;; We found a fixed-size child window, so WINDOW's size
669 ;; is fixed.
672 ;; WINDOW is a live window.
679 "Return non-nil if WINDOW's height is fixed.
680 WINDOW can be an arbitrary window and defaults to the selected
681 window. Optional argument HORIZONTAL non-nil means return
682 non-nil if WINDOW's width is fixed.
684 If this function returns nil, this does not necessarily mean that
685 WINDOW can be resized in the desired direction. The function
686 `window-resizable' can tell that."
691 "Internal function for `window-min-delta'."
693 ;; If we can't go up, return zero.
694 0
695 ;; Else try to find a non-fixed-size sibling of WINDOW.
700 ;; In an iso-combination throw DELTA if we find at least one
701 ;; child window and that window is either not fixed-size or
702 ;; we can ignore fixed-sizeness.
712 ;; We found a non-fixed-size child window.
715 ;; In an ortho-combination set DELTA to the minimum value by
716 ;; which other child windows can shrink.
725 delta
729 "Return number of lines by which WINDOW can be shrunk.
730 WINDOW can be an arbitrary window and defaults to the selected
731 window. Return zero if WINDOW cannot be shrunk.
733 Optional argument HORIZONTAL non-nil means return number of
734 columns by which WINDOW can be shrunk.
736 Optional argument IGNORE non-nil means ignore any restrictions
737 imposed by fixed size windows, `window-min-height' or
738 `window-min-width' settings. IGNORE a window means ignore
739 restrictions for that window only. IGNORE equal `safe' means
740 live windows may get as small as `window-safe-min-height' lines
741 and `window-safe-min-width' columns.
743 Optional argument TRAIL `before' means only windows to the left
744 of or above WINDOW can be enlarged. Optional argument TRAIL
745 `after' means only windows to the right of or below WINDOW can be
746 enlarged.
748 Optional argument NOUP non-nil means don't go up in the window
749 tree but try to enlarge windows within WINDOW's combination only.
751 Optional argument NODOWN non-nil means don't check whether WINDOW
752 itself (and its child windows) can be shrunk; check only whether
753 at least one other window can be enlarged appropriately."
759 ;; If NODOWN is t, try to recover the entire size of WINDOW.
762 ;; If NODOWN is nil and WINDOW's size is already at its minimum,
763 ;; there's nothing to recover.
766 ;; Otherwise, try to recover whatever WINDOW is larger than its
767 ;; minimum size.
772 "Internal function of `window-max-delta'."
774 ;; Can't go up. Return DELTA.
775 delta
780 ;; For an iso-combination calculate how much we can get from
781 ;; other child windows.
790 (+ delta
794 ;; For an ortho-combination throw DELTA when at least one
795 ;; child window is fixed-size.
803 ;; When NOUP is nil, DELTA is all we can get.
804 delta
805 ;; Else try with parent of WINDOW, passing the DELTA we
806 ;; recovered so far.
810 "Return maximum number of lines WINDOW by which WINDOW can be enlarged.
811 WINDOW can be an arbitrary window and defaults to the selected
812 window. The return value is zero if WINDOW cannot be enlarged.
814 Optional argument HORIZONTAL non-nil means return maximum number
815 of columns by which WINDOW can be enlarged.
817 Optional argument IGNORE non-nil means ignore any restrictions
818 imposed by fixed size windows, `window-min-height' or
819 `window-min-width' settings. IGNORE a window means ignore
820 restrictions for that window only. IGNORE equal `safe' means
821 live windows may get as small as `window-safe-min-height' lines
822 and `window-safe-min-width' columns.
824 Optional argument TRAIL `before' means only windows to the left
825 of or below WINDOW can be shrunk. Optional argument TRAIL
826 `after' means only windows to the right of or above WINDOW can be
827 shrunk.
829 Optional argument NOUP non-nil means don't go up in the window
830 tree but try to obtain the entire space from windows within
831 WINDOW's combination.
833 Optional argument NODOWN non-nil means do not check whether
834 WINDOW itself (and its child windows) can be enlarged; check
835 only whether other windows can be shrunk appropriately."
839 ;; With IGNORE and NOWDON nil return zero if WINDOW has fixed
840 ;; size.
841 0
842 ;; WINDOW has no fixed size.
845 ;; Make NOUP also inhibit the min-size check.
847 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
848 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
849 can be resized horizontally by DELTA columns. A return value of
850 zero means that WINDOW is not resizable.
852 DELTA positive means WINDOW shall be enlarged by DELTA lines or
853 columns. If WINDOW cannot be enlarged by DELTA lines or columns,
854 return the maximum value in the range 0..DELTA by which WINDOW
855 can be enlarged.
857 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
858 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
859 return the minimum value in the range DELTA..0 that can be used
860 for shrinking WINDOW.
862 Optional argument IGNORE non-nil means ignore any restrictions
863 imposed by fixed size windows, `window-min-height' or
864 `window-min-width' settings. IGNORE a window means ignore
865 restrictions for that window only. IGNORE equal `safe' means
866 live windows may get as small as `window-safe-min-height' lines
867 and `window-safe-min-width' columns.
869 Optional argument TRAIL `before' means only windows to the left
870 of or below WINDOW can be shrunk. Optional argument TRAIL
871 `after' means only windows to the right of or above WINDOW can be
872 shrunk.
874 Optional argument NOUP non-nil means don't go up in the window
875 tree but check only whether space can be obtained from (or given
876 to) WINDOW's siblings.
878 Optional argument NODOWN non-nil means don't go down in the
879 window tree. This means do not check whether resizing would
880 violate size restrictions of WINDOW or its child windows."
885 delta))
888 delta))
892 "Return t if WINDOW can be resized vertically by DELTA lines.
893 For the meaning of the arguments of this function see the
894 doc-string of `window--resizable'."
898 delta)
900 delta)))
903 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
904 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
905 can be resized horizontally by DELTA columns. A return value of
906 zero means that WINDOW is not resizable.
908 DELTA positive means WINDOW shall be enlarged by DELTA lines or
909 columns. If WINDOW cannot be enlarged by DELTA lines or columns
910 return the maximum value in the range 0..DELTA by which WINDOW
911 can be enlarged.
913 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
914 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
915 return the minimum value in the range DELTA..0 that can be used
916 for shrinking WINDOW.
918 Optional argument IGNORE non-nil means ignore any restrictions
919 imposed by fixed size windows, `window-min-height' or
920 `window-min-width' settings. IGNORE a window means ignore
921 restrictions for that window only. IGNORE equal `safe' means
922 live windows may get as small as `window-safe-min-height' lines
923 and `window-safe-min-width' columns."
928 "Return the total height or width of window WINDOW.
929 If WINDOW is omitted or nil, it defaults to the selected window.
931 If HORIZONTAL is omitted or nil, return the total height of
932 WINDOW, in lines, like `window-total-height'. Otherwise return
933 the total width, in columns, like `window-total-width'."
938 ;; Eventually we should make `window-height' obsolete.
941 ;; See discussion in bug#4543.
943 "Return t if WINDOW is as high as the containing frame.
944 More precisely, return t if and only if the total height of
945 WINDOW equals the total height of the root window of WINDOW's
946 frame. WINDOW can be any window and defaults to the selected
947 one."
953 "Return t if WINDOW is as wide as the containing frame.
954 More precisely, return t if and only if the total width of WINDOW
955 equals the total width of the root window of WINDOW's frame.
956 WINDOW can be any window and defaults to the selected one."
962 "Return the height or width of WINDOW's text area.
963 If WINDOW is omitted or nil, it defaults to the selected window.
964 Signal an error if the window is not live.
966 If HORIZONTAL is omitted or nil, return the height of the text
967 area, like `window-body-height'. Otherwise, return the width of
968 the text area, like `window-body-width'."
973 ;; Eventually we should make `window-height' obsolete.
977 "Return the current scroll bar settings for WINDOW.
978 WINDOW must be a live window and defaults to the selected one.
980 The return value is a cons cell (VERTICAL . HORIZONTAL) where
981 VERTICAL specifies the current location of the vertical scroll
982 bars (`left', `right', or nil), and HORIZONTAL specifies the
983 current location of the horizontal scroll bars (`top', `bottom',
984 or nil).
986 Unlike `window-scroll-bars', this function reports the scroll bar
987 type actually used, once frame defaults and `scroll-bar-mode' are
988 taken into account."
1001 "Cycle through all live windows, calling FUN for each one.
1002 FUN must specify a function with a window as its sole argument.
1003 The optional arguments MINIBUF and ALL-FRAMES specify the set of
1004 windows to include in the walk.
1006 MINIBUF t means include the minibuffer window even if the
1007 minibuffer is not active. MINIBUF nil or omitted means include
1008 the minibuffer window only if the minibuffer is active. Any
1009 other value means do not include the minibuffer window even if
1010 the minibuffer is active.
1012 ALL-FRAMES nil or omitted means consider all windows on the
1013 selected frame, plus the minibuffer window if specified by the
1014 MINIBUF argument. If the minibuffer counts, consider all windows
1015 on all frames that share that minibuffer too. The following
1016 non-nil values of ALL-FRAMES have special meanings:
1018 - t means consider all windows on all existing frames.
1020 - `visible' means consider all windows on all visible frames on
1021 the current terminal.
1023 - 0 (the number zero) means consider all windows on all visible
1024 and iconified frames on the current terminal.
1026 - A frame means consider all windows on that frame only.
1028 Anything else means consider all windows on the selected frame
1029 and no others.
1031 This function changes neither the order of recently selected
1032 windows nor the buffer list."
1033 ;; If we start from the minibuffer window, don't fail to come
1034 ;; back to it.
1037 ;; Make sure to not mess up the order of recently selected
1038 ;; windows. Use `save-selected-window' and `select-window'
1039 ;; with second argument non-nil for this purpose.
1047 "Return value of WINDOW's point.
1048 WINDOW can be any live window and defaults to the selected one.
1050 This function is like `window-point' with one exception: If
1051 WINDOW is selected, it returns the value of `point' of WINDOW's
1052 buffer regardless of whether that buffer is current or not."
1060 "Set value of WINDOW's point to POS.
1061 WINDOW can be any live window and defaults to the selected one.
1063 This function is like `set-window-point' with one exception: If
1064 WINDOW is selected, it moves `point' of WINDOW's buffer to POS
1065 regardless of whether that buffer is current or not."
1073 "Return t if WINDOW is at SIDE of its containing frame.
1074 WINDOW can be any window and defaults to the selected one. SIDE
1075 can be any of the symbols `left', `top', `right' or `bottom'.
1076 The default value nil is handled like `bottom'."
1088 "Return list of all windows on SIDE of FRAME.
1089 FRAME must be a live frame and defaults to the selected frame.
1090 SIDE can be any of the symbols `left', `top', `right' or
1091 `bottom'. The default value nil is handled like `bottom'."
1098 frame)
1102 "Support function for `window-in-direction'."
1114 "Return window in DIRECTION as seen from WINDOW.
1115 DIRECTION must be one of `above', `below', `left' or `right'.
1116 WINDOW must be a live window and defaults to the selected one.
1117 IGNORE, when non-nil means a window can be returned even if its
1118 `no-other-window' parameter is non-nil."
1131 ;; The column / row value of `posn-at-point' can be nil for the
1132 ;; mini-window, guard against that.
1143 best best-2 best-diff-2-new)
1150 ;; Ignore ourselves.
1152 ;; Ignore W unless IGNORE is non-nil.
1158 ;; W is to the left or right of WINDOW and covers POSN.
1168 ;; W is to the left or right of WINDOW but does not
1169 ;; cover POSN.
1184 ;; W is above or below WINDOW and covers POSN.
1194 ;; W is above or below WINDOW but does not cover POSN.
1209 "Return a live window satisfying PREDICATE.
1210 More precisely, cycle through all windows calling the function
1211 PREDICATE on each one of them with the window as its sole
1212 argument. Return the first window for which PREDICATE returns
1213 non-nil. Windows are scanned starting with the window following
1214 the selected window. If no window satisfies PREDICATE, return
1215 DEFAULT.
1217 MINIBUF t means include the minibuffer window even if the
1218 minibuffer is not active. MINIBUF nil or omitted means include
1219 the minibuffer window only if the minibuffer is active. Any
1220 other value means do not include the minibuffer window even if
1221 the minibuffer is active.
1223 ALL-FRAMES nil or omitted means consider all windows on the selected
1224 frame, plus the minibuffer window if specified by the MINIBUF
1225 argument. If the minibuffer counts, consider all windows on all
1226 frames that share that minibuffer too. The following non-nil
1227 values of ALL-FRAMES have special meanings:
1229 - t means consider all windows on all existing frames.
1231 - `visible' means consider all windows on all visible frames on
1232 the current terminal.
1234 - 0 (the number zero) means consider all windows on all visible
1235 and iconified frames on the current terminal.
1237 - A frame means consider all windows on that frame only.
1239 Anything else means consider all windows on the selected frame
1240 and no others."
1244 minibuf all-frames))
1247 default))
1252 "Return the least recently used window on frames specified by ALL-FRAMES.
1253 Return a full-width window if possible. A minibuffer window is
1254 never a candidate. A dedicated window is never a candidate
1255 unless DEDICATED is non-nil, so if all windows are dedicated, the
1256 value is nil. Avoid returning the selected window if possible.
1258 The following non-nil values of the optional argument ALL-FRAMES
1259 have special meanings:
1261 - t means consider all windows on all existing frames.
1263 - `visible' means consider all windows on all visible frames on
1264 the current terminal.
1266 - 0 (the number zero) means consider all windows on all visible
1267 and iconified frames on the current terminal.
1269 - A frame means consider all windows on that frame only.
1271 Any other value of ALL-FRAMES means consider all windows on the
1272 selected frame and no others."
1288 "Return the most recently used window on frames specified by ALL-FRAMES.
1289 Do not return a minibuffer window.
1291 The following non-nil values of the optional argument ALL-FRAMES
1292 have special meanings:
1294 - t means consider all windows on all existing frames.
1296 - `visible' means consider all windows on all visible frames on
1297 the current terminal.
1299 - 0 (the number zero) means consider all windows on all visible
1300 and iconified frames on the current terminal.
1302 - A frame means consider all windows on that frame only.
1304 Any other value of ALL-FRAMES means consider all windows on the
1305 selected frame and no others."
1312 best-window))
1315 "Return the largest window on frames specified by ALL-FRAMES.
1316 A minibuffer window is never a candidate. A dedicated window is
1317 never a candidate unless DEDICATED is non-nil, so if all windows
1318 are dedicated, the value is nil.
1320 The following non-nil values of the optional argument ALL-FRAMES
1321 have special meanings:
1323 - t means consider all windows on all existing frames.
1325 - `visible' means consider all windows on all visible frames on
1326 the current terminal.
1328 - 0 (the number zero) means consider all windows on all visible
1329 and iconified frames on the current terminal.
1331 - A frame means consider all windows on that frame only.
1333 Any other value of ALL-FRAMES means consider all windows on the
1334 selected frame and no others."
1336 best-window size)
1344 best-window))
1347 "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
1348 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
1349 and defaults to the current buffer. Windows are scanned starting
1350 with the selected window.
1352 MINIBUF t means include the minibuffer window even if the
1353 minibuffer is not active. MINIBUF nil or omitted means include
1354 the minibuffer window only if the minibuffer is active. Any
1355 other value means do not include the minibuffer window even if
1356 the minibuffer is active.
1358 ALL-FRAMES nil or omitted means consider all windows on the
1359 selected frame, plus the minibuffer window if specified by the
1360 MINIBUF argument. If the minibuffer counts, consider all windows
1361 on all frames that share that minibuffer too. The following
1362 non-nil values of ALL-FRAMES have special meanings:
1364 - t means consider all windows on all existing frames.
1366 - `visible' means consider all windows on all visible frames on
1367 the current terminal.
1369 - 0 (the number zero) means consider all windows on all visible
1370 and iconified frames on the current terminal.
1372 - A frame means consider all windows on that frame only.
1374 Anything else means consider all windows on the selected frame
1375 and no others."
1377 windows)
1384 "Return t if WINDOW is the currently active minibuffer window."
1388 "Return the number of live windows on the selected frame.
1389 The optional argument MINIBUF specifies whether the minibuffer
1390 window shall be counted. See `walk-windows' for the precise
1391 meaning of this argument."
1393 \f
1394 ;;; Resizing windows.
1396 "Reset resize values for all windows on FRAME.
1397 FRAME defaults to the selected frame.
1399 This function stores the current value of `window-total-size' applied
1400 with argument HORIZONTAL in the new total size of all windows on
1401 FRAME. It also resets the new normal size of each of these
1402 windows."
1407 "Internal function of `window--resize-reset'."
1408 ;; Register old size in the new total size.
1410 ;; Reset new normal size.
1417 ;; The following routine is used to manually resize the minibuffer
1418 ;; window and is currently used, for example, by ispell.el.
1420 "Resize minibuffer window WINDOW by DELTA lines.
1421 If WINDOW cannot be resized by DELTA lines make it as large (or
1422 as small) as possible but don't signal an error."
1430 ;; Sanitize DELTA.
1437 ;; Resize now.
1439 ;; Ideally we should be able to resize just the last child of root
1440 ;; here. See the comment in `resize-root-window-vertically' for
1441 ;; why we do not do that.
1444 ;; The following routine catches the case where we want to resize
1445 ;; a minibuffer-only frame.
1449 "Resize WINDOW vertically by DELTA lines.
1450 WINDOW can be an arbitrary window and defaults to the selected
1451 one. An attempt to resize the root window of a frame will raise
1452 an error though.
1454 DELTA a positive number means WINDOW shall be enlarged by DELTA
1455 lines. DELTA negative means WINDOW shall be shrunk by -DELTA
1456 lines.
1458 Optional argument HORIZONTAL non-nil means resize WINDOW
1459 horizontally by DELTA columns. In this case a positive DELTA
1460 means enlarge WINDOW by DELTA columns. DELTA negative means
1461 WINDOW shall be shrunk by -DELTA columns.
1463 Optional argument IGNORE non-nil means ignore any restrictions
1464 imposed by fixed size windows, `window-min-height' or
1465 `window-min-width' settings. IGNORE any window means ignore
1466 restrictions for that window only. IGNORE equal `safe' means
1467 live windows may get as small as `window-safe-min-height' lines
1468 and `window-safe-min-width' columns.
1470 This function resizes other windows proportionally and never
1471 deletes any windows. If you want to move only the low (right)
1472 edge of WINDOW consider using `adjust-window-trailing-edge'
1473 instead."
1476 sibling)
1489 ;; If window-combination-resize is nil, WINDOW is part of an
1490 ;; iso-combination, and WINDOW's neighboring right or left
1491 ;; sibling can be resized as requested, resize that sibling.
1498 normal-delta))
1501 normal-delta)))
1502 ;; Otherwise, resize all other windows in the same combination.
1509 "Return non-nil if WINDOW shall be skipped by resizing routines."
1512 (defun window--resize-child-windows-normal (parent horizontal window this-delta &optional trail other-delta)
1513 "Recursively set new normal height of child windows of window PARENT.
1514 HORIZONTAL non-nil means set the new normal width of these
1515 windows. WINDOW specifies a child window of PARENT that has been
1516 resized by THIS-DELTA lines (columns).
1518 Optional argument TRAIL either 'before or 'after means set values
1519 for windows before or after WINDOW only. Optional argument
1520 OTHER-DELTA a number specifies that this many lines (columns)
1521 have been obtained from (or returned to) an ancestor window of
1522 PARENT in order to resize WINDOW."
1526 ;; When WINDOW gets deleted and we can return its entire
1527 ;; space to its siblings, use WINDOW's normal size as the
1528 ;; normal delta.
1530 ;; In any other case calculate the normal delta from the
1531 ;; relation of THIS-DELTA to the total size of PARENT.
1537 ;; Set parent-normal to the sum of the normal sizes of all child
1538 ;; windows of PARENT that shall be resized, excluding only WINDOW
1539 ;; and any windows specified by the optional TRAIL argument.
1550 ;; Set the new normal size of all child windows of PARENT from what
1551 ;; they should have contributed for recovering THIS-DELTA lines
1552 ;; (columns).
1566 delta-normal))
1567 ;; Don't drop below 0.
1572 ;; Set the new normal size of windows from what they should have
1573 ;; contributed for recovering OTHER-DELTA lines (columns).
1576 other-delta)))
1588 ;; Don't drop below 0.
1592 ;; Set the new normal size of WINDOW to what is left by the sum of
1593 ;; the normal sizes of its siblings.
1595 window
1606 ;; Don't get larger than 1 or smaller than 0.
1609 (defun window--resize-child-windows (parent delta &optional horizontal window ignore trail edge)
1610 "Resize child windows of window PARENT vertically by DELTA lines.
1611 PARENT must be a vertically combined internal window.
1613 Optional argument HORIZONTAL non-nil means resize child windows of
1614 PARENT horizontally by DELTA columns. In this case PARENT must
1615 be a horizontally combined internal window.
1617 WINDOW, if specified, must denote a child window of PARENT that
1618 is resized by DELTA lines.
1620 Optional argument IGNORE non-nil means ignore any restrictions
1621 imposed by fixed size windows, `window-min-height' or
1622 `window-min-width' settings. IGNORE equal `safe' means live
1623 windows may get as small as `window-safe-min-height' lines and
1624 `window-safe-min-width' columns. IGNORE any window means ignore
1625 restrictions for that window only.
1627 Optional arguments TRAIL and EDGE, when non-nil, restrict the set
1628 of windows that shall be resized. If TRAIL equals `before',
1629 resize only windows on the left or above EDGE. If TRAIL equals
1630 `after', resize only windows on the right or below EDGE. Also,
1631 preferably only resize windows adjacent to EDGE.
1633 Return the symbol `normalized' if new normal sizes have been
1634 already set by this routine."
1638 best-window best-value)
1650 sub)
1655 edge)
1660 edge)
1663 ;; Resize only windows adjacent to EDGE.
1666 sub delta horizontal ignore t trail edge)
1669 ;; Assign new normal sizes.
1678 ;; Return 'normalized to notify `window--resize-siblings' that
1679 ;; normal sizes have been already set.
1681 ;; Resize all windows proportionally.
1686 ;; Ignore windows to skip and fixed-size child windows -
1687 ;; in the latter case make it a window to skip.
1692 ;; When shrinking store the number of lines/cols we can get
1693 ;; from this window here together with the total/normal size
1694 ;; factor.
1696 sub
1698 ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
1701 parent-total)
1704 ;; When enlarging store the total/normal size factor only
1706 sub
1708 parent-total)
1715 ;; Shrink windows by delta.
1734 best-window
1739 parent-total)
1742 ;; Enlarge windows by delta.
1760 best-window
1762 parent-total)
1770 ;; Reset new normal size fields so `window-resize-apply'
1771 ;; won't use them to apply new sizes.
1775 ;; Resize this window's child windows (back-engineering
1776 ;; delta from sub's old and new total sizes).
1780 ;; For the TRAIL non-nil case we have to resize SUB
1781 ;; recursively even if it's size does not change.
1783 sub delta horizontal ignore nil trail edge))))
1787 "Resize other windows when WINDOW is resized vertically by DELTA lines.
1788 Optional argument HORIZONTAL non-nil means resize other windows
1789 when WINDOW is resized horizontally by DELTA columns. WINDOW
1790 itself is not resized by this function.
1792 Optional argument IGNORE non-nil means ignore any restrictions
1793 imposed by fixed size windows, `window-min-height' or
1794 `window-min-width' settings. IGNORE equal `safe' means live
1795 windows may get as small as `window-safe-min-height' lines and
1796 `window-safe-min-width' columns. IGNORE any window means ignore
1797 restrictions for that window only.
1799 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1800 of windows that shall be resized. If TRAIL equals `before',
1801 resize only windows on the left or above EDGE. If TRAIL equals
1802 `after', resize only windows on the right or below EDGE. Also,
1803 preferably only resize windows adjacent to EDGE."
1808 ;; In an iso-combination try to extract DELTA from WINDOW's
1809 ;; siblings.
1811 this-delta other-delta)
1812 ;; Decide which windows shall be left alone.
1816 ;; Make sure WINDOW is left alone when
1817 ;; resizing its siblings.
1821 ;; Make sure this sibling is left alone when
1822 ;; resizing its siblings.
1826 ;; Set this-delta to t to signal that we found a sibling
1827 ;; of WINDOW whose size is not fixed.
1832 ;; Set this-delta to what we can get from WINDOW's siblings.
1834 ;; A deletion, presumably. We must handle this case
1835 ;; specially since `window--resizable' can't be used.
1837 ;; There's at least one resizable sibling we can
1838 ;; give WINDOW's size to.
1840 ;; No resizable sibling exists.
1842 ;; Any other form of resizing.
1846 ;; Set other-delta to what we still have to get from
1847 ;; ancestor windows of parent.
1850 ;; Unless we got everything from WINDOW's siblings, PARENT
1851 ;; must be resized by other-delta lines or columns.
1855 ;; We haven't got anything from WINDOW's siblings but we
1856 ;; must update the normal sizes to respect other-delta.
1858 parent horizontal window this-delta trail other-delta)
1859 ;; We did get something from WINDOW's siblings which means
1860 ;; we have to resize their child windows.
1863 window ignore trail edge)
1864 ;; If `window--resize-child-windows' returns
1865 ;; 'normalized, this means it has set the
1866 ;; normal sizes already.
1868 ;; Set the normal sizes.
1870 parent horizontal window this-delta trail other-delta))
1871 ;; Set DELTA to what we still have to get from ancestor
1872 ;; windows.
1875 ;; In an ortho-combination all siblings of WINDOW must be
1876 ;; resized by DELTA.
1884 ;; "Go up."
1886 parent delta horizontal ignore trail edge)))))
1889 "Resize WINDOW vertically by DELTA lines.
1890 Optional argument HORIZONTAL non-nil means resize WINDOW
1891 horizontally by DELTA columns.
1893 Optional argument IGNORE non-nil means ignore any restrictions
1894 imposed by fixed size windows, `window-min-height' or
1895 `window-min-width' settings. IGNORE equal `safe' means live
1896 windows may get as small as `window-safe-min-height' lines and
1897 `window-safe-min-width' columns. IGNORE any window means ignore
1898 restrictions for that window only.
1900 Optional argument ADD non-nil means add DELTA to the new total
1901 size of WINDOW.
1903 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1904 of windows that shall be resized. If TRAIL equals `before',
1905 resize only windows on the left or above EDGE. If TRAIL equals
1906 `after', resize only windows on the right or below EDGE. Also,
1907 preferably only resize windows adjacent to EDGE.
1909 This function recursively resizes WINDOW's child windows to fit the
1910 new size. Make sure that WINDOW is `window--resizable' before
1911 calling this function. Note that this function does not resize
1912 siblings of WINDOW or WINDOW's parent window. You have to
1913 eventually call `window-resize-apply' in order to make resizing
1914 actually take effect."
1916 ;; Add DELTA to the new total size of WINDOW.
1923 ;; In an iso-combination resize child windows according to their
1924 ;; normal sizes.
1926 window delta horizontal nil ignore trail edge))
1927 ;; In an ortho-combination resize each child window by DELTA.
1931 sub delta horizontal ignore t trail edge)
1935 "Resize root window WINDOW vertically by DELTA lines.
1936 HORIZONTAL non-nil means resize root window WINDOW horizontally
1937 by DELTA columns.
1939 IGNORE non-nil means ignore any restrictions imposed by fixed
1940 size windows, `window-min-height' or `window-min-width' settings.
1942 This function is only called by the frame resizing routines. It
1943 resizes windows proportionally and never deletes any windows."
1950 "Resize root window WINDOW vertically by DELTA lines.
1951 If DELTA is less than zero and we can't shrink WINDOW by DELTA
1952 lines, shrink it as much as possible. If DELTA is greater than
1953 zero, this function can resize fixed-size windows in order to
1954 recover the necessary lines.
1956 Return the number of lines that were recovered.
1958 This function is only called by the minibuffer window resizing
1959 routines. It resizes windows proportionally and never deletes
1960 any windows."
1971 ;; Ideally, we would resize just the last window in a combination
1972 ;; but that's not feasible for the following reason: If we grow
1973 ;; the minibuffer window and the last window cannot be shrunk any
1974 ;; more, we shrink another window instead. But if we then shrink
1975 ;; the minibuffer window again, the last window might get enlarged
1976 ;; and the state after shrinking is not the state before growing.
1977 ;; So, in practice, we'd need a history variable to record how to
1978 ;; proceed. But I'm not sure how such a variable could work with
1979 ;; repeated minibuffer window growing steps.
1981 delta)))
1984 "Move WINDOW's bottom edge by DELTA lines.
1985 Optional argument HORIZONTAL non-nil means move WINDOW's right
1986 edge by DELTA columns. WINDOW defaults to the selected window.
1988 If DELTA is greater zero, then move the edge downwards or to the
1989 right. If DELTA is less than zero, move the edge upwards or to
1990 the left. If the edge can't be moved by DELTA lines or columns,
1991 move it as far as possible in the desired direction."
1995 left this-delta min-delta max-delta)
1996 ;; Find the edge we want to move.
2009 ;; Set LEFT to the first resizable window on the left. This step is
2010 ;; needed to handle fixed-size windows.
2023 ;; Set RIGHT to the first resizable window on the right. This step
2024 ;; is needed to handle fixed-size windows.
2037 ;; LEFT and RIGHT (which might be both internal windows) are now the
2038 ;; two windows we want to resize.
2044 ;; We can't get the whole DELTA - move as far as possible.
2047 ;; Start resizing.
2049 ;; Try to enlarge LEFT first.
2053 left this-delta horizontal nil t 'before
2057 ;; Shrink windows on right of LEFT.
2059 left delta horizontal nil 'after
2067 ;; We can't get the whole DELTA - move as far as possible.
2070 ;; Start resizing.
2072 ;; Try to enlarge RIGHT.
2076 right this-delta horizontal nil t 'after
2080 ;; Shrink windows on left of RIGHT.
2087 ;; Don't report an error in the standard case.
2089 ;; But do report an error if applying the changes fails.
2093 "Make selected window DELTA lines taller.
2094 Interactively, if no argument is given, make the selected window
2095 one line taller. If optional argument HORIZONTAL is non-nil,
2096 make selected window wider by DELTA columns. If DELTA is
2097 negative, shrink selected window by -DELTA lines or columns.
2098 Return nil."
2111 horizontal))))
2114 "Make selected window DELTA lines smaller.
2115 Interactively, if no argument is given, make the selected window
2116 one line smaller. If optional argument HORIZONTAL is non-nil,
2117 make selected window narrower by DELTA columns. If DELTA is
2118 negative, enlarge selected window by -DELTA lines or columns.
2119 Return nil."
2132 horizontal))))
2135 "Maximize WINDOW.
2136 Make WINDOW as large as possible without deleting any windows.
2137 WINDOW can be any window and defaults to the selected window."
2144 "Minimize WINDOW.
2145 Make WINDOW as small as possible without deleting any windows.
2146 WINDOW can be any window and defaults to the selected window."
2151 \f
2153 "Return non-nil if WINDOW is the root window of its frame."
2157 "Return window subtree rooted at WINDOW.
2158 Optional argument NEXT non-nil means include WINDOW's right
2159 siblings in the return value.
2161 See the documentation of `window-tree' for a description of the
2162 return value."
2175 list))
2180 "Return the window tree of frame FRAME.
2181 FRAME must be a live frame and defaults to the selected frame.
2182 The return value is a list of the form (ROOT MINI), where ROOT
2183 represents the window tree of the frame's root window, and MINI
2184 is the frame's minibuffer window.
2186 If the root window is not split, ROOT is the root window itself.
2187 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
2188 for a horizontal split, and t for a vertical split. EDGES gives
2189 the combined size and position of the child windows in the split,
2190 and the rest of the elements are the child windows in the split.
2191 Each of the child windows may again be a window or a list
2192 representing a window split, and so on. EDGES is a list (LEFT
2193 TOP RIGHT BOTTOM) as returned by `window-edges'."
2196 \f
2198 "Select another window in cyclic ordering of windows.
2199 COUNT specifies the number of windows to skip, starting with the
2200 selected window, before making the selection. If COUNT is
2201 positive, skip COUNT windows forwards. If COUNT is negative,
2202 skip -COUNT windows backwards. COUNT zero means do not skip any
2203 window, so select the selected window. In an interactive call,
2204 COUNT is the numeric prefix argument. Return nil.
2206 If the `other-window' parameter of the selected window is a
2207 function and `ignore-window-parameters' is nil, call that
2208 function with the arguments COUNT and ALL-FRAMES.
2210 This function does not select a window whose `no-other-window'
2211 window parameter is non-nil.
2213 This function uses `next-window' for finding the window to
2214 select. The argument ALL-FRAMES has the same meaning as in
2215 `next-window', but the MINIBUF argument of `next-window' is
2216 always effectively nil."
2221 old-window old-count)
2224 ;; `next-window' and `previous-window' may return a window we are
2225 ;; not allowed to select. Hence we need an exit strategy in case
2226 ;; all windows are non-selectable.
2233 ;; Keep out of infinite loops. When COUNT has not changed
2234 ;; since we last looked at `window' we're probably in one.
2238 ;; The first non-selectable window `next-window' got us:
2239 ;; Remember it and the current value of COUNT.
2249 ;; Keep out of infinite loops. When COUNT has not changed
2250 ;; since we last looked at `window' we're probably in one.
2254 ;; The first non-selectable window `previous-window' got
2255 ;; us: Remember it and the current value of COUNT.
2262 ;; Always return nil.
2263 nil))))
2265 ;; This should probably return non-nil when the selected window is part
2266 ;; of an atomic window whose root is the frame's root window.
2268 "Return non-nil if the selected window is the only window.
2269 Optional arg NOMINI non-nil means don't count the minibuffer
2270 even if it is active. Otherwise, the minibuffer is counted
2271 when it is active.
2273 Optional argument ALL-FRAMES specifies the set of frames to
2274 consider, see also `next-window'. ALL-FRAMES nil or omitted
2275 means consider windows on the selected frame only, plus the
2276 minibuffer window if specified by the NOMINI argument. If the
2277 minibuffer counts, consider all windows on all frames that share
2278 that minibuffer too. The remaining non-nil values of ALL-FRAMES
2279 with a special meaning are:
2281 - t means consider all windows on all existing frames.
2283 - `visible' means consider all windows on all visible frames on
2284 the current terminal.
2286 - 0 (the number zero) means consider all windows on all visible
2287 and iconified frames on the current terminal.
2289 - A frame means consider all windows on that frame only.
2291 Anything else means consider all windows on the selected frame
2292 and no others."
2298 \f
2299 ;;; Deleting windows.
2301 "Return t if WINDOW can be safely deleted from its frame.
2302 Return `frame' if deleting WINDOW should also delete its
2303 frame."
2307 ;; Handle atomicity.
2315 ;; WINDOW's frame can be deleted only if there are other frames
2316 ;; on the same terminal.
2322 ;; WINDOW can be deleted unless it is the main window of its
2323 ;; frame.
2324 t))))
2327 "Return t if WINDOW is either ROOT or a member of ROOT's subtree."
2337 "Delete WINDOW.
2338 WINDOW can be an arbitrary window and defaults to the selected
2339 one. Return nil.
2341 If the variable `ignore-window-parameters' is non-nil or the
2342 `delete-window' parameter of WINDOW equals t, do not process any
2343 parameters of WINDOW. Otherwise, if the `delete-window'
2344 parameter of WINDOW specifies a function, call that function with
2345 WINDOW as its sole argument and return the value returned by that
2346 function.
2348 Otherwise, if WINDOW is part of an atomic window, call
2349 `delete-window' with the root of the atomic window as its
2350 argument. If WINDOW is the only window on its frame or the last
2351 non-side window, signal an error."
2357 atom-root)
2360 ;; Handle window parameters.
2362 ;; Ignore window parameters if `ignore-window-parameters' tells
2363 ;; us so or `delete-window' equals t.
2366 ;; The `delete-window' parameter specifies the function to call.
2367 ;; If that function is `ignore' nothing is done. It's up to the
2368 ;; function called here to avoid infinite recursion.
2385 ;; Emacs 23 preferably gives WINDOW's space to its left
2386 ;; sibling.
2392 ;; Resize WINDOW's sibling.
2398 ;; Can do without resizing fixed-size windows.
2401 ;; Can't do without resizing fixed-size windows.
2403 ;; Actually delete WINDOW.
2408 ;; `delete-window-internal' has selected a window that should
2409 ;; not be selected, fix this here.
2413 ;; Always return nil.
2414 nil))))
2417 "Make WINDOW fill its frame.
2418 WINDOW may be any window and defaults to the selected one.
2419 Return nil.
2421 If the variable `ignore-window-parameters' is non-nil or the
2422 `delete-other-windows' parameter of WINDOW equals t, do not
2423 process any parameters of WINDOW. Otherwise, if the
2424 `delete-other-windows' parameter of WINDOW specifies a function,
2425 call that function with WINDOW as its sole argument and return
2426 the value returned by that function.
2428 Otherwise, if WINDOW is part of an atomic window, call this
2429 function with the root of the atomic window as its argument. If
2430 WINDOW is a non-side window, make WINDOW the only non-side window
2431 on the frame. Side windows are not deleted. If WINDOW is a side
2432 window signal an error."
2438 atom-root side-main)
2442 ;; Ignore window parameters if `ignore-window-parameters' is t or
2443 ;; `delete-other-windows' is t.
2446 ;; The `delete-other-windows' parameter specifies the function
2447 ;; to call. If the function is `ignore' no windows are deleted.
2448 ;; It's up to the function called to avoid infinite recursion.
2455 ;; Set side-main to the major non-side window.
2459 ;; If WINDOW is the main non-side window, do nothing.
2464 ;; Always return nil.
2465 nil)))
2468 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
2470 if you often split windows horizontally."
2482 ;;; Windows and buffers.
2484 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
2485 ;; for (1) determining which buffer to show in the window when its
2486 ;; buffer shall be buried or killed and (2) which buffer to show for
2487 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2489 ;; `prev-buffers' consists of <buffer, window-start, window-point>
2490 ;; triples. The entries on this list are ordered by the time their
2491 ;; buffer has been removed from the window, the most recently removed
2492 ;; buffer's entry being first. The window-start and window-point
2493 ;; components are `window-start' and `window-point' at the time the
2494 ;; buffer was removed from the window which implies that the entry must
2495 ;; be added when `set-window-buffer' removes the buffer from the window.
2497 ;; `next-buffers' is the list of buffers that have been replaced
2498 ;; recently by `switch-to-prev-buffer'. These buffers are the least
2499 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
2500 ;; candidates of `switch-to-next-buffer' to switch to. This list is
2501 ;; reset to nil by any action changing the window's buffer with the
2502 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
2503 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
2504 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
2506 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
2507 ;; if such a buffer was killed while the window was hidden within a
2508 ;; window configuration. Such killed buffers get removed whenever
2509 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
2511 ;; The following function is called by `set-window-buffer' _before_ it
2512 ;; replaces the buffer of the argument window with the new buffer.
2514 "Record WINDOW's buffer.
2515 WINDOW must be a live window and defaults to the selected one."
2519 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
2520 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2524 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
2528 ;; Don't record insignificant buffers.
2530 ;; Add an entry for buffer to WINDOW's previous buffers.
2537 ;; We have an entry, update marker positions.
2540 ;; Make new markers.
2548 "Unrecord BUFFER in WINDOW.
2549 WINDOW must be a live window and defaults to the selected one.
2550 BUFFER must be a live buffer and defaults to the buffer of
2551 WINDOW."
2560 "Set WINDOW's buffer to BUFFER.
2561 Optional argument START non-nil means set WINDOW's start position
2562 to START. Optional argument POINT non-nil means set WINDOW's
2563 point to POINT. If WINDOW is selected this also sets BUFFER's
2564 `point' to POINT. If WINDOW is selected and the buffer it showed
2565 before was current this also makes BUFFER the current buffer."
2572 ;; Don't force window-start here (even if POINT is nil).
2578 "In WINDOW switch to previous buffer.
2579 WINDOW must be a live window and defaults to the selected one.
2581 Optional argument BURY-OR-KILL non-nil means the buffer currently
2582 shown in WINDOW is about to be buried or killed and consequently
2583 shall not be switched to in future invocations of this command."
2587 ;; Save this since it's destroyed by `set-window-buffer'.
2589 entry new-buffer killed-buffers visible)
2594 ;; Scan WINDOW's previous buffers first, skipping entries of next
2595 ;; buffers.
2607 ;; Scan reverted buffer list of WINDOW's frame next, skipping
2608 ;; entries of next buffers. Note that when we bury or kill a
2609 ;; buffer we don't reverse the global buffer list to avoid showing
2610 ;; a buried buffer instead. Otherwise, we must reverse the global
2611 ;; buffer list in order to make sure that switching to the
2612 ;; previous/next buffer traverse it in opposite directions.
2621 ;; Try to avoid showing a buffer visible in some other window.
2627 ;; Scan reverted next buffers last (must not use nreverse
2628 ;; here!).
2630 ;; Actually, buffer _must_ be live here since otherwise it
2631 ;; would have been caught in the scan of previous buffers.
2642 ;; Show a buffer visible in another window.
2648 ;; Remove `old-buffer' from WINDOW's previous and (restored list
2649 ;; of) next buffers.
2654 ;; Move `old-buffer' to head of WINDOW's restored list of next
2655 ;; buffers.
2659 ;; Remove killed buffers from WINDOW's previous and next buffers.
2667 ;; Return new-buffer.
2668 new-buffer))
2671 "In WINDOW switch to next buffer.
2672 WINDOW must be a live window and defaults to the selected one."
2677 new-buffer entry killed-buffers visible)
2682 ;; Scan WINDOW's next buffers first.
2693 ;; Scan the buffer list of WINDOW's frame next, skipping previous
2694 ;; buffers entries.
2700 ;; Try to avoid showing a buffer visible in some other window.
2705 ;; Scan WINDOW's reverted previous buffers last (must not use
2706 ;; nreverse here!)
2717 ;; Show a buffer visible in another window.
2722 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
2725 ;; Remove killed buffers from WINDOW's previous and next buffers.
2733 ;; Return new-buffer.
2734 new-buffer))
2737 "Search LIST for a valid buffer to display in FRAME.
2738 Return nil when all buffers in LIST are undesirable for display,
2739 otherwise return the first suitable buffer in LIST.
2741 Buffers not visible in windows are preferred to visible buffers,
2742 unless VISIBLE-OK is non-nil.
2743 If the optional argument FRAME is nil, it defaults to the selected frame.
2744 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
2745 ;; This logic is more or less copied from other-buffer.
2748 found buf)
2761 "Return the last buffer in FRAME's buffer list.
2762 If BUFFER is the last buffer, return the preceding buffer
2763 instead. Buffers not visible in windows are preferred to visible
2764 buffers, unless optional argument VISIBLE-OK is non-nil.
2765 Optional third argument FRAME nil or omitted means use the
2766 selected frame's buffer list. If no such buffer exists, return
2767 the buffer `*scratch*', creating it if necessary."
2770 buffer visible-ok frame)
2774 scratch)))
2777 "Function called to automatically hide frames.
2778 The function is called with one argument - a frame.
2780 Functions affected by this option are those that bury a buffer
2781 shown in a separate frame like `quit-window' and `bury-buffer'."
2785 function)
2791 "Delete WINDOW if possible.
2792 WINDOW must be a live window and defaults to the selected one.
2793 Optional argument DEDICATED-ONLY non-nil means to delete WINDOW
2794 only if it's dedicated to its buffer. Optional argument KILL
2795 means the buffer shown in window will be killed. Return non-nil
2796 if WINDOW gets deleted or its frame is auto-hidden."
2811 t)))))
2814 "Put BUFFER-OR-NAME at the end of the list of all buffers.
2815 There it is the least likely candidate for `other-buffer' to
2817 select by default.
2819 You can specify a buffer name as BUFFER-OR-NAME, or an actual
2820 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
2821 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
2822 remove the current buffer from the selected window if it is
2823 displayed there."
2826 ;; If `buffer-or-name' is not on the selected frame we unrecord it
2827 ;; although it's not "here" (call it a feature).
2829 ;; Handle case where `buffer-or-name' is nil and the current buffer
2830 ;; is shown in the selected window.
2835 ;; Switch to another buffer in window.
2839 ;; Always return nil.
2840 nil))
2843 "Switch to the last buffer in the buffer list."
2848 "In selected window switch to next buffer."
2855 "In selected window switch to previous buffer."
2862 "Delete all windows showing BUFFER-OR-NAME.
2863 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2864 and defaults to the current buffer.
2866 The following non-nil values of the optional argument FRAME
2867 have special meanings:
2869 - t means consider all windows on the selected frame only.
2871 - `visible' means consider all windows on all visible frames on
2872 the current terminal.
2874 - 0 (the number zero) means consider all windows on all visible
2875 and iconified frames on the current terminal.
2877 - A frame means consider all windows on that frame only.
2879 Any other value of FRAME means consider all windows on all
2880 frames.
2882 When a window showing BUFFER-OR-NAME is dedicated and the only
2883 window of its frame, that frame is deleted when there are other
2884 frames left."
2887 ;; Handle the "inverted" meaning of the FRAME argument wrt other
2888 ;; `window-list-1' based function.
2895 ;; Delete frame if and only if window is dedicated.
2898 ;; Delete window.
2901 ;; In window switch to previous buffer.
2904 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
2908 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
2909 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2910 and defaults to the current buffer.
2912 When a window showing BUFFER-OR-NAME is dedicated, that window is
2913 deleted. If that window is the only window on its frame, the
2914 frame is deleted too when there are other frames left. If there
2915 are no other frames left, some other buffer is displayed in that
2916 window.
2918 This function removes the buffer denoted by BUFFER-OR-NAME from
2919 all window-local buffer lists."
2925 ;; Switch to another buffer in window.
2928 ;; Unrecord BUFFER in WINDOW.
2932 "Quit WINDOW and bury its buffer.
2933 WINDOW must be a live window and defaults to the selected one.
2934 With prefix argument KILL non-nil, kill the buffer instead of
2935 burying it.
2937 According to information stored in WINDOW's `quit-restore' window
2938 parameter either (1) delete WINDOW and its frame, (2) delete
2939 WINDOW, (3) restore the buffer previously displayed in WINDOW,
2940 or (4) make WINDOW display some other buffer than the present
2941 one. If non-nil, reset `quit-restore' parameter to nil."
2952 buffer))))
2953 prev-buffer)))
2954 quad resize)
2959 ;; Delete WINDOW if possible.
2961 ;; If the previously selected window is still alive, select it.
2967 ;; Show another buffer stored in quit-restore parameter.
2973 ;; Try to resize WINDOW to its old height but don't signal an
2974 ;; error.
2978 ;; Restore WINDOW's previous buffer, start and point position.
2981 ;; Unrecord WINDOW's buffer here (Bug#9937) to make sure it's not
2982 ;; re-recorded by `set-window-buffer'.
2984 ;; Reset the quit-restore parameter.
2986 ;; Select old window.
2990 ;; Show some other buffer in WINDOW and reset the quit-restore
2991 ;; parameter.
2993 ;; Make sure that WINDOW is no more dedicated.
2997 ;; Kill WINDOW's old-buffer if requested
3003 "Quit all windows showing BUFFER-OR-NAME.
3004 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
3005 and defaults to the current buffer. Optional argument KILL
3006 non-nil means to kill BUFFER-OR-NAME. KILL nil means to bury
3007 BUFFER-OR-NAME. Optional argument FRAME is handled as by
3008 `delete-windows-on'.
3010 This function calls `quit-window' on all candidate windows
3011 showing BUFFER-OR-NAME."
3014 ;; Handle the "inverted" meaning of the FRAME argument wrt other
3015 ;; `window-list-1' based function.
3020 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
3022 \f
3023 ;;; Splitting windows.
3025 "Return minimum height of any window when splitting windows.
3026 Optional argument HORIZONTAL non-nil means return minimum width."
3032 "Make a new window adjacent to WINDOW.
3033 WINDOW can be any window and defaults to the selected one.
3034 Return the new window which is always a live window.
3036 Optional argument SIZE a positive number means make WINDOW SIZE
3037 lines or columns tall. If SIZE is negative, make the new window
3038 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
3039 absolute value can be less than `window-min-height' or
3040 `window-min-width'; so this command can make a new window as
3041 small as one line or two columns. SIZE defaults to half of
3042 WINDOW's size. Interactively, SIZE is the prefix argument.
3044 Optional third argument SIDE nil (or `below') specifies that the
3045 new window shall be located below WINDOW. SIDE `above' means the
3046 new window shall be located above WINDOW. In both cases SIZE
3047 specifies the new number of lines for WINDOW (or the new window
3048 if SIZE is negative) including space reserved for the mode and/or
3049 header line.
3051 SIDE t (or `right') specifies that the new window shall be
3052 located on the right side of WINDOW. SIDE `left' means the new
3053 window shall be located on the left of WINDOW. In both cases
3054 SIZE specifies the new number of columns for WINDOW (or the new
3055 window provided SIZE is negative) including space reserved for
3056 fringes and the scrollbar or a divider column. Any other non-nil
3057 value for SIDE is currently handled like t (or `right').
3059 If the variable `ignore-window-parameters' is non-nil or the
3060 `split-window' parameter of WINDOW equals t, do not process any
3061 parameters of WINDOW. Otherwise, if the `split-window' parameter
3062 of WINDOW specifies a function, call that function with all three
3063 arguments and return the value returned by that function.
3066 root of that atomic window. The new window does not become a
3067 member of that atomic window.
3069 If WINDOW is live, properties of the new window like margins and
3070 scrollbars are inherited from WINDOW. If WINDOW is an internal
3071 window, these properties as well as the buffer displayed in the
3072 new window are inherited from the window selected on WINDOW's
3073 frame. The selected window is not changed by this function."
3085 ;; Rebind `window-combination-limit' since in some cases we may
3086 ;; have to override its value.
3088 atom-root)
3093 ;; Ignore window parameters if either `ignore-window-parameters'
3094 ;; is t or the `split-window' parameter equals t.
3097 ;; The `split-window' parameter specifies the function to call.
3098 ;; If that function is `ignore', do nothing.
3100 ;; If WINDOW is part of an atomic window, split the root window
3101 ;; of that atomic window instead.
3110 ;; WINDOW is a side root window. To make sure that a new parent
3111 ;; window gets created set `window-combination-limit' to t.
3115 ;; If `window-combination-resize' is non-nil and SIZE is a
3116 ;; non-negative integer, we cannot reasonably resize other
3117 ;; windows. Rather bind `window-combination-limit' to t to make
3118 ;; sure that subsequent window deletions are handled correctly.
3122 ;; `parent-size' is the size of WINDOW's parent, provided
3123 ;; it has one.
3125 ;; `resize' non-nil means we are supposed to resize other
3126 ;; windows in WINDOW's combination.
3129 ;; Resize makes sense in iso-combinations only.
3131 ;; `old-size' is the current size of WINDOW.
3133 ;; `new-size' is the specified or calculated size of the
3134 ;; new window.
3140 ;; When resizing try to give the new window the
3141 ;; average size of a window in its combination.
3144 (/ parent-size
3146 parent horizontal))))
3147 ;; Else try to give the new window half the size
3148 ;; of WINDOW (plus an eventual odd line).
3151 ;; SIZE non-negative specifies the new size of WINDOW.
3153 ;; Note: Specifying a non-negative SIZE is practically
3154 ;; always done as workaround for making the new window
3155 ;; appear above or on the left of the new window (the
3156 ;; ispell window is a typical example of that). In all
3157 ;; these cases the SIDE argument should be set to 'above
3158 ;; or 'left in order to support the 'resize option.
3159 ;; Here we have to nest the windows instead, see above.
3162 ;; SIZE negative specifies the size of the new window.
3164 new-parent new-normal)
3166 ;; Check SIZE.
3171 ;; SIZE unspecified, resizing.
3173 ;; Try again with minimum split size.
3179 ;; SIZE unspecified, no resizing.
3184 window-safe-min-width
3185 window-safe-min-width))))
3186 ;; SIZE specified as new size of old window. If the new size
3187 ;; is larger than the old size or the size of the new window
3188 ;; would be less than the safe minimum, signal an error.
3191 ;; SIZE specified, resizing.
3193 ;; If we cannot resize the parent give up.
3199 ;; SIZE specification violates minimum size restrictions.
3205 ;; Make new-parent non-nil if we need a new parent window;
3206 ;; either because we want to nest or because WINDOW is not
3207 ;; iso-combined.
3211 ;; Make new-normal the normal size of the new window.
3219 ;; Try to get space from OLD's siblings. We could go "up" and
3220 ;; try getting additional space from surrounding windows but
3221 ;; we won't be able to return space to those windows when we
3222 ;; delete the one we create here. Hence we do not go up.
3231 ;; Get entire space from WINDOW.
3236 new-normal)))
3239 ;; Inherit window-side parameters, if any.
3246 ;; Always return the new window.
3247 new)))))
3249 ;; I think this should be the default; I think people will prefer it--rms.
3252 If nil, adjust point in the two windows to minimize redisplay.
3253 This option applies only to `split-window-below' and functions
3254 that call it. The low-level `split-window' function always keeps
3255 the original point in both windows."
3260 "Split the selected window into two windows, one above the other.
3261 The selected window is above. The newly split-off window is
3262 below, and displays the same buffer. Return the new window.
3264 If optional argument SIZE is omitted or nil, both windows get the
3265 same height, or close to it. If SIZE is positive, the upper
3266 \(selected) window gets SIZE lines. If SIZE is negative, the
3267 lower (new) window gets -SIZE lines.
3269 If the variable `split-window-keep-point' is non-nil, both
3270 windows get the same value of point as the selected window.
3271 Otherwise, the window starts are chosen so as to minimize the
3272 amount of redisplay; this is convenient on slow terminals."
3277 moved-by-window-height moved new-window bottom)
3279 ;; `split-window' would not signal an error here.
3300 ;; Always copy quit-restore parameter in interactive use.
3304 new-window))
3309 "Split the selected window into two side-by-side windows.
3310 The selected window is on the left. The newly split-off window
3311 is on the right, and displays the same buffer. Return the new
3312 window.
3314 If optional argument SIZE is omitted or nil, both windows get the
3315 same width, or close to it. If SIZE is positive, the left-hand
3316 \(selected) window gets SIZE columns. If SIZE is negative, the
3317 right-hand (new) window gets -SIZE columns. Here, SIZE includes
3318 the width of the window's scroll bar; if there are no scroll
3319 bars, it includes the width of the divider column to the window's
3320 right, if any."
3324 new-window)
3326 ;; `split-window' would not signal an error here.
3329 ;; Always copy quit-restore parameter in interactive use.
3333 new-window))
3336 \f
3337 ;;; Balancing windows.
3339 ;; The following routine uses the recycled code from an old version of
3340 ;; `window--resize-child-windows'. It's not very pretty, but coding it the way the
3341 ;; new `window--resize-child-windows' code does would hardly make it any shorter or
3342 ;; more readable (FWIW we'd need three loops - one to calculate the
3343 ;; minimum sizes per window, one to enlarge or shrink windows until the
3344 ;; new parent-size matches, and one where we shrink the largest/enlarge
3345 ;; the smallest window).
3347 "Subroutine of `balance-windows-1'.
3348 WINDOW must be a vertical combination (horizontal if HORIZONTAL
3349 is non-nil."
3355 failed size sub-total sub-delta sub-amount rest)
3370 ;; Ignore child windows that should be ignored or are stuck.
3376 ;; Register the new total size for this child window.
3381 ;; We failed and need a new round.
3387 ;; Fix rounding by trying to enlarge non-stuck windows by one line
3388 ;; (column) until `rest' is zero.
3396 ;; Fix rounding by trying to enlarge stuck windows by one line
3397 ;; (column) until `rest' equals zero.
3407 ;; Record new normal sizes.
3413 ;; Recursively balance each window's child windows.
3418 "Subroutine of `balance-windows'."
3430 "Balance the sizes of windows of WINDOW-OR-FRAME.
3431 WINDOW-OR-FRAME is optional and defaults to the selected frame.
3432 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
3433 windows of that frame. If WINDOW-OR-FRAME denotes a window,
3434 recursively balance the sizes of all child windows of that
3435 window."
3444 window-or-frame)
3448 ;; Balance vertically.
3452 ;; Balance horizontally.
3458 "Return t if WINDOW cannot be resized in DIRECTION.
3459 WINDOW defaults to the selected window. DIRECTION can be
3460 nil (i.e. any), `height' or `width'."
3467 ;;; A different solution to balance-windows.
3469 "Factor by which the window area should be over-estimated.
3470 This is used by `balance-windows-area'.
3475 "Wrapper around `window-resize' with error checking.
3476 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
3477 ;; `window-resize' may fail if delta is too large.
3484 ;;(message "adjust: %s" (error-message-string err))
3488 "Make all visible windows the same area (approximately).
3489 See also `window-area-factor' to change the relative size of
3490 specific buffers."
3493 ;; Remove fixed-size windows.
3498 next)
3499 ;; Resizing a window changes the size of surrounding windows in complex
3500 ;; ways, so it's difficult to balance them all. The introduction of
3501 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
3502 ;; very difficult to do. `balance-window' above takes an off-line
3503 ;; approach: get the whole window tree, then balance it, then try to
3504 ;; adjust the windows so they fit the result.
3505 ;; Here, instead, we take a "local optimization" approach, where we just
3506 ;; go through all the windows several times until nothing needs to be
3507 ;; changed. The main problem with this approach is that it's difficult
3508 ;; to make sure it terminates, so we use some heuristic to try and break
3509 ;; off infinite loops.
3510 ;; After a round without any change, we allow a second, to give a chance
3511 ;; to the carry to propagate a minor imbalance from the end back to
3512 ;; the beginning.
3514 ;; (message "New round")
3520 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
3538 ;; Maybe diff is actually closer to 1 than to 0.
3542 ;; Change things smoothly.
3545 ;; Make sure negligible differences don't accumulate to
3546 ;; become significant.
3548 ;; This used `adjust-window-trailing-edge' before and uses
3549 ;; `window-resize' now. Error wrapping is still needed.
3551 ;; (sit-for 0.5)
3553 ;; If the same change has been seen already for this window,
3554 ;; we're most likely in an endless loop, so don't count it as
3555 ;; a change.
3559 ;; We've now basically balanced all the windows.
3560 ;; But there may be some minor off-by-one imbalance left over,
3561 ;; so let's do some fine tuning.
3562 ;; (bw-finetune wins)
3563 ;; (message "Done in %d rounds" round)
3564 ))
3566 ;;; Window states, how to get them and how to put them in a window.
3568 "Helper function for `window-state-get'."
3577 `(,type
3585 list)
3586 ;; Make copies of those window parameters whose
3587 ;; persistence property is `writable' if WRITABLE is
3588 ;; non-nil and non-nil if WRITABLE is nil.
3591 window-persistent-parameters))))
3594 ;; Add `clone-of' parameter if necessary.
3596 window-persistent-parameters))))
3603 ;; All buffer related things go in here.
3628 "Return state of WINDOW as a Lisp object.
3629 WINDOW can be any window and defaults to the root window of the
3630 selected frame.
3632 Optional argument WRITABLE non-nil means do not use markers for
3633 sampling `window-point' and `window-start'. Together, WRITABLE
3634 and the variable `window-persistent-parameters' specify which
3635 window parameters are saved by this function. WRITABLE should be
3636 non-nil when the return value shall be written to a file and read
3637 back in another session. Otherwise, an application may run into
3638 an `invalid-read-syntax' error while attempting to read back the
3639 value from file.
3641 The return value can be used as argument for `window-state-put'
3642 to put the state recorded here into an arbitrary window. The
3643 value can be also stored on disk and read back in a new session."
3647 window
3650 ;; The return value is a cons whose car specifies some constraints on
3651 ;; the size of WINDOW. The cdr lists the states of the child windows
3652 ;; of WINDOW.
3654 ;; Frame related things would go into a function, say `frame-state',
3655 ;; calling `window-state-get' to insert the frame's root window.
3668 "Helper function for `window-state-put'."
3673 ;; For a leaf window just add unprocessed entries to
3674 ;; `window-state-put-list'.
3680 size new)
3682 ;; Find the next child window. WINDOW always points to the
3683 ;; real window that we want to fill with what we find here.
3686 ;; The last child window. Below `window--state-put-1'
3687 ;; will put into it whatever ITEM has in store.
3689 ;; Not the last child window, prepare for splitting
3690 ;; WINDOW. SIZE is the new (and final) size of the old
3691 ;; window.
3694 ;; Use total size.
3696 ;; Use normalized size and round.
3700 item))))))
3702 ;; Use safe sizes, we try to resize later.
3704 window-safe-min-height
3705 window-safe-min-width)))
3710 ;; We must inherit the combination limit, otherwise
3711 ;; we might mess up handling of atomic and side
3712 ;; 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'."
3740 ;; Reset window's parameters and assign saved ones (we might want
3741 ;; a `remove-window-parameters' function here).
3747 ;; Process buffer related state.
3749 ;; We don't want to raise an error here so we create a buffer if
3750 ;; there's none.
3762 ;; Adjust vertically.
3764 ;; A fixed height window, try to restore the original size.
3767 window-size-fixed)
3770 ;; Else check whether the window is not high enough.
3776 ;; Adjust horizontally.
3778 ;; A fixed width window, try to restore the original size.
3781 window-size-fixed)
3784 ;; Else check whether the window is not wide enough.
3790 ;; Set dedicated status.
3792 ;; Install positions (maybe we should do this after all windows
3793 ;; have been created and sized).
3797 ;; Select window if it's the selected one.
3802 "Put window state STATE into WINDOW.
3803 STATE should be the state of a window returned by an earlier
3804 invocation of `window-state-get'. Optional argument WINDOW must
3805 specify a live window and defaults to the selected one.
3807 Optional argument IGNORE non-nil means ignore minimum window
3808 sizes and fixed size restrictions. IGNORE equal `safe' means
3809 windows can get as small as `window-safe-min-height' and
3810 `window-safe-min-width'."
3814 ;; We check here (1) whether the total sizes of root window of
3815 ;; STATE and that of WINDOW are equal so we can avoid
3816 ;; calculating new sizes, and (2) if we do have to resize
3817 ;; whether we can do so without violating size restrictions.
3842 (> min-width
3844 ;; The check above might not catch all errors due to rounding
3845 ;; issues - so IGNORE equal 'safe might not always produce the
3846 ;; minimum possible state. But such configurations hardly make
3847 ;; sense anyway.
3851 ;; Work on the windows of a temporary buffer to make sure that
3852 ;; splitting proceeds regardless of any buffer local values of
3853 ;; `window-size-fixed'. Release that buffer after the buffers of
3854 ;; all live windows have been set by `window--state-put-2'.
3860 \f
3862 "Record information for window used by `display-buffer'.
3863 TYPE specifies the type of the calling operation and must be one
3864 of the symbols 'reuse (when WINDOW existed already and was
3865 reused for displaying BUFFER), 'window (when WINDOW was created
3866 on an already existing frame), or 'frame (when WINDOW was
3867 created on a new frame). WINDOW is the window used for or created
3868 by the `display-buffer' routines. BUFFER is the buffer that
3869 shall be displayed.
3871 This function installs or updates the quit-restore parameter of
3872 WINDOW. The quit-restore parameter is a list of four elements:
3873 The first element is one of the symbols 'window, 'frame, 'same or
3874 'other. The second element is either one of the symbols 'window
3875 or 'frame or a list whose elements are the buffer previously
3876 shown in the window, that buffer's window start and window point,
3877 and the window's height. The third element is the window
3878 selected at the time the parameter was created. The fourth
3879 element is BUFFER."
3883 ;; WINDOW shows BUFFER already.
3885 ;; If WINDOW has a quit-restore parameter, reset its car.
3887 ;; WINDOW shows another buffer.
3889 window 'quit-restore
3891 ;; A quadruple of WINDOW's buffer, start, point and height.
3896 ;; WINDOW has been created on an existing frame.
3898 window 'quit-restore
3901 ;; WINDOW has been created on a new frame.
3903 window 'quit-restore
3907 "If non-nil, function to call to handle `display-buffer'.
3908 It will receive two args, the buffer and a flag which if non-nil
3909 means that the currently selected window is not acceptable. It
3910 should choose or create a window, display the specified buffer in
3911 it, and return the window.
3913 The specified function should call `display-buffer-record-window'
3914 with corresponding arguments to set up the quit-restore parameter
3915 of the window used."
3922 "Alist of parameters for automatically generated new frames.
3923 You can set this in your init file; for example,
3925 (setq pop-up-frame-alist '((width . 80) (height . 20)))
3927 If non-nil, the value you specify here is used by the default
3928 `pop-up-frame-function' for the creation of new frames.
3930 Since `pop-up-frame-function' is used by `display-buffer' for
3931 making new frames, any value specified here by default affects
3932 the automatic generation of new frames via `display-buffer' and
3933 all functions based on it. The behavior of `make-frame' is not
3934 affected by this variable."
3942 "Function used by `display-buffer' for creating a new frame.
3943 This function is called with no arguments and should return a new
3944 frame. The default value calls `make-frame' with the argument
3945 `pop-up-frame-alist'."
3950 "List of names of buffers that should be displayed specially.
3951 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
3952 its name is in this list, displays the buffer in a way specified
3953 by `special-display-function'. `special-display-popup-frame'
3954 \(the default for `special-display-function') usually displays
3955 the buffer in a separate frame made with the parameters specified
3956 by `special-display-frame-alist'. If `special-display-function'
3957 has been set to some other function, that function is called with
3958 the buffer as first, and nil as second argument.
3960 Alternatively, an element of this list can be specified as
3961 \(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
3962 name and FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
3963 `special-display-popup-frame' will interpret such pairs as frame
3964 parameters when it creates a special frame, overriding the
3965 corresponding values from `special-display-frame-alist'.
3967 As a special case, if FRAME-PARAMETERS contains (same-window . t)
3968 `special-display-popup-frame' displays that buffer in the
3969 selected window. If FRAME-PARAMETERS contains (same-frame . t),
3970 it displays that buffer in a window on the selected frame.
3972 If `special-display-function' specifies some other function than
3973 `special-display-popup-frame', that function is called with the
3974 buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
3975 argument.
3977 Finally, an element of this list can be also specified as
3978 \(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
3979 `special-display-popup-frame' will call FUNCTION with the buffer
3980 named BUFFER-NAME as first argument, and OTHER-ARGS as the
3981 second.
3983 Any alternative function specified here is responsible for
3984 setting up the quit-restore parameter of the window used.
3987 name to it but the corresponding buffer is displayed in the
3988 selected window, look at the values of `same-window-buffer-names'
3989 and `same-window-regexps'. Those variables take precedence over
3990 this one.
3992 See also `special-display-regexps'."
4014 ;;;###autoload
4018 "List of regexps saying which buffers should be displayed specially.
4019 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
4020 any regexp in this list matches its name, displays it specially
4021 using `special-display-function'. `special-display-popup-frame'
4022 \(the default for `special-display-function') usually displays
4023 the buffer in a separate frame made with the parameters specified
4024 by `special-display-frame-alist'. If `special-display-function'
4025 has been set to some other function, that function is called with
4026 the buffer as first, and nil as second argument.
4028 Alternatively, an element of this list can be specified as
4029 \(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
4030 FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
4031 `special-display-popup-frame' will then interpret these pairs as
4032 frame parameters when creating a special frame for a buffer whose
4033 name matches REGEXP, overriding the corresponding values from
4034 `special-display-frame-alist'.
4036 As a special case, if FRAME-PARAMETERS contains (same-window . t)
4037 `special-display-popup-frame' displays buffers matching REGEXP in
4038 the selected window. (same-frame . t) in FRAME-PARAMETERS means
4039 to display such buffers in a window on the selected frame.
4041 If `special-display-function' specifies some other function than
4042 `special-display-popup-frame', that function is called with the
4043 buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
4044 as second argument.
4046 Finally, an element of this list can be also specified as
4047 \(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
4048 will then call FUNCTION with the buffer whose name matched
4049 REGEXP as first, and OTHER-ARGS as second argument.
4051 Any alternative function specified here is responsible for
4052 setting up the quit-restore parameter of the window used.
4055 name to it but the corresponding buffer is displayed in the
4056 selected window, look at the values of `same-window-buffer-names'
4057 and `same-window-regexps'. Those variables take precedence over
4058 this one.
4060 See also `special-display-buffer-names'."
4083 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
4084 More precisely, return t if `special-display-buffer-names' or
4085 `special-display-regexps' contain a string entry equaling or
4086 matching BUFFER-NAME. If `special-display-buffer-names' or
4087 `special-display-regexps' contain a list entry whose car equals
4088 or matches BUFFER-NAME, the return value is the cdr of that
4089 entry."
4094 t)
4109 "Alist of parameters for special frames.
4110 Special frames are used for buffers whose names are listed in
4111 `special-display-buffer-names' and for buffers whose names match
4112 one of the regular expressions in `special-display-regexps'.
4114 This variable can be set in your init file, like this:
4116 (setq special-display-frame-alist '((width . 80) (height . 20)))
4118 These supersede the values given in `default-frame-alist'."
4125 "Display BUFFER and return the window chosen.
4126 If BUFFER is already displayed in a visible or iconified frame,
4127 raise that frame. Otherwise, display BUFFER in a new frame.
4129 Optional argument ARGS is a list specifying additional
4130 information.
4132 If ARGS is an alist, use it as a list of frame parameters. If
4133 these parameters contain (same-window . t), display BUFFER in
4134 the selected window. If they contain (same-frame . t), display
4135 BUFFER in a window of the selected frame.
4137 If ARGS is a list whose car is a symbol, use (car ARGS) as a
4138 function to do the work. Pass it BUFFER as first argument,
4139 and (cdr ARGS) as second."
4144 ;; If we have a window already, make it visible.
4150 window))
4151 ;; Reuse the current window if the user requested it.
4156 ;; Stay on the same frame if requested.
4159 pop-up-frames
4160 special-display-buffer-names special-display-regexps)
4162 ;; If no window yet, make one in a new frame.
4168 ;; FIXME: Use window--display-buffer-2?
4170 ;; Reset list of WINDOW's previous buffers to nil.
4173 window)))))
4176 "Function to call for displaying special buffers.
4177 This function is called with two arguments - the buffer and,
4178 optionally, a list - and should return a window displaying that
4179 buffer. The default value usually makes a separate frame for the
4180 buffer using `special-display-frame-alist' to specify the frame
4181 parameters. See the definition of `special-display-popup-frame'
4182 for how to specify such a function.
4184 A buffer is special when its name is either listed in
4185 `special-display-buffer-names' or matches a regexp in
4186 `special-display-regexps'.
4188 The specified function should call `display-buffer-record-window'
4189 with corresponding arguments to set up the quit-restore parameter
4190 of the window used."
4196 `display-buffer' and `pop-to-buffer' show a buffer whose name is
4197 on this list in the selected rather than some other window.
4199 An element of this list can be a cons cell instead of just a
4200 string. In that case, the cell's car must be a string specifying
4201 the buffer name. This is for compatibility with
4202 `special-display-buffer-names'; the cdr of the cons cell is
4203 ignored.
4205 See also `same-window-regexps'."
4211 `display-buffer' and `pop-to-buffer' show a buffer whose name
4212 matches a regexp on this list in the selected rather than some
4213 other window.
4215 An element of this list can be a cons cell instead of just a
4216 string. In that case, the cell's car must be a regexp matching
4217 the buffer name. This is for compatibility with
4218 `special-display-regexps'; the cdr of the cons cell is ignored.
4220 See also `same-window-buffer-names'."
4226 This function returns non-nil if `display-buffer' or
4227 `pop-to-buffer' would show a buffer named BUFFER-NAME in the
4228 selected rather than (as usual) some other window. See
4229 `same-window-buffer-names' and `same-window-regexps'."
4232 ;; The elements of `same-window-buffer-names' can be buffer
4233 ;; names or cons cells whose cars are buffer names.
4238 ;; The elements of `same-window-regexps' can be regexps
4239 ;; or cons cells whose cars are regexps.
4247 "Whether `display-buffer' should make a separate frame.
4248 If nil, never make a separate frame.
4249 If the value is `graphic-only', make a separate frame
4250 on graphic displays only.
4251 Any other non-nil value means always make a separate frame."
4259 "Non-nil means `display-buffer' should reuse frames.
4260 If the buffer in question is already displayed in a frame, raise
4261 that frame."
4267 "Non-nil means `display-buffer' should make a new window."
4272 "Function called by `display-buffer' routines to split a window.
4273 This function is called with a window as single argument and is
4274 supposed to split that window and return the new window. If the
4275 window can (or shall) not be split, it is supposed to return nil.
4276 The default is to call the function `split-window-sensibly' which
4277 tries to split the window in a way which seems most suitable.
4278 You can customize the options `split-height-threshold' and/or
4279 `split-width-threshold' in order to have `split-window-sensibly'
4280 prefer either vertical or horizontal splitting.
4282 If you set this to any other function, bear in mind that the
4283 `display-buffer' routines may call this function two times. The
4284 argument of the first call is the largest window on its frame.
4285 If that call fails to return a live window, the function is
4286 called again with the least recently used window as argument. If
4287 that call fails too, `display-buffer' will use an existing window
4288 to display its buffer.
4290 The window selected at the time `display-buffer' was invoked is
4291 still selected when this function is called. Hence you can
4292 compare the window argument with the value of `selected-window'
4293 if you intend to split the selected window instead or if you do
4294 not want to split the selected window."
4300 "Minimum height for splitting windows sensibly.
4301 If this is an integer, `split-window-sensibly' may split a window
4302 vertically only if it has at least this many lines. If this is
4303 nil, `split-window-sensibly' is not allowed to split a window
4304 vertically. If, however, a window is the only window on its
4305 frame, `split-window-sensibly' may split it vertically
4306 disregarding the value of this variable."
4312 "Minimum width for splitting windows sensibly.
4313 If this is an integer, `split-window-sensibly' may split a window
4314 horizontally only if it has at least this many columns. If this
4315 is nil, `split-window-sensibly' is not allowed to split a window
4316 horizontally."
4322 "Return non-nil if `split-window-sensibly' may split WINDOW.
4323 Optional argument HORIZONTAL nil or omitted means check whether
4324 `split-window-sensibly' may split WINDOW vertically. HORIZONTAL
4325 non-nil means check whether WINDOW may be split horizontally.
4327 WINDOW may be split vertically when the following conditions
4328 hold:
4329 - `window-size-fixed' is either nil or equals `width' for the
4330 buffer of WINDOW.
4331 - `split-height-threshold' is an integer and WINDOW is at least as
4332 high as `split-height-threshold'.
4333 - When WINDOW is split evenly, the emanating windows are at least
4334 `window-min-height' lines tall and can accommodate at least one
4335 line plus - if WINDOW has one - a mode line.
4337 WINDOW may be split horizontally when the following conditions
4338 hold:
4339 - `window-size-fixed' is either nil or equals `height' for the
4340 buffer of WINDOW.
4341 - `split-width-threshold' is an integer and WINDOW is at least as
4342 wide as `split-width-threshold'.
4343 - When WINDOW is split evenly, the emanating windows are at least
4344 `window-min-width' or two (whichever is larger) columns wide."
4348 ;; A window can be split horizontally when its width is not
4349 ;; fixed, it is at least `split-width-threshold' columns wide
4350 ;; and at least twice as wide as `window-min-width' and 2 (the
4351 ;; latter value is hardcoded).
4353 ;; Testing `window-full-width-p' here hardly makes any
4354 ;; sense nowadays. This can be done more intuitively by
4355 ;; setting up `split-width-threshold' appropriately.
4360 ;; A window can be split vertically when its height is not
4361 ;; fixed, it is at least `split-height-threshold' lines high,
4362 ;; and it is at least twice as high as `window-min-height' and 2
4363 ;; if it has a modeline or 1.
4372 "Split WINDOW in a way suitable for `display-buffer'.
4373 If `split-height-threshold' specifies an integer, WINDOW is at
4374 least `split-height-threshold' lines tall and can be split
4375 vertically, split WINDOW into two windows one above the other and
4376 return the lower window. Otherwise, if `split-width-threshold'
4377 specifies an integer, WINDOW is at least `split-width-threshold'
4378 columns wide and can be split horizontally, split WINDOW into two
4379 windows side by side and return the window on the right. If this
4380 can't be done either and WINDOW is the only window on its frame,
4381 try to split WINDOW vertically disregarding any value specified
4382 by `split-height-threshold'. If that succeeds, return the lower
4383 window. Return nil otherwise.
4385 By default `display-buffer' routines call this function to split
4386 the largest or least recently used window. To change the default
4387 customize the option `split-window-preferred-function'.
4389 You can enforce this function to not split WINDOW horizontally,
4390 by setting (or binding) the variable `split-width-threshold' to
4391 nil. If, in addition, you set `split-height-threshold' to zero,
4392 chances increase that this function does split WINDOW vertically.
4394 In order to not split WINDOW vertically, set (or bind) the
4395 variable `split-height-threshold' to nil. Additionally, you can
4396 set `split-width-threshold' to zero to make a horizontal split
4397 more likely to occur.
4399 Have a look at the function `window-splittable-p' if you want to
4400 know how `split-window-sensibly' determines whether WINDOW can be
4401 split."
4403 ;; Split window vertically.
4407 ;; Split window horizontally.
4412 ;; If WINDOW is the only window on its frame and is not the
4413 ;; minibuffer window, try to split it vertically disregarding
4414 ;; the value of `split-height-threshold'.
4421 "Try to split WINDOW.
4422 Return value returned by `split-window-preferred-function' if it
4423 represents a live window, nil otherwise."
4427 ;; Since `split-window-preferred-function' might
4428 ;; throw an error use `condition-case'.
4435 "Return FRAME if it can be used to display a buffer."
4438 ;; `frame-root-window' may be an internal window which is considered
4439 ;; "dead" by `window-live-p'. Hence if `window' is not live we
4440 ;; implicitly know that `frame' has a visible window we can use.
4443 ;; If the window is soft-dedicated, the frame is usable.
4444 ;; Actually, even if the window is really dedicated,
4445 ;; the frame is still usable by splitting it.
4446 ;; At least Emacs-22 allowed it, and it is desirable
4447 ;; when displaying same-frame windows.
4448 nil ; (eq t (window-dedicated-p window))
4449 ))
4450 frame))))
4453 "If non-nil `display-buffer' will try to even window heights.
4454 Otherwise `display-buffer' will leave the window configuration
4455 alone. Heights are evened only when `display-buffer' chooses a
4456 window that appears above or below the selected window."
4461 "Even heights of WINDOW and selected window.
4462 Do this only if these windows are vertically adjacent to each
4463 other, `even-window-heights' is non-nil, and the selected window
4464 is higher than WINDOW."
4467 ;; Don't resize minibuffer windows.
4478 ;; Don't throw an error if we can't even window heights for
4479 ;; whatever reason.
4485 "Raise the frame containing WINDOW.
4486 Do not raise the selected frame. Return WINDOW."
4490 ;; Assume the selected frame is already visible enough.
4492 ;; Assume the frame from which we invoked the minibuffer
4493 ;; is visible.
4497 window))
4500 "Display BUFFER in WINDOW and make its frame visible.
4501 Set `window-dedicated-p' to DEDICATED if non-nil.
4502 Return WINDOW."
4509 ;; FIXME: Not implemented.
4510 ;; FIXME: By the way, there could be more levels of dedication:
4511 ;; - `barely' dedicated doesn't prevent reuse of the window, only records that
4512 ;; the window hasn't been used for something else yet.
4513 ;; - `softly' dedicated only allows reuse when asked explicitly.
4514 ;; - `strongly' never allows reuse.
4516 "If non-nil, `display-buffer' marks the windows it creates as dedicated.
4517 The actual non-nil value of this variable will be copied to the
4534 ,display-buffer--action-function-custom-type
4539 :key-type symbol
4544 "Overriding action to perform to display a buffer.
4545 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4546 function or a list of functions. Each function should accept two
4547 arguments: a buffer to display and an alist similar to ALIST.
4552 "Alist of conditional actions for `display-buffer'.
4553 This is a list of elements (CONDITION . ACTION), where:
4555 CONDITION is either a regexp matching buffer names, or a function
4556 that takes a buffer and returns a boolean.
4558 ACTION is a cons cell (FUNCTION . ALIST), where FUNCTION is a
4559 function or a list of functions. Each such function should
4560 accept two arguments: a buffer to display and an alist of the
4561 same form as ALIST. See `display-buffer' for details."
4564 regexp
4567 :risky t
4572 "User-specified default action for `display-buffer'.
4573 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4574 function or a list of functions. Each function should accept two
4575 arguments: a buffer to display and an alist similar to ALIST.
4576 See `display-buffer' for details."
4577 :type display-buffer--action-custom-type
4578 :risky t
4584 display-buffer-reuse-window
4585 display-buffer--maybe-pop-up-frame-or-window
4586 display-buffer-use-some-window
4587 ;; If all else fails, pop up a new frame.
4588 display-buffer-pop-up-frame))
4589 "Default fallback action for `display-buffer'.
4590 This is the action used by `display-buffer' if no other actions
4591 specified, e.g. by the user options `display-buffer-alist' or
4596 "Retrieve ALIST entry corresponding to BUFFER-NAME."
4614 display-buffer-pop-up-frame)
4621 "Display BUFFER-OR-NAME in some window, without selecting it.
4622 BUFFER-OR-NAME must be a buffer or the name of an existing
4623 buffer. Return the window chosen for displaying BUFFER-OR-NAME,
4624 or nil if no such window is found.
4626 Optional argument ACTION should have the form (FUNCTION . ALIST).
4627 FUNCTION is either a function or a list of functions. Each such
4628 function is called with two arguments: the buffer to display and
4629 an alist. It should either display the buffer and return the
4630 window, or return nil if unable to display the buffer.
4632 The `display-buffer' function builds a function list and an alist
4633 from `display-buffer-overriding-action', `display-buffer-alist',
4634 the ACTION argument, `display-buffer-base-action', and
4635 `display-buffer-fallback-action' (in that order). Then it calls
4636 each function in the combined function list in turn, passing the
4637 buffer as the first argument and the combined alist as the second
4638 argument, until one of the functions returns non-nil.
4640 Available action functions include:
4641 `display-buffer-same-window'
4642 `display-buffer-reuse-window'
4643 `display-buffer-pop-up-frame'
4644 `display-buffer-pop-up-window'
4645 `display-buffer-use-some-window'
4647 Recognized alist entries include:
4649 `inhibit-same-window' -- A non-nil value prevents the same
4650 window from being used for display.
4652 `reusable-frames' -- Value specifies frame(s) to search for a
4653 window that already displays the buffer.
4654 See `display-buffer-reuse-window'.
4656 The ACTION argument to `display-buffer' can also have a non-nil
4657 and non-list value. This means to display the buffer in a window
4658 other than the selected one, even if it is already displayed in
4659 the selected window. If called interactively with a prefix
4660 argument, ACTION is t.
4662 Optional argument FRAME, if non-nil, acts like an additional
4663 ALIST entry (reusable-frames . FRAME), specifying the frame(s) to
4664 search for a window that is already displaying the buffer. See
4665 `display-buffer-reuse-window'."
4669 buffer-or-name
4671 ;; Handle the old form of the first argument.
4675 ;; If `display-buffer-function' is defined, let it do the job.
4677 ;; Otherwise, use the defined actions.
4680 display-buffer-alist))
4682 ;; Extra actions from the arguments to this function:
4688 ;; Construct action function list and action alist.
4690 user-action special-action action extra-action
4691 display-buffer-base-action
4692 display-buffer-fallback-action))
4697 actions)))
4699 window)
4705 window))))
4708 "Display buffer BUFFER in another frame.
4709 This uses the function `display-buffer' as a subroutine; see
4710 its documentation for additional customization information."
4714 ;;; `display-buffer' action functions:
4717 "Display BUFFER in the selected window.
4718 This fails if ALIST has a non-nil `inhibit-same-window' entry, or
4719 if the selected window is a minibuffer window or is dedicated to
4720 another buffer; in that case, return nil. Otherwise, return the
4721 selected window."
4729 "Conditionally display BUFFER in the selected window.
4730 If `same-window-p' returns non-nil for BUFFER's name, call
4731 `display-buffer-same-window' and return its value. Otherwise,
4732 return nil."
4737 "Return a window that is already displaying BUFFER.
4738 Return nil if no usable window is found.
4740 If ALIST has a non-nil `inhibit-same-window' entry, the selected
4741 window is not eligible for reuse.
4743 If ALIST contains a `reusable-frames' entry, its value determines
4744 which frames to search for a reusable window:
4745 nil -- the selected frame (actually the last non-minibuffer frame)
4746 A frame -- just that frame
4747 `visible' -- all visible frames
4748 0 -- all frames on the current terminal
4749 t -- all frames.
4751 If ALIST contains no `reusable-frames' entry, search just the
4752 selected frame if `display-buffer-reuse-frames' and
4753 `pop-up-frames' are both nil; search all frames on the current
4754 terminal if either of those variables is non-nil."
4759 pop-up-frames)
4768 frames))))))
4774 "Return special display action for BUFFER, if any.
4775 If `special-display-p' returns non-nil for BUFFER, return an
4776 appropriate display action involving `special-display-function'.
4777 See `display-buffer' for the format of display actions."
4779 ;; `special-display-p' returns either t or a list of frame
4780 ;; parameters to pass to `special-display-function'.
4789 "Display BUFFER in a new frame.
4790 This works by calling `pop-up-frame-function'. If successful,
4791 return the window used; otherwise return nil."
4793 frame window)
4799 ;; Reset list of WINDOW's previous buffers to nil.
4801 window)))
4804 "Display BUFFER by popping up a new window.
4805 The new window is created on the selected frame, or in
4806 `last-nonminibuffer-frame' if no windows can be created there.
4807 If successful, return the new window; otherwise return nil."
4810 window)
4812 ;; If the selected frame cannot be split, look at
4813 ;; `last-nonminibuffer-frame'.
4818 ;; Attempt to split largest or least recently used window.
4825 ;; Reset list of WINDOW's previous buffers to nil.
4827 window)))
4830 "Try displaying BUFFER based on `pop-up-frames' or `pop-up-windows'.
4832 If `pop-up-frames' is non-nil (and not `graphic-only' on a
4833 text-only terminal), try with `display-buffer-pop-up-frame'.
4835 If that cannot be done, and `pop-up-windows' is non-nil, try
4836 again with `display-buffer-pop-up-window'."
4839 pop-up-frames)
4845 "Display BUFFER in an existing window.
4846 Search for a usable window, set that window to the buffer, and
4847 return the window. If no suitable window is found, return nil."
4850 ;; When NOT-THIS-WINDOW is non-nil, temporarily dedicate the
4851 ;; selected window to its buffer, to prevent any of the
4852 ;; `get-' routines below from choosing it. (Bug#1415)
4858 window)
4861 ;; Reuse an existing window.
4866 window))
4871 window))
4874 ;; Restore dedicated status of selected window.
4881 ;;; Display + selection commands:
4884 "Select buffer BUFFER in some window, preferably a different one.
4885 BUFFER may be a buffer, a string (a buffer name), or nil. If it
4886 is a string not naming an existent buffer, create a buffer with
4887 that name. If BUFFER is nil, choose some other buffer. Return
4888 the buffer.
4890 This uses `display-buffer' as a subroutine. The optional ACTION
4891 argument is passed to `display-buffer' as its ACTION argument.
4892 See `display-buffer' for more information. ACTION is t if called
4893 interactively with a prefix argument, which means to pop to a
4894 window other than the selected one even if the buffer is already
4895 displayed in the selected window.
4897 If the window to show BUFFER is not on the selected
4898 frame, raise that window's frame and give it input focus.
4900 Optional third arg NORECORD non-nil means do not put this buffer
4901 at the front of the list of recently selected ones."
4909 ;; If we chose another frame, make sure it gets input focus.
4912 ;; Make sure new window is selected (Bug#8615), (Bug#6954).
4914 buffer))
4917 "Select buffer BUFFER in some window, preferably the same one.
4918 This function behaves much like `switch-to-buffer', except it
4919 displays with `special-display-function' if BUFFER has a match in
4920 `special-display-buffer-names' or `special-display-regexps'.
4922 Unlike `pop-to-buffer', this function prefers using the selected
4923 window over popping up a new window or frame.
4925 BUFFER may be a buffer, a string (a buffer name), or nil. If it
4926 is a string not naming an existent buffer, create a buffer with
4927 that name. If BUFFER is nil, choose some other buffer. Return
4928 the buffer.
4930 NORECORD, if non-nil means do not put this buffer at the front of
4931 the list of recently selected ones."
4935 "Read the name of a buffer to switch to, prompting with PROMPT.
4936 Return the name of the buffer as a string.
4938 This function is intended for the `switch-to-buffer' family of
4939 commands since these need to omit the name of the current buffer
4940 from the list of completions and default values."
4945 ;; Since rbts-completion-table is built dynamically, we
4946 ;; can't just add it to the default value of
4947 ;; icomplete-with-completion-tables, so we add it
4948 ;; here manually.
4953 icomplete-with-completion-tables))))
4958 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
4959 If BUFFER-OR-NAME is nil, return the buffer returned by
4960 `other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
4961 exists, return that buffer. If no such buffer exists, create a
4962 buffer with the name BUFFER-OR-NAME and return that buffer."
4967 buffer))
4971 "Switch to buffer BUFFER-OR-NAME in the selected window.
4972 If called interactively, prompt for the buffer name using the
4973 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
4974 determines whether to request confirmation before creating a new
4975 buffer.
4977 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
4978 nil. If BUFFER-OR-NAME is a string that does not identify an
4979 existing buffer, create a buffer with that name. If
4980 BUFFER-OR-NAME is nil, switch to the buffer returned by
4981 `other-buffer'.
4983 Optional argument NORECORD non-nil means do not put the buffer
4984 specified by BUFFER-OR-NAME at the front of the buffer list and
4985 do not make the window displaying it the most recently selected
4986 one.
4988 If FORCE-SAME-WINDOW is non-nil, BUFFER-OR-NAME must be displayed
4989 in the selected window; signal an error if that is
4990 impossible (e.g. if the selected window is minibuffer-only). If
4991 nil, BUFFER-OR-NAME may be displayed in another window.
4993 Return the buffer switched to."
4998 ;; Don't call set-window-buffer if it's not needed since it
4999 ;; might signal an error (e.g. if the window is dedicated).
5016 "Select the buffer specified by BUFFER-OR-NAME in another window.
5017 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5018 nil. Return the buffer switched to.
5020 If called interactively, prompt for the buffer name using the
5021 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5022 determines whether to request confirmation before creating a new
5023 buffer.
5025 If BUFFER-OR-NAME is a string and does not identify an existing
5026 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5027 nil, switch to the buffer returned by `other-buffer'.
5029 Optional second argument NORECORD non-nil means do not put this
5030 buffer at the front of the list of recently selected ones.
5032 This uses the function `display-buffer' as a subroutine; see its
5033 documentation for additional customization information."
5040 "Switch to buffer BUFFER-OR-NAME in another frame.
5041 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5042 nil. Return the buffer switched to.
5044 If called interactively, prompt for the buffer name using the
5045 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5046 determines whether to request confirmation before creating a new
5047 buffer.
5049 If BUFFER-OR-NAME is a string and does not identify an existing
5050 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5051 nil, switch to the buffer returned by `other-buffer'.
5053 Optional second arg NORECORD non-nil means do not put this
5054 buffer at the front of the list of recently selected ones.
5056 This uses the function `display-buffer' as a subroutine; see its
5057 documentation for additional customization information."
5061 \f
5063 "Set the height in lines of the text display area of WINDOW to HEIGHT.
5064 WINDOW must be a live window. HEIGHT doesn't include the mode
5065 line or header line, if any, or any partial-height lines in the
5066 text display area.
5068 Note that the current implementation of this function cannot
5069 always set the height exactly, but attempts to be conservative,
5070 by allocating more lines than are actually needed in the case
5071 where some error may be present."
5075 ;; Setting window-min-height to a value like 1 can lead to very
5076 ;; bizarre displays because it also allows Emacs to make *other*
5077 ;; windows 1-line tall, which means that there's no more space for
5078 ;; the modeline.
5083 "Make selected window DELTA columns wider.
5084 Interactively, if no argument is given, make selected window one
5085 column wider."
5090 "Make selected window DELTA columns narrower.
5091 Interactively, if no argument is given, make selected window one
5092 column narrower."
5097 "Return the number of screen lines in the region.
5098 The number of screen lines may be different from the number of actual lines,
5099 due to line breaking, display table, etc.
5101 Optional arguments BEG and END default to `point-min' and `point-max'
5102 respectively.
5104 If region ends with a newline, ignore it unless optional third argument
5105 COUNT-FINAL-NEWLINE is non-nil.
5107 The optional fourth argument WINDOW specifies the window used for obtaining
5108 parameters such as width, horizontal scrolling, and so on. The default is
5109 to use the selected window's parameters.
5111 Like `vertical-motion', `count-screen-lines' always uses the current buffer,
5112 regardless of which buffer is displayed in WINDOW. This makes possible to use
5113 `count-screen-lines' in any buffer, whether or not it is currently displayed
5114 in some window."
5120 0
5133 "Return the height (in screen lines) of the buffer that WINDOW is displaying."
5137 ;; If buffer ends with a newline, ignore it when
5138 ;; counting height unless point is after it.
5140 window))))
5142 ;;; Resizing buffers to fit their contents exactly.
5144 "Adjust height of WINDOW to display its buffer's contents exactly.
5145 WINDOW can be any live window and defaults to the selected one.
5147 Optional argument MAX-HEIGHT specifies the maximum height of
5148 WINDOW and defaults to the height of WINDOW's frame. Optional
5149 argument MIN-HEIGHT specifies the minimum height of WINDOW and
5150 defaults to `window-min-height'. Both MAX-HEIGHT and MIN-HEIGHT
5151 are specified in lines and include the mode line and header line,
5152 if any.
5154 Optional argument OVERRIDE non-nil means override restrictions
5155 imposed by `window-min-height' and `window-min-width' on the size
5156 of WINDOW.
5158 Return the number of lines by which WINDOW was enlarged or
5159 shrunk. If an error occurs during resizing, return nil but don't
5160 signal an error.
5162 Note that even if this function makes WINDOW large enough to show
5163 _all_ lines of its buffer you might not see the first lines when
5164 WINDOW was scrolled."
5166 ;; Do all the work in WINDOW and its buffer and restore the selected
5167 ;; window and the current buffer when we're done.
5169 ;; Can't resize a full height or fixed-size window.
5172 ;; `with-selected-window' should orderly restore the current buffer.
5174 ;; We are in WINDOW's buffer now.
5180 window-safe-min-height)))
5183 ;; Adjust MAX-HEIGHT.
5186 max-window-height
5188 ;; Make `desired-height' the height necessary to show
5189 ;; all of WINDOW's buffer, constrained by MIN-HEIGHT
5190 ;; and MAX-HEIGHT.
5195 ;; For non-minibuffers count the mode line, if any.
5197 mode-line-format)
5198 1
5200 ;; Count the header line, if any.
5202 max-height)
5203 min-height))
5212 ;; This `condition-case' shouldn't be necessary, but who knows?
5215 ;; Return zero if DELTA became zero in the process.
5216 0
5217 ;; Don't try to redisplay with the cursor at the end on its
5218 ;; own line--that would force a scroll and spoil things.
5220 ;; It's silly to put `point' at the end of the previous
5221 ;; line and so maybe force horizontal scrolling.
5223 ;; Call `window-resize' with OVERRIDE argument equal WINDOW.
5225 ;; Check if the last line is surely fully visible. If
5226 ;; not, enlarge the window.
5230 ;; Don't include final newline.
5233 ;; If line-wrapping is turned off, test the
5234 ;; beginning of the last line for
5235 ;; visibility instead of the end, as the
5236 ;; end of the line could be invisible by
5237 ;; virtue of extending past the edge of the
5238 ;; window.
5242 ;; This loop might in some rare pathological cases raise
5243 ;; an error - another reason for the `condition-case'.
5250 delta))))
5253 "Return t if WINDOW can be shrunk without shrinking other windows.
5254 WINDOW defaults to the selected window."
5261 "Shrink height of WINDOW if its buffer doesn't need so many lines.
5262 More precisely, shrink WINDOW vertically to be as small as
5263 possible, while still showing the full contents of its buffer.
5264 WINDOW defaults to the selected window.
5266 Do not shrink WINDOW to less than `window-min-height' lines. Do
5267 nothing if the buffer contains more lines than the present window
5268 height, or if some of the window's contents are scrolled out of
5269 view, or if shrinking this window would also shrink another
5270 window, or if the window is the only window of its frame.
5272 Return non-nil if the window was shrunk, nil otherwise."
5275 ;; Make sure that WINDOW is vertically combined and `point-min' is
5276 ;; visible (for whatever reason that's needed). The remaining issues
5277 ;; should be taken care of by `fit-window-to-buffer'.
5281 \f
5283 "Kill the current buffer and delete the selected window."
5292 ;; If `delete-window' failed before, we rerun it to regenerate
5293 ;; the error so it can be seen in the echo area.
5296 ;; If the buffer is not dead for some reason (probably because
5297 ;; of a `quit' signal), remove the hook again.
5302 \f
5304 "Indicates the last recenter operation performed.
5308 "Cycling order for `recenter-top-bottom'.
5309 A list of elements with possible values `top', `middle', `bottom',
5310 integer or float numbers that define the cycling order for
5311 the command `recenter-top-bottom'.
5313 Top and bottom destinations are `scroll-margin' lines from the true
5314 window top and bottom. Middle redraws the frame and centers point
5315 vertically within the window. Integer number moves current line to
5316 the specified absolute window-line. Float number between 0.0 and 1.0
5317 means the percentage of the screen space from the top. The default
5318 cycling order is middle -> top -> bottom."
5329 "Move current buffer line to the specified window line.
5330 With no prefix argument, successive calls place point according
5331 to the cycling order defined by `recenter-positions'.
5333 A prefix argument is handled like `recenter':
5334 With numeric prefix ARG, move current line to window-line ARG.
5335 With plain `C-u', move current line to window center."
5343 recenter-positions))
5362 "Position point relative to window.
5364 With a prefix argument ARG, acts like `move-to-window-line'.
5366 With no argument, positions point at center of window.
5367 Successive calls position point at positions defined
5368 by `recenter-positions'."
5376 recenter-positions))
5393 \f
5394 ;;; Scrolling commands.
5396 ;;; Scrolling commands which do not signal errors at top/bottom
5397 ;;; of buffer at first key-press (instead move to top/bottom
5398 ;;; of buffer).
5401 "Move point to top/bottom of buffer before signaling a scrolling error.
5402 A value of nil means just signal an error if no more scrolling possible.
5403 A value of t means point moves to the beginning or the end of the buffer
5404 \(depending on scrolling direction) when no more scrolling possible.
5405 When point is already on that position, then signal an error."
5411 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
5412 If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
5413 scroll window further, move cursor to the bottom line.
5414 When point is already on that position, then signal an error.
5415 A near full screen is `next-screen-context-lines' less than a full screen.
5416 Negative ARG means scroll downward.
5417 If ARG is the atom `-', scroll downward by nearly full screen."
5433 ;; When scrolling by ARG lines can't be done,
5434 ;; move by ARG lines instead.
5436 ;; When ARG is nil for full-screen scrolling,
5437 ;; move to the bottom of the buffer.
5443 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
5444 If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
5445 scroll window further, move cursor to the top line.
5446 When point is already on that position, then signal an error.
5447 A near full screen is `next-screen-context-lines' less than a full screen.
5448 Negative ARG means scroll upward.
5449 If ARG is the atom `-', scroll upward by nearly full screen."
5465 ;; When scrolling by ARG lines can't be done,
5466 ;; move by ARG lines instead.
5468 ;; When ARG is nil for full-screen scrolling,
5469 ;; move to the top of the buffer.
5474 ;;; Scrolling commands which scroll a line instead of full screen.
5477 "Scroll text of selected window upward ARG lines; or one line if no ARG.
5478 If ARG is omitted or nil, scroll upward by one line.
5479 This is different from `scroll-up-command' that scrolls a full screen."
5486 "Scroll text of selected window down ARG lines; or one line if no ARG.
5487 If ARG is omitted or nil, scroll down by one line.
5488 This is different from `scroll-down-command' that scrolls a full screen."
5494 \f
5497 For more details, see the documentation for `scroll-other-window'."
5500 ;; Just invert the argument's meaning.
5501 ;; We can do that without knowing which window it will be.
5507 "Move point to the beginning of the buffer in the other window.
5508 Leave mark at previous position.
5509 With arg N, put point N/10 of the way from the true beginning."
5513 ;; We use unwind-protect rather than save-window-excursion
5514 ;; because the latter would preserve the things we want to change.
5518 ;; Set point and mark in that window's buffer.
5521 ;; Set point accordingly.
5526 "Move point to the end of the buffer in the other window.
5527 Leave mark at previous position.
5528 With arg N, put point N/10 of the way from the true end."
5530 ;; See beginning-of-buffer-other-window for comments.
5540 \f
5551 "When non-nil, special state of delayed window autoselection.
5552 Possible values are `suspend' (suspend autoselection after a menu or
5553 scrollbar interaction) and `select' (the next invocation of
5557 "Cancel delayed window autoselection.
5558 Optional argument FORCE means cancel unconditionally."
5560 ;; Don't cancel for select-window or select-frame events
5561 ;; or when the user drags a scroll bar.
5573 "Start delayed window autoselection.
5574 MOUSE-POSITION is the last position where the mouse was seen as returned
5575 by `mouse-position'. Optional argument WINDOW non-nil denotes the
5576 window where the mouse was seen. Optional argument SUSPEND non-nil
5577 means suspend autoselection."
5578 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
5582 ;; Install timer which runs `mouse-autoselect-window-select' after
5583 ;; `mouse-autoselect-window' seconds.
5589 "Select window with delayed window autoselection.
5590 If the mouse position has stabilized in a non-selected window, select
5591 that window. The minibuffer window is selected only if the minibuffer
5592 is active. This function is run by `mouse-autoselect-window-timer'."
5603 ;; A menu / popup dialog is active or the mouse is on the scroll-bar
5604 ;; of WINDOW, temporarily suspend delayed autoselection.
5607 ;; Delayed autoselection was temporarily suspended, reenable it.
5612 ;; If `mouse-autoselect-window' is positive, select
5613 ;; window if the window is the same as before.
5615 ;; Otherwise select window if the mouse is at the same
5616 ;; position as before. Observe that the first test after
5617 ;; starting autoselection usually fails since the value of
5618 ;; `mouse-autoselect-window-position' recorded there is the
5619 ;; position where the mouse has entered the new window and
5620 ;; not necessarily where the mouse has stopped moving.
5622 ;; The minibuffer is a candidate window if it's active.
5625 ;; Mouse position has stabilized in non-selected window: Cancel
5626 ;; delayed autoselection and try to select that window.
5628 ;; Select window where mouse appears unless the selected window is the
5629 ;; minibuffer. Use `unread-command-events' in order to execute pre-
5630 ;; and post-command hooks and trigger idle timers. To avoid delaying
5631 ;; autoselection again, set `mouse-autoselect-window-state'."
5636 unread-command-events))))
5640 ;; Mouse position has either stabilized in the selected window or at
5641 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
5644 ;; Mouse position has not stabilized yet, resume delayed
5645 ;; autoselection.
5649 "Handle select-window events."
5653 ;; Don't switch if we're currently in the minibuffer.
5654 ;; This tries to work around problems where the
5655 ;; minibuffer gets unselected unexpectedly, and where
5656 ;; you then have to move your mouse all the way down to
5657 ;; the minibuffer to select it.
5659 ;; Don't switch to minibuffer window unless it's active.
5662 ;; Don't switch when autoselection shall be delayed.
5667 ;; Cancel any delayed autoselection.
5669 ;; Start delayed autoselection from current mouse
5670 ;; position and window.
5672 ;; Executing a command cancels delayed autoselection.
5676 ;; Reset state of delayed autoselection.
5678 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
5683 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
5684 WINDOW defaults to the selected window.
5685 Return nil if WINDOW is not a partial-width window
5686 (regardless of the value of `truncate-lines').
5687 Otherwise, consult the value of `truncate-partial-width-windows'
5688 for the buffer shown in WINDOW."
5696 t-p-w-w))))
5697 \f
5698 ;; Some of these are in tutorial--default-keys, so update that if you
5699 ;; change these.
5712 ;;; window.el ends here