| blob | dcf7394b2041eeb6f39bbdde88ef23e03cbe02a7 |
1 ;;; window.el --- GNU Emacs window commands aside from those written in C
3 ;; Copyright (C) 1985, 1989, 1992-1994, 2000-2011
4 ;; Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: internal
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; Window tree functions.
29 ;;; Code:
34 "Execute BODY, then select the previously selected window.
35 The value returned is the value of the last form in BODY.
37 This macro saves and restores the selected window, as well as the
38 selected window in each frame. If the previously selected window
39 is no longer live, then whatever window is selected at the end of
40 BODY remains selected. If the previously selected window of some
41 frame is no longer live at the end of BODY, that frame's selected
42 window is left alone.
44 This macro saves and restores the current buffer, since otherwise
45 its normal operation could make a different buffer current. The
46 order of recently selected windows and the buffer list ordering
47 are not altered by this macro (unless they are altered in BODY)."
50 ;; It is necessary to save all of these, because calling
51 ;; select-window changes frame-selected-window for whatever
52 ;; frame that window is in.
66 ;; The following two functions are like `window-next-sibling' and
67 ;; `window-prev-sibling' but the WINDOW argument is _not_ optional (so
68 ;; they don't substitute the selected window for nil), and they return
69 ;; nil when WINDOW doesn't have a parent (like a frame's root window or
70 ;; a minibuffer window).
72 "Return WINDOW's right sibling.
73 Return nil if WINDOW is the root window of its frame. WINDOW can
74 be any window."
78 "Return WINDOW's left sibling.
79 Return nil if WINDOW is the root window of its frame. WINDOW can
80 be any window."
84 "Return WINDOW's first child window."
88 "Return number of WINDOW's child windows."
94 count))
97 "Return last child window of WINDOW."
101 window)
104 "Return t if OBJECT denotes a live window or internal window.
105 Otherwise, return nil; this includes the case where OBJECT is a
106 deleted window."
109 t))
112 "Return buffer specified by BUFFER-OR-NAME.
113 BUFFER-OR-NAME must be either a buffer or a string naming a live
114 buffer and defaults to the current buffer."
120 buffer-or-name
127 "Return frame specified by FRAME.
128 FRAME must be a live frame and defaults to the selected frame."
131 frame
136 "Return window specified by WINDOW.
137 If WINDOW is nil, return `selected-window'.
138 If WINDOW is a live window or internal window, return WINDOW;
139 if LIVE-ONLY is non-nil, return WINDOW for a live window only.
140 Otherwise, signal an error."
145 window
148 window
152 "If non-nil, standard functions ignore window parameters.
153 The functions currently affected by this are `split-window',
154 `delete-window', `delete-other-windows' and `other-window'.
156 An application may bind this to a non-nil value around calls to
160 "The absolute minimum number of lines of a window.
164 "The minimum number of lines of any window.
165 The value has to accommodate a mode- or header-line if present.
166 A value less than `window-safe-min-height' is ignored. The value
167 of this variable is honored when windows are resized or split.
169 Applications should never rebind this variable. To resize a
170 window to a height less than the one specified here, an
171 application should instead call `window-resize' with a non-nil
172 IGNORE argument. In order to have `split-window' make a window
173 shorter, 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 code)
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.
1812 this-delta other-delta)
1813 ;; Decide which windows shall be left alone.
1817 ;; Make sure WINDOW is left alone when
1818 ;; resizing its siblings.
1822 ;; Make sure this sibling is left alone when
1823 ;; resizing its siblings.
1827 ;; Set this-delta to t to signal that we found a sibling
1828 ;; of WINDOW whose size is not fixed.
1833 ;; Set this-delta to what we can get from WINDOW's siblings.
1835 ;; A deletion, presumably. We must handle this case
1836 ;; specially since `window--resizable' can't be used.
1838 ;; There's at least one resizable sibling we can
1839 ;; give WINDOW's size to.
1841 ;; No resizable sibling exists.
1843 ;; Any other form of resizing.
1847 ;; Set other-delta to what we still have to get from
1848 ;; ancestor windows of parent.
1851 ;; Unless we got everything from WINDOW's siblings, PARENT
1852 ;; must be resized by other-delta lines or columns.
1856 ;; We haven't got anything from WINDOW's siblings but we
1857 ;; must update the normal sizes to respect other-delta.
1859 parent horizontal window this-delta trail other-delta)
1860 ;; We did get something from WINDOW's siblings which means
1861 ;; we have to resize their child windows.
1864 window ignore trail edge)
1865 ;; If `window--resize-child-windows' returns
1866 ;; 'normalized, this means it has set the
1867 ;; normal sizes already.
1869 ;; Set the normal sizes.
1871 parent horizontal window this-delta trail other-delta))
1872 ;; Set DELTA to what we still have to get from ancestor
1873 ;; windows.
1876 ;; In an ortho-combination all siblings of WINDOW must be
1877 ;; resized by DELTA.
1885 ;; "Go up."
1887 parent delta horizontal ignore trail edge)))))
1890 "Resize WINDOW vertically by DELTA lines.
1891 Optional argument HORIZONTAL non-nil means resize WINDOW
1892 horizontally by DELTA columns.
1894 Optional argument IGNORE non-nil means ignore any restrictions
1895 imposed by fixed size windows, `window-min-height' or
1896 `window-min-width' settings. IGNORE equal `safe' means live
1897 windows may get as small as `window-safe-min-height' lines and
1898 `window-safe-min-width' columns. IGNORE any window means ignore
1899 restrictions for that window only.
1901 Optional argument ADD non-nil means add DELTA to the new total
1902 size of WINDOW.
1904 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1905 of windows that shall be resized. If TRAIL equals `before',
1906 resize only windows on the left or above EDGE. If TRAIL equals
1907 `after', resize only windows on the right or below EDGE. Also,
1908 preferably only resize windows adjacent to EDGE.
1910 This function recursively resizes WINDOW's child windows to fit the
1911 new size. Make sure that WINDOW is `window--resizable' before
1912 calling this function. Note that this function does not resize
1913 siblings of WINDOW or WINDOW's parent window. You have to
1914 eventually call `window-resize-apply' in order to make resizing
1915 actually take effect."
1917 ;; Add DELTA to the new total size of WINDOW.
1924 ;; In an iso-combination resize child windows according to their
1925 ;; normal sizes.
1927 window delta horizontal nil ignore trail edge))
1928 ;; In an ortho-combination resize each child window by DELTA.
1932 sub delta horizontal ignore t trail edge)
1936 "Resize root window WINDOW vertically by DELTA lines.
1937 HORIZONTAL non-nil means resize root window WINDOW horizontally
1938 by DELTA columns.
1940 IGNORE non-nil means ignore any restrictions imposed by fixed
1941 size windows, `window-min-height' or `window-min-width' settings.
1943 This function is only called by the frame resizing routines. It
1944 resizes windows proportionally and never deletes any windows."
1951 "Resize root window WINDOW vertically by DELTA lines.
1952 If DELTA is less than zero and we can't shrink WINDOW by DELTA
1953 lines, shrink it as much as possible. If DELTA is greater than
1954 zero, this function can resize fixed-size windows in order to
1955 recover the necessary lines.
1957 Return the number of lines that were recovered.
1959 This function is only called by the minibuffer window resizing
1960 routines. It resizes windows proportionally and never deletes
1961 any windows."
1972 ;; Ideally, we would resize just the last window in a combination
1973 ;; but that's not feasible for the following reason: If we grow
1974 ;; the minibuffer window and the last window cannot be shrunk any
1975 ;; more, we shrink another window instead. But if we then shrink
1976 ;; the minibuffer window again, the last window might get enlarged
1977 ;; and the state after shrinking is not the state before growing.
1978 ;; So, in practice, we'd need a history variable to record how to
1979 ;; proceed. But I'm not sure how such a variable could work with
1980 ;; repeated minibuffer window growing steps.
1982 delta)))
1985 "Move WINDOW's bottom edge by DELTA lines.
1986 Optional argument HORIZONTAL non-nil means move WINDOW's right
1987 edge by DELTA columns. WINDOW defaults to the selected window.
1989 If DELTA is greater zero, then move the edge downwards or to the
1990 right. If DELTA is less than zero, move the edge upwards or to
1991 the left. If the edge can't be moved by DELTA lines or columns,
1992 move it as far as possible in the desired direction."
1996 left this-delta min-delta max-delta failed)
1997 ;; Find the edge we want to move.
2010 ;; Set LEFT to the first resizable window on the left. This step is
2011 ;; needed to handle fixed-size windows.
2024 ;; Set RIGHT to the first resizable window on the right. This step
2025 ;; is needed to handle fixed-size windows.
2038 ;; LEFT and RIGHT (which might be both internal windows) are now the
2039 ;; two windows we want to resize.
2045 ;; We can't get the whole DELTA - move as far as possible.
2048 ;; Start resizing.
2050 ;; Try to enlarge LEFT first.
2054 left this-delta horizontal nil t 'before
2058 ;; Shrink windows on right of LEFT.
2060 left delta horizontal nil 'after
2068 ;; We can't get the whole DELTA - move as far as possible.
2071 ;; Start resizing.
2073 ;; Try to enlarge RIGHT.
2077 right this-delta horizontal nil t 'after
2081 ;; Shrink windows on left of RIGHT.
2088 ;; Don't report an error in the standard case.
2090 ;; But do report an error if applying the changes fails.
2094 "Make selected window DELTA lines taller.
2095 Interactively, if no argument is given, make the selected window
2096 one line taller. If optional argument HORIZONTAL is non-nil,
2097 make selected window wider by DELTA columns. If DELTA is
2098 negative, shrink selected window by -DELTA lines or columns.
2099 Return nil."
2112 horizontal))))
2115 "Make selected window DELTA lines smaller.
2116 Interactively, if no argument is given, make the selected window
2117 one line smaller. If optional argument HORIZONTAL is non-nil,
2118 make selected window narrower by DELTA columns. If DELTA is
2119 negative, enlarge selected window by -DELTA lines or columns.
2120 Return nil."
2133 horizontal))))
2136 "Maximize WINDOW.
2137 Make WINDOW as large as possible without deleting any windows.
2138 WINDOW can be any window and defaults to the selected window."
2145 "Minimize WINDOW.
2146 Make WINDOW as small as possible without deleting any windows.
2147 WINDOW can be any window and defaults to the selected window."
2152 \f
2154 "Return non-nil if WINDOW is the root window of its frame."
2158 "Return window subtree rooted at WINDOW.
2159 Optional argument NEXT non-nil means include WINDOW's right
2160 siblings in the return value.
2162 See the documentation of `window-tree' for a description of the
2163 return value."
2176 list))
2181 "Return the window tree of frame FRAME.
2182 FRAME must be a live frame and defaults to the selected frame.
2183 The return value is a list of the form (ROOT MINI), where ROOT
2184 represents the window tree of the frame's root window, and MINI
2185 is the frame's minibuffer window.
2187 If the root window is not split, ROOT is the root window itself.
2188 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
2189 for a horizontal split, and t for a vertical split. EDGES gives
2190 the combined size and position of the child windows in the split,
2191 and the rest of the elements are the child windows in the split.
2192 Each of the child windows may again be a window or a list
2193 representing a window split, and so on. EDGES is a list (LEFT
2194 TOP RIGHT BOTTOM) as returned by `window-edges'."
2197 \f
2199 "Select another window in cyclic ordering of windows.
2200 COUNT specifies the number of windows to skip, starting with the
2201 selected window, before making the selection. If COUNT is
2202 positive, skip COUNT windows forwards. If COUNT is negative,
2203 skip -COUNT windows backwards. COUNT zero means do not skip any
2204 window, so select the selected window. In an interactive call,
2205 COUNT is the numeric prefix argument. Return nil.
2207 If the `other-window' parameter of the selected window is a
2208 function and `ignore-window-parameters' is nil, call that
2209 function with the arguments COUNT and ALL-FRAMES.
2211 This function does not select a window whose `no-other-window'
2212 window parameter is non-nil.
2214 This function uses `next-window' for finding the window to
2215 select. The argument ALL-FRAMES has the same meaning as in
2216 `next-window', but the MINIBUF argument of `next-window' is
2217 always effectively nil."
2222 old-window old-count)
2225 ;; `next-window' and `previous-window' may return a window we are
2226 ;; not allowed to select. Hence we need an exit strategy in case
2227 ;; all windows are non-selectable.
2234 ;; Keep out of infinite loops. When COUNT has not changed
2235 ;; since we last looked at `window' we're probably in one.
2239 ;; The first non-selectable window `next-window' got us:
2240 ;; Remember it and the current value of COUNT.
2250 ;; Keep out of infinite loops. When COUNT has not changed
2251 ;; since we last looked at `window' we're probably in one.
2255 ;; The first non-selectable window `previous-window' got
2256 ;; us: Remember it and the current value of COUNT.
2263 ;; Always return nil.
2264 nil))))
2266 ;; This should probably return non-nil when the selected window is part
2267 ;; of an atomic window whose root is the frame's root window.
2269 "Return non-nil if the selected window is the only window.
2270 Optional arg NOMINI non-nil means don't count the minibuffer
2271 even if it is active. Otherwise, the minibuffer is counted
2272 when it is active.
2274 Optional argument ALL-FRAMES specifies the set of frames to
2275 consider, see also `next-window'. ALL-FRAMES nil or omitted
2276 means consider windows on the selected frame only, plus the
2277 minibuffer window if specified by the NOMINI argument. If the
2278 minibuffer counts, consider all windows on all frames that share
2279 that minibuffer too. The remaining non-nil values of ALL-FRAMES
2280 with a special meaning are:
2282 - t means consider all windows on all existing frames.
2284 - `visible' means consider all windows on all visible frames on
2285 the current terminal.
2287 - 0 (the number zero) means consider all windows on all visible
2288 and iconified frames on the current terminal.
2290 - A frame means consider all windows on that frame only.
2292 Anything else means consider all windows on the selected frame
2293 and no others."
2299 \f
2300 ;;; Deleting windows.
2302 "Return t if WINDOW can be safely deleted from its frame.
2303 Return `frame' if deleting WINDOW should also delete its
2304 frame."
2308 ;; Handle atomicity.
2317 ;; WINDOW's frame can be deleted only if there are other frames
2318 ;; on the same terminal.
2324 ;; WINDOW can be deleted unless it is the main window of its
2325 ;; frame.
2326 t))))
2329 "Return t if WINDOW is either ROOT or a member of ROOT's subtree."
2339 "Delete WINDOW.
2340 WINDOW can be an arbitrary window and defaults to the selected
2341 one. Return nil.
2343 If the variable `ignore-window-parameters' is non-nil or the
2344 `delete-window' parameter of WINDOW equals t, do not process any
2345 parameters of WINDOW. Otherwise, if the `delete-window'
2346 parameter of WINDOW specifies a function, call that function with
2347 WINDOW as its sole argument and return the value returned by that
2348 function.
2350 Otherwise, if WINDOW is part of an atomic window, call
2351 `delete-window' with the root of the atomic window as its
2352 argument. If WINDOW is the only window on its frame or the last
2353 non-side window, signal an error."
2359 atom-root)
2362 ;; Handle window parameters.
2364 ;; Ignore window parameters if `ignore-window-parameters' tells
2365 ;; us so or `delete-window' equals t.
2368 ;; The `delete-window' parameter specifies the function to call.
2369 ;; If that function is `ignore' nothing is done. It's up to the
2370 ;; function called here to avoid infinite recursion.
2387 ;; Emacs 23 preferably gives WINDOW's space to its left
2388 ;; sibling.
2394 ;; Resize WINDOW's sibling.
2400 ;; Can do without resizing fixed-size windows.
2403 ;; Can't do without resizing fixed-size windows.
2405 ;; Actually delete WINDOW.
2410 ;; `delete-window-internal' has selected a window that should
2411 ;; not be selected, fix this here.
2415 ;; Always return nil.
2416 nil))))
2419 "Make WINDOW fill its frame.
2420 WINDOW may be any window and defaults to the selected one.
2421 Return nil.
2423 If the variable `ignore-window-parameters' is non-nil or the
2424 `delete-other-windows' parameter of WINDOW equals t, do not
2425 process any parameters of WINDOW. Otherwise, if the
2426 `delete-other-windows' parameter of WINDOW specifies a function,
2427 call that function with WINDOW as its sole argument and return
2428 the value returned by that function.
2430 Otherwise, if WINDOW is part of an atomic window, call this
2431 function with the root of the atomic window as its argument. If
2432 WINDOW is a non-side window, make WINDOW the only non-side window
2433 on the frame. Side windows are not deleted. If WINDOW is a side
2434 window signal an error."
2440 atom-root side-main)
2444 ;; Ignore window parameters if `ignore-window-parameters' is t or
2445 ;; `delete-other-windows' is t.
2448 ;; The `delete-other-windows' parameter specifies the function
2449 ;; to call. If the function is `ignore' no windows are deleted.
2450 ;; It's up to the function called to avoid infinite recursion.
2457 ;; Set side-main to the major non-side window.
2461 ;; If WINDOW is the main non-side window, do nothing.
2466 ;; Always return nil.
2467 nil)))
2470 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
2472 if you often split windows horizontally."
2484 ;;; Windows and buffers.
2486 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
2487 ;; for (1) determining which buffer to show in the window when its
2488 ;; buffer shall be buried or killed and (2) which buffer to show for
2489 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2491 ;; `prev-buffers' consists of <buffer, window-start, window-point>
2492 ;; triples. The entries on this list are ordered by the time their
2493 ;; buffer has been removed from the window, the most recently removed
2494 ;; buffer's entry being first. The window-start and window-point
2495 ;; components are `window-start' and `window-point' at the time the
2496 ;; buffer was removed from the window which implies that the entry must
2497 ;; be added when `set-window-buffer' removes the buffer from the window.
2499 ;; `next-buffers' is the list of buffers that have been replaced
2500 ;; recently by `switch-to-prev-buffer'. These buffers are the least
2501 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
2502 ;; candidates of `switch-to-next-buffer' to switch to. This list is
2503 ;; reset to nil by any action changing the window's buffer with the
2504 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
2505 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
2506 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
2508 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
2509 ;; if such a buffer was killed while the window was hidden within a
2510 ;; window configuration. Such killed buffers get removed whenever
2511 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
2513 ;; The following function is called by `set-window-buffer' _before_ it
2514 ;; replaces the buffer of the argument window with the new buffer.
2516 "Record WINDOW's buffer.
2517 WINDOW must be a live window and defaults to the selected one."
2521 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
2522 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2526 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
2530 ;; Don't record insignificant buffers.
2532 ;; Add an entry for buffer to WINDOW's previous buffers.
2539 ;; We have an entry, update marker positions.
2542 ;; Make new markers.
2550 "Unrecord BUFFER in WINDOW.
2551 WINDOW must be a live window and defaults to the selected one.
2552 BUFFER must be a live buffer and defaults to the buffer of
2553 WINDOW."
2562 "Set WINDOW's buffer to BUFFER.
2563 Optional argument START non-nil means set WINDOW's start position
2564 to START. Optional argument POINT non-nil means set WINDOW's
2565 point to POINT. If WINDOW is selected this also sets BUFFER's
2566 `point' to POINT. If WINDOW is selected and the buffer it showed
2567 before was current this also makes BUFFER the current buffer."
2574 ;; Don't force window-start here (even if POINT is nil).
2580 "In WINDOW switch to previous buffer.
2581 WINDOW must be a live window and defaults to the selected one.
2583 Optional argument BURY-OR-KILL non-nil means the buffer currently
2584 shown in WINDOW is about to be buried or killed and consequently
2585 shall not be switched to in future invocations of this command."
2589 ;; Save this since it's destroyed by `set-window-buffer'.
2591 entry new-buffer killed-buffers visible)
2596 ;; Scan WINDOW's previous buffers first, skipping entries of next
2597 ;; buffers.
2609 ;; Scan reverted buffer list of WINDOW's frame next, skipping
2610 ;; entries of next buffers. Note that when we bury or kill a
2611 ;; buffer we don't reverse the global buffer list to avoid showing
2612 ;; a buried buffer instead. Otherwise, we must reverse the global
2613 ;; buffer list in order to make sure that switching to the
2614 ;; previous/next buffer traverse it in opposite directions.
2623 ;; Try to avoid showing a buffer visible in some other window.
2629 ;; Scan reverted next buffers last (must not use nreverse
2630 ;; here!).
2632 ;; Actually, buffer _must_ be live here since otherwise it
2633 ;; would have been caught in the scan of previous buffers.
2644 ;; Show a buffer visible in another window.
2650 ;; Remove `old-buffer' from WINDOW's previous and (restored list
2651 ;; of) next buffers.
2656 ;; Move `old-buffer' to head of WINDOW's restored list of next
2657 ;; buffers.
2661 ;; Remove killed buffers from WINDOW's previous and next buffers.
2669 ;; Return new-buffer.
2670 new-buffer))
2673 "In WINDOW switch to next buffer.
2674 WINDOW must be a live window and defaults to the selected one."
2679 new-buffer entry killed-buffers visible)
2684 ;; Scan WINDOW's next buffers first.
2695 ;; Scan the buffer list of WINDOW's frame next, skipping previous
2696 ;; buffers entries.
2702 ;; Try to avoid showing a buffer visible in some other window.
2707 ;; Scan WINDOW's reverted previous buffers last (must not use
2708 ;; nreverse here!)
2719 ;; Show a buffer visible in another window.
2724 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
2727 ;; Remove killed buffers from WINDOW's previous and next buffers.
2735 ;; Return new-buffer.
2736 new-buffer))
2739 "Search LIST for a valid buffer to display in FRAME.
2740 Return nil when all buffers in LIST are undesirable for display,
2741 otherwise return the first suitable buffer in LIST.
2743 Buffers not visible in windows are preferred to visible buffers,
2744 unless VISIBLE-OK is non-nil.
2745 If the optional argument FRAME is nil, it defaults to the selected frame.
2746 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
2747 ;; This logic is more or less copied from other-buffer.
2750 found buf)
2763 "Return the last buffer in FRAME's buffer list.
2764 If BUFFER is the last buffer, return the preceding buffer
2765 instead. Buffers not visible in windows are preferred to visible
2766 buffers, unless optional argument VISIBLE-OK is non-nil.
2767 Optional third argument FRAME nil or omitted means use the
2768 selected frame's buffer list. If no such buffer exists, return
2769 the buffer `*scratch*', creating it if necessary."
2772 buffer visible-ok frame)
2776 scratch)))
2779 "Function called to automatically hide frames.
2780 The function is called with one argument - a frame.
2782 Functions affected by this option are those that bury a buffer
2783 shown in a separate frame like `quit-window' and `bury-buffer'."
2787 function)
2793 "Delete WINDOW if possible.
2794 WINDOW must be a live window and defaults to the selected one.
2795 Optional argument DEDICATED-ONLY non-nil means to delete WINDOW
2796 only if it's dedicated to its buffer. Optional argument KILL
2797 means the buffer shown in window will be killed. Return non-nil
2798 if WINDOW gets deleted or its frame is auto-hidden."
2814 t)))))
2817 "Put BUFFER-OR-NAME at the end of the list of all buffers.
2818 There it is the least likely candidate for `other-buffer' to
2820 select by default.
2822 You can specify a buffer name as BUFFER-OR-NAME, or an actual
2823 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
2824 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
2825 remove the current buffer from the selected window if it is
2826 displayed there."
2829 ;; If `buffer-or-name' is not on the selected frame we unrecord it
2830 ;; although it's not "here" (call it a feature).
2832 ;; Handle case where `buffer-or-name' is nil and the current buffer
2833 ;; is shown in the selected window.
2838 ;; Switch to another buffer in window.
2842 ;; Always return nil.
2843 nil))
2846 "Switch to the last buffer in the buffer list."
2851 "In selected window switch to next buffer."
2858 "In selected window switch to previous buffer."
2865 "Delete all windows showing BUFFER-OR-NAME.
2866 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2867 and defaults to the current buffer.
2869 The following non-nil values of the optional argument FRAME
2870 have special meanings:
2872 - t means consider all windows on the selected frame only.
2874 - `visible' means consider all windows on all visible frames on
2875 the current terminal.
2877 - 0 (the number zero) means consider all windows on all visible
2878 and iconified frames on the current terminal.
2880 - A frame means consider all windows on that frame only.
2882 Any other value of FRAME means consider all windows on all
2883 frames.
2885 When a window showing BUFFER-OR-NAME is dedicated and the only
2886 window of its frame, that frame is deleted when there are other
2887 frames left."
2890 ;; Handle the "inverted" meaning of the FRAME argument wrt other
2891 ;; `window-list-1' based function.
2898 ;; Delete frame if and only if window is dedicated.
2901 ;; Delete window.
2904 ;; In window switch to previous buffer.
2907 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
2911 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
2912 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2913 and defaults to the current buffer.
2915 When a window showing BUFFER-OR-NAME is dedicated, that window is
2916 deleted. If that window is the only window on its frame, the
2917 frame is deleted too when there are other frames left. If there
2918 are no other frames left, some other buffer is displayed in that
2919 window.
2921 This function removes the buffer denoted by BUFFER-OR-NAME from
2922 all window-local buffer lists."
2928 ;; Switch to another buffer in window.
2931 ;; Unrecord BUFFER in WINDOW.
2935 "Quit WINDOW and bury its buffer.
2936 WINDOW must be a live window and defaults to the selected one.
2937 With prefix argument KILL non-nil, kill the buffer instead of
2938 burying it.
2940 According to information stored in WINDOW's `quit-restore' window
2941 parameter either (1) delete WINDOW and its frame, (2) delete
2942 WINDOW, (3) restore the buffer previously displayed in WINDOW,
2943 or (4) make WINDOW display some other buffer than the present
2944 one. If non-nil, reset `quit-restore' parameter to nil."
2955 buffer))))
2956 prev-buffer)))
2957 quad resize)
2962 ;; Delete WINDOW if possible.
2964 ;; If the previously selected window is still alive, select it.
2970 ;; Show another buffer stored in quit-restore parameter.
2976 ;; Try to resize WINDOW to its old height but don't signal an
2977 ;; error.
2981 ;; Restore WINDOW's previous buffer, start and point position.
2984 ;; Unrecord WINDOW's buffer here (Bug#9937) to make sure it's not
2985 ;; re-recorded by `set-window-buffer'.
2987 ;; Reset the quit-restore parameter.
2989 ;; Select old window.
2993 ;; Show some other buffer in WINDOW and reset the quit-restore
2994 ;; parameter.
2996 ;; Make sure that WINDOW is no more dedicated.
3000 ;; Kill WINDOW's old-buffer if requested
3006 "Quit all windows showing BUFFER-OR-NAME.
3007 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
3008 and defaults to the current buffer. Optional argument KILL
3009 non-nil means to kill BUFFER-OR-NAME. KILL nil means to bury
3010 BUFFER-OR-NAME. Optional argument FRAME is handled as by
3011 `delete-windows-on'.
3013 This function calls `quit-window' on all candidate windows
3014 showing BUFFER-OR-NAME."
3017 ;; Handle the "inverted" meaning of the FRAME argument wrt other
3018 ;; `window-list-1' based function.
3023 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
3025 \f
3026 ;;; Splitting windows.
3028 "Return minimum height of any window when splitting windows.
3029 Optional argument HORIZONTAL non-nil means return minimum width."
3035 "Make a new window adjacent to WINDOW.
3036 WINDOW can be any window and defaults to the selected one.
3037 Return the new window which is always a live window.
3039 Optional argument SIZE a positive number means make WINDOW SIZE
3040 lines or columns tall. If SIZE is negative, make the new window
3041 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
3042 absolute value can be less than `window-min-height' or
3043 `window-min-width'; so this command can make a new window as
3044 small as one line or two columns. SIZE defaults to half of
3045 WINDOW's size. Interactively, SIZE is the prefix argument.
3047 Optional third argument SIDE nil (or `below') specifies that the
3048 new window shall be located below WINDOW. SIDE `above' means the
3049 new window shall be located above WINDOW. In both cases SIZE
3050 specifies the new number of lines for WINDOW (or the new window
3051 if SIZE is negative) including space reserved for the mode and/or
3052 header line.
3054 SIDE t (or `right') specifies that the new window shall be
3055 located on the right side of WINDOW. SIDE `left' means the new
3056 window shall be located on the left of WINDOW. In both cases
3057 SIZE specifies the new number of columns for WINDOW (or the new
3058 window provided SIZE is negative) including space reserved for
3059 fringes and the scrollbar or a divider column. Any other non-nil
3060 value for SIDE is currently handled like t (or `right').
3062 If the variable `ignore-window-parameters' is non-nil or the
3063 `split-window' parameter of WINDOW equals t, do not process any
3064 parameters of WINDOW. Otherwise, if the `split-window' parameter
3065 of WINDOW specifies a function, call that function with all three
3066 arguments and return the value returned by that function.
3069 root of that atomic window. The new window does not become a
3070 member of that atomic window.
3072 If WINDOW is live, properties of the new window like margins and
3073 scrollbars are inherited from WINDOW. If WINDOW is an internal
3074 window, these properties as well as the buffer displayed in the
3075 new window are inherited from the window selected on WINDOW's
3076 frame. The selected window is not changed by this function."
3088 ;; Rebind `window-combination-limit' since in some cases we may
3089 ;; have to override its value.
3091 atom-root)
3096 ;; Ignore window parameters if either `ignore-window-parameters'
3097 ;; is t or the `split-window' parameter equals t.
3100 ;; The `split-window' parameter specifies the function to call.
3101 ;; If that function is `ignore', do nothing.
3103 ;; If WINDOW is part of an atomic window, split the root window
3104 ;; of that atomic window instead.
3113 ;; WINDOW is a side root window. To make sure that a new parent
3114 ;; window gets created set `window-combination-limit' to t.
3118 ;; If `window-combination-resize' is non-nil and SIZE is a
3119 ;; non-negative integer, we cannot reasonably resize other
3120 ;; windows. Rather bind `window-combination-limit' to t to make
3121 ;; sure that subsequent window deletions are handled correctly.
3125 ;; `parent-size' is the size of WINDOW's parent, provided
3126 ;; it has one.
3128 ;; `resize' non-nil means we are supposed to resize other
3129 ;; windows in WINDOW's combination.
3132 ;; Resize makes sense in iso-combinations only.
3134 ;; `old-size' is the current size of WINDOW.
3136 ;; `new-size' is the specified or calculated size of the
3137 ;; new window.
3143 ;; When resizing try to give the new window the
3144 ;; average size of a window in its combination.
3147 (/ parent-size
3149 parent horizontal))))
3150 ;; Else try to give the new window half the size
3151 ;; of WINDOW (plus an eventual odd line).
3154 ;; SIZE non-negative specifies the new size of WINDOW.
3156 ;; Note: Specifying a non-negative SIZE is practically
3157 ;; always done as workaround for making the new window
3158 ;; appear above or on the left of the new window (the
3159 ;; ispell window is a typical example of that). In all
3160 ;; these cases the SIDE argument should be set to 'above
3161 ;; or 'left in order to support the 'resize option.
3162 ;; Here we have to nest the windows instead, see above.
3165 ;; SIZE negative specifies the size of the new window.
3167 new-parent new-normal)
3169 ;; Check SIZE.
3174 ;; SIZE unspecified, resizing.
3176 ;; Try again with minimum split size.
3182 ;; SIZE unspecified, no resizing.
3187 window-safe-min-width
3188 window-safe-min-width))))
3189 ;; SIZE specified as new size of old window. If the new size
3190 ;; is larger than the old size or the size of the new window
3191 ;; would be less than the safe minimum, signal an error.
3194 ;; SIZE specified, resizing.
3196 ;; If we cannot resize the parent give up.
3202 ;; SIZE specification violates minimum size restrictions.
3208 ;; Make new-parent non-nil if we need a new parent window;
3209 ;; either because we want to nest or because WINDOW is not
3210 ;; iso-combined.
3214 ;; Make new-normal the normal size of the new window.
3222 ;; Try to get space from OLD's siblings. We could go "up" and
3223 ;; try getting additional space from surrounding windows but
3224 ;; we won't be able to return space to those windows when we
3225 ;; delete the one we create here. Hence we do not go up.
3234 ;; Get entire space from WINDOW.
3239 new-normal)))
3242 ;; Inherit window-side parameters, if any.
3249 ;; Always return the new window.
3250 new)))))
3252 ;; I think this should be the default; I think people will prefer it--rms.
3255 If nil, adjust point in the two windows to minimize redisplay.
3256 This option applies only to `split-window-below' and functions
3257 that call it. The low-level `split-window' function always keeps
3258 the original point in both windows."
3263 "Split the selected window into two windows, one above the other.
3264 The selected window is above. The newly split-off window is
3265 below, and displays the same buffer. Return the new window.
3267 If optional argument SIZE is omitted or nil, both windows get the
3268 same height, or close to it. If SIZE is positive, the upper
3269 \(selected) window gets SIZE lines. If SIZE is negative, the
3270 lower (new) window gets -SIZE lines.
3272 If the variable `split-window-keep-point' is non-nil, both
3273 windows get the same value of point as the selected window.
3274 Otherwise, the window starts are chosen so as to minimize the
3275 amount of redisplay; this is convenient on slow terminals."
3280 moved-by-window-height moved new-window bottom)
3282 ;; `split-window' would not signal an error here.
3303 ;; Always copy quit-restore parameter in interactive use.
3307 new-window))
3312 "Split the selected window into two side-by-side windows.
3313 The selected window is on the left. The newly split-off window
3314 is on the right, and displays the same buffer. Return the new
3315 window.
3317 If optional argument SIZE is omitted or nil, both windows get the
3318 same width, or close to it. If SIZE is positive, the left-hand
3319 \(selected) window gets SIZE columns. If SIZE is negative, the
3320 right-hand (new) window gets -SIZE columns. Here, SIZE includes
3321 the width of the window's scroll bar; if there are no scroll
3322 bars, it includes the width of the divider column to the window's
3323 right, if any."
3327 new-window)
3329 ;; `split-window' would not signal an error here.
3332 ;; Always copy quit-restore parameter in interactive use.
3336 new-window))
3339 \f
3340 ;;; Balancing windows.
3342 ;; The following routine uses the recycled code from an old version of
3343 ;; `window--resize-child-windows'. It's not very pretty, but coding it the way the
3344 ;; new `window--resize-child-windows' code does would hardly make it any shorter or
3345 ;; more readable (FWIW we'd need three loops - one to calculate the
3346 ;; minimum sizes per window, one to enlarge or shrink windows until the
3347 ;; new parent-size matches, and one where we shrink the largest/enlarge
3348 ;; the smallest window).
3350 "Subroutine of `balance-windows-1'.
3351 WINDOW must be a vertical combination (horizontal if HORIZONTAL
3352 is non-nil."
3358 found failed size sub-total sub-delta sub-amount rest)
3373 ;; Ignore child windows that should be ignored or are stuck.
3380 ;; Register the new total size for this child window.
3385 ;; We failed and need a new round.
3391 ;; Fix rounding by trying to enlarge non-stuck windows by one line
3392 ;; (column) until `rest' is zero.
3400 ;; Fix rounding by trying to enlarge stuck windows by one line
3401 ;; (column) until `rest' equals zero.
3411 ;; Record new normal sizes.
3417 ;; Recursively balance each window's child windows.
3422 "Subroutine of `balance-windows'."
3434 "Balance the sizes of windows of WINDOW-OR-FRAME.
3435 WINDOW-OR-FRAME is optional and defaults to the selected frame.
3436 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
3437 windows of that frame. If WINDOW-OR-FRAME denotes a window,
3438 recursively balance the sizes of all child windows of that
3439 window."
3448 window-or-frame)
3452 ;; Balance vertically.
3456 ;; Balance horizontally.
3462 "Return t if WINDOW cannot be resized in DIRECTION.
3463 WINDOW defaults to the selected window. DIRECTION can be
3464 nil (i.e. any), `height' or `width'."
3471 ;;; A different solution to balance-windows.
3473 "Factor by which the window area should be over-estimated.
3474 This is used by `balance-windows-area'.
3479 "Wrapper around `window-resize' with error checking.
3480 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
3481 ;; `window-resize' may fail if delta is too large.
3488 ;;(message "adjust: %s" (error-message-string err))
3492 "Make all visible windows the same area (approximately).
3493 See also `window-area-factor' to change the relative size of
3494 specific buffers."
3497 ;; Remove fixed-size windows.
3502 next)
3503 ;; Resizing a window changes the size of surrounding windows in complex
3504 ;; ways, so it's difficult to balance them all. The introduction of
3505 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
3506 ;; very difficult to do. `balance-window' above takes an off-line
3507 ;; approach: get the whole window tree, then balance it, then try to
3508 ;; adjust the windows so they fit the result.
3509 ;; Here, instead, we take a "local optimization" approach, where we just
3510 ;; go through all the windows several times until nothing needs to be
3511 ;; changed. The main problem with this approach is that it's difficult
3512 ;; to make sure it terminates, so we use some heuristic to try and break
3513 ;; off infinite loops.
3514 ;; After a round without any change, we allow a second, to give a chance
3515 ;; to the carry to propagate a minor imbalance from the end back to
3516 ;; the beginning.
3518 ;; (message "New round")
3524 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
3542 ;; Maybe diff is actually closer to 1 than to 0.
3546 ;; Change things smoothly.
3549 ;; Make sure negligible differences don't accumulate to
3550 ;; become significant.
3552 ;; This used `adjust-window-trailing-edge' before and uses
3553 ;; `window-resize' now. Error wrapping is still needed.
3555 ;; (sit-for 0.5)
3557 ;; If the same change has been seen already for this window,
3558 ;; we're most likely in an endless loop, so don't count it as
3559 ;; a change.
3563 ;; We've now basically balanced all the windows.
3564 ;; But there may be some minor off-by-one imbalance left over,
3565 ;; so let's do some fine tuning.
3566 ;; (bw-finetune wins)
3567 ;; (message "Done in %d rounds" round)
3568 ))
3570 ;;; Window states, how to get them and how to put them in a window.
3575 "Helper function for `window-state-get'."
3584 `(,type
3594 window-state-ignored-parameters)
3597 ;; Make a clone-of parameter.
3602 ;; All buffer related things go in here - make the buffer
3603 ;; current when retrieving `point' and `mark'.
3635 "Return state of WINDOW as a Lisp object.
3636 WINDOW can be any window and defaults to the root window of the
3637 selected frame.
3639 Optional argument MARKERS non-nil means use markers for sampling
3640 positions like `window-point' or `window-start'. MARKERS should
3641 be non-nil only if the value is used for putting the state back
3642 in the same session (note that markers slow down processing).
3644 The return value can be used as argument for `window-state-put'
3645 to put the state recorded here into an arbitrary window. The
3646 value can be also stored on disk and read back in a new session."
3650 window
3653 ;; The return value is a cons whose car specifies some constraints on
3654 ;; the size of WINDOW. The cdr lists the states of the child windows
3655 ;; of WINDOW.
3657 ;; Frame related things would go into a function, say `frame-state',
3658 ;; calling `window-state-get' to insert the frame's root window.
3665 ;; These are probably not needed.
3674 "Helper function for `window-state-put'."
3679 ;; For a leaf window just add unprocessed entries to
3680 ;; `window-state-put-list'.
3686 size new)
3688 ;; Find the next child window. WINDOW always points to the
3689 ;; real window that we want to fill with what we find here.
3692 ;; The last child window. Below `window--state-put-1'
3693 ;; will put into it whatever ITEM has in store.
3695 ;; Not the last child window, prepare for splitting
3696 ;; WINDOW. SIZE is the new (and final) size of the old
3697 ;; window.
3700 ;; Use total size.
3702 ;; Use normalized size and round.
3706 item))))))
3708 ;; Use safe sizes, we try to resize later.
3710 window-safe-min-height
3711 window-safe-min-width)))
3716 ;; We must inherit the combiantion limit, otherwise
3717 ;; we might mess up handling of atomic and side
3718 ;; window.
3720 ;; Give up if we can't resize window down to safe sizes.
3725 ;; When creating the first child window add for parent
3726 ;; unprocessed entries to `window-state-put-list'.
3729 window-state-put-list))))
3731 ;; Now process the current window (either the one we've just
3732 ;; split or the last child of its parent).
3734 ;; Continue with the last window split off.
3738 "Helper function for `window-state-put'."
3747 ;; Process parameters.
3751 ;; Process buffer related state.
3753 ;; We don't want to raise an error here so we create a buffer if
3754 ;; there's none.
3766 ;; Adjust vertically.
3768 ;; A fixed height window, try to restore the original size.
3771 window-size-fixed)
3774 ;; Else check whether the window is not high enough.
3780 ;; Adjust horizontally.
3782 ;; A fixed width window, try to restore the original size.
3785 window-size-fixed)
3788 ;; Else check whether the window is not wide enough.
3794 ;; Set dedicated status.
3796 ;; Install positions (maybe we should do this after all windows
3797 ;; have been created and sized).
3801 ;; I'm not sure whether we should set the mark here, but maybe
3802 ;; it can be used.
3805 ;; Select window if it's the selected one.
3810 "Put window state STATE into WINDOW.
3811 STATE should be the state of a window returned by an earlier
3812 invocation of `window-state-get'. Optional argument WINDOW must
3813 specify a live window and defaults to the selected one.
3815 Optional argument IGNORE non-nil means ignore minimum window
3816 sizes and fixed size restrictions. IGNORE equal `safe' means
3817 windows can get as small as `window-safe-min-height' and
3818 `window-safe-min-width'."
3822 ;; We check here (1) whether the total sizes of root window of
3823 ;; STATE and that of WINDOW are equal so we can avoid
3824 ;; calculating new sizes, and (2) if we do have to resize
3825 ;; whether we can do so without violating size restrictions.
3833 selected)
3851 (> min-width
3853 ;; The check above might not catch all errors due to rounding
3854 ;; issues - so IGNORE equal 'safe might not always produce the
3855 ;; minimum possible state. But such configurations hardly make
3856 ;; sense anyway.
3860 ;; Work on the windows of a temporary buffer to make sure that
3861 ;; splitting proceeds regardless of any buffer local values of
3862 ;; `window-size-fixed'. Release that buffer after the buffers of
3863 ;; all live windows have been set by `window--state-put-2'.
3869 \f
3871 "Record information for window used by `display-buffer'.
3872 TYPE specifies the type of the calling operation and must be one
3873 of the symbols 'reuse (when WINDOW existed already and was
3874 reused for displaying BUFFER), 'window (when WINDOW was created
3875 on an already existing frame), or 'frame (when WINDOW was
3876 created on a new frame). WINDOW is the window used for or created
3877 by the `display-buffer' routines. BUFFER is the buffer that
3878 shall be displayed.
3880 This function installs or updates the quit-restore parameter of
3881 WINDOW. The quit-restore parameter is a list of four elements:
3882 The first element is one of the symbols 'window, 'frame, 'same or
3883 'other. The second element is either one of the symbols 'window
3884 or 'frame or a list whose elements are the buffer previously
3885 shown in the window, that buffer's window start and window point,
3886 and the window's height. The third element is the window
3887 selected at the time the parameter was created. The fourth
3888 element is BUFFER."
3892 ;; WINDOW shows BUFFER already.
3894 ;; If WINDOW has a quit-restore parameter, reset its car.
3896 ;; WINDOW shows another buffer.
3898 window 'quit-restore
3900 ;; A quadruple of WINDOW's buffer, start, point and height.
3905 ;; WINDOW has been created on an existing frame.
3907 window 'quit-restore
3910 ;; WINDOW has been created on a new frame.
3912 window 'quit-restore
3916 "If non-nil, function to call to handle `display-buffer'.
3917 It will receive two args, the buffer and a flag which if non-nil
3918 means that the currently selected window is not acceptable. It
3919 should choose or create a window, display the specified buffer in
3920 it, and return the window.
3922 The specified function should call `display-buffer-record-window'
3923 with corresponding arguments to set up the quit-restore parameter
3924 of the window used."
3931 "Alist of parameters for automatically generated new frames.
3932 You can set this in your init file; for example,
3934 (setq pop-up-frame-alist '((width . 80) (height . 20)))
3936 If non-nil, the value you specify here is used by the default
3937 `pop-up-frame-function' for the creation of new frames.
3939 Since `pop-up-frame-function' is used by `display-buffer' for
3940 making new frames, any value specified here by default affects
3941 the automatic generation of new frames via `display-buffer' and
3942 all functions based on it. The behavior of `make-frame' is not
3943 affected by this variable."
3951 "Function used by `display-buffer' for creating a new frame.
3952 This function is called with no arguments and should return a new
3953 frame. The default value calls `make-frame' with the argument
3954 `pop-up-frame-alist'."
3959 "List of names of buffers that should be displayed specially.
3960 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
3961 its name is in this list, displays the buffer in a way specified
3962 by `special-display-function'. `special-display-popup-frame'
3963 \(the default for `special-display-function') usually displays
3964 the buffer in a separate frame made with the parameters specified
3965 by `special-display-frame-alist'. If `special-display-function'
3966 has been set to some other function, that function is called with
3967 the buffer as first, and nil as second argument.
3969 Alternatively, an element of this list can be specified as
3970 \(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
3971 name and FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
3972 `special-display-popup-frame' will interpret such pairs as frame
3973 parameters when it creates a special frame, overriding the
3974 corresponding values from `special-display-frame-alist'.
3976 As a special case, if FRAME-PARAMETERS contains (same-window . t)
3977 `special-display-popup-frame' displays that buffer in the
3978 selected window. If FRAME-PARAMETERS contains (same-frame . t),
3979 it displays that buffer in a window on the selected frame.
3981 If `special-display-function' specifies some other function than
3982 `special-display-popup-frame', that function is called with the
3983 buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
3984 argument.
3986 Finally, an element of this list can be also specified as
3987 \(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
3988 `special-display-popup-frame' will call FUNCTION with the buffer
3989 named BUFFER-NAME as first argument, and OTHER-ARGS as the
3990 second.
3992 Any alternative function specified here is responsible for
3993 setting up the quit-restore parameter of the window used.
3996 name to it but the corresponding buffer is displayed in the
3997 selected window, look at the values of `same-window-buffer-names'
3998 and `same-window-regexps'. Those variables take precedence over
3999 this one.
4001 See also `special-display-regexps'."
4023 ;;;###autoload
4027 "List of regexps saying which buffers should be displayed specially.
4028 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
4029 any regexp in this list matches its name, displays it specially
4030 using `special-display-function'. `special-display-popup-frame'
4031 \(the default for `special-display-function') usually displays
4032 the buffer in a separate frame made with the parameters specified
4033 by `special-display-frame-alist'. If `special-display-function'
4034 has been set to some other function, that function is called with
4035 the buffer as first, and nil as second argument.
4037 Alternatively, an element of this list can be specified as
4038 \(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
4039 FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
4040 `special-display-popup-frame' will then interpret these pairs as
4041 frame parameters when creating a special frame for a buffer whose
4042 name matches REGEXP, overriding the corresponding values from
4043 `special-display-frame-alist'.
4045 As a special case, if FRAME-PARAMETERS contains (same-window . t)
4046 `special-display-popup-frame' displays buffers matching REGEXP in
4047 the selected window. (same-frame . t) in FRAME-PARAMETERS means
4048 to display such buffers in a window on the selected frame.
4050 If `special-display-function' specifies some other function than
4051 `special-display-popup-frame', that function is called with the
4052 buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
4053 as second argument.
4055 Finally, an element of this list can be also specified as
4056 \(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
4057 will then call FUNCTION with the buffer whose name matched
4058 REGEXP as first, and OTHER-ARGS as second argument.
4060 Any alternative function specified here is responsible for
4061 setting up the quit-restore parameter of the window used.
4064 name to it but the corresponding buffer is displayed in the
4065 selected window, look at the values of `same-window-buffer-names'
4066 and `same-window-regexps'. Those variables take precedence over
4067 this one.
4069 See also `special-display-buffer-names'."
4092 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
4093 More precisely, return t if `special-display-buffer-names' or
4094 `special-display-regexps' contain a string entry equaling or
4095 matching BUFFER-NAME. If `special-display-buffer-names' or
4096 `special-display-regexps' contain a list entry whose car equals
4097 or matches BUFFER-NAME, the return value is the cdr of that
4098 entry."
4103 t)
4118 "Alist of parameters for special frames.
4119 Special frames are used for buffers whose names are listed in
4120 `special-display-buffer-names' and for buffers whose names match
4121 one of the regular expressions in `special-display-regexps'.
4123 This variable can be set in your init file, like this:
4125 (setq special-display-frame-alist '((width . 80) (height . 20)))
4127 These supersede the values given in `default-frame-alist'."
4134 "Display BUFFER and return the window chosen.
4135 If BUFFER is already displayed in a visible or iconified frame,
4136 raise that frame. Otherwise, display BUFFER in a new frame.
4138 Optional argument ARGS is a list specifying additional
4139 information.
4141 If ARGS is an alist, use it as a list of frame parameters. If
4142 these parameters contain (same-window . t), display BUFFER in
4143 the selected window. If they contain (same-frame . t), display
4144 BUFFER in a window of the selected frame.
4146 If ARGS is a list whose car is a symbol, use (car ARGS) as a
4147 function to do the work. Pass it BUFFER as first argument,
4148 and (cdr ARGS) as second."
4153 ;; If we have a window already, make it visible.
4159 window))
4160 ;; Reuse the current window if the user requested it.
4165 ;; Stay on the same frame if requested.
4168 pop-up-frames
4169 special-display-buffer-names special-display-regexps)
4171 ;; If no window yet, make one in a new frame.
4177 ;; FIXME: Use window--display-buffer-2?
4179 ;; Reset list of WINDOW's previous buffers to nil.
4182 window)))))
4185 "Function to call for displaying special buffers.
4186 This function is called with two arguments - the buffer and,
4187 optionally, a list - and should return a window displaying that
4188 buffer. The default value usually makes a separate frame for the
4189 buffer using `special-display-frame-alist' to specify the frame
4190 parameters. See the definition of `special-display-popup-frame'
4191 for how to specify such a function.
4193 A buffer is special when its name is either listed in
4194 `special-display-buffer-names' or matches a regexp in
4195 `special-display-regexps'.
4197 The specified function should call `display-buffer-record-window'
4198 with corresponding arguments to set up the quit-restore parameter
4199 of the window used."
4205 `display-buffer' and `pop-to-buffer' show a buffer whose name is
4206 on this list in the selected rather than some other window.
4208 An element of this list can be a cons cell instead of just a
4209 string. In that case, the cell's car must be a string specifying
4210 the buffer name. This is for compatibility with
4211 `special-display-buffer-names'; the cdr of the cons cell is
4212 ignored.
4214 See also `same-window-regexps'."
4220 `display-buffer' and `pop-to-buffer' show a buffer whose name
4221 matches a regexp on this list in the selected rather than some
4222 other window.
4224 An element of this list can be a cons cell instead of just a
4225 string. In that case, the cell's car must be a regexp matching
4226 the buffer name. This is for compatibility with
4227 `special-display-regexps'; the cdr of the cons cell is ignored.
4229 See also `same-window-buffer-names'."
4235 This function returns non-nil if `display-buffer' or
4236 `pop-to-buffer' would show a buffer named BUFFER-NAME in the
4237 selected rather than (as usual) some other window. See
4238 `same-window-buffer-names' and `same-window-regexps'."
4241 ;; The elements of `same-window-buffer-names' can be buffer
4242 ;; names or cons cells whose cars are buffer names.
4247 ;; The elements of `same-window-regexps' can be regexps
4248 ;; or cons cells whose cars are regexps.
4256 "Whether `display-buffer' should make a separate frame.
4257 If nil, never make a separate frame.
4258 If the value is `graphic-only', make a separate frame
4259 on graphic displays only.
4260 Any other non-nil value means always make a separate frame."
4268 "Non-nil means `display-buffer' should reuse frames.
4269 If the buffer in question is already displayed in a frame, raise
4270 that frame."
4276 "Non-nil means `display-buffer' should make a new window."
4281 "Function called by `display-buffer' routines to split a window.
4282 This function is called with a window as single argument and is
4283 supposed to split that window and return the new window. If the
4284 window can (or shall) not be split, it is supposed to return nil.
4285 The default is to call the function `split-window-sensibly' which
4286 tries to split the window in a way which seems most suitable.
4287 You can customize the options `split-height-threshold' and/or
4288 `split-width-threshold' in order to have `split-window-sensibly'
4289 prefer either vertical or horizontal splitting.
4291 If you set this to any other function, bear in mind that the
4292 `display-buffer' routines may call this function two times. The
4293 argument of the first call is the largest window on its frame.
4294 If that call fails to return a live window, the function is
4295 called again with the least recently used window as argument. If
4296 that call fails too, `display-buffer' will use an existing window
4297 to display its buffer.
4299 The window selected at the time `display-buffer' was invoked is
4300 still selected when this function is called. Hence you can
4301 compare the window argument with the value of `selected-window'
4302 if you intend to split the selected window instead or if you do
4303 not want to split the selected window."
4309 "Minimum height for splitting windows sensibly.
4310 If this is an integer, `split-window-sensibly' may split a window
4311 vertically only if it has at least this many lines. If this is
4312 nil, `split-window-sensibly' is not allowed to split a window
4313 vertically. If, however, a window is the only window on its
4314 frame, `split-window-sensibly' may split it vertically
4315 disregarding the value of this variable."
4321 "Minimum width for splitting windows sensibly.
4322 If this is an integer, `split-window-sensibly' may split a window
4323 horizontally only if it has at least this many columns. If this
4324 is nil, `split-window-sensibly' is not allowed to split a window
4325 horizontally."
4331 "Return non-nil if `split-window-sensibly' may split WINDOW.
4332 Optional argument HORIZONTAL nil or omitted means check whether
4333 `split-window-sensibly' may split WINDOW vertically. HORIZONTAL
4334 non-nil means check whether WINDOW may be split horizontally.
4336 WINDOW may be split vertically when the following conditions
4337 hold:
4338 - `window-size-fixed' is either nil or equals `width' for the
4339 buffer of WINDOW.
4340 - `split-height-threshold' is an integer and WINDOW is at least as
4341 high as `split-height-threshold'.
4342 - When WINDOW is split evenly, the emanating windows are at least
4343 `window-min-height' lines tall and can accommodate at least one
4344 line plus - if WINDOW has one - a mode line.
4346 WINDOW may be split horizontally when the following conditions
4347 hold:
4348 - `window-size-fixed' is either nil or equals `height' for the
4349 buffer of WINDOW.
4350 - `split-width-threshold' is an integer and WINDOW is at least as
4351 wide as `split-width-threshold'.
4352 - When WINDOW is split evenly, the emanating windows are at least
4353 `window-min-width' or two (whichever is larger) columns wide."
4357 ;; A window can be split horizontally when its width is not
4358 ;; fixed, it is at least `split-width-threshold' columns wide
4359 ;; and at least twice as wide as `window-min-width' and 2 (the
4360 ;; latter value is hardcoded).
4362 ;; Testing `window-full-width-p' here hardly makes any
4363 ;; sense nowadays. This can be done more intuitively by
4364 ;; setting up `split-width-threshold' appropriately.
4369 ;; A window can be split vertically when its height is not
4370 ;; fixed, it is at least `split-height-threshold' lines high,
4371 ;; and it is at least twice as high as `window-min-height' and 2
4372 ;; if it has a modeline or 1.
4381 "Split WINDOW in a way suitable for `display-buffer'.
4382 If `split-height-threshold' specifies an integer, WINDOW is at
4383 least `split-height-threshold' lines tall and can be split
4384 vertically, split WINDOW into two windows one above the other and
4385 return the lower window. Otherwise, if `split-width-threshold'
4386 specifies an integer, WINDOW is at least `split-width-threshold'
4387 columns wide and can be split horizontally, split WINDOW into two
4388 windows side by side and return the window on the right. If this
4389 can't be done either and WINDOW is the only window on its frame,
4390 try to split WINDOW vertically disregarding any value specified
4391 by `split-height-threshold'. If that succeeds, return the lower
4392 window. Return nil otherwise.
4394 By default `display-buffer' routines call this function to split
4395 the largest or least recently used window. To change the default
4396 customize the option `split-window-preferred-function'.
4398 You can enforce this function to not split WINDOW horizontally,
4399 by setting (or binding) the variable `split-width-threshold' to
4400 nil. If, in addition, you set `split-height-threshold' to zero,
4401 chances increase that this function does split WINDOW vertically.
4403 In order to not split WINDOW vertically, set (or bind) the
4404 variable `split-height-threshold' to nil. Additionally, you can
4405 set `split-width-threshold' to zero to make a horizontal split
4406 more likely to occur.
4408 Have a look at the function `window-splittable-p' if you want to
4409 know how `split-window-sensibly' determines whether WINDOW can be
4410 split."
4412 ;; Split window vertically.
4416 ;; Split window horizontally.
4421 ;; If WINDOW is the only window on its frame and is not the
4422 ;; minibuffer window, try to split it vertically disregarding
4423 ;; the value of `split-height-threshold'.
4430 "Try to split WINDOW.
4431 Return value returned by `split-window-preferred-function' if it
4432 represents a live window, nil otherwise."
4436 ;; Since `split-window-preferred-function' might
4437 ;; throw an error use `condition-case'.
4444 "Return FRAME if it can be used to display a buffer."
4447 ;; `frame-root-window' may be an internal window which is considered
4448 ;; "dead" by `window-live-p'. Hence if `window' is not live we
4449 ;; implicitly know that `frame' has a visible window we can use.
4452 ;; If the window is soft-dedicated, the frame is usable.
4453 ;; Actually, even if the window is really dedicated,
4454 ;; the frame is still usable by splitting it.
4455 ;; At least Emacs-22 allowed it, and it is desirable
4456 ;; when displaying same-frame windows.
4457 nil ; (eq t (window-dedicated-p window))
4458 ))
4459 frame))))
4462 "If non-nil `display-buffer' will try to even window heights.
4463 Otherwise `display-buffer' will leave the window configuration
4464 alone. Heights are evened only when `display-buffer' chooses a
4465 window that appears above or below the selected window."
4470 "Even heights of WINDOW and selected window.
4471 Do this only if these windows are vertically adjacent to each
4472 other, `even-window-heights' is non-nil, and the selected window
4473 is higher than WINDOW."
4476 ;; Don't resize minibuffer windows.
4487 ;; Don't throw an error if we can't even window heights for
4488 ;; whatever reason.
4494 "Raise the frame containing WINDOW.
4495 Do not raise the selected frame. Return WINDOW."
4499 ;; Assume the selected frame is already visible enough.
4501 ;; Assume the frame from which we invoked the minibuffer
4502 ;; is visible.
4506 window))
4509 "Display BUFFER in WINDOW and make its frame visible.
4510 Set `window-dedicated-p' to DEDICATED if non-nil.
4511 Return WINDOW."
4518 ;; FIXME: Not implemented.
4519 ;; FIXME: By the way, there could be more levels of dedication:
4520 ;; - `barely' dedicated doesn't prevent reuse of the window, only records that
4521 ;; the window hasn't been used for something else yet.
4522 ;; - `softly' dedicated only allows reuse when asked explicitly.
4523 ;; - `strongly' never allows reuse.
4525 "If non-nil, `display-buffer' marks the windows it creates as dedicated.
4526 The actual non-nil value of this variable will be copied to the
4530 "Normalize BUFFER-OR-NAME argument for buffer display functions.
4531 If BUFFER-OR-NAME is nil, return the current buffer. Else, if a
4532 buffer specified by BUFFER-OR-NAME exists, return that buffer.
4533 If no such buffer exists, create a buffer with the name
4534 BUFFER-OR-NAME and return that buffer."
4539 buffer))
4556 ,display-buffer--action-function-custom-type
4561 :key-type symbol
4566 "Overriding action to perform to display a buffer.
4567 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4568 function or a list of functions. Each function should accept two
4569 arguments: a buffer to display and an alist similar to ALIST.
4574 "Alist of conditional actions for `display-buffer'.
4575 This is a list of elements (CONDITION . ACTION), where:
4577 CONDITION is either a regexp matching buffer names, or a function
4578 that takes a buffer and returns a boolean.
4580 ACTION is a cons cell (FUNCTION . ALIST), where FUNCTION is a
4581 function or a list of functions. Each such function should
4582 accept two arguments: a buffer to display and an alist of the
4583 same form as ALIST. See `display-buffer' for details."
4586 regexp
4589 :risky t
4594 "User-specified default action for `display-buffer'.
4595 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4596 function or a list of functions. Each function should accept two
4597 arguments: a buffer to display and an alist similar to ALIST.
4598 See `display-buffer' for details."
4599 :type display-buffer--action-custom-type
4600 :risky t
4606 display-buffer-reuse-window
4607 display-buffer--maybe-pop-up-frame-or-window
4608 display-buffer-use-some-window
4609 ;; If all else fails, pop up a new frame.
4610 display-buffer-pop-up-frame))
4611 "Default fallback action for `display-buffer'.
4612 This is the action used by `display-buffer' if no other actions
4613 specified, e.g. by the user options `display-buffer-alist' or
4618 "Retrieve ALIST entry corresponding to BUFFER-NAME."
4637 display-buffer-pop-up-frame)
4644 "Display BUFFER-OR-NAME in some window, without selecting it.
4645 BUFFER-OR-NAME must be a buffer or the name of an existing
4646 buffer. Return the window chosen for displaying BUFFER-OR-NAME,
4647 or nil if no such window is found.
4649 Optional argument ACTION should have the form (FUNCTION . ALIST).
4650 FUNCTION is either a function or a list of functions. Each such
4651 function is called with two arguments: the buffer to display and
4652 an alist. It should either display the buffer and return the
4653 window, or return nil if unable to display the buffer.
4655 The `display-buffer' function builds a function list and an alist
4656 from `display-buffer-overriding-action', `display-buffer-alist',
4657 the ACTION argument, `display-buffer-base-action', and
4658 `display-buffer-fallback-action' (in that order). Then it calls
4659 each function in the combined function list in turn, passing the
4660 buffer as the first argument and the combined alist as the second
4661 argument, until one of the functions returns non-nil.
4663 Available action functions include:
4664 `display-buffer-same-window'
4665 `display-buffer-reuse-window'
4666 `display-buffer-pop-up-frame'
4667 `display-buffer-pop-up-window'
4668 `display-buffer-use-some-window'
4670 Recognized alist entries include:
4672 `inhibit-same-window' -- A non-nil value prevents the same
4673 window from being used for display.
4675 `reusable-frames' -- Value specifies frame(s) to search for a
4676 window that already displays the buffer.
4677 See `display-buffer-reuse-window'.
4679 The ACTION argument to `display-buffer' can also have a non-nil
4680 and non-list value. This means to display the buffer in a window
4681 other than the selected one, even if it is already displayed in
4682 the selected window. If called interactively with a prefix
4683 argument, ACTION is t.
4685 Optional argument FRAME, if non-nil, acts like an additional
4686 ALIST entry (reusable-frames . FRAME), specifying the frame(s) to
4687 search for a window that is already displaying the buffer. See
4688 `display-buffer-reuse-window'."
4692 ;; Handle the old form of the first argument.
4696 ;; If `display-buffer-function' is defined, let it do the job.
4698 ;; Otherwise, use the defined actions.
4701 display-buffer-alist))
4703 ;; Extra actions from the arguments to this function:
4709 ;; Construct action function list and action alist.
4711 user-action special-action action extra-action
4712 display-buffer-base-action
4713 display-buffer-fallback-action))
4718 actions)))
4720 window)
4726 window))))
4729 "Display buffer BUFFER in another frame.
4730 This uses the function `display-buffer' as a subroutine; see
4731 its documentation for additional customization information."
4735 ;;; `display-buffer' action functions:
4738 "Display BUFFER in the selected window.
4739 This fails if ALIST has a non-nil `inhibit-same-window' entry, or
4740 if the selected window is a minibuffer window or is dedicated to
4741 another buffer; in that case, return nil. Otherwise, return the
4742 selected window."
4750 "Conditionally display BUFFER in the selected window.
4751 If `same-window-p' returns non-nil for BUFFER's name, call
4752 `display-buffer-same-window' and return its value. Otherwise,
4753 return nil."
4758 "Return a window that is already displaying BUFFER.
4759 Return nil if no usable window is found.
4761 If ALIST has a non-nil `inhibit-same-window' entry, the selected
4762 window is not eligible for reuse.
4764 If ALIST contains a `reusable-frames' entry, its value determines
4765 which frames to search for a reusable window:
4766 nil -- the selected frame (actually the last non-minibuffer frame)
4767 A frame -- just that frame
4768 `visible' -- all visible frames
4769 0 -- all frames on the current terminal
4770 t -- all frames.
4772 If ALIST contains no `reusable-frames' entry, search just the
4773 selected frame if `display-buffer-reuse-frames' and
4774 `pop-up-frames' are both nil; search all frames on the current
4775 terminal if either of those variables is non-nil."
4780 pop-up-frames)
4789 frames))))))
4795 "Return special display action for BUFFER, if any.
4796 If `special-display-p' returns non-nil for BUFFER, return an
4797 appropriate display action involving `special-display-function'.
4798 See `display-buffer' for the format of display actions."
4800 ;; `special-display-p' returns either t or a list of frame
4801 ;; parameters to pass to `special-display-function'.
4810 "Display BUFFER in a new frame.
4811 This works by calling `pop-up-frame-function'. If successful,
4812 return the window used; otherwise return nil."
4814 frame window)
4820 ;; Reset list of WINDOW's previous buffers to nil.
4822 window)))
4825 "Display BUFFER by popping up a new window.
4826 The new window is created on the selected frame, or in
4827 `last-nonminibuffer-frame' if no windows can be created there.
4828 If sucessful, return the new window; otherwise return nil."
4831 window)
4833 ;; If the selected frame cannot be split, look at
4834 ;; `last-nonminibuffer-frame'.
4839 ;; Attempt to split largest or least recently used window.
4846 ;; Reset list of WINDOW's previous buffers to nil.
4848 window)))
4851 "Try displaying BUFFER based on `pop-up-frames' or `pop-up-windows'.
4853 If `pop-up-frames' is non-nil (and not `graphic-only' on a
4854 text-only terminal), try with `display-buffer-pop-up-frame'.
4856 If that cannot be done, and `pop-up-windows' is non-nil, try
4857 again with `display-buffer-pop-up-window'."
4860 pop-up-frames)
4866 "Display BUFFER in an existing window.
4867 Search for a usable window, set that window to the buffer, and
4868 return the window. If no suitable window is found, return nil."
4871 ;; When NOT-THIS-WINDOW is non-nil, temporarily dedicate the
4872 ;; selected window to its buffer, to prevent any of the
4873 ;; `get-' routines below from choosing it. (Bug#1415)
4879 window)
4882 ;; Reuse an existing window.
4887 window))
4892 window))
4895 ;; Restore dedicated status of selected window.
4902 ;;; Display + selection commands:
4905 "Select buffer BUFFER in some window, preferably a different one.
4906 BUFFER may be a buffer, a string (a buffer name), or nil. If it
4907 is a string not naming an existent buffer, create a buffer with
4908 that name. If BUFFER is nil, choose some other buffer. Return
4909 the buffer.
4911 This uses `display-buffer' as a subroutine. The optional ACTION
4912 argument is passed to `display-buffer' as its ACTION argument.
4913 See `display-buffer' for more information. ACTION is t if called
4914 interactively with a prefix argument, which means to pop to a
4915 window other than the selected one even if the buffer is already
4916 displayed in the selected window.
4918 If the window to show BUFFER is not on the selected
4919 frame, raise that window's frame and give it input focus.
4921 Optional third arg NORECORD non-nil means do not put this buffer
4922 at the front of the list of recently selected ones."
4931 ;; If we chose another frame, make sure it gets input focus.
4934 ;; Make sure new window is selected (Bug#8615), (Bug#6954).
4936 buffer))
4939 "Select buffer BUFFER in some window, preferably the same one.
4940 This function behaves much like `switch-to-buffer', except it
4941 displays with `special-display-function' if BUFFER has a match in
4942 `special-display-buffer-names' or `special-display-regexps'.
4944 Unlike `pop-to-buffer', this function prefers using the selected
4945 window over popping up a new window or frame.
4947 BUFFER may be a buffer, a string (a buffer name), or nil. If it
4948 is a string not naming an existent buffer, create a buffer with
4949 that name. If BUFFER is nil, choose some other buffer. Return
4950 the buffer.
4952 NORECORD, if non-nil means do not put this buffer at the front of
4953 the list of recently selected ones."
4957 "Read the name of a buffer to switch to, prompting with PROMPT.
4958 Return the name of the buffer as a string.
4960 This function is intended for the `switch-to-buffer' family of
4961 commands since these need to omit the name of the current buffer
4962 from the list of completions and default values."
4967 ;; Since rbts-completion-table is built dynamically, we
4968 ;; can't just add it to the default value of
4969 ;; icomplete-with-completion-tables, so we add it
4970 ;; here manually.
4975 icomplete-with-completion-tables))))
4980 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
4981 If BUFFER-OR-NAME is nil, return the buffer returned by
4982 `other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
4983 exists, return that buffer. If no such buffer exists, create a
4984 buffer with the name BUFFER-OR-NAME and return that buffer."
4989 buffer))
4993 "Switch to buffer BUFFER-OR-NAME in the selected window.
4994 If called interactively, prompt for the buffer name using the
4995 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
4996 determines whether to request confirmation before creating a new
4997 buffer.
4999 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5000 nil. If BUFFER-OR-NAME is a string that does not identify an
5001 existing buffer, create a buffer with that name. If
5002 BUFFER-OR-NAME is nil, switch to the buffer returned by
5003 `other-buffer'.
5005 Optional argument NORECORD non-nil means do not put the buffer
5006 specified by BUFFER-OR-NAME at the front of the buffer list and
5007 do not make the window displaying it the most recently selected
5008 one.
5010 If FORCE-SAME-WINDOW is non-nil, BUFFER-OR-NAME must be displayed
5011 in the selected window; signal an error if that is
5012 impossible (e.g. if the selected window is minibuffer-only). If
5013 nil, BUFFER-OR-NAME may be displayed in another window.
5015 Return the buffer switched to."
5020 ;; Don't call set-window-buffer if it's not needed since it
5021 ;; might signal an error (e.g. if the window is dedicated).
5038 "Select the buffer specified by BUFFER-OR-NAME in another window.
5039 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5040 nil. Return the buffer switched to.
5042 If called interactively, prompt for the buffer name using the
5043 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5044 determines whether to request confirmation before creating a new
5045 buffer.
5047 If BUFFER-OR-NAME is a string and does not identify an existing
5048 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5049 nil, switch to the buffer returned by `other-buffer'.
5051 Optional second argument NORECORD non-nil means do not put this
5052 buffer at the front of the list of recently selected ones.
5054 This uses the function `display-buffer' as a subroutine; see its
5055 documentation for additional customization information."
5062 "Switch to buffer BUFFER-OR-NAME in another frame.
5063 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5064 nil. Return the buffer switched to.
5066 If called interactively, prompt for the buffer name using the
5067 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5068 determines whether to request confirmation before creating a new
5069 buffer.
5071 If BUFFER-OR-NAME is a string and does not identify an existing
5072 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5073 nil, switch to the buffer returned by `other-buffer'.
5075 Optional second arg NORECORD non-nil means do not put this
5076 buffer at the front of the list of recently selected ones.
5078 This uses the function `display-buffer' as a subroutine; see its
5079 documentation for additional customization information."
5083 \f
5085 "Set the height in lines of the text display area of WINDOW to HEIGHT.
5086 WINDOW must be a live window. HEIGHT doesn't include the mode
5087 line or header line, if any, or any partial-height lines in the
5088 text display area.
5090 Note that the current implementation of this function cannot
5091 always set the height exactly, but attempts to be conservative,
5092 by allocating more lines than are actually needed in the case
5093 where some error may be present."
5097 ;; Setting window-min-height to a value like 1 can lead to very
5098 ;; bizarre displays because it also allows Emacs to make *other*
5099 ;; windows 1-line tall, which means that there's no more space for
5100 ;; the modeline.
5105 "Make selected window DELTA columns wider.
5106 Interactively, if no argument is given, make selected window one
5107 column wider."
5112 "Make selected window DELTA columns narrower.
5113 Interactively, if no argument is given, make selected window one
5114 column narrower."
5119 "Return the number of screen lines in the region.
5120 The number of screen lines may be different from the number of actual lines,
5121 due to line breaking, display table, etc.
5123 Optional arguments BEG and END default to `point-min' and `point-max'
5124 respectively.
5126 If region ends with a newline, ignore it unless optional third argument
5127 COUNT-FINAL-NEWLINE is non-nil.
5129 The optional fourth argument WINDOW specifies the window used for obtaining
5130 parameters such as width, horizontal scrolling, and so on. The default is
5131 to use the selected window's parameters.
5133 Like `vertical-motion', `count-screen-lines' always uses the current buffer,
5134 regardless of which buffer is displayed in WINDOW. This makes possible to use
5135 `count-screen-lines' in any buffer, whether or not it is currently displayed
5136 in some window."
5142 0
5155 "Return the height (in screen lines) of the buffer that WINDOW is displaying."
5159 ;; If buffer ends with a newline, ignore it when
5160 ;; counting height unless point is after it.
5162 window))))
5164 ;;; Resizing buffers to fit their contents exactly.
5166 "Adjust height of WINDOW to display its buffer's contents exactly.
5167 WINDOW can be any live window and defaults to the selected one.
5169 Optional argument MAX-HEIGHT specifies the maximum height of
5170 WINDOW and defaults to the height of WINDOW's frame. Optional
5171 argument MIN-HEIGHT specifies the minimum height of WINDOW and
5172 defaults to `window-min-height'. Both MAX-HEIGHT and MIN-HEIGHT
5173 are specified in lines and include the mode line and header line,
5174 if any.
5176 Optional argument OVERRIDE non-nil means override restrictions
5177 imposed by `window-min-height' and `window-min-width' on the size
5178 of WINDOW.
5180 Return the number of lines by which WINDOW was enlarged or
5181 shrunk. If an error occurs during resizing, return nil but don't
5182 signal an error.
5184 Note that even if this function makes WINDOW large enough to show
5185 _all_ lines of its buffer you might not see the first lines when
5186 WINDOW was scrolled."
5188 ;; Do all the work in WINDOW and its buffer and restore the selected
5189 ;; window and the current buffer when we're done.
5191 ;; Can't resize a full height or fixed-size window.
5194 ;; `with-selected-window' should orderly restore the current buffer.
5196 ;; We are in WINDOW's buffer now.
5202 window-safe-min-height)))
5205 ;; Adjust MAX-HEIGHT.
5208 max-window-height
5210 ;; Make `desired-height' the height necessary to show
5211 ;; all of WINDOW's buffer, constrained by MIN-HEIGHT
5212 ;; and MAX-HEIGHT.
5217 ;; For non-minibuffers count the mode line, if any.
5219 mode-line-format)
5220 1
5222 ;; Count the header line, if any.
5224 max-height)
5225 min-height))
5234 ;; This `condition-case' shouldn't be necessary, but who knows?
5237 ;; Return zero if DELTA became zero in the process.
5238 0
5239 ;; Don't try to redisplay with the cursor at the end on its
5240 ;; own line--that would force a scroll and spoil things.
5242 ;; It's silly to put `point' at the end of the previous
5243 ;; line and so maybe force horizontal scrolling.
5245 ;; Call `window-resize' with OVERRIDE argument equal WINDOW.
5247 ;; Check if the last line is surely fully visible. If
5248 ;; not, enlarge the window.
5252 ;; Don't include final newline.
5255 ;; If line-wrapping is turned off, test the
5256 ;; beginning of the last line for
5257 ;; visibility instead of the end, as the
5258 ;; end of the line could be invisible by
5259 ;; virtue of extending past the edge of the
5260 ;; window.
5264 ;; This loop might in some rare pathological cases raise
5265 ;; an error - another reason for the `condition-case'.
5272 delta))))
5275 "Return t if WINDOW can be shrunk without shrinking other windows.
5276 WINDOW defaults to the selected window."
5283 "Shrink height of WINDOW if its buffer doesn't need so many lines.
5284 More precisely, shrink WINDOW vertically to be as small as
5285 possible, while still showing the full contents of its buffer.
5286 WINDOW defaults to the selected window.
5288 Do not shrink WINDOW to less than `window-min-height' lines. Do
5289 nothing if the buffer contains more lines than the present window
5290 height, or if some of the window's contents are scrolled out of
5291 view, or if shrinking this window would also shrink another
5292 window, or if the window is the only window of its frame.
5294 Return non-nil if the window was shrunk, nil otherwise."
5297 ;; Make sure that WINDOW is vertically combined and `point-min' is
5298 ;; visible (for whatever reason that's needed). The remaining issues
5299 ;; should be taken care of by `fit-window-to-buffer'.
5303 \f
5305 "Kill the current buffer and delete the selected window."
5314 ;; If `delete-window' failed before, we rerun it to regenerate
5315 ;; the error so it can be seen in the echo area.
5318 ;; If the buffer is not dead for some reason (probably because
5319 ;; of a `quit' signal), remove the hook again.
5324 \f
5326 "Indicates the last recenter operation performed.
5330 "Cycling order for `recenter-top-bottom'.
5331 A list of elements with possible values `top', `middle', `bottom',
5332 integer or float numbers that define the cycling order for
5333 the command `recenter-top-bottom'.
5335 Top and bottom destinations are `scroll-margin' lines from the true
5336 window top and bottom. Middle redraws the frame and centers point
5337 vertically within the window. Integer number moves current line to
5338 the specified absolute window-line. Float number between 0.0 and 1.0
5339 means the percentage of the screen space from the top. The default
5340 cycling order is middle -> top -> bottom."
5351 "Move current buffer line to the specified window line.
5352 With no prefix argument, successive calls place point according
5353 to the cycling order defined by `recenter-positions'.
5355 A prefix argument is handled like `recenter':
5356 With numeric prefix ARG, move current line to window-line ARG.
5357 With plain `C-u', move current line to window center."
5365 recenter-positions))
5384 "Position point relative to window.
5386 With a prefix argument ARG, acts like `move-to-window-line'.
5388 With no argument, positions point at center of window.
5389 Successive calls position point at positions defined
5390 by `recenter-positions'."
5398 recenter-positions))
5415 \f
5416 ;;; Scrolling commands.
5418 ;;; Scrolling commands which do not signal errors at top/bottom
5419 ;;; of buffer at first key-press (instead move to top/bottom
5420 ;;; of buffer).
5423 "Move point to top/bottom of buffer before signaling a scrolling error.
5424 A value of nil means just signal an error if no more scrolling possible.
5425 A value of t means point moves to the beginning or the end of the buffer
5426 \(depending on scrolling direction) when no more scrolling possible.
5427 When point is already on that position, then signal an error."
5433 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
5434 If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
5435 scroll window further, move cursor to the bottom line.
5436 When point is already on that position, then signal an error.
5437 A near full screen is `next-screen-context-lines' less than a full screen.
5438 Negative ARG means scroll downward.
5439 If ARG is the atom `-', scroll downward by nearly full screen."
5455 ;; When scrolling by ARG lines can't be done,
5456 ;; move by ARG lines instead.
5458 ;; When ARG is nil for full-screen scrolling,
5459 ;; move to the bottom of the buffer.
5465 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
5466 If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
5467 scroll window further, move cursor to the top line.
5468 When point is already on that position, then signal an error.
5469 A near full screen is `next-screen-context-lines' less than a full screen.
5470 Negative ARG means scroll upward.
5471 If ARG is the atom `-', scroll upward by nearly full screen."
5487 ;; When scrolling by ARG lines can't be done,
5488 ;; move by ARG lines instead.
5490 ;; When ARG is nil for full-screen scrolling,
5491 ;; move to the top of the buffer.
5496 ;;; Scrolling commands which scroll a line instead of full screen.
5499 "Scroll text of selected window upward ARG lines; or one line if no ARG.
5500 If ARG is omitted or nil, scroll upward by one line.
5501 This is different from `scroll-up-command' that scrolls a full screen."
5508 "Scroll text of selected window down ARG lines; or one line if no ARG.
5509 If ARG is omitted or nil, scroll down by one line.
5510 This is different from `scroll-down-command' that scrolls a full screen."
5516 \f
5519 For more details, see the documentation for `scroll-other-window'."
5522 ;; Just invert the argument's meaning.
5523 ;; We can do that without knowing which window it will be.
5529 "Move point to the beginning of the buffer in the other window.
5530 Leave mark at previous position.
5531 With arg N, put point N/10 of the way from the true beginning."
5535 ;; We use unwind-protect rather than save-window-excursion
5536 ;; because the latter would preserve the things we want to change.
5540 ;; Set point and mark in that window's buffer.
5543 ;; Set point accordingly.
5548 "Move point to the end of the buffer in the other window.
5549 Leave mark at previous position.
5550 With arg N, put point N/10 of the way from the true end."
5552 ;; See beginning-of-buffer-other-window for comments.
5562 \f
5573 "When non-nil, special state of delayed window autoselection.
5574 Possible values are `suspend' (suspend autoselection after a menu or
5575 scrollbar interaction) and `select' (the next invocation of
5579 "Cancel delayed window autoselection.
5580 Optional argument FORCE means cancel unconditionally."
5582 ;; Don't cancel for select-window or select-frame events
5583 ;; or when the user drags a scroll bar.
5595 "Start delayed window autoselection.
5596 MOUSE-POSITION is the last position where the mouse was seen as returned
5597 by `mouse-position'. Optional argument WINDOW non-nil denotes the
5598 window where the mouse was seen. Optional argument SUSPEND non-nil
5599 means suspend autoselection."
5600 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
5604 ;; Install timer which runs `mouse-autoselect-window-select' after
5605 ;; `mouse-autoselect-window' seconds.
5611 "Select window with delayed window autoselection.
5612 If the mouse position has stabilized in a non-selected window, select
5613 that window. The minibuffer window is selected only if the minibuffer
5614 is active. This function is run by `mouse-autoselect-window-timer'."
5625 ;; A menu / popup dialog is active or the mouse is on the scroll-bar
5626 ;; of WINDOW, temporarily suspend delayed autoselection.
5629 ;; Delayed autoselection was temporarily suspended, reenable it.
5634 ;; If `mouse-autoselect-window' is positive, select
5635 ;; window if the window is the same as before.
5637 ;; Otherwise select window if the mouse is at the same
5638 ;; position as before. Observe that the first test after
5639 ;; starting autoselection usually fails since the value of
5640 ;; `mouse-autoselect-window-position' recorded there is the
5641 ;; position where the mouse has entered the new window and
5642 ;; not necessarily where the mouse has stopped moving.
5644 ;; The minibuffer is a candidate window if it's active.
5647 ;; Mouse position has stabilized in non-selected window: Cancel
5648 ;; delayed autoselection and try to select that window.
5650 ;; Select window where mouse appears unless the selected window is the
5651 ;; minibuffer. Use `unread-command-events' in order to execute pre-
5652 ;; and post-command hooks and trigger idle timers. To avoid delaying
5653 ;; autoselection again, set `mouse-autoselect-window-state'."
5658 unread-command-events))))
5662 ;; Mouse position has either stabilized in the selected window or at
5663 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
5666 ;; Mouse position has not stabilized yet, resume delayed
5667 ;; autoselection.
5671 "Handle select-window events."
5675 ;; Don't switch if we're currently in the minibuffer.
5676 ;; This tries to work around problems where the
5677 ;; minibuffer gets unselected unexpectedly, and where
5678 ;; you then have to move your mouse all the way down to
5679 ;; the minibuffer to select it.
5681 ;; Don't switch to minibuffer window unless it's active.
5684 ;; Don't switch when autoselection shall be delayed.
5689 ;; Cancel any delayed autoselection.
5691 ;; Start delayed autoselection from current mouse
5692 ;; position and window.
5694 ;; Executing a command cancels delayed autoselection.
5698 ;; Reset state of delayed autoselection.
5700 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
5705 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
5706 WINDOW defaults to the selected window.
5707 Return nil if WINDOW is not a partial-width window
5708 (regardless of the value of `truncate-lines').
5709 Otherwise, consult the value of `truncate-partial-width-windows'
5710 for the buffer shown in WINDOW."
5718 t-p-w-w))))
5719 \f
5720 ;; Some of these are in tutorial--default-keys, so update that if you
5721 ;; change these.
5734 ;;; window.el ends here