| blob | 968f47f4f31f082c04cc0c1e760cecc797afd5a6 |
1 ;;; window.el --- GNU Emacs window commands aside from those written in C
3 ;; Copyright (C) 1985, 1989, 1992-1994, 2000-2011
4 ;; Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: internal
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; Window tree functions.
29 ;;; Code:
34 "Execute BODY, then select the previously selected window.
35 The value returned is the value of the last form in BODY.
37 This macro saves and restores the selected window, as well as the
38 selected window in each frame. If the previously selected window
39 is no longer live, then whatever window is selected at the end of
40 BODY remains selected. If the previously selected window of some
41 frame is no longer live at the end of BODY, that frame's selected
42 window is left alone.
44 This macro saves and restores the current buffer, since otherwise
45 its normal operation could make a different buffer current. The
46 order of recently selected windows and the buffer list ordering
47 are not altered by this macro (unless they are altered in BODY)."
50 ;; It is necessary to save all of these, because calling
51 ;; select-window changes frame-selected-window for whatever
52 ;; frame that window is in.
66 ;; The following two functions are like `window-next-sibling' and
67 ;; `window-prev-sibling' but the WINDOW argument is _not_ optional (so
68 ;; they don't substitute the selected window for nil), and they return
69 ;; nil when WINDOW doesn't have a parent (like a frame's root window or
70 ;; a minibuffer window).
72 "Return WINDOW's right sibling.
73 Return nil if WINDOW is the root window of its frame. WINDOW can
74 be any window."
78 "Return WINDOW's left sibling.
79 Return nil if WINDOW is the root window of its frame. WINDOW can
80 be any window."
84 "Return WINDOW's first child window."
88 "Return number of WINDOW's child windows."
94 count))
97 "Return last child window of WINDOW."
101 window)
104 "Return t if OBJECT denotes a live or internal window."
107 t))
110 "Return buffer specified by BUFFER-OR-NAME.
111 BUFFER-OR-NAME must be either a buffer or a string naming a live
112 buffer and defaults to the current buffer."
118 buffer-or-name
125 "Return frame specified by FRAME.
126 FRAME must be a live frame and defaults to the selected frame."
129 frame
134 "Return window specified by WINDOW.
135 WINDOW must be a window that has not been deleted and defaults to
136 the selected window."
139 window
144 "Return live window specified by WINDOW.
145 WINDOW must be a live window and defaults to the selected one."
148 window
153 "If non-nil, standard functions ignore window parameters.
154 The functions currently affected by this are `split-window',
155 `delete-window', `delete-other-windows' and `other-window'.
157 An application may bind this to a non-nil value around calls to
161 "The absolute minimum number of lines of a window.
165 "The minimum number of lines of any window.
166 The value has to accommodate a mode- or header-line if present.
167 A value less than `window-safe-min-height' is ignored. The value
168 of this variable is honored when windows are resized or split.
170 Applications should never rebind this variable. To resize a
171 window to a height less than the one specified here, an
172 application should instead call `window-resize' with a non-nil
173 IGNORE argument. In order to have `split-window' make a window
174 shorter, explictly specify the SIZE argument of that function."
180 "The absolute minimum number of columns of a window.
184 "The minimum number of columns of any window.
185 The value has to accommodate margins, fringes, or scrollbars if
186 present. A value less than `window-safe-min-width' is ignored.
187 The value of this variable is honored when windows are resized or
188 split.
190 Applications should never rebind this variable. To resize a
191 window to a width less than the one specified here, an
192 application should instead call `window-resize' with a non-nil
193 IGNORE argument. In order to have `split-window' make a window
194 narrower, explictly specify the SIZE argument of that function."
200 "If WINDOW is a vertical combination return WINDOW's first child.
201 WINDOW can be any window and defaults to the selected one.
202 Optional argument HORIZONTAL non-nil means return WINDOW's first
203 child if WINDOW is a horizontal combination."
210 "Return non-nil if and only if WINDOW is vertically combined.
211 WINDOW can be any window and defaults to the selected one.
212 Optional argument HORIZONTAL non-nil means return non-nil if and
213 only if WINDOW is horizontally combined."
219 "Return largest number of vertically arranged subwindows of WINDOW.
220 WINDOW can be any window and defaults to the selected one.
221 Optional argument HORIZONTAL non-nil means to return the largest
222 number of horizontally arranged subwindows of WINDOW."
226 ;; If WINDOW is live, return 1.
229 ;; If WINDOW is iso-combined, return the sum of the values for all
230 ;; subwindows of WINDOW.
236 count))
238 count))
240 ;; If WINDOW is not iso-combined, return the maximum value of any
241 ;; subwindow of WINDOW.
247 count))
249 count))))
252 "Helper function for `walk-window-tree' and `walk-window-subtree'."
270 "Run function PROC on each live window of FRAME.
271 PROC must be a function with one argument - a window. FRAME must
272 be a live frame and defaults to the selected one. ANY, if
273 non-nil means to run PROC on all live and internal windows of
274 FRAME.
276 This function performs a pre-order, depth-first traversal of the
277 window tree. If PROC changes the window tree, the result is
278 unpredictable."
284 "Run function PROC on each live subwindow of WINDOW.
285 WINDOW defaults to the selected window. PROC must be a function
286 with one argument - a window. ANY, if non-nil means to run PROC
287 on all live and internal subwindows of WINDOW.
289 This function performs a pre-order, depth-first traversal of the
290 window tree rooted at WINDOW. If PROC changes that window tree,
291 the result is unpredictable."
296 "Return a list of all windows on FRAME with PARAMETER non-nil.
297 FRAME defaults to the selected frame. Optional argument VALUE
298 non-nil means only return windows whose window-parameter value of
299 PARAMETER equals VALUE \(comparison is done using `equal').
300 Optional argument ANY non-nil means consider internal windows
301 too. Optional argument VALUES non-nil means return a list of cons
302 cells whose car is the value of the parameter and whose cdr is
303 the window."
313 frame any)
318 "Return first window on FRAME with PARAMETER non-nil.
319 FRAME defaults to the selected frame. Optional argument VALUE
320 non-nil means only return a window whose window-parameter value
321 for PARAMETER equals VALUE \(comparison is done with `equal').
322 Optional argument ANY non-nil means consider internal windows
323 too."
331 frame any))))
333 ;;; Atomic windows.
335 "Return root of atomic window WINDOW is a part of.
336 WINDOW can be any window and defaults to the selected one.
337 Return nil if WINDOW is not part of a atomic window."
343 root))
346 "Make WINDOW an atomic window.
347 WINDOW must be an internal window. Return WINDOW."
353 window t)
354 window))
357 "Subroutine of `window-atom-check'."
367 window t))
368 ;; count >= 1 must hold here. If there's no other
369 ;; window around dissolve this atomic window.
371 ;; Dissolve atomic window.
375 window t)))
376 ;; Check children.
380 ;; Check right sibling
384 "Check atomicity of all windows on FRAME.
385 FRAME defaults to the selected frame. If an atomic window is
386 wrongly configured, reset the atomicity of all its subwindows to
387 nil. An atomic window is wrongly configured if it has no
388 subwindows or one of its subwindows is not atomic."
391 ;; Side windows.
396 "If non-nil, left and right side windows are full height.
397 Otherwise, top and bottom side windows are full width."
403 "Maximum number of side window slots.
404 The value is a list of four elements specifying the number of
405 side window slots on \(in this order) the left, top, right and
406 bottom side of each frame. If an element is a number, this means
407 to display at most that many side windows on the corresponding
408 side. If an element is nil, this means there's no bound on the
409 number of slots on that side."
410 :risky t
411 :type
417 :value nil
424 :value nil
431 :value nil
438 :value nil
445 "Check the window-side parameter of all windows on FRAME.
446 FRAME defaults to the selected frame. If the configuration is
447 invalid, reset all window-side parameters to nil.
449 A valid configuration has to preserve the following invariant:
451 - If a window has a non-nil window-side parameter, it must have a
452 parent window and the parent window's window-side parameter
453 must be either nil or the same as for window.
455 - If windows with non-nil window-side parameters exist, there
456 must be at most one window of each side and non-side with a
457 parent whose window-side parameter is nil and there must be no
458 leaf window whose window-side parameter is nil."
460 side parent parent-side code)
468 ;; The following `cond' seems a bit tedious, but I'd
469 ;; rather stick to using just the stack.
473 ;; A parent whose window-side is non-nil must
474 ;; have a child with the same window-side.
476 ;; Now check that there's more than one main window
477 ;; for any of none, left, top, right and bottom.
499 ;; A leaf window without window-side parameter,
500 ;; record its existence.
502 frame t))
504 ;; At least one non-side window exists, so there must
505 ;; be at least one side-window and no normal window.
507 ;; No non-side window exists, so there must be no side
508 ;; window either.
513 frame t))))
516 "Check atomic and side windows on FRAME.
517 FRAME defaults to the selected frame."
521 ;;; Window sizes.
523 "Non-nil in a buffer means windows displaying the buffer are fixed-size.
524 If the value is `height', then only the window's height is fixed.
525 If the value is `width', then only the window's width is fixed.
526 Any other non-nil value fixes both the width and the height.
528 Emacs won't change the size of any window displaying that buffer,
529 unless it has no other choice \(like when deleting a neighboring
534 "Return non-nil if IGNORE says to ignore size restrictions for WINDOW."
538 "Return the minimum number of lines of WINDOW.
539 WINDOW can be an arbitrary window and defaults to the selected
540 one. Optional argument HORIZONTAL non-nil means return the
541 minimum number of columns of WINDOW.
543 Optional argument IGNORE non-nil means ignore any restrictions
544 imposed by fixed size windows, `window-min-height' or
545 `window-min-width' settings. IGNORE equal `safe' means live
546 windows may get as small as `window-safe-min-height' lines and
547 `window-safe-min-width' columns. IGNORE a window means ignore
548 restrictions for that window only."
553 "Internal function of `window-min-size'."
557 ;; WINDOW is an internal window.
559 ;; The minimum size of an iso-combination is the sum of
560 ;; the minimum sizes of its subwindows.
565 ;; The minimum size of an ortho-combination is the maximum of
566 ;; the minimum sizes of its subwindows.
571 value)
576 ;; The minimum size of a fixed size window is its size.
579 ;; If IGNORE equals `safe' or WINDOW return the safe values.
582 ;; For the minimum width of a window take fringes and
583 ;; scroll-bars into account. This is questionable and should
584 ;; be removed as soon as we are able to split (and resize)
585 ;; windows such that the new (or resized) windows can get a
586 ;; size less than the user-specified `window-min-height' and
587 ;; `window-min-width'.
592 (+ window-safe-min-width
605 window-min-width
608 ;; For the minimum height of a window take any mode- or
609 ;; header-line into account.
615 window-min-height
619 "Return DELTA if DELTA lines can be added to WINDOW.
620 Optional argument HORIZONTAL non-nil means return DELTA if DELTA
621 columns can be added to WINDOW. A return value of zero means
622 that no lines (or columns) can be added to WINDOW.
624 This function looks only at WINDOW and its subwindows. The
625 function `window-resizable' looks at other windows as well.
627 DELTA positive means WINDOW shall be enlarged by DELTA lines or
628 columns. If WINDOW cannot be enlarged by DELTA lines or columns
629 return the maximum value in the range 0..DELTA by which WINDOW
630 can be enlarged.
632 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
633 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
634 return the minimum value in the range DELTA..0 by which WINDOW
635 can be shrunk.
637 Optional argument IGNORE non-nil means ignore any restrictions
638 imposed by fixed size windows, `window-min-height' or
639 `window-min-width' settings. IGNORE equal `safe' means live
640 windows may get as small as `window-safe-min-height' lines and
641 `window-safe-min-width' columns. IGNORE any window means ignore
642 restrictions for that window only."
648 delta))
650 delta)
653 0
654 delta))
658 "Return t if WINDOW can be resized by DELTA lines.
659 For the meaning of the arguments of this function see the
660 doc-string of `window-sizable'."
667 "Internal function for `window-size-fixed-p'."
671 ;; WINDOW is an internal window.
673 ;; An iso-combination is fixed size if all its subwindows
674 ;; are fixed-size.
678 ;; We found a non-fixed-size subwindow, so WINDOW's
679 ;; size is not fixed.
682 ;; All subwindows are fixed-size, so WINDOW's size is
683 ;; fixed.
685 ;; An ortho-combination is fixed-size if at least one of its
686 ;; subwindows is fixed-size.
689 ;; We found a fixed-size subwindow, so WINDOW's size is
690 ;; fixed.
693 ;; WINDOW is a live window.
700 "Return non-nil if WINDOW's height is fixed.
701 WINDOW can be an arbitrary window and defaults to the selected
702 window. Optional argument HORIZONTAL non-nil means return
703 non-nil if WINDOW's width is fixed.
705 If this function returns nil, this does not necessarily mean that
706 WINDOW can be resized in the desired direction. The functions
707 `window-resizable' and `window-resizable-p' will tell that."
712 "Internal function for `window-min-delta'."
714 ;; If we can't go up, return zero.
715 0
716 ;; Else try to find a non-fixed-size sibling of WINDOW.
721 ;; In an iso-combination throw DELTA if we find at least one
722 ;; subwindow and that subwindow is either not of fixed-size
723 ;; or we can ignore fixed-sizeness.
733 ;; We found a non-fixed-size subwindow.
736 ;; In an ortho-combination set DELTA to the minimum value by
737 ;; which other subwindows can shrink.
746 delta
750 "Return number of lines by which WINDOW can be shrunk.
751 WINDOW can be an arbitrary window and defaults to the selected
752 window. Return zero if WINDOW cannot be shrunk.
754 Optional argument HORIZONTAL non-nil means return number of
755 columns by which WINDOW can be shrunk.
757 Optional argument IGNORE non-nil means ignore any restrictions
758 imposed by fixed size windows, `window-min-height' or
759 `window-min-width' settings. IGNORE a window means ignore
760 restrictions for that window only. IGNORE equal `safe' means
761 live windows may get as small as `window-safe-min-height' lines
762 and `window-safe-min-width' columns.
764 Optional argument TRAIL `before' means only windows to the left
765 of or above WINDOW can be enlarged. Optional argument TRAIL
766 `after' means only windows to the right of or below WINDOW can be
767 enlarged.
769 Optional argument NOUP non-nil means don't go up in the window
770 tree but try to enlarge windows within WINDOW's combination only.
772 Optional argument NODOWN non-nil means don't check whether WINDOW
773 itself \(and its subwindows) can be shrunk; check only whether at
774 least one other windows can be enlarged appropriately."
780 ;; If NODOWN is t, try to recover the entire size of WINDOW.
783 ;; If NODOWN is nil and WINDOW's size is already at its minimum,
784 ;; there's nothing to recover.
787 ;; Otherwise, try to recover whatever WINDOW is larger than its
788 ;; minimum size.
793 "Internal function of `window-max-delta'."
795 ;; Can't go up. Return DELTA.
796 delta
801 ;; For an iso-combination calculate how much we can get from
802 ;; other subwindows.
811 (+ delta
815 ;; For an ortho-combination throw DELTA when at least one
816 ;; subwindow is fixed-size.
824 ;; When NOUP is nil, DELTA is all we can get.
825 delta
826 ;; Else try with parent of WINDOW, passing the DELTA we
827 ;; recovered so far.
831 "Return maximum number of lines WINDOW by which WINDOW can be enlarged.
832 WINDOW can be an arbitrary window and defaults to the selected
833 window. The return value is zero if WINDOW cannot be enlarged.
835 Optional argument HORIZONTAL non-nil means return maximum number
836 of columns by which WINDOW can be enlarged.
838 Optional argument IGNORE non-nil means ignore any restrictions
839 imposed by fixed size windows, `window-min-height' or
840 `window-min-width' settings. IGNORE a window means ignore
841 restrictions for that window only. IGNORE equal `safe' means
842 live windows may get as small as `window-safe-min-height' lines
843 and `window-safe-min-width' columns.
845 Optional argument TRAIL `before' means only windows to the left
846 of or below WINDOW can be shrunk. Optional argument TRAIL
847 `after' means only windows to the right of or above WINDOW can be
848 shrunk.
850 Optional argument NOUP non-nil means don't go up in the window
851 tree but try to obtain the entire space from windows within
852 WINDOW's combination.
854 Optional argument NODOWN non-nil means do not check whether
855 WINDOW itself \(and its subwindows) can be enlarged; check only
856 whether other windows can be shrunk appropriately."
860 ;; With IGNORE and NOWDON nil return zero if WINDOW has fixed
861 ;; size.
862 0
863 ;; WINDOW has no fixed size.
866 ;; Make NOUP also inhibit the min-size check.
868 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
869 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
870 can be resized horizontally by DELTA columns. A return value of
871 zero means that WINDOW is not resizable.
873 DELTA positive means WINDOW shall be enlarged by DELTA lines or
874 columns. If WINDOW cannot be enlarged by DELTA lines or columns
875 return the maximum value in the range 0..DELTA by which WINDOW
876 can be enlarged.
878 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
879 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
880 return the minimum value in the range DELTA..0 that can be used
881 for shrinking WINDOW.
883 Optional argument IGNORE non-nil means ignore any restrictions
884 imposed by fixed size windows, `window-min-height' or
885 `window-min-width' settings. IGNORE a window means ignore
886 restrictions for that window only. IGNORE equal `safe' means
887 live windows may get as small as `window-safe-min-height' lines
888 and `window-safe-min-width' columns.
890 Optional argument TRAIL `before' means only windows to the left
891 of or below WINDOW can be shrunk. Optional argument TRAIL
892 `after' means only windows to the right of or above WINDOW can be
893 shrunk.
895 Optional argument NOUP non-nil means don't go up in the window
896 tree but try to distribute the space among the other windows
897 within WINDOW's combination.
899 Optional argument NODOWN non-nil means don't check whether WINDOW
900 and its subwindows can be resized."
905 delta))
908 delta))
912 "Return t if WINDOW can be resized vertically by DELTA lines.
913 For the meaning of the arguments of this function see the
914 doc-string of `window-resizable'."
918 delta)
920 delta)))
923 "Return the total number of lines of WINDOW.
924 WINDOW can be any window and defaults to the selected one. The
925 return value includes WINDOW's mode line and header line, if any.
926 If WINDOW is internal the return value is the sum of the total
927 number of lines of WINDOW's child windows if these are vertically
928 combined and the height of WINDOW's first child otherwise.
930 Note: This function does not take into account the value of
931 `line-spacing' when calculating the number of lines in WINDOW."
934 ;; Eventually we should make `window-height' obsolete.
937 ;; See discussion in bug#4543.
939 "Return t if WINDOW is as high as the containing frame.
940 More precisely, return t if and only if the total height of
941 WINDOW equals the total height of the root window of WINDOW's
942 frame. WINDOW can be any window and defaults to the selected
943 one."
949 "Return the total number of columns of WINDOW.
950 WINDOW can be any window and defaults to the selected one. The
951 return value includes any vertical dividers or scrollbars of
952 WINDOW. If WINDOW is internal, the return value is the sum of
953 the total number of columns of WINDOW's child windows if these
954 are horizontally combined and the width of WINDOW's first child
955 otherwise."
959 "Return t if WINDOW is as wide as the containing frame.
960 More precisely, return t if and only if the total width of WINDOW
961 equals the total width of the root window of WINDOW's frame.
962 WINDOW can be any window and defaults to the selected one."
968 "Return the number of lines of WINDOW's body.
969 WINDOW must be a live window and defaults to the selected one.
971 The return value does not include WINDOW's mode line and header
972 line, if any. If a line at the bottom of the window is only
973 partially visible, that line is included in the return value. If
974 you do not want to include a partially visible bottom line in the
975 return value, use `window-text-height' instead."
979 "Return the number of columns of WINDOW's body.
980 WINDOW must be a live window and defaults to the selected one.
982 The return value does not include any vertical dividers or scroll
983 bars owned by WINDOW. On a window-system the return value does
984 not include the number of columns used for WINDOW's fringes or
985 display margins either."
988 ;; Eventually we should make `window-height' obsolete.
992 "Return the current scroll bar settings for WINDOW.
993 WINDOW must be a live window and defaults to the selected one.
995 The return value is a cons cell (VERTICAL . HORIZONTAL) where
996 VERTICAL specifies the current location of the vertical scroll
997 bars (`left', `right', or nil), and HORIZONTAL specifies the
998 current location of the horizontal scroll bars (`top', `bottom',
999 or nil).
1001 Unlike `window-scroll-bars', this function reports the scroll bar
1002 type actually used, once frame defaults and `scroll-bar-mode' are
1003 taken into account."
1016 "Cycle through all live windows, calling PROC for each one.
1017 PROC must specify a function with a window as its sole argument.
1018 The optional arguments MINIBUF and ALL-FRAMES specify the set of
1019 windows to include in the walk.
1021 MINIBUF t means include the minibuffer window even if the
1022 minibuffer is not active. MINIBUF nil or omitted means include
1023 the minibuffer window only if the minibuffer is active. Any
1024 other value means do not include the minibuffer window even if
1025 the minibuffer is active.
1027 ALL-FRAMES nil or omitted means consider all windows on the
1028 selected frame, plus the minibuffer window if specified by the
1029 MINIBUF argument. If the minibuffer counts, consider all windows
1030 on all frames that share that minibuffer too. The following
1031 non-nil values of ALL-FRAMES have special meanings:
1033 - t means consider all windows on all existing frames.
1035 - `visible' means consider all windows on all visible frames on
1036 the current terminal.
1038 - 0 (the number zero) means consider all windows on all visible
1039 and iconified frames on the current terminal.
1041 - A frame means consider all windows on that frame only.
1043 Anything else means consider all windows on the selected frame
1044 and no others.
1046 This function changes neither the order of recently selected
1047 windows nor the buffer list."
1048 ;; If we start from the minibuffer window, don't fail to come
1049 ;; back to it.
1052 ;; Make sure to not mess up the order of recently selected
1053 ;; windows. Use `save-selected-window' and `select-window'
1054 ;; with second argument non-nil for this purpose.
1062 "Return value of WINDOW's point.
1063 WINDOW can be any live window and defaults to the selected one.
1065 This function is like `window-point' with one exception: If
1066 WINDOW is selected, it returns the value of `point' of WINDOW's
1067 buffer regardless of whether that buffer is current or not."
1075 "Set value of WINDOW's point to POS.
1076 WINDOW can be any live window and defaults to the selected one.
1078 This function is like `set-window-point' with one exception: If
1079 WINDOW is selected, it moves `point' of WINDOW's buffer to POS
1080 regardless of whether that buffer is current or not."
1088 "Return t if WINDOW is at SIDE of its containing frame.
1089 WINDOW can be any window and defaults to the selected one. SIDE
1090 can be any of the symbols `left', `top', `right' or `bottom'.
1091 The default value nil is handled like `bottom'."
1103 "Return list of all windows on SIDE of FRAME.
1104 FRAME must be a live frame and defaults to the selected frame.
1105 SIDE can be any of the symbols `left', `top', `right' or
1106 `bottom'. The default value nil is handled like `bottom'."
1113 frame)
1117 "Support function for `window-in-direction'."
1129 "Return window in DIRECTION as seen from WINDOW.
1130 DIRECTION must be one of `above', `below', `left' or `right'.
1131 WINDOW must be a live window and defaults to the selected one.
1132 IGNORE, when non-nil means a window can be returned even if its
1133 `no-other-window' parameter is non-nil."
1146 ;; The column / row value of `posn-at-point' can be nil for the
1147 ;; mini-window, guard against that.
1158 best best-2 best-diff-2-new)
1165 ;; Ignore ourselves.
1167 ;; Ignore W unless IGNORE is non-nil.
1173 ;; W is to the left or right of WINDOW and covers POSN.
1183 ;; W is to the left or right of WINDOW but does not
1184 ;; cover POSN.
1199 ;; W is above or below WINDOW and covers POSN.
1209 ;; W is above or below WINDOW but does not cover POSN.
1224 "Return a live window satisfying PREDICATE.
1225 More precisely, cycle through all windows calling the function
1226 PREDICATE on each one of them with the window as its sole
1227 argument. Return the first window for which PREDICATE returns
1228 non-nil. Windows are scanned starting with the window following
1229 the selcted window. If no window satisfies PREDICATE, return
1230 DEFAULT.
1232 MINIBUF t means include the minibuffer window even if the
1233 minibuffer is not active. MINIBUF nil or omitted means include
1234 the minibuffer window only if the minibuffer is active. Any
1235 other value means do not include the minibuffer window even if
1236 the minibuffer is active.
1238 ALL-FRAMES nil or omitted means consider all windows on the selected
1239 frame, plus the minibuffer window if specified by the MINIBUF
1240 argument. If the minibuffer counts, consider all windows on all
1241 frames that share that minibuffer too. The following non-nil
1242 values of ALL-FRAMES have special meanings:
1244 - t means consider all windows on all existing frames.
1246 - `visible' means consider all windows on all visible frames on
1247 the current terminal.
1249 - 0 (the number zero) means consider all windows on all visible
1250 and iconified frames on the current terminal.
1252 - A frame means consider all windows on that frame only.
1254 Anything else means consider all windows on the selected frame
1255 and no others."
1259 minibuf all-frames))
1262 default))
1267 "Return the least recently used window on frames specified by ALL-FRAMES.
1268 Return a full-width window if possible. A minibuffer window is
1269 never a candidate. A dedicated window is never a candidate
1270 unless DEDICATED is non-nil, so if all windows are dedicated, the
1271 value is nil. Avoid returning the selected window if possible.
1273 The following non-nil values of the optional argument ALL-FRAMES
1274 have special meanings:
1276 - t means consider all windows on all existing frames.
1278 - `visible' means consider all windows on all visible frames on
1279 the current terminal.
1281 - 0 (the number zero) means consider all windows on all visible
1282 and iconified frames on the current terminal.
1284 - A frame means consider all windows on that frame only.
1286 Any other value of ALL-FRAMES means consider all windows on the
1287 selected frame and no others."
1303 "Return the most recently used window on frames specified by ALL-FRAMES.
1304 Do not return a minibuffer window.
1306 The following non-nil values of the optional argument ALL-FRAMES
1307 have special meanings:
1309 - t means consider all windows on all existing frames.
1311 - `visible' means consider all windows on all visible frames on
1312 the current terminal.
1314 - 0 (the number zero) means consider all windows on all visible
1315 and iconified frames on the current terminal.
1317 - A frame means consider all windows on that frame only.
1319 Any other value of ALL-FRAMES means consider all windows on the
1320 selected frame and no others."
1327 best-window))
1330 "Return the largest window on frames specified by ALL-FRAMES.
1331 A minibuffer window is never a candidate. A dedicated window is
1332 never a candidate unless DEDICATED is non-nil, so if all windows
1333 are dedicated, the value is nil.
1335 The following non-nil values of the optional argument ALL-FRAMES
1336 have special meanings:
1338 - t means consider all windows on all existing frames.
1340 - `visible' means consider all windows on all visible frames on
1341 the current terminal.
1343 - 0 (the number zero) means consider all windows on all visible
1344 and iconified frames on the current terminal.
1346 - A frame means consider all windows on that frame only.
1348 Any other value of ALL-FRAMES means consider all windows on the
1349 selected frame and no others."
1351 best-window size)
1359 best-window))
1362 "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
1363 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
1364 and defaults to the current buffer. Windows are scanned starting
1365 with the selected window.
1367 MINIBUF t means include the minibuffer window even if the
1368 minibuffer is not active. MINIBUF nil or omitted means include
1369 the minibuffer window only if the minibuffer is active. Any
1370 other value means do not include the minibuffer window even if
1371 the minibuffer is active.
1373 ALL-FRAMES nil or omitted means consider all windows on the
1374 selected frame, plus the minibuffer window if specified by the
1375 MINIBUF argument. If the minibuffer counts, consider all windows
1376 on all frames that share that minibuffer too. The following
1377 non-nil values of ALL-FRAMES have special meanings:
1379 - t means consider all windows on all existing frames.
1381 - `visible' means consider all windows on all visible frames on
1382 the current terminal.
1384 - 0 (the number zero) means consider all windows on all visible
1385 and iconified frames on the current terminal.
1387 - A frame means consider all windows on that frame only.
1389 Anything else means consider all windows on the selected frame
1390 and no others."
1392 windows)
1399 "Return t if WINDOW is the currently active minibuffer window."
1403 "Return the number of live windows on the selected frame.
1404 The optional argument MINIBUF specifies whether the minibuffer
1405 window shall be counted. See `walk-windows' for the precise
1406 meaning of this argument."
1408 \f
1409 ;;; Resizing windows.
1411 "Reset resize values for all windows on FRAME.
1412 FRAME defaults to the selected frame.
1414 This function stores the current value of `window-total-size' applied
1415 with argument HORIZONTAL in the new total size of all windows on
1416 FRAME. It also resets the new normal size of each of these
1417 windows."
1422 "Internal function of `window--resize-reset'."
1423 ;; Register old size in the new total size.
1425 ;; Reset new normal size.
1432 ;; The following routine is used to manually resize the minibuffer
1433 ;; window and is currently used, for example, by ispell.el.
1435 "Resize minibuffer window WINDOW by DELTA lines.
1436 If WINDOW cannot be resized by DELTA lines make it as large \(or
1437 as small) as possible but don't signal an error."
1445 ;; Sanitize DELTA.
1452 ;; Resize now.
1454 ;; Ideally we should be able to resize just the last subwindow of
1455 ;; root here. See the comment in `resize-root-window-vertically'
1456 ;; for why we do not do that.
1459 ;; The following routine catches the case where we want to resize
1460 ;; a minibuffer-only frame.
1464 "Resize WINDOW vertically by DELTA lines.
1465 WINDOW can be an arbitrary window and defaults to the selected
1466 one. An attempt to resize the root window of a frame will raise
1467 an error though.
1469 DELTA a positive number means WINDOW shall be enlarged by DELTA
1470 lines. DELTA negative means WINDOW shall be shrunk by -DELTA
1471 lines.
1473 Optional argument HORIZONTAL non-nil means resize WINDOW
1474 horizontally by DELTA columns. In this case a positive DELTA
1475 means enlarge WINDOW by DELTA columns. DELTA negative means
1476 WINDOW shall be shrunk by -DELTA columns.
1478 Optional argument IGNORE non-nil means ignore any restrictions
1479 imposed by fixed size windows, `window-min-height' or
1480 `window-min-width' settings. IGNORE any window means ignore
1481 restrictions for that window only. IGNORE equal `safe' means
1482 live windows may get as small as `window-safe-min-height' lines
1483 and `window-safe-min-width' columns.
1485 This function resizes other windows proportionally and never
1486 deletes any windows. If you want to move only the low (right)
1487 edge of WINDOW consider using `adjust-window-trailing-edge'
1488 instead."
1491 sibling)
1504 ;; If window-splits returns nil for WINDOW, WINDOW is part of
1505 ;; an iso-combination, and WINDOW's neighboring right or left
1506 ;; sibling can be resized as requested, resize that sibling.
1513 normal-delta))
1516 normal-delta)))
1517 ;; Otherwise, resize all other windows in the same combination.
1524 "Return non-nil if WINDOW shall be skipped by resizing routines."
1527 (defun window--resize-subwindows-normal (parent horizontal window this-delta &optional trail other-delta)
1528 "Set the new normal height of subwindows of window PARENT.
1529 HORIZONTAL non-nil means set the new normal width of these
1530 windows. WINDOW specifies a subwindow of PARENT that has been
1531 resized by THIS-DELTA lines \(columns).
1533 Optional argument TRAIL either 'before or 'after means set values
1534 for windows before or after WINDOW only. Optional argument
1535 OTHER-DELTA a number specifies that this many lines \(columns)
1536 have been obtained from \(or returned to) an ancestor window of
1537 PARENT in order to resize WINDOW."
1541 ;; When WINDOW gets deleted and we can return its entire
1542 ;; space to its siblings, use WINDOW's normal size as the
1543 ;; normal delta.
1545 ;; In any other case calculate the normal delta from the
1546 ;; relation of THIS-DELTA to the total size of PARENT.
1552 ;; Set parent-normal to the sum of the normal sizes of all
1553 ;; subwindows of PARENT that shall be resized, excluding only WINDOW
1554 ;; and any windows specified by the optional TRAIL argument.
1565 ;; Set the new normal size of all subwindows of PARENT from what
1566 ;; they should have contributed for recovering THIS-DELTA lines
1567 ;; (columns).
1581 delta-normal))
1582 ;; Don't drop below 0.
1587 ;; Set the new normal size of windows from what they should have
1588 ;; contributed for recovering OTHER-DELTA lines (columns).
1591 other-delta)))
1603 ;; Don't drop below 0.
1607 ;; Set the new normal size of WINDOW to what is left by the sum of
1608 ;; the normal sizes of its siblings.
1610 window
1621 ;; Don't get larger than 1 or smaller than 0.
1625 "Resize subwindows of window PARENT vertically by DELTA lines.
1626 PARENT must be a vertically combined internal window.
1628 Optional argument HORIZONTAL non-nil means resize subwindows of
1629 PARENT horizontally by DELTA columns. In this case PARENT must
1630 be a horizontally combined internal window.
1632 WINDOW, if specified, must denote a child window of PARENT that
1633 is resized by DELTA lines.
1635 Optional argument IGNORE non-nil means ignore any restrictions
1636 imposed by fixed size windows, `window-min-height' or
1637 `window-min-width' settings. IGNORE equal `safe' means live
1638 windows may get as small as `window-safe-min-height' lines and
1639 `window-safe-min-width' columns. IGNORE any window means ignore
1640 restrictions for that window only.
1642 Optional arguments TRAIL and EDGE, when non-nil, restrict the set
1643 of windows that shall be resized. If TRAIL equals `before',
1644 resize only windows on the left or above EDGE. If TRAIL equals
1645 `after', resize only windows on the right or below EDGE. Also,
1646 preferably only resize windows adjacent to EDGE.
1648 Return the symbol `normalized' if new normal sizes have been
1649 already set by this routine."
1653 best-window best-value)
1665 sub)
1670 edge)
1675 edge)
1678 ;; Resize only windows adjacent to EDGE.
1681 sub delta horizontal ignore t trail edge)
1684 ;; Assign new normal sizes.
1693 ;; Return 'normalized to notify `window--resize-siblings' that
1694 ;; normal sizes have been already set.
1696 ;; Resize all windows proportionally.
1701 ;; Ignore windows to skip and fixed-size subwindows - in
1702 ;; the latter case make it a window to skip.
1707 ;; When shrinking store the number of lines/cols we can get
1708 ;; from this window here together with the total/normal size
1709 ;; factor.
1711 sub
1713 ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
1716 parent-total)
1719 ;; When enlarging store the total/normal size factor only
1721 sub
1723 parent-total)
1730 ;; Shrink windows by delta.
1749 best-window
1754 parent-total)
1757 ;; Enlarge windows by delta.
1775 best-window
1777 parent-total)
1785 ;; Reset new normal size fields so `window-resize-apply'
1786 ;; won't use them to apply new sizes.
1790 ;; Resize this subwindow's subwindows (back-engineering
1791 ;; delta from sub's old and new total sizes).
1795 ;; For the TRAIL non-nil case we have to resize SUB
1796 ;; recursively even if it's size does not change.
1798 sub delta horizontal ignore nil trail edge))))
1802 "Resize other windows when WINDOW is resized vertically by DELTA lines.
1803 Optional argument HORIZONTAL non-nil means resize other windows
1804 when WINDOW is resized horizontally by DELTA columns. WINDOW
1805 itself is not resized by this function.
1807 Optional argument IGNORE non-nil means ignore any restrictions
1808 imposed by fixed size windows, `window-min-height' or
1809 `window-min-width' settings. IGNORE equal `safe' means live
1810 windows may get as small as `window-safe-min-height' lines and
1811 `window-safe-min-width' columns. IGNORE any window means ignore
1812 restrictions for that window only.
1814 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1815 of windows that shall be resized. If TRAIL equals `before',
1816 resize only windows on the left or above EDGE. If TRAIL equals
1817 `after', resize only windows on the right or below EDGE. Also,
1818 preferably only resize windows adjacent to EDGE."
1823 ;; In an iso-combination try to extract DELTA from WINDOW's
1824 ;; siblings.
1827 this-delta other-delta)
1828 ;; Decide which windows shall be left alone.
1832 ;; Make sure WINDOW is left alone when
1833 ;; resizing its siblings.
1837 ;; Make sure this sibling is left alone when
1838 ;; resizing its siblings.
1842 ;; Set this-delta to t to signal that we found a sibling
1843 ;; of WINDOW whose size is not fixed.
1848 ;; Set this-delta to what we can get from WINDOW's siblings.
1850 ;; A deletion, presumably. We must handle this case
1851 ;; specially since `window-resizable' can't be used.
1853 ;; There's at least one resizable sibling we can
1854 ;; give WINDOW's size to.
1856 ;; No resizable sibling exists.
1858 ;; Any other form of resizing.
1862 ;; Set other-delta to what we still have to get from
1863 ;; ancestor windows of parent.
1866 ;; Unless we got everything from WINDOW's siblings, PARENT
1867 ;; must be resized by other-delta lines or columns.
1871 ;; We haven't got anything from WINDOW's siblings but we
1872 ;; must update the normal sizes to respect other-delta.
1874 parent horizontal window this-delta trail other-delta)
1875 ;; We did get something from WINDOW's siblings which means
1876 ;; we have to resize their subwindows.
1879 window ignore trail edge)
1880 ;; If `window--resize-subwindows' returns
1881 ;; 'normalized, this means it has set the
1882 ;; normal sizes already.
1884 ;; Set the normal sizes.
1886 parent horizontal window this-delta trail other-delta))
1887 ;; Set DELTA to what we still have to get from ancestor
1888 ;; windows.
1891 ;; In an ortho-combination all siblings of WINDOW must be
1892 ;; resized by DELTA.
1900 ;; "Go up."
1902 parent delta horizontal ignore trail edge)))))
1905 "Resize WINDOW vertically by DELTA lines.
1906 Optional argument HORIZONTAL non-nil means resize WINDOW
1907 horizontally by DELTA columns.
1909 Optional argument IGNORE non-nil means ignore any restrictions
1910 imposed by fixed size windows, `window-min-height' or
1911 `window-min-width' settings. IGNORE equal `safe' means live
1912 windows may get as small as `window-safe-min-height' lines and
1913 `window-safe-min-width' columns. IGNORE any window means ignore
1914 restrictions for that window only.
1916 Optional argument ADD non-nil means add DELTA to the new total
1917 size of WINDOW.
1919 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1920 of windows that shall be resized. If TRAIL equals `before',
1921 resize only windows on the left or above EDGE. If TRAIL equals
1922 `after', resize only windows on the right or below EDGE. Also,
1923 preferably only resize windows adjacent to EDGE.
1925 This function recursively resizes WINDOW's subwindows to fit the
1926 new size. Make sure that WINDOW is `window-resizable' before
1927 calling this function. Note that this function does not resize
1928 siblings of WINDOW or WINDOW's parent window. You have to
1929 eventually call `window-resize-apply' in order to make resizing
1930 actually take effect."
1932 ;; Add DELTA to the new total size of WINDOW.
1939 ;; In an iso-combination resize subwindows according to their
1940 ;; normal sizes.
1942 window delta horizontal nil ignore trail edge))
1943 ;; In an ortho-combination resize each subwindow by DELTA.
1947 sub delta horizontal ignore t trail edge)
1951 "Resize root window WINDOW vertically by DELTA lines.
1952 HORIZONTAL non-nil means resize root window WINDOW horizontally
1953 by DELTA columns.
1955 IGNORE non-nil means ignore any restrictions imposed by fixed
1956 size windows, `window-min-height' or `window-min-width' settings.
1958 This function is only called by the frame resizing routines. It
1959 resizes windows proportionally and never deletes any windows."
1966 "Resize root window WINDOW vertically by DELTA lines.
1967 If DELTA is less than zero and we can't shrink WINDOW by DELTA
1968 lines, shrink it as much as possible. If DELTA is greater than
1969 zero, this function can resize fixed-size subwindows in order to
1970 recover the necessary lines.
1972 Return the number of lines that were recovered.
1974 This function is only called by the minibuffer window resizing
1975 routines. It resizes windows proportionally and never deletes
1976 any windows."
1987 ;; Ideally, we would resize just the last window in a combination
1988 ;; but that's not feasible for the following reason: If we grow
1989 ;; the minibuffer window and the last window cannot be shrunk any
1990 ;; more, we shrink another window instead. But if we then shrink
1991 ;; the minibuffer window again, the last window might get enlarged
1992 ;; and the state after shrinking is not the state before growing.
1993 ;; So, in practice, we'd need a history variable to record how to
1994 ;; proceed. But I'm not sure how such a variable could work with
1995 ;; repeated minibuffer window growing steps.
1997 delta)))
2000 "Move WINDOW's bottom edge by DELTA lines.
2001 Optional argument HORIZONTAL non-nil means move WINDOW's right
2002 edge by DELTA columns. WINDOW defaults to the selected window.
2004 If DELTA is greater zero, then move the edge downwards or to the
2005 right. If DELTA is less than zero, move the edge upwards or to
2006 the left. If the edge can't be moved by DELTA lines or columns,
2007 move it as far as possible in the desired direction."
2011 left this-delta min-delta max-delta failed)
2012 ;; Find the edge we want to move.
2025 ;; Set LEFT to the first resizable window on the left. This step is
2026 ;; needed to handle fixed-size windows.
2039 ;; Set RIGHT to the first resizable window on the right. This step
2040 ;; is needed to handle fixed-size windows.
2053 ;; LEFT and RIGHT (which might be both internal windows) are now the
2054 ;; two windows we want to resize.
2060 ;; We can't get the whole DELTA - move as far as possible.
2063 ;; Start resizing.
2065 ;; Try to enlarge LEFT first.
2069 left this-delta horizontal nil t 'before
2073 ;; Shrink windows on right of LEFT.
2075 left delta horizontal nil 'after
2083 ;; We can't get the whole DELTA - move as far as possible.
2086 ;; Start resizing.
2088 ;; Try to enlarge RIGHT.
2092 right this-delta horizontal nil t 'after
2096 ;; Shrink windows on left of RIGHT.
2103 ;; Don't report an error in the standard case.
2105 ;; But do report an error if applying the changes fails.
2109 "Make selected window DELTA lines taller.
2110 Interactively, if no argument is given, make the selected window
2111 one line taller. If optional argument HORIZONTAL is non-nil,
2112 make selected window wider by DELTA columns. If DELTA is
2113 negative, shrink selected window by -DELTA lines or columns.
2114 Return nil."
2127 horizontal))))
2130 "Make selected window DELTA lines smaller.
2131 Interactively, if no argument is given, make the selected window
2132 one line smaller. If optional argument HORIZONTAL is non-nil,
2133 make selected window narrower by DELTA columns. If DELTA is
2134 negative, enlarge selected window by -DELTA lines or columns.
2135 Return nil."
2148 horizontal))))
2151 "Maximize WINDOW.
2152 Make WINDOW as large as possible without deleting any windows.
2153 WINDOW can be any window and defaults to the selected window."
2160 "Minimize WINDOW.
2161 Make WINDOW as small as possible without deleting any windows.
2162 WINDOW can be any window and defaults to the selected window."
2167 \f
2169 "Return non-nil if WINDOW is the root window of its frame."
2173 "Return window tree rooted at WINDOW.
2174 Optional argument NEXT non-nil means include windows right
2175 siblings in the return value.
2177 See the documentation of `window-tree' for a description of the
2178 return value."
2191 list))
2196 "Return the window tree of frame FRAME.
2197 FRAME must be a live frame and defaults to the selected frame.
2198 The return value is a list of the form (ROOT MINI), where ROOT
2199 represents the window tree of the frame's root window, and MINI
2200 is the frame's minibuffer window.
2202 If the root window is not split, ROOT is the root window itself.
2203 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
2204 for a horizontal split, and t for a vertical split. EDGES gives
2205 the combined size and position of the subwindows in the split,
2206 and the rest of the elements are the subwindows in the split.
2207 Each of the subwindows may again be a window or a list
2208 representing a window split, and so on. EDGES is a list \(LEFT
2209 TOP RIGHT BOTTOM) as returned by `window-edges'."
2212 \f
2214 "Select another window in cyclic ordering of windows.
2215 COUNT specifies the number of windows to skip, starting with the
2216 selected window, before making the selection. If COUNT is
2217 positive, skip COUNT windows forwards. If COUNT is negative,
2218 skip -COUNT windows backwards. COUNT zero means do not skip any
2219 window, so select the selected window. In an interactive call,
2220 COUNT is the numeric prefix argument. Return nil.
2222 If the `other-window' parameter of WINDOW is a function and
2223 `ignore-window-parameters' is nil, call that function with the
2224 arguments COUNT and ALL-FRAMES.
2226 This function does not select a window whose `no-other-window'
2227 window parameter is non-nil.
2229 This function uses `next-window' for finding the window to
2230 select. The argument ALL-FRAMES has the same meaning as in
2231 `next-window', but the MINIBUF argument of `next-window' is
2232 always effectively nil."
2237 old-window old-count)
2240 ;; `next-window' and `previous-window' may return a window we are
2241 ;; not allowed to select. Hence we need an exit strategy in case
2242 ;; all windows are non-selectable.
2249 ;; Keep out of infinite loops. When COUNT has not changed
2250 ;; since we last looked at `window' we're probably in one.
2254 ;; The first non-selectable window `next-window' got us:
2255 ;; Remember it and the current value of COUNT.
2265 ;; Keep out of infinite loops. When COUNT has not changed
2266 ;; since we last looked at `window' we're probably in one.
2270 ;; The first non-selectable window `previous-window' got
2271 ;; us: Remember it and the current value of COUNT.
2278 ;; Always return nil.
2279 nil))))
2281 ;; This should probably return non-nil when the selected window is part
2282 ;; of an atomic window whose root is the frame's root window.
2284 "Return non-nil if the selected window is the only window.
2285 Optional arg NOMINI non-nil means don't count the minibuffer
2286 even if it is active. Otherwise, the minibuffer is counted
2287 when it is active.
2289 Optional argument ALL-FRAMES specifies the set of frames to
2290 consider, see also `next-window'. ALL-FRAMES nil or omitted
2291 means consider windows on the selected frame only, plus the
2292 minibuffer window if specified by the NOMINI argument. If the
2293 minibuffer counts, consider all windows on all frames that share
2294 that minibuffer too. The remaining non-nil values of ALL-FRAMES
2295 with a special meaning are:
2297 - t means consider all windows on all existing frames.
2299 - `visible' means consider all windows on all visible frames on
2300 the current terminal.
2302 - 0 (the number zero) means consider all windows on all visible
2303 and iconified frames on the current terminal.
2305 - A frame means consider all windows on that frame only.
2307 Anything else means consider all windows on the selected frame
2308 and no others."
2314 \f
2315 ;;; Deleting windows.
2317 "Return t if WINDOW can be safely deleted from its frame.
2318 Return `frame' if deleting WINDOW should also delete its
2319 frame."
2323 ;; Handle atomicity.
2332 ;; WINDOW's frame can be deleted only if there are other frames
2333 ;; on the same terminal.
2339 ;; WINDOW can be deleted unless it is the main window of its
2340 ;; frame.
2341 t))))
2344 "Return t if SUBWINDOW is either WINDOW or a subwindow of WINDOW."
2354 "Delete WINDOW.
2355 WINDOW can be an arbitrary window and defaults to the selected
2356 one. Return nil.
2358 If the variable `ignore-window-parameters' is non-nil or the
2359 `delete-window' parameter of WINDOW equals t, do not process any
2360 parameters of WINDOW. Otherwise, if the `delete-window'
2361 parameter of WINDOW specifies a function, call that function with
2362 WINDOW as its sole argument and return the value returned by that
2363 function.
2365 Otherwise, if WINDOW is part of an atomic window, call
2366 `delete-window' with the root of the atomic window as its
2367 argument. If WINDOW is the only window on its frame or the last
2368 non-side window, signal an error."
2374 atom-root)
2377 ;; Handle window parameters.
2379 ;; Ignore window parameters if `ignore-window-parameters' tells
2380 ;; us so or `delete-window' equals t.
2383 ;; The `delete-window' parameter specifies the function to call.
2384 ;; If that function is `ignore' nothing is done. It's up to the
2385 ;; function called here to avoid infinite recursion.
2402 ;; Emacs 23 preferably gives WINDOW's space to its left
2403 ;; sibling.
2409 ;; Resize WINDOW's sibling.
2415 ;; Can do without resizing fixed-size windows.
2418 ;; Can't do without resizing fixed-size windows.
2420 ;; Actually delete WINDOW.
2425 ;; `delete-window-internal' has selected a window that should
2426 ;; not be selected, fix this here.
2430 ;; Always return nil.
2431 nil))))
2434 "Make WINDOW fill its frame.
2435 WINDOW may be any window and defaults to the selected one.
2436 Return nil.
2438 If the variable `ignore-window-parameters' is non-nil or the
2439 `delete-other-windows' parameter of WINDOW equals t, do not
2440 process any parameters of WINDOW. Otherwise, if the
2441 `delete-other-windows' parameter of WINDOW specifies a function,
2442 call that function with WINDOW as its sole argument and return
2443 the value returned by that function.
2445 Otherwise, if WINDOW is part of an atomic window, call this
2446 function with the root of the atomic window as its argument. If
2447 WINDOW is a non-side window, make WINDOW the only non-side window
2448 on the frame. Side windows are not deleted. If WINDOW is a side
2449 window signal an error."
2455 atom-root side-main)
2459 ;; Ignore window parameters if `ignore-window-parameters' is t or
2460 ;; `delete-other-windows' is t.
2463 ;; The `delete-other-windows' parameter specifies the function
2464 ;; to call. If the function is `ignore' no windows are deleted.
2465 ;; It's up to the function called to avoid infinite recursion.
2472 ;; Set side-main to the major non-side window.
2476 ;; If WINDOW is the main non-side window, do nothing.
2481 ;; Always return nil.
2482 nil)))
2485 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
2487 if you often split windows horizontally."
2499 ;;; Windows and buffers.
2501 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
2502 ;; for (1) determining which buffer to show in the window when its
2503 ;; buffer shall be buried or killed and (2) which buffer to show for
2504 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2506 ;; `prev-buffers' consists of <buffer, window-start, window-point>
2507 ;; triples. The entries on this list are ordered by the time their
2508 ;; buffer has been removed from the window, the most recently removed
2509 ;; buffer's entry being first. The window-start and window-point
2510 ;; components are `window-start' and `window-point' at the time the
2511 ;; buffer was removed from the window which implies that the entry must
2512 ;; be added when `set-window-buffer' removes the buffer from the window.
2514 ;; `next-buffers' is the list of buffers that have been replaced
2515 ;; recently by `switch-to-prev-buffer'. These buffers are the least
2516 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
2517 ;; candidates of `switch-to-next-buffer' to switch to. This list is
2518 ;; reset to nil by any action changing the window's buffer with the
2519 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
2520 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
2521 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
2523 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
2524 ;; if such a buffer was killed while the window was hidden within a
2525 ;; window configuration. Such killed buffers get removed whenever
2526 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
2528 ;; The following function is called by `set-window-buffer' _before_ it
2529 ;; replaces the buffer of the argument window with the new buffer.
2531 "Record WINDOW's buffer.
2532 WINDOW must be a live window and defaults to the selected one."
2536 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
2537 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2541 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
2545 ;; Don't record insignificant buffers.
2547 ;; Add an entry for buffer to WINDOW's previous buffers.
2554 ;; We have an entry, update marker positions.
2557 ;; Make new markers.
2565 "Unrecord BUFFER in WINDOW.
2566 WINDOW must be a live window and defaults to the selected one.
2567 BUFFER must be a live buffer and defaults to the buffer of
2568 WINDOW."
2577 "Set WINDOW's buffer to BUFFER.
2578 Optional argument START non-nil means set WINDOW's start position
2579 to START. Optional argument POINT non-nil means set WINDOW's
2580 point to POINT. If WINDOW is selected this also sets BUFFER's
2581 `point' to POINT. If WINDOW is selected and the buffer it showed
2582 before was current this also makes BUFFER the current buffer."
2589 ;; Don't force window-start here (even if POINT is nil).
2595 "In WINDOW switch to previous buffer.
2596 WINDOW must be a live window and defaults to the selected one.
2598 Optional argument BURY-OR-KILL non-nil means the buffer currently
2599 shown in WINDOW is about to be buried or killed and consequently
2600 shall not be switched to in future invocations of this command."
2604 ;; Save this since it's destroyed by `set-window-buffer'.
2606 entry new-buffer killed-buffers visible)
2611 ;; Scan WINDOW's previous buffers first, skipping entries of next
2612 ;; buffers.
2624 ;; Scan reverted buffer list of WINDOW's frame next, skipping
2625 ;; entries of next buffers. Note that when we bury or kill a
2626 ;; buffer we don't reverse the global buffer list to avoid showing
2627 ;; a buried buffer instead. Otherwise, we must reverse the global
2628 ;; buffer list in order to make sure that switching to the
2629 ;; previous/next buffer traverse it in opposite directions.
2638 ;; Try to avoid showing a buffer visible in some other window.
2644 ;; Scan reverted next buffers last (must not use nreverse
2645 ;; here!).
2647 ;; Actually, buffer _must_ be live here since otherwise it
2648 ;; would have been caught in the scan of previous buffers.
2659 ;; Show a buffer visible in another window.
2665 ;; Remove `old-buffer' from WINDOW's previous and (restored list
2666 ;; of) next buffers.
2671 ;; Move `old-buffer' to head of WINDOW's restored list of next
2672 ;; buffers.
2676 ;; Remove killed buffers from WINDOW's previous and next buffers.
2684 ;; Return new-buffer.
2685 new-buffer))
2688 "In WINDOW switch to next buffer.
2689 WINDOW must be a live window and defaults to the selected one."
2694 new-buffer entry killed-buffers visible)
2699 ;; Scan WINDOW's next buffers first.
2710 ;; Scan the buffer list of WINDOW's frame next, skipping previous
2711 ;; buffers entries.
2717 ;; Try to avoid showing a buffer visible in some other window.
2722 ;; Scan WINDOW's reverted previous buffers last (must not use
2723 ;; nreverse here!)
2734 ;; Show a buffer visible in another window.
2739 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
2742 ;; Remove killed buffers from WINDOW's previous and next buffers.
2750 ;; Return new-buffer.
2751 new-buffer))
2754 "Search LIST for a valid buffer to display in FRAME.
2755 Return nil when all buffers in LIST are undesirable for display,
2756 otherwise return the first suitable buffer in LIST.
2758 Buffers not visible in windows are preferred to visible buffers,
2759 unless VISIBLE-OK is non-nil.
2760 If the optional argument FRAME is nil, it defaults to the selected frame.
2761 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
2762 ;; This logic is more or less copied from other-buffer.
2765 found buf)
2778 "Return the last buffer in FRAME's buffer list.
2779 If BUFFER is the last buffer, return the preceding buffer
2780 instead. Buffers not visible in windows are preferred to visible
2781 buffers, unless optional argument VISIBLE-OK is non-nil.
2782 Optional third argument FRAME nil or omitted means use the
2783 selected frame's buffer list. If no such buffer exists, return
2784 the buffer `*scratch*', creating it if necessary."
2787 buffer visible-ok frame)
2791 scratch)))
2794 "Function called to automatically hide frames.
2795 The function is called with one argument - a frame.
2797 Functions affected by this option are those that bury a buffer
2798 shown in a separate frame like `quit-window' and `bury-buffer'."
2802 function)
2808 "Delete WINDOW if possible.
2809 WINDOW must be a live window and defaults to the selected one.
2810 Optional argument DEDICATED-ONLY non-nil means to delete WINDOW
2811 only if it's dedicated to its buffer. Optional argument KILL
2812 means the buffer shown in window will be killed. Return non-nil
2813 if WINDOW gets deleted or its frame is auto-hidden."
2829 t)))))
2832 "Put BUFFER-OR-NAME at the end of the list of all buffers.
2833 There it is the least likely candidate for `other-buffer' to
2835 select by default.
2837 You can specify a buffer name as BUFFER-OR-NAME, or an actual
2838 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
2839 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
2840 remove the current buffer from the selected window if it is
2841 displayed there."
2844 ;; If `buffer-or-name' is not on the selected frame we unrecord it
2845 ;; although it's not "here" (call it a feature).
2847 ;; Handle case where `buffer-or-name' is nil and the current buffer
2848 ;; is shown in the selected window.
2853 ;; Switch to another buffer in window.
2857 ;; Always return nil.
2858 nil))
2861 "Switch to the last buffer in the buffer list."
2866 "In selected window switch to next buffer."
2873 "In selected window switch to previous buffer."
2880 "Delete all windows showing BUFFER-OR-NAME.
2881 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2882 and defaults to the current buffer.
2884 The following non-nil values of the optional argument FRAME
2885 have special meanings:
2887 - t means consider all windows on the selected frame only.
2889 - `visible' means consider all windows on all visible frames on
2890 the current terminal.
2892 - 0 (the number zero) means consider all windows on all visible
2893 and iconified frames on the current terminal.
2895 - A frame means consider all windows on that frame only.
2897 Any other value of FRAME means consider all windows on all
2898 frames.
2900 When a window showing BUFFER-OR-NAME is dedicated and the only
2901 window of its frame, that frame is deleted when there are other
2902 frames left."
2905 ;; Handle the "inverted" meaning of the FRAME argument wrt other
2906 ;; `window-list-1' based function.
2913 ;; Delete frame if and only if window is dedicated.
2916 ;; Delete window.
2919 ;; In window switch to previous buffer.
2922 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
2926 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
2927 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2928 and defaults to the current buffer.
2930 When a window showing BUFFER-OR-NAME is dedicated, that window is
2931 deleted. If that window is the only window on its frame, the
2932 frame is deleted too when there are other frames left. If there
2933 are no other frames left, some other buffer is displayed in that
2934 window.
2936 This function removes the buffer denoted by BUFFER-OR-NAME from
2937 all window-local buffer lists."
2942 ;; Switch to another buffer in window.
2945 ;; Unrecord BUFFER in WINDOW.
2949 "Quit WINDOW and bury its buffer.
2950 WINDOW must be a live window and defaults to the selected one.
2951 With prefix argument KILL non-nil, kill the buffer instead of
2952 burying it.
2954 According to information stored in WINDOW's `quit-restore' window
2955 parameter either \(1) delete WINDOW and its frame, \(2) delete
2956 WINDOW, \(3) restore the buffer previously displayed in WINDOW,
2957 or \(4) make WINDOW display some other buffer than the present
2958 one. If non-nil, reset `quit-restore' parameter to nil."
2969 buffer))))
2970 prev-buffer)))
2971 quad resize)
2976 ;; Delete WINDOW if possible.
2978 ;; If the previously selected window is still alive, select it.
2984 ;; Show another buffer stored in quit-restore parameter.
2991 ;; Try to resize WINDOW to its old height but don't signal an
2992 ;; error.
2996 ;; Restore WINDOW's previous buffer, window start and point.
2999 ;; Reset the quit-restore parameter.
3001 ;; Select old window.
3005 ;; Show some other buffer in WINDOW and reset the quit-restore
3006 ;; parameter.
3008 ;; Make sure that WINDOW is no more dedicated.
3012 ;; Kill WINDOW's old-buffer if requested
3018 "Quit all windows showing BUFFER-OR-NAME.
3019 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
3020 and defaults to the current buffer. Optional argument KILL
3021 non-nil means to kill BUFFER-OR-NAME. KILL nil means to bury
3022 BUFFER-OR-NAME. Optional argument FRAME is handled as by
3023 `delete-windows-on'.
3025 This function calls `quit-window' on all candidate windows
3026 showing BUFFER-OR-NAME."
3029 ;; Handle the "inverted" meaning of the FRAME argument wrt other
3030 ;; `window-list-1' based function.
3035 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
3037 \f
3038 ;;; Splitting windows.
3040 "Return minimum height of any window when splitting windows.
3041 Optional argument HORIZONTAL non-nil means return minimum width."
3047 "Make a new window adjacent to WINDOW.
3048 WINDOW can be any window and defaults to the selected one.
3049 Return the new window which is always a live window.
3051 Optional argument SIZE a positive number means make WINDOW SIZE
3052 lines or columns tall. If SIZE is negative, make the new window
3053 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
3054 absolute value can be less than `window-min-height' or
3055 `window-min-width'; so this command can make a new window as
3056 small as one line or two columns. SIZE defaults to half of
3057 WINDOW's size. Interactively, SIZE is the prefix argument.
3059 Optional third argument SIDE nil (or `below') specifies that the
3060 new window shall be located below WINDOW. SIDE `above' means the
3061 new window shall be located above WINDOW. In both cases SIZE
3062 specifies the new number of lines for WINDOW \(or the new window
3063 if SIZE is negative) including space reserved for the mode and/or
3064 header line.
3066 SIDE t (or `right') specifies that the new window shall be
3067 located on the right side of WINDOW. SIDE `left' means the new
3068 window shall be located on the left of WINDOW. In both cases
3069 SIZE specifies the new number of columns for WINDOW \(or the new
3070 window provided SIZE is negative) including space reserved for
3071 fringes and the scrollbar or a divider column. Any other non-nil
3072 value for SIDE is currently handled like t (or `right').
3074 If the variable `ignore-window-parameters' is non-nil or the
3075 `split-window' parameter of WINDOW equals t, do not process any
3076 parameters of WINDOW. Otherwise, if the `split-window' parameter
3077 of WINDOW specifies a function, call that function with all three
3078 arguments and return the value returned by that function.
3081 root of that atomic window. The new window does not become a
3082 member of that atomic window.
3084 If WINDOW is live, properties of the new window like margins and
3085 scrollbars are inherited from WINDOW. If WINDOW is an internal
3086 window, these properties as well as the buffer displayed in the
3087 new window are inherited from the window selected on WINDOW's
3088 frame. The selected window is not changed by this function."
3100 ;; Rebind `window-nest' since in some cases we may have to
3101 ;; override its value.
3103 atom-root)
3108 ;; Ignore window parameters if either `ignore-window-parameters'
3109 ;; is t or the `split-window' parameter equals t.
3112 ;; The `split-window' parameter specifies the function to call.
3113 ;; If that function is `ignore', do nothing.
3115 ;; If WINDOW is a subwindow of an atomic window, split the root
3116 ;; window of that atomic window instead.
3125 ;; WINDOW is a side root window. To make sure that a new parent
3126 ;; window gets created set `window-nest' to t.
3130 ;; If `window-splits' is non-nil and SIZE is a non-negative
3131 ;; integer, we cannot reasonably resize other windows. Rather
3132 ;; bind `window-nest' to t to make sure that subsequent window
3133 ;; deletions are handled correctly.
3137 ;; `parent-size' is the size of WINDOW's parent, provided
3138 ;; it has one.
3140 ;; `resize' non-nil means we are supposed to resize other
3141 ;; windows in WINDOW's combination.
3144 ;; Resize makes sense in iso-combinations only.
3146 ;; `old-size' is the current size of WINDOW.
3148 ;; `new-size' is the specified or calculated size of the
3149 ;; new window.
3155 ;; When resizing try to give the new window the
3156 ;; average size of a window in its combination.
3159 (/ parent-size
3161 parent horizontal))))
3162 ;; Else try to give the new window half the size
3163 ;; of WINDOW (plus an eventual odd line).
3166 ;; SIZE non-negative specifies the new size of WINDOW.
3168 ;; Note: Specifying a non-negative SIZE is practically
3169 ;; always done as workaround for making the new window
3170 ;; appear above or on the left of the new window (the
3171 ;; ispell window is a typical example of that). In all
3172 ;; these cases the SIDE argument should be set to 'above
3173 ;; or 'left in order to support the 'resize option.
3174 ;; Here we have to nest the windows instead, see above.
3177 ;; SIZE negative specifies the size of the new window.
3179 new-parent new-normal)
3181 ;; Check SIZE.
3186 ;; SIZE unspecified, resizing.
3188 ;; Try again with minimum split size.
3194 ;; SIZE unspecified, no resizing.
3199 window-safe-min-width
3200 window-safe-min-width))))
3201 ;; SIZE specified as new size of old window. If the new size
3202 ;; is larger than the old size or the size of the new window
3203 ;; would be less than the safe minimum, signal an error.
3206 ;; SIZE specified, resizing.
3208 ;; If we cannot resize the parent give up.
3214 ;; SIZE specification violates minimum size restrictions.
3220 ;; Make new-parent non-nil if we need a new parent window;
3221 ;; either because we want to nest or because WINDOW is not
3222 ;; iso-combined.
3225 ;; Make new-normal the normal size of the new window.
3233 ;; Try to get space from OLD's siblings. We could go "up" and
3234 ;; try getting additional space from surrounding windows but
3235 ;; we won't be able to return space to those windows when we
3236 ;; delete the one we create here. Hence we do not go up.
3245 ;; Get entire space from WINDOW.
3250 new-normal)))
3253 ;; Inherit window-side parameters, if any.
3260 ;; Always return the new window.
3261 new)))))
3263 ;; I think this should be the default; I think people will prefer it--rms.
3266 in both children.
3267 This is often more convenient for editing.
3268 If nil, adjust point in each of the two windows to minimize redisplay.
3269 This is convenient on slow terminals, but point can move strangely.
3271 This option applies only to `split-window-above-each-other' and
3272 functions that call it. `split-window' always keeps the original
3273 point in both children."
3278 "Split selected window into two windows, one above the other.
3279 The upper window gets SIZE lines and the lower one gets the rest.
3280 SIZE negative means the lower window gets -SIZE lines and the
3281 upper one the rest. With no argument, split windows equally or
3282 close to it. Both windows display the same buffer, now current.
3284 If the variable `split-window-keep-point' is non-nil, both new
3285 windows will get the same value of point as the selected window.
3286 This is often more convenient for editing. The upper window is
3287 the selected window.
3289 Otherwise, we choose window starts so as to minimize the amount of
3290 redisplay; this is convenient on slow terminals. The new selected
3291 window is the one that the current value of point appears in. The
3292 value of point can change if the text around point is hidden by the
3293 new mode line.
3295 Regardless of the value of `split-window-keep-point', the upper
3296 window is the original one and the return value is the new, lower
3297 window."
3302 moved-by-window-height moved new-window bottom)
3304 ;; `split-window' would not signal an error here.
3325 ;; Always copy quit-restore parameter in interactive use.
3329 new-window))
3334 "Split selected window into two windows side by side.
3335 The selected window becomes the left one and gets SIZE columns.
3336 SIZE negative means the right window gets -SIZE columns.
3338 SIZE includes the width of the window's scroll bar; if there are
3339 no scroll bars, it includes the width of the divider column to
3340 the window's right, if any. SIZE omitted or nil means split
3341 window equally.
3343 The selected window remains selected. Return the new window."
3347 new-window)
3349 ;; `split-window' would not signal an error here.
3352 ;; Always copy quit-restore parameter in interactive use.
3356 new-window))
3359 \f
3360 ;;; Balancing windows.
3362 ;; The following routine uses the recycled code from an old version of
3363 ;; `window--resize-subwindows'. It's not very pretty, but coding it the way the
3364 ;; new `window--resize-subwindows' code does would hardly make it any shorter or
3365 ;; more readable (FWIW we'd need three loops - one to calculate the
3366 ;; minimum sizes per window, one to enlarge or shrink windows until the
3367 ;; new parent-size matches, and one where we shrink the largest/enlarge
3368 ;; the smallest window).
3370 "Subroutine of `balance-windows-1'.
3371 WINDOW must be an iso-combination."
3377 found failed size sub-total sub-delta sub-amount rest)
3392 ;; Ignore subwindows that should be ignored or are stuck.
3399 ;; Register the new total size for this subwindow.
3404 ;; We failed and need a new round.
3410 ;; Fix rounding by trying to enlarge non-stuck windows by one line
3411 ;; (column) until `rest' is zero.
3419 ;; Fix rounding by trying to enlarge stuck windows by one line
3420 ;; (column) until `rest' equals zero.
3430 ;; Record new normal sizes.
3436 ;; Recursively balance each subwindow's subwindows.
3441 "Subroutine of `balance-windows'."
3453 "Balance the sizes of subwindows of WINDOW-OR-FRAME.
3454 WINDOW-OR-FRAME is optional and defaults to the selected frame.
3455 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
3456 subwindows of that frame's root window. If WINDOW-OR-FRAME
3457 denots a window, balance the sizes of all subwindows of that
3458 window."
3467 window-or-frame)
3471 ;; Balance vertically.
3475 ;; Balance horizontally.
3481 "Return t if WINDOW cannot be resized in DIRECTION.
3482 WINDOW defaults to the selected window. DIRECTION can be
3483 nil (i.e. any), `height' or `width'."
3490 ;;; A different solution to balance-windows.
3492 "Factor by which the window area should be over-estimated.
3493 This is used by `balance-windows-area'.
3498 "Wrapper around `window-resize' with error checking.
3499 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
3500 ;; `window-resize' may fail if delta is too large.
3507 ;;(message "adjust: %s" (error-message-string err))
3511 "Make all visible windows the same area (approximately).
3512 See also `window-area-factor' to change the relative size of
3513 specific buffers."
3516 ;; Remove fixed-size windows.
3521 next)
3522 ;; Resizing a window changes the size of surrounding windows in complex
3523 ;; ways, so it's difficult to balance them all. The introduction of
3524 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
3525 ;; very difficult to do. `balance-window' above takes an off-line
3526 ;; approach: get the whole window tree, then balance it, then try to
3527 ;; adjust the windows so they fit the result.
3528 ;; Here, instead, we take a "local optimization" approach, where we just
3529 ;; go through all the windows several times until nothing needs to be
3530 ;; changed. The main problem with this approach is that it's difficult
3531 ;; to make sure it terminates, so we use some heuristic to try and break
3532 ;; off infinite loops.
3533 ;; After a round without any change, we allow a second, to give a chance
3534 ;; to the carry to propagate a minor imbalance from the end back to
3535 ;; the beginning.
3537 ;; (message "New round")
3543 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
3561 ;; Maybe diff is actually closer to 1 than to 0.
3565 ;; Change things smoothly.
3568 ;; Make sure negligible differences don't accumulate to
3569 ;; become significant.
3571 ;; This used `adjust-window-trailing-edge' before and uses
3572 ;; `window-resize' now. Error wrapping is still needed.
3574 ;; (sit-for 0.5)
3576 ;; If the same change has been seen already for this window,
3577 ;; we're most likely in an endless loop, so don't count it as
3578 ;; a change.
3582 ;; We've now basically balanced all the windows.
3583 ;; But there may be some minor off-by-one imbalance left over,
3584 ;; so let's do some fine tuning.
3585 ;; (bw-finetune wins)
3586 ;; (message "Done in %d rounds" round)
3587 ))
3589 ;;; Window states, how to get them and how to put them in a window.
3591 "Like LIST but do not add nil elements of ARGS."
3598 "Helper function for `window-state-get'."
3608 type
3619 window-state-ignored-parameters)
3622 ;; Make a clone-of parameter.
3627 ;; All buffer related things go in here - make the buffer
3628 ;; current when retrieving `point' and `mark'.
3658 "Return state of WINDOW as a Lisp object.
3659 WINDOW can be any window and defaults to the root window of the
3660 selected frame.
3662 Optional argument MARKERS non-nil means use markers for sampling
3663 positions like `window-point' or `window-start'. MARKERS should
3664 be non-nil only if the value is used for putting the state back
3665 in the same session (note that markers slow down processing).
3667 The return value can be used as argument for `window-state-put'
3668 to put the state recorded here into an arbitrary window. The
3669 value can be also stored on disk and read back in a new session."
3673 window
3676 ;; The return value is a cons whose car specifies some constraints on
3677 ;; the size of WINDOW. The cdr lists the states of the subwindows of
3678 ;; WINDOW.
3680 ;; Frame related things would go into a function, say `frame-state',
3681 ;; calling `window-state-get' to insert the frame's root window.
3689 ;; These are probably not needed.
3698 "Helper function for `window-state-put'."
3703 ;; For a leaf window just add unprocessed entries to
3704 ;; `window-state-put-list'.
3711 size new)
3713 ;; Find the next child window. WINDOW always points to the
3714 ;; real window that we want to fill with what we find here.
3717 ;; The last child window. Below `window-state-put-1'
3718 ;; will put into it whatever ITEM has in store.
3720 ;; Not the last child window, prepare for splitting
3721 ;; WINDOW. SIZE is the new (and final) size of the old
3722 ;; window.
3725 ;; Use total size.
3727 ;; Use normalized size and round.
3731 item))))))
3733 ;; Use safe sizes, we try to resize later.
3735 window-safe-min-height
3736 window-safe-min-width)))
3740 ;; We must inherit the nesting, otherwise we might mess
3741 ;; up handling of atomic and side window.
3743 ;; Give up if we can't resize window down to safe sizes.
3748 ;; When creating the first child window add for parent
3749 ;; unprocessed entries to `window-state-put-list'.
3752 window-state-put-list))))
3754 ;; Now process the current window (either the one we've just
3755 ;; split or the last child of its parent).
3757 ;; Continue with the last window split off.
3761 "Helper function for `window-state-put'."
3770 ;; Process parameters.
3774 ;; Process buffer related state.
3776 ;; We don't want to raise an error here so we create a buffer if
3777 ;; there's none.
3789 ;; Adjust vertically.
3791 ;; A fixed height window, try to restore the original size.
3794 window-size-fixed)
3797 ;; Else check whether the window is not high enough.
3803 ;; Adjust horizontally.
3805 ;; A fixed width window, try to restore the original size.
3808 window-size-fixed)
3811 ;; Else check whether the window is not wide enough.
3817 ;; Set dedicated status.
3819 ;; Install positions (maybe we should do this after all windows
3820 ;; have been created and sized).
3824 ;; I'm not sure whether we should set the mark here, but maybe
3825 ;; it can be used.
3828 ;; Select window if it's the selected one.
3833 "Put window state STATE into WINDOW.
3834 STATE should be the state of a window returned by an earlier
3835 invocation of `window-state-get'. Optional argument WINDOW must
3836 specify a live window and defaults to the selected one.
3838 Optional argument IGNORE non-nil means ignore minimum window
3839 sizes and fixed size restrictions. IGNORE equal `safe' means
3840 subwindows can get as small as `window-safe-min-height' and
3841 `window-safe-min-width'."
3845 ;; We check here (1) whether the total sizes of root window of
3846 ;; STATE and that of WINDOW are equal so we can avoid
3847 ;; calculating new sizes, and (2) if we do have to resize
3848 ;; whether we can do so without violating size restrictions.
3856 window-splits selected)
3874 (> min-width
3876 ;; The check above might not catch all errors due to rounding
3877 ;; issues - so IGNORE equal 'safe might not always produce the
3878 ;; minimum possible state. But such configurations hardly make
3879 ;; sense anyway.
3883 ;; Work on the windows of a temporary buffer to make sure that
3884 ;; splitting proceeds regardless of any buffer local values of
3885 ;; `window-size-fixed'. Release that buffer after the buffers of
3886 ;; all live windows have been set by `window-state-put-2'.
3892 \f
3894 "Record information for window used by `display-buffer'.
3895 TYPE specifies the type of the calling operation and must be one
3896 of the symbols 'reuse \(when WINDOW existed already and was
3897 reused for displaying BUFFER), 'window \(when WINDOW was created
3898 on an already existing frame), or 'frame \(when WINDOW was
3899 created on a new frame). WINDOW is the window used for or created
3900 by the `display-buffer' routines. BUFFER is the buffer that
3901 shall be displayed.
3903 This function installs or updates the quit-restore parameter of
3904 WINDOW. The quit-restore parameter is a list of four elements:
3905 The first element is one of the symbols 'window, 'frame, 'same or
3906 'other. The second element is either one of the symbols 'window
3907 or 'frame or a list whose elements are the buffer previously
3908 shown in the window, that buffer's window start and window point,
3909 and the window's height. The third element is the window
3910 selected at the time the parameter was created. The fourth
3911 element is BUFFER."
3915 ;; WINDOW shows BUFFER already.
3917 ;; If WINDOW has a quit-restore parameter, reset its car.
3919 ;; WINDOW shows another buffer.
3921 window 'quit-restore
3923 ;; A quadruple of WINDOW's buffer, start, point and height.
3928 ;; WINDOW has been created on an existing frame.
3930 window 'quit-restore
3933 ;; WINDOW has been created on a new frame.
3935 window 'quit-restore
3939 "If non-nil, function to call to handle `display-buffer'.
3940 It will receive two args, the buffer and a flag which if non-nil
3941 means that the currently selected window is not acceptable. It
3942 should choose or create a window, display the specified buffer in
3943 it, and return the window.
3945 The function specified here is responsible for setting the
3946 quit-restore and help-setup parameters of the window used."
3953 "Alist of parameters for automatically generated new frames.
3954 You can set this in your init file; for example,
3956 (setq pop-up-frame-alist '((width . 80) (height . 20)))
3958 If non-nil, the value you specify here is used by the default
3959 `pop-up-frame-function' for the creation of new frames.
3961 Since `pop-up-frame-function' is used by `display-buffer' for
3962 making new frames, any value specified here by default affects
3963 the automatic generation of new frames via `display-buffer' and
3964 all functions based on it. The behavior of `make-frame' is not
3965 affected by this variable."
3973 "Function used by `display-buffer' for creating a new frame.
3974 This function is called with no arguments and should return a new
3975 frame. The default value calls `make-frame' with the argument
3976 `pop-up-frame-alist'."
3981 "List of names of buffers that should be displayed specially.
3982 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
3983 its name is in this list, displays the buffer in a way specified
3984 by `special-display-function'. `special-display-popup-frame'
3985 \(the default for `special-display-function') usually displays
3986 the buffer in a separate frame made with the parameters specified
3987 by `special-display-frame-alist'. If `special-display-function'
3988 has been set to some other function, that function is called with
3989 the buffer as first, and nil as second argument.
3991 Alternatively, an element of this list can be specified as
3992 \(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
3993 name and FRAME-PARAMETERS an alist of \(PARAMETER . VALUE) pairs.
3994 `special-display-popup-frame' will interpret such pairs as frame
3995 parameters when it creates a special frame, overriding the
3996 corresponding values from `special-display-frame-alist'.
3998 As a special case, if FRAME-PARAMETERS contains (same-window . t)
3999 `special-display-popup-frame' displays that buffer in the
4000 selected window. If FRAME-PARAMETERS contains (same-frame . t),
4001 it displays that buffer in a window on the selected frame.
4003 If `special-display-function' specifies some other function than
4004 `special-display-popup-frame', that function is called with the
4005 buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
4006 argument.
4008 Finally, an element of this list can be also specified as
4009 \(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
4010 `special-display-popup-frame' will call FUNCTION with the buffer
4011 named BUFFER-NAME as first argument, and OTHER-ARGS as the
4012 second.
4014 Any alternative function specified here is responsible for
4015 setting up the quit-restore parameter of the window used.
4018 name to it but the corresponding buffer is displayed in the
4019 selected window, look at the values of `same-window-buffer-names'
4020 and `same-window-regexps'. Those variables take precedence over
4021 this one.
4023 See also `special-display-regexps'."
4045 ;;;###autoload
4049 "List of regexps saying which buffers should be displayed specially.
4050 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
4051 any regexp in this list matches its name, displays it specially
4052 using `special-display-function'. `special-display-popup-frame'
4053 \(the default for `special-display-function') usually displays
4054 the buffer in a separate frame made with the parameters specified
4055 by `special-display-frame-alist'. If `special-display-function'
4056 has been set to some other function, that function is called with
4057 the buffer as first, and nil as second argument.
4059 Alternatively, an element of this list can be specified as
4060 \(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
4061 FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
4062 `special-display-popup-frame' will then interpret these pairs as
4063 frame parameters when creating a special frame for a buffer whose
4064 name matches REGEXP, overriding the corresponding values from
4065 `special-display-frame-alist'.
4067 As a special case, if FRAME-PARAMETERS contains (same-window . t)
4068 `special-display-popup-frame' displays buffers matching REGEXP in
4069 the selected window. \(same-frame . t) in FRAME-PARAMETERS means
4070 to display such buffers in a window on the selected frame.
4072 If `special-display-function' specifies some other function than
4073 `special-display-popup-frame', that function is called with the
4074 buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
4075 as second argument.
4077 Finally, an element of this list can be also specified as
4078 \(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
4079 will then call FUNCTION with the buffer whose name matched
4080 REGEXP as first, and OTHER-ARGS as second argument.
4082 Any alternative function specified here is responsible for
4083 setting up the quit-restore parameter of the window used.
4086 name to it but the corresponding buffer is displayed in the
4087 selected window, look at the values of `same-window-buffer-names'
4088 and `same-window-regexps'. Those variables take precedence over
4089 this one.
4091 See also `special-display-buffer-names'."
4114 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
4115 More precisely, return t if `special-display-buffer-names' or
4116 `special-display-regexps' contain a string entry equaling or
4117 matching BUFFER-NAME. If `special-display-buffer-names' or
4118 `special-display-regexps' contain a list entry whose car equals
4119 or matches BUFFER-NAME, the return value is the cdr of that
4120 entry."
4125 t)
4140 "Alist of parameters for special frames.
4141 Special frames are used for buffers whose names are listed in
4142 `special-display-buffer-names' and for buffers whose names match
4143 one of the regular expressions in `special-display-regexps'.
4145 This variable can be set in your init file, like this:
4147 (setq special-display-frame-alist '((width . 80) (height . 20)))
4149 These supersede the values given in `default-frame-alist'."
4156 "Display BUFFER and return the window chosen.
4157 If BUFFER is already displayed in a visible or iconified frame,
4158 raise that frame. Otherwise, display BUFFER in a new frame.
4160 Optional argument ARGS is a list specifying additional
4161 information.
4163 If ARGS is an alist, use it as a list of frame parameters. If
4164 these parameters contain \(same-window . t), display BUFFER in
4165 the selected window. If they contain \(same-frame . t), display
4166 BUFFER in a window of the selected frame.
4168 If ARGS is a list whose car is a symbol, use (car ARGS) as a
4169 function to do the work. Pass it BUFFER as first argument,
4170 and (cdr ARGS) as second."
4175 ;; If we have a window already, make it visible.
4181 window))
4182 ;; Reuse the current window if the user requested it.
4187 ;; Stay on the same frame if requested.
4190 pop-up-frames
4191 special-display-buffer-names special-display-regexps)
4193 ;; If no window yet, make one in a new frame.
4200 ;; Reset list of WINDOW's previous buffers to nil.
4203 window)))))
4206 "Function to call for displaying special buffers.
4207 This function is called with two arguments - the buffer and,
4208 optionally, a list - and should return a window displaying that
4209 buffer. The default value usually makes a separate frame for the
4210 buffer using `special-display-frame-alist' to specify the frame
4211 parameters. See the definition of `special-display-popup-frame'
4212 for how to specify such a function.
4214 A buffer is special when its name is either listed in
4215 `special-display-buffer-names' or matches a regexp in
4216 `special-display-regexps'.
4218 The function specified here is responsible for setting the
4219 quit-restore and help-setup parameters of the window used."
4225 `display-buffer' and `pop-to-buffer' show a buffer whose name is
4226 on this list in the selected rather than some other window.
4228 An element of this list can be a cons cell instead of just a
4229 string. In that case, the cell's car must be a string specifying
4230 the buffer name. This is for compatibility with
4231 `special-display-buffer-names'; the cdr of the cons cell is
4232 ignored.
4234 See also `same-window-regexps'."
4240 `display-buffer' and `pop-to-buffer' show a buffer whose name
4241 matches a regexp on this list in the selected rather than some
4242 other window.
4244 An element of this list can be a cons cell instead of just a
4245 string. In that case, the cell's car must be a regexp matching
4246 the buffer name. This is for compatibility with
4247 `special-display-regexps'; the cdr of the cons cell is ignored.
4249 See also `same-window-buffer-names'."
4255 This function returns non-nil if `display-buffer' or
4256 `pop-to-buffer' would show a buffer named BUFFER-NAME in the
4257 selected rather than \(as usual\) some other window. See
4258 `same-window-buffer-names' and `same-window-regexps'."
4261 ;; The elements of `same-window-buffer-names' can be buffer
4262 ;; names or cons cells whose cars are buffer names.
4267 ;; The elements of `same-window-regexps' can be regexps
4268 ;; or cons cells whose cars are regexps.
4276 "Whether `display-buffer' should make a separate frame.
4277 If nil, never make a separate frame.
4278 If the value is `graphic-only', make a separate frame
4279 on graphic displays only.
4280 Any other non-nil value means always make a separate frame."
4288 "Non-nil means `display-buffer' should reuse frames.
4289 If the buffer in question is already displayed in a frame, raise
4290 that frame."
4296 "Non-nil means `display-buffer' should make a new window."
4301 "Function called by `display-buffer' routines to split a window.
4302 This function is called with a window as single argument and is
4303 supposed to split that window and return the new window. If the
4304 window can (or shall) not be split, it is supposed to return nil.
4305 The default is to call the function `split-window-sensibly' which
4306 tries to split the window in a way which seems most suitable.
4307 You can customize the options `split-height-threshold' and/or
4308 `split-width-threshold' in order to have `split-window-sensibly'
4309 prefer either vertical or horizontal splitting.
4311 If you set this to any other function, bear in mind that the
4312 `display-buffer' routines may call this function two times. The
4313 argument of the first call is the largest window on its frame.
4314 If that call fails to return a live window, the function is
4315 called again with the least recently used window as argument. If
4316 that call fails too, `display-buffer' will use an existing window
4317 to display its buffer.
4319 The window selected at the time `display-buffer' was invoked is
4320 still selected when this function is called. Hence you can
4321 compare the window argument with the value of `selected-window'
4322 if you intend to split the selected window instead or if you do
4323 not want to split the selected window."
4329 "Minimum height for splitting windows sensibly.
4330 If this is an integer, `split-window-sensibly' may split a window
4331 vertically only if it has at least this many lines. If this is
4332 nil, `split-window-sensibly' is not allowed to split a window
4333 vertically. If, however, a window is the only window on its
4334 frame, `split-window-sensibly' may split it vertically
4335 disregarding the value of this variable."
4341 "Minimum width for splitting windows sensibly.
4342 If this is an integer, `split-window-sensibly' may split a window
4343 horizontally only if it has at least this many columns. If this
4344 is nil, `split-window-sensibly' is not allowed to split a window
4345 horizontally."
4351 "Return non-nil if `split-window-sensibly' may split WINDOW.
4352 Optional argument HORIZONTAL nil or omitted means check whether
4353 `split-window-sensibly' may split WINDOW vertically. HORIZONTAL
4354 non-nil means check whether WINDOW may be split horizontally.
4356 WINDOW may be split vertically when the following conditions
4357 hold:
4358 - `window-size-fixed' is either nil or equals `width' for the
4359 buffer of WINDOW.
4360 - `split-height-threshold' is an integer and WINDOW is at least as
4361 high as `split-height-threshold'.
4362 - When WINDOW is split evenly, the emanating windows are at least
4363 `window-min-height' lines tall and can accommodate at least one
4364 line plus - if WINDOW has one - a mode line.
4366 WINDOW may be split horizontally when the following conditions
4367 hold:
4368 - `window-size-fixed' is either nil or equals `height' for the
4369 buffer of WINDOW.
4370 - `split-width-threshold' is an integer and WINDOW is at least as
4371 wide as `split-width-threshold'.
4372 - When WINDOW is split evenly, the emanating windows are at least
4373 `window-min-width' or two (whichever is larger) columns wide."
4377 ;; A window can be split horizontally when its width is not
4378 ;; fixed, it is at least `split-width-threshold' columns wide
4379 ;; and at least twice as wide as `window-min-width' and 2 (the
4380 ;; latter value is hardcoded).
4382 ;; Testing `window-full-width-p' here hardly makes any
4383 ;; sense nowadays. This can be done more intuitively by
4384 ;; setting up `split-width-threshold' appropriately.
4389 ;; A window can be split vertically when its height is not
4390 ;; fixed, it is at least `split-height-threshold' lines high,
4391 ;; and it is at least twice as high as `window-min-height' and 2
4392 ;; if it has a modeline or 1.
4401 "Split WINDOW in a way suitable for `display-buffer'.
4402 If `split-height-threshold' specifies an integer, WINDOW is at
4403 least `split-height-threshold' lines tall and can be split
4404 vertically, split WINDOW into two windows one above the other and
4405 return the lower window. Otherwise, if `split-width-threshold'
4406 specifies an integer, WINDOW is at least `split-width-threshold'
4407 columns wide and can be split horizontally, split WINDOW into two
4408 windows side by side and return the window on the right. If this
4409 can't be done either and WINDOW is the only window on its frame,
4410 try to split WINDOW vertically disregarding any value specified
4411 by `split-height-threshold'. If that succeeds, return the lower
4412 window. Return nil otherwise.
4414 By default `display-buffer' routines call this function to split
4415 the largest or least recently used window. To change the default
4416 customize the option `split-window-preferred-function'.
4418 You can enforce this function to not split WINDOW horizontally,
4419 by setting \(or binding) the variable `split-width-threshold' to
4420 nil. If, in addition, you set `split-height-threshold' to zero,
4421 chances increase that this function does split WINDOW vertically.
4423 In order to not split WINDOW vertically, set \(or bind) the
4424 variable `split-height-threshold' to nil. Additionally, you can
4425 set `split-width-threshold' to zero to make a horizontal split
4426 more likely to occur.
4428 Have a look at the function `window-splittable-p' if you want to
4429 know how `split-window-sensibly' determines whether WINDOW can be
4430 split."
4432 ;; Split window vertically.
4436 ;; Split window horizontally.
4441 ;; If WINDOW is the only window on its frame and is not the
4442 ;; minibuffer window, try to split it vertically disregarding
4443 ;; the value of `split-height-threshold'.
4450 "Try to split WINDOW.
4451 Return value returned by `split-window-preferred-function' if it
4452 represents a live window, nil otherwise."
4456 ;; Since `split-window-preferred-function' might
4457 ;; throw an error use `condition-case'.
4464 "Return FRAME if it can be used to display a buffer."
4467 ;; `frame-root-window' may be an internal window which is considered
4468 ;; "dead" by `window-live-p'. Hence if `window' is not live we
4469 ;; implicitly know that `frame' has a visible window we can use.
4472 ;; If the window is soft-dedicated, the frame is usable.
4473 ;; Actually, even if the window is really dedicated,
4474 ;; the frame is still usable by splitting it.
4475 ;; At least Emacs-22 allowed it, and it is desirable
4476 ;; when displaying same-frame windows.
4477 nil ; (eq t (window-dedicated-p window))
4478 ))
4479 frame))))
4482 "If non-nil `display-buffer' will try to even window heights.
4483 Otherwise `display-buffer' will leave the window configuration
4484 alone. Heights are evened only when `display-buffer' chooses a
4485 window that appears above or below the selected window."
4490 "Even heights of WINDOW and selected window.
4491 Do this only if these windows are vertically adjacent to each
4492 other, `even-window-heights' is non-nil, and the selected window
4493 is higher than WINDOW."
4496 ;; Don't resize minibuffer windows.
4507 ;; Don't throw an error if we can't even window heights for
4508 ;; whatever reason.
4514 "Raise the frame containing WINDOW.
4515 Do not raise the selected frame. Return WINDOW."
4519 ;; Assume the selected frame is already visible enough.
4521 ;; Assume the frame from which we invoked the minibuffer
4522 ;; is visible.
4526 window))
4529 "Display BUFFER in WINDOW and make its frame visible.
4530 Set `window-dedicated-p' to DEDICATED if non-nil.
4531 Return WINDOW."
4539 "If non-nil, `display-buffer' marks the windows it creates as dedicated.
4540 The actual non-nil value of this variable will be copied to the
4544 "Normalize BUFFER-OR-NAME argument for buffer display functions.
4545 If BUFFER-OR-NAME is nil, return the curent buffer. Else, if a
4546 buffer specified by BUFFER-OR-NAME exists, return that buffer.
4547 If no such buffer exists, create a buffer with the name
4548 BUFFER-OR-NAME and return that buffer."
4553 buffer))
4570 ,display-buffer--action-function-custom-type
4575 :key-type symbol
4580 "Overriding action to perform to display a buffer.
4581 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4582 function or a list of functions. Each function should accept 2
4583 arguments: a buffer to display and an alist similar to ALIST.
4588 "Alist of conditional actions for `display-buffer'.
4589 This is a list of elements (CONDITION . ACTION), where:
4591 CONDITION is either a regexp matching buffer names, or a function
4592 that takes a buffer and returns a boolean.
4594 ACTION is a cons cell (FUNCTION . ALIST), where FUNCTION is a
4595 function or a list of functions. Each such function should
4596 accept 2 arguments: a buffer to display and an alist of the
4597 same form as ALIST. See `display-buffer' for details."
4600 regexp
4603 :risky t
4608 "User-specified default action for `display-buffer'.
4609 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4610 function or a list of functions. Each function should accept 2
4611 arguments: a buffer to display and an alist similar to ALIST.
4612 See `display-buffer' for details."
4613 :type display-buffer--action-custom-type
4614 :risky t
4620 display-buffer-reuse-window
4621 display-buffer--special
4622 display-buffer--maybe-pop-up-frame-or-window
4623 display-buffer-use-some-window
4624 ;; If all else fails, pop up a new frame.
4625 display-buffer-pop-up-frame))
4626 "Default fallback action for `display-buffer'.
4627 This is the action used by `display-buffer' if no other actions
4628 specified, e.g. by the user options `display-buffer-alist' or
4633 "Retrieve ALIST entry corresponding to BUFFER-NAME."
4652 display-buffer--special
4653 display-buffer-pop-up-frame)
4660 "Display BUFFER-OR-NAME in some window, without selecting it.
4661 BUFFER-OR-NAME must be a buffer or the name of an existing
4662 buffer. Return the window chosen for displaying BUFFER-OR-NAME,
4663 or nil if no such window is found.
4665 Optional argument ACTION should have the form (FUNCTION . ALIST).
4666 FUNCTION is either a function or a list of functions. Each such
4667 function is called with 2 arguments: the buffer to display and an
4668 alist. It should either display the buffer and return the
4669 window, or return nil if unable to display the buffer.
4671 The `display-buffer' function builds a function list and an alist
4672 from `display-buffer-overriding-action', `display-buffer-alist',
4673 the ACTION argument, `display-buffer-base-action', and
4674 `display-buffer-fallback-action' (in that order). Then it calls
4675 each function in the combined function list in turn, passing the
4676 buffer as the first argument and the combined alist as the second
4677 argument, until one of the functions returns non-nil.
4679 Available action functions include:
4680 `display-buffer-same-window'
4681 `display-buffer-reuse-window'
4682 `display-buffer-pop-up-frame'
4683 `display-buffer-pop-up-window'
4684 `display-buffer-use-some-window'
4686 Recognized alist entries include:
4688 `inhibit-same-window' -- A non-nil value prevents the same
4689 window from being used for display.
4691 `reusable-frames' -- Value specifies frame(s) to search for a
4692 window that already displays the buffer.
4693 See `display-buffer-reuse-window'.
4695 The ACTION argument to `display-buffer' can also have a non-nil
4696 and non-list value. This means to display the buffer in a window
4697 other than the selected one, even if it is already displayed in
4698 the selected window. If called interactively with a prefix
4699 argument, ACTION is t.
4701 Optional argument FRAME, if non-nil, acts like an additional
4702 ALIST entry (reusable-frames . FRAME), specifying the frame(s) to
4703 search for a window that is already displaying the buffer. See
4704 `display-buffer-reuse-window'."
4708 ;; Handle the old form of the first argument.
4712 ;; If `display-buffer-function' is defined, let it do the job.
4714 ;; Otherwise, use the defined actions.
4717 display-buffer-alist))
4718 ;; Extra actions from the arguments to this function:
4724 ;; Construct action function list and action alist.
4726 user-action action extra-action
4727 display-buffer-base-action
4728 display-buffer-fallback-action))
4733 actions)))
4735 window)
4741 window))))
4744 "Display buffer BUFFER in another frame.
4745 This uses the function `display-buffer' as a subroutine; see
4746 its documentation for additional customization information."
4750 ;;; `display-buffer' action functions:
4753 "Display BUFFER in the selected window.
4754 This fails if ALIST has a non-nil `inhibit-same-window' entry, or
4755 if the selected window is a minibuffer window or is dedicated to
4756 another buffer; in that case, return nil. Otherwise, return the
4757 selected window."
4765 "Conditionally display BUFFER in the selected window.
4766 If `same-window-p' returns non-nil for BUFFER's name, call
4767 `display-buffer-same-window' and return its value. Otherwise,
4768 return nil."
4773 "Return a window that is already displaying BUFFER.
4774 Return nil if no usable window is found.
4776 If ALIST has a non-nil `inhibit-same-window' entry, the selected
4777 window is not eligible for reuse.
4779 If ALIST contains a `reusable-frames' entry, its value determines
4780 which frames to search for a reusable window:
4781 nil -- the selected frame (actually the last non-minibuffer frame)
4782 A frame -- just that frame
4783 `visible' -- all visible frames
4784 0 -- all frames on the current terminal
4785 t -- all frames.
4787 If ALIST contains no `reusable-frames' entry, search just the
4788 selected frame if `display-buffer-reuse-frames' and
4789 `pop-up-frames' are both nil; search all frames on the current
4790 terminal if either of those variables is non-nil."
4795 pop-up-frames)
4804 frames))))))
4810 "Try to display BUFFER using `special-display-function'.
4811 Call `special-display-p' on BUFFER's name, and if that returns
4812 non-nil, call `special-display-function' on BUFFER."
4814 ;; `special-display-p' returns either t or a list of frame
4815 ;; parameters to pass to `special-display-function'.
4822 "Display BUFFER in a new frame.
4823 This works by calling `pop-up-frame-function'. If successful,
4824 return the window used; otherwise return nil."
4826 frame window)
4832 ;; Reset list of WINDOW's previous buffers to nil.
4834 window)))
4837 "Display BUFFER by popping up a new window.
4838 The new window is created on the selected frame, or in
4839 `last-nonminibuffer-frame' if no windows can be created there.
4840 If sucessful, return the new window; otherwise return nil."
4843 window)
4845 ;; If the selected frame cannot be split, look at
4846 ;; `last-nonminibuffer-frame'.
4851 ;; Attempt to split largest or least recently used window.
4858 ;; Reset list of WINDOW's previous buffers to nil.
4860 window)))
4863 "Try displaying BUFFER based on `pop-up-frames' or `pop-up-windows'.
4865 If `pop-up-frames' is non-nil (and not `graphic-only' on a
4866 text-only terminal), try with `display-buffer-pop-up-frame'.
4868 If that cannot be done, and `pop-up-windows' is non-nil, try
4869 again with `display-buffer-pop-up-window'."
4872 pop-up-frames)
4878 "Display BUFFER in an existing window.
4879 Search for a usable window, set that window to the buffer, and
4880 return the window. If no suitable window is found, return nil."
4883 ;; When NOT-THIS-WINDOW is non-nil, temporarily dedicate the
4884 ;; selected window to its buffer, to prevent any of the
4885 ;; `get-' routines below from choosing it. (Bug#1415)
4891 window)
4894 ;; Reuse an existing window.
4899 window))
4904 window))
4907 ;; Restore dedicated status of selected window.
4914 ;;; Display + selection commands:
4917 "Select buffer BUFFER in some window, preferably a different one.
4918 BUFFER may be a buffer, a string (a buffer name), or nil. If it
4919 is a string not naming an existent buffer, create a buffer with
4920 that name. If BUFFER is nil, choose some other buffer. Return
4921 the buffer.
4923 This uses `display-buffer' as a subroutine. The optional ACTION
4924 argument is passed to `display-buffer' as its ACTION argument.
4925 See `display-buffer' for more information. ACTION is t if called
4926 interactively with a prefix argument, which means to pop to a
4927 window other than the selected one even if the buffer is already
4928 displayed in the selected window.
4930 If the window to show BUFFER is not on the selected
4931 frame, raise that window's frame and give it input focus.
4933 Optional third arg NORECORD non-nil means do not put this buffer
4934 at the front of the list of recently selected ones."
4943 ;; If we chose another frame, make sure it gets input focus.
4946 ;; Make sure new window is selected (Bug#8615), (Bug#6954).
4948 buffer))
4951 "Select buffer BUFFER in some window, preferably the same one.
4952 This function behaves much like `switch-to-buffer', except it
4953 displays with `special-display-function' if BUFFER has a match in
4954 `special-display-buffer-names' or `special-display-regexps'.
4956 Unlike `pop-to-buffer', this function prefers using the selected
4957 window over popping up a new window or frame.
4959 BUFFER may be a buffer, a string (a buffer name), or nil. If it
4960 is a string not naming an existent buffer, create a buffer with
4961 that name. If BUFFER is nil, choose some other buffer. Return
4962 the buffer.
4964 NORECORD, if non-nil means do not put this buffer at the front of
4965 the list of recently selected ones."
4968 display-buffer-same-window)
4970 norecord))
4973 "Read the name of a buffer to switch to, prompting with PROMPT.
4974 Return the neame of the buffer as a string.
4976 This function is intended for the `switch-to-buffer' family of
4977 commands since these need to omit the name of the current buffer
4978 from the list of completions and default values."
4983 ;; Since rbts-completion-table is built dynamically, we
4984 ;; can't just add it to the default value of
4985 ;; icomplete-with-completion-tables, so we add it
4986 ;; here manually.
4991 icomplete-with-completion-tables))))
4996 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
4997 If BUFFER-OR-NAME is nil, return the buffer returned by
4998 `other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
4999 exists, return that buffer. If no such buffer exists, create a
5000 buffer with the name BUFFER-OR-NAME and return that buffer."
5005 buffer))
5009 "Switch to buffer BUFFER-OR-NAME in the selected window.
5010 If called interactively, prompt for the buffer name using the
5011 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5012 determines whether to request confirmation before creating a new
5013 buffer.
5015 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
5016 nil. If BUFFER-OR-NAME is a string that does not identify an
5017 existing buffer, create a buffer with that name. If
5018 BUFFER-OR-NAME is nil, switch to the buffer returned by
5019 `other-buffer'.
5021 Optional argument NORECORD non-nil means do not put the buffer
5022 specified by BUFFER-OR-NAME at the front of the buffer list and
5023 do not make the window displaying it the most recently selected
5024 one.
5026 If FORCE-SAME-WINDOW is non-nil, BUFFER-OR-NAME must be displayed
5027 in the selected window; signal an error if that is
5028 impossible (e.g. if the selected window is minibuffer-only). If
5029 nil, BUFFER-OR-NAME may be displayed in another window.
5031 Return the buffer switched to."
5038 ;; Don't call set-window-buffer if it's not needed since it
5039 ;; might signal an error (e.g. if the window is dedicated).
5052 "Select the buffer specified by BUFFER-OR-NAME in another window.
5053 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
5054 nil. Return the buffer switched to.
5056 If called interactively, prompt for the buffer name using the
5057 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5058 determines whether to request confirmation before creating a new
5059 buffer.
5061 If BUFFER-OR-NAME is a string and does not identify an existing
5062 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5063 nil, switch to the buffer returned by `other-buffer'.
5065 Optional second argument NORECORD non-nil means do not put this
5066 buffer at the front of the list of recently selected ones.
5068 This uses the function `display-buffer' as a subroutine; see its
5069 documentation for additional customization information."
5076 "Switch to buffer BUFFER-OR-NAME in another frame.
5077 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
5078 nil. Return the buffer switched to.
5080 If called interactively, prompt for the buffer name using the
5081 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5082 determines whether to request confirmation before creating a new
5083 buffer.
5085 If BUFFER-OR-NAME is a string and does not identify an existing
5086 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5087 nil, switch to the buffer returned by `other-buffer'.
5089 Optional second arg NORECORD non-nil means do not put this
5090 buffer at the front of the list of recently selected ones.
5092 This uses the function `display-buffer' as a subroutine; see its
5093 documentation for additional customization information."
5097 \f
5099 "Set the height in lines of the text display area of WINDOW to HEIGHT.
5100 WINDOW must be a live window. HEIGHT doesn't include the mode
5101 line or header line, if any, or any partial-height lines in the
5102 text display area.
5104 Note that the current implementation of this function cannot
5105 always set the height exactly, but attempts to be conservative,
5106 by allocating more lines than are actually needed in the case
5107 where some error may be present."
5111 ;; Setting window-min-height to a value like 1 can lead to very
5112 ;; bizarre displays because it also allows Emacs to make *other*
5113 ;; windows 1-line tall, which means that there's no more space for
5114 ;; the modeline.
5119 "Make selected window DELTA columns wider.
5120 Interactively, if no argument is given, make selected window one
5121 column wider."
5126 "Make selected window DELTA columns narrower.
5127 Interactively, if no argument is given, make selected window one
5128 column narrower."
5133 "Return the number of screen lines in the region.
5134 The number of screen lines may be different from the number of actual lines,
5135 due to line breaking, display table, etc.
5137 Optional arguments BEG and END default to `point-min' and `point-max'
5138 respectively.
5140 If region ends with a newline, ignore it unless optional third argument
5141 COUNT-FINAL-NEWLINE is non-nil.
5143 The optional fourth argument WINDOW specifies the window used for obtaining
5144 parameters such as width, horizontal scrolling, and so on. The default is
5145 to use the selected window's parameters.
5147 Like `vertical-motion', `count-screen-lines' always uses the current buffer,
5148 regardless of which buffer is displayed in WINDOW. This makes possible to use
5149 `count-screen-lines' in any buffer, whether or not it is currently displayed
5150 in some window."
5156 0
5169 "Return the height (in screen lines) of the buffer that WINDOW is displaying."
5173 ;; If buffer ends with a newline, ignore it when
5174 ;; counting height unless point is after it.
5176 window))))
5178 ;;; Resizing buffers to fit their contents exactly.
5180 "Adjust height of WINDOW to display its buffer's contents exactly.
5181 WINDOW can be any live window and defaults to the selected one.
5183 Optional argument MAX-HEIGHT specifies the maximum height of
5184 WINDOW and defaults to the height of WINDOW's frame. Optional
5185 argument MIN-HEIGHT specifies the minimum height of WINDOW and
5186 defaults to `window-min-height'. Both, MAX-HEIGHT and MIN-HEIGHT
5187 are specified in lines and include the mode line and header line,
5188 if any.
5190 Optional argument OVERRIDE non-nil means override restrictions
5191 imposed by `window-min-height' and `window-min-width' on the size
5192 of WINDOW.
5194 Return the number of lines by which WINDOW was enlarged or
5195 shrunk. If an error occurs during resizing, return nil but don't
5196 signal an error.
5198 Note that even if this function makes WINDOW large enough to show
5199 _all_ lines of its buffer you might not see the first lines when
5200 WINDOW was scrolled."
5202 ;; Do all the work in WINDOW and its buffer and restore the selected
5203 ;; window and the current buffer when we're done.
5205 ;; Can't resize a full height or fixed-size window.
5208 ;; `with-selected-window' should orderly restore the current buffer.
5210 ;; We are in WINDOW's buffer now.
5216 window-safe-min-height)))
5219 ;; Adjust MAX-HEIGHT.
5222 max-window-height
5224 ;; Make `desired-height' the height necessary to show
5225 ;; all of WINDOW's buffer, constrained by MIN-HEIGHT
5226 ;; and MAX-HEIGHT.
5231 ;; For non-minibuffers count the mode line, if any.
5233 mode-line-format)
5234 1
5236 ;; Count the header line, if any.
5238 max-height)
5239 min-height))
5248 ;; This `condition-case' shouldn't be necessary, but who knows?
5251 ;; Return zero if DELTA became zero in the proces.
5252 0
5253 ;; Don't try to redisplay with the cursor at the end on its
5254 ;; own line--that would force a scroll and spoil things.
5256 ;; It's silly to put `point' at the end of the previous
5257 ;; line and so maybe force horizontal scrolling.
5259 ;; Call `window-resize' with OVERRIDE argument equal WINDOW.
5261 ;; Check if the last line is surely fully visible. If
5262 ;; not, enlarge the window.
5266 ;; Don't include final newline.
5269 ;; If line-wrapping is turned off, test the
5270 ;; beginning of the last line for
5271 ;; visibility instead of the end, as the
5272 ;; end of the line could be invisible by
5273 ;; virtue of extending past the edge of the
5274 ;; window.
5278 ;; This loop might in some rare pathological cases raise
5279 ;; an error - another reason for the `condition-case'.
5286 delta))))
5289 "Return t if WINDOW can be shrunk without shrinking other windows.
5290 WINDOW defaults to the selected window."
5293 ;; The following doesn't satisfy the doc-string's claim when
5294 ;; window and previous-/next-window are not part of the same
5295 ;; combination but still share a common edge. Using
5296 ;; `window-iso-combined-p' instead should handle that.
5299 ;; (make-obsolete
5300 ;; 'window-safely-shrinkable-p "use `window-iso-combined-p' instead." "24.1")
5303 "Shrink height of WINDOW if its buffer doesn't need so many lines.
5304 More precisely, shrink WINDOW vertically to be as small as
5305 possible, while still showing the full contents of its buffer.
5306 WINDOW defaults to the selected window.
5308 Do not shrink WINDOW to less than `window-min-height' lines. Do
5309 nothing if the buffer contains more lines than the present window
5310 height, or if some of the window's contents are scrolled out of
5311 view, or if shrinking this window would also shrink another
5312 window, or if the window is the only window of its frame.
5314 Return non-nil if the window was shrunk, nil otherwise."
5317 ;; Make sure that WINDOW is vertically combined and `point-min' is
5318 ;; visible (for whatever reason that's needed). The remaining issues
5319 ;; should be taken care of by `fit-window-to-buffer'.
5323 \f
5325 "Kill the current buffer and delete the selected window."
5334 ;; If `delete-window' failed before, we rerun it to regenerate
5335 ;; the error so it can be seen in the echo area.
5338 ;; If the buffer is not dead for some reason (probably because
5339 ;; of a `quit' signal), remove the hook again.
5344 \f
5346 "Indicates the last recenter operation performed.
5350 "Cycling order for `recenter-top-bottom'.
5351 A list of elements with possible values `top', `middle', `bottom',
5352 integer or float numbers that define the cycling order for
5353 the command `recenter-top-bottom'.
5355 Top and bottom destinations are `scroll-margin' lines the from true
5356 window top and bottom. Middle redraws the frame and centers point
5357 vertically within the window. Integer number moves current line to
5358 the specified absolute window-line. Float number between 0.0 and 1.0
5359 means the percentage of the screen space from the top. The default
5360 cycling order is middle -> top -> bottom."
5371 "Move current buffer line to the specified window line.
5372 With no prefix argument, successive calls place point according
5373 to the cycling order defined by `recenter-positions'.
5375 A prefix argument is handled like `recenter':
5376 With numeric prefix ARG, move current line to window-line ARG.
5377 With plain `C-u', move current line to window center."
5385 recenter-positions))
5404 "Position point relative to window.
5406 With a prefix argument ARG, acts like `move-to-window-line'.
5408 With no argument, positions point at center of window.
5409 Successive calls position point at positions defined
5410 by `recenter-positions'."
5418 recenter-positions))
5435 \f
5436 ;;; Scrolling commands.
5438 ;;; Scrolling commands which does not signal errors at top/bottom
5439 ;;; of buffer at first key-press (instead moves to top/bottom
5440 ;;; of buffer).
5443 "Move point to top/bottom of buffer before signalling a scrolling error.
5444 A value of nil means just signal an error if no more scrolling possible.
5445 A value of t means point moves to the beginning or the end of the buffer
5446 \(depending on scrolling direction) when no more scrolling possible.
5447 When point is already on that position, then signal an error."
5453 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
5454 If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
5455 scroll window further, move cursor to the bottom line.
5456 When point is already on that position, then signal an error.
5457 A near full screen is `next-screen-context-lines' less than a full screen.
5458 Negative ARG means scroll downward.
5459 If ARG is the atom `-', scroll downward by nearly full screen."
5475 ;; When scrolling by ARG lines can't be done,
5476 ;; move by ARG lines instead.
5478 ;; When ARG is nil for full-screen scrolling,
5479 ;; move to the bottom of the buffer.
5485 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
5486 If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
5487 scroll window further, move cursor to the top line.
5488 When point is already on that position, then signal an error.
5489 A near full screen is `next-screen-context-lines' less than a full screen.
5490 Negative ARG means scroll upward.
5491 If ARG is the atom `-', scroll upward by nearly full screen."
5507 ;; When scrolling by ARG lines can't be done,
5508 ;; move by ARG lines instead.
5510 ;; When ARG is nil for full-screen scrolling,
5511 ;; move to the top of the buffer.
5516 ;;; Scrolling commands which scroll a line instead of full screen.
5519 "Scroll text of selected window upward ARG lines; or one line if no ARG.
5520 If ARG is omitted or nil, scroll upward by one line.
5521 This is different from `scroll-up-command' that scrolls a full screen."
5528 "Scroll text of selected window down ARG lines; or one line if no ARG.
5529 If ARG is omitted or nil, scroll down by one line.
5530 This is different from `scroll-down-command' that scrolls a full screen."
5536 \f
5539 For more details, see the documentation for `scroll-other-window'."
5542 ;; Just invert the argument's meaning.
5543 ;; We can do that without knowing which window it will be.
5549 "Move point to the beginning of the buffer in the other window.
5550 Leave mark at previous position.
5551 With arg N, put point N/10 of the way from the true beginning."
5555 ;; We use unwind-protect rather than save-window-excursion
5556 ;; because the latter would preserve the things we want to change.
5560 ;; Set point and mark in that window's buffer.
5563 ;; Set point accordingly.
5568 "Move point to the end of the buffer in the other window.
5569 Leave mark at previous position.
5570 With arg N, put point N/10 of the way from the true end."
5572 ;; See beginning-of-buffer-other-window for comments.
5582 \f
5593 "When non-nil, special state of delayed window autoselection.
5594 Possible values are `suspend' \(suspend autoselection after a menu or
5595 scrollbar interaction\) and `select' \(the next invocation of
5599 "Cancel delayed window autoselection.
5600 Optional argument FORCE means cancel unconditionally."
5602 ;; Don't cancel for select-window or select-frame events
5603 ;; or when the user drags a scroll bar.
5615 "Start delayed window autoselection.
5616 MOUSE-POSITION is the last position where the mouse was seen as returned
5617 by `mouse-position'. Optional argument WINDOW non-nil denotes the
5618 window where the mouse was seen. Optional argument SUSPEND non-nil
5619 means suspend autoselection."
5620 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
5624 ;; Install timer which runs `mouse-autoselect-window-select' after
5625 ;; `mouse-autoselect-window' seconds.
5631 "Select window with delayed window autoselection.
5632 If the mouse position has stabilized in a non-selected window, select
5633 that window. The minibuffer window is selected only if the minibuffer is
5634 active. This function is run by `mouse-autoselect-window-timer'."
5645 ;; A menu / popup dialog is active or the mouse is on the scroll-bar
5646 ;; of WINDOW, temporarily suspend delayed autoselection.
5649 ;; Delayed autoselection was temporarily suspended, reenable it.
5654 ;; If `mouse-autoselect-window' is positive, select
5655 ;; window if the window is the same as before.
5657 ;; Otherwise select window if the mouse is at the same
5658 ;; position as before. Observe that the first test after
5659 ;; starting autoselection usually fails since the value of
5660 ;; `mouse-autoselect-window-position' recorded there is the
5661 ;; position where the mouse has entered the new window and
5662 ;; not necessarily where the mouse has stopped moving.
5664 ;; The minibuffer is a candidate window if it's active.
5667 ;; Mouse position has stabilized in non-selected window: Cancel
5668 ;; delayed autoselection and try to select that window.
5670 ;; Select window where mouse appears unless the selected window is the
5671 ;; minibuffer. Use `unread-command-events' in order to execute pre-
5672 ;; and post-command hooks and trigger idle timers. To avoid delaying
5673 ;; autoselection again, set `mouse-autoselect-window-state'."
5678 unread-command-events))))
5682 ;; Mouse position has either stabilized in the selected window or at
5683 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
5686 ;; Mouse position has not stabilized yet, resume delayed
5687 ;; autoselection.
5691 "Handle select-window events."
5695 ;; Don't switch if we're currently in the minibuffer.
5696 ;; This tries to work around problems where the
5697 ;; minibuffer gets unselected unexpectedly, and where
5698 ;; you then have to move your mouse all the way down to
5699 ;; the minibuffer to select it.
5701 ;; Don't switch to minibuffer window unless it's active.
5704 ;; Don't switch when autoselection shall be delayed.
5709 ;; Cancel any delayed autoselection.
5711 ;; Start delayed autoselection from current mouse
5712 ;; position and window.
5714 ;; Executing a command cancels delayed autoselection.
5718 ;; Reset state of delayed autoselection.
5720 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
5725 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
5726 WINDOW defaults to the selected window.
5727 Return nil if WINDOW is not a partial-width window
5728 (regardless of the value of `truncate-lines').
5729 Otherwise, consult the value of `truncate-partial-width-windows'
5730 for the buffer shown in WINDOW."
5738 t-p-w-w))))
5739 \f
5740 ;; Some of these are in tutorial--default-keys, so update that if you
5741 ;; change these.
5754 ;;; window.el ends here