| blob | edd8a113876b5ccb293951a2ff17af387baa9d6f |
1 ;;; window.el --- GNU Emacs window commands aside from those written in C
3 ;; Copyright (C) 1985, 1989, 1992-1994, 2000-2012
4 ;; Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: internal
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; Window tree functions.
29 ;;; Code:
34 "Execute BODY, then select the previously selected window.
35 The value returned is the value of the last form in BODY.
37 This macro saves and restores the selected window, as well as the
38 selected window in each frame. If the previously selected window
39 is no longer live, then whatever window is selected at the end of
40 BODY remains selected. If the previously selected window of some
41 frame is no longer live at the end of BODY, that frame's selected
42 window is left alone.
44 This macro saves and restores the current buffer, since otherwise
45 its normal operation could make a different buffer current. The
46 order of recently selected windows and the buffer list ordering
47 are not altered by this macro (unless they are altered in BODY)."
50 ;; It is necessary to save all of these, because calling
51 ;; select-window changes frame-selected-window for whatever
52 ;; frame that window is in.
66 ;; The following two functions are like `window-next-sibling' and
67 ;; `window-prev-sibling' but the WINDOW argument is _not_ optional (so
68 ;; they don't substitute the selected window for nil), and they return
69 ;; nil when WINDOW doesn't have a parent (like a frame's root window or
70 ;; a minibuffer window).
72 "Return WINDOW's right sibling.
73 Return nil if WINDOW is the root window of its frame. WINDOW can
74 be any window."
78 "Return WINDOW's left sibling.
79 Return nil if WINDOW is the root window of its frame. WINDOW can
80 be any window."
84 "Return WINDOW's first child window."
88 "Return number of WINDOW's child windows."
94 count))
97 "Return last child window of WINDOW."
101 window)
104 "Return t if OBJECT denotes a live window or internal window.
105 Otherwise, return nil; this includes the case where OBJECT is a
106 deleted window."
109 t))
112 "Return buffer specified by BUFFER-OR-NAME.
113 BUFFER-OR-NAME must be either a buffer or a string naming a live
114 buffer and defaults to the current buffer."
120 buffer-or-name
127 "Return frame specified by FRAME.
128 FRAME must be a live frame and defaults to the selected frame."
131 frame
136 "Return window specified by WINDOW.
137 If WINDOW is nil, return `selected-window'.
138 If WINDOW is a live window or internal window, return WINDOW;
139 if LIVE-ONLY is non-nil, return WINDOW for a live window only.
140 Otherwise, signal an error."
145 window
148 window
152 "If non-nil, standard functions ignore window parameters.
153 The functions currently affected by this are `split-window',
154 `delete-window', `delete-other-windows' and `other-window'.
156 An application may bind this to a non-nil value around calls to
160 "The absolute minimum number of lines of a window.
164 "The minimum number of lines of any window.
165 The value has to accommodate a mode- or header-line if present.
166 A value less than `window-safe-min-height' is ignored. The value
167 of this variable is honored when windows are resized or split.
169 Applications should never rebind this variable. To resize a
170 window to a height less than the one specified here, an
171 application should instead call `window-resize' with a non-nil
172 IGNORE argument. In order to have `split-window' make a window
173 shorter, explicitly specify the SIZE argument of that function."
179 "The absolute minimum number of columns of a window.
183 "The minimum number of columns of any window.
184 The value has to accommodate margins, fringes, or scrollbars if
185 present. A value less than `window-safe-min-width' is ignored.
186 The value of this variable is honored when windows are resized or
187 split.
189 Applications should never rebind this variable. To resize a
190 window to a width less than the one specified here, an
191 application should instead call `window-resize' with a non-nil
192 IGNORE argument. In order to have `split-window' make a window
193 narrower, explicitly specify the SIZE argument of that function."
199 "Return non-nil if WINDOW has siblings in a given direction.
200 If WINDOW is omitted or nil, it defaults to the selected window.
202 HORIZONTAL determines a direction for the window combination.
203 If HORIZONTAL is omitted or nil, return non-nil if WINDOW is part
204 of a vertical window combination.
205 If HORIZONTAL is non-nil, return non-nil if WINDOW is part of a
206 horizontal window combination."
215 "Return largest number of windows vertically arranged within WINDOW.
216 If WINDOW is omitted or nil, it defaults to the selected window.
217 If HORIZONTAL is non-nil, return the largest number of
218 windows horizontally arranged within WINDOW."
222 ;; If WINDOW is live, return 1.
227 ;; If WINDOW is iso-combined, return the sum of the values for all
228 ;; child windows of WINDOW.
234 count))
236 count))
238 ;; If WINDOW is not iso-combined, return the maximum value of any
239 ;; child window of WINDOW.
245 count))
247 count))))
250 "Helper function for `walk-window-tree' and `walk-window-subtree'."
268 "Run function FUN on each live window of FRAME.
269 FUN must be a function with one argument - a window. FRAME must
270 be a live frame and defaults to the selected one. ANY, if
271 non-nil means to run FUN on all live and internal windows of
272 FRAME.
274 This function performs a pre-order, depth-first traversal of the
275 window tree. If FUN changes the window tree, the result is
276 unpredictable."
282 "Run function FUN on the subtree of windows rooted at WINDOW.
283 WINDOW defaults to the selected window. FUN must be a function
284 with one argument - a window. By default, run FUN only on live
285 windows of the subtree. If the optional argument ANY is non-nil,
286 run FUN on all live and internal windows of the subtree. If
287 WINDOW is live, run FUN on WINDOW only.
289 This function performs a pre-order, depth-first traversal of the
290 subtree rooted at WINDOW. If FUN changes that tree, the result
291 is unpredictable."
296 "Return first window on FRAME with PARAMETER non-nil.
297 FRAME defaults to the selected frame. Optional argument VALUE
298 non-nil means only return a window whose window-parameter value
299 for PARAMETER equals VALUE (comparison is done with `equal').
300 Optional argument ANY non-nil means consider internal windows
301 too."
309 frame any))))
311 ;;; Atomic windows.
313 "Return root of atomic window WINDOW is a part of.
314 WINDOW can be any window and defaults to the selected one.
315 Return nil if WINDOW is not part of an atomic window."
321 root))
324 "Make WINDOW an atomic window.
325 WINDOW must be an internal window. Return WINDOW."
331 window t)
332 window))
335 "Subroutine of `window--atom-check'."
345 window t))
346 ;; count >= 1 must hold here. If there's no other
347 ;; window around dissolve this atomic window.
349 ;; Dissolve atomic window.
353 window t)))
354 ;; Check children.
358 ;; Check right sibling
362 "Check atomicity of all windows on FRAME.
363 FRAME defaults to the selected frame. If an atomic window is
364 wrongly configured, reset the atomicity of all its windows on
365 FRAME to nil. An atomic window is wrongly configured if it has
366 no child windows or one of its child windows is not atomic."
369 ;; Side windows.
374 "If non-nil, left and right side windows are full height.
375 Otherwise, top and bottom side windows are full width."
381 "Maximum number of side window slots.
382 The value is a list of four elements specifying the number of
383 side window slots on (in this order) the left, top, right and
384 bottom side of each frame. If an element is a number, this means
385 to display at most that many side windows on the corresponding
386 side. If an element is nil, this means there's no bound on the
387 number of slots on that side."
389 :risky t
390 :type
396 :value nil
403 :value nil
410 :value nil
417 :value nil
424 "Check the window-side parameter of all windows on FRAME.
425 FRAME defaults to the selected frame. If the configuration is
426 invalid, reset all window-side parameters to nil.
428 A valid configuration has to preserve the following invariant:
430 - If a window has a non-nil window-side parameter, it must have a
431 parent window and the parent window's window-side parameter
432 must be either nil or the same as for window.
434 - If windows with non-nil window-side parameters exist, there
435 must be at most one window of each side and non-side with a
436 parent whose window-side parameter is nil and there must be no
437 leaf window whose window-side parameter is nil."
439 side parent parent-side)
447 ;; The following `cond' seems a bit tedious, but I'd
448 ;; rather stick to using just the stack.
452 ;; A parent whose window-side is non-nil must
453 ;; have a child with the same window-side.
455 ;; Now check that there's more than one main window
456 ;; for any of none, left, top, right and bottom.
478 ;; A leaf window without window-side parameter,
479 ;; record its existence.
481 frame t))
483 ;; At least one non-side window exists, so there must
484 ;; be at least one side-window and no normal window.
486 ;; No non-side window exists, so there must be no side
487 ;; window either.
492 frame t))))
495 "Check atomic and side windows on FRAME.
496 FRAME defaults to the selected frame."
500 ;;; Window sizes.
502 "Non-nil in a buffer means windows displaying the buffer are fixed-size.
503 If the value is `height', then only the window's height is fixed.
504 If the value is `width', then only the window's width is fixed.
505 Any other non-nil value fixes both the width and the height.
507 Emacs won't change the size of any window displaying that buffer,
508 unless it has no other choice (like when deleting a neighboring
513 "Return non-nil if IGNORE says to ignore size restrictions for WINDOW."
517 "Return the minimum number of lines of WINDOW.
518 WINDOW can be an arbitrary window and defaults to the selected
519 one. Optional argument HORIZONTAL non-nil means return the
520 minimum number of columns of WINDOW.
522 Optional argument IGNORE non-nil means ignore any restrictions
523 imposed by fixed size windows, `window-min-height' or
524 `window-min-width' settings. IGNORE equal `safe' means live
525 windows may get as small as `window-safe-min-height' lines and
526 `window-safe-min-width' columns. IGNORE a window means ignore
527 restrictions for that window only."
532 "Internal function of `window-min-size'."
536 ;; WINDOW is an internal window.
538 ;; The minimum size of an iso-combination is the sum of
539 ;; the minimum sizes of its child windows.
544 ;; The minimum size of an ortho-combination is the maximum of
545 ;; the minimum sizes of its child windows.
550 value)
555 ;; The minimum size of a fixed size window is its size.
558 ;; If IGNORE equals `safe' or WINDOW return the safe values.
561 ;; For the minimum width of a window take fringes and
562 ;; scroll-bars into account. This is questionable and should
563 ;; be removed as soon as we are able to split (and resize)
564 ;; windows such that the new (or resized) windows can get a
565 ;; size less than the user-specified `window-min-height' and
566 ;; `window-min-width'.
571 (+ window-safe-min-width
584 window-min-width
587 ;; For the minimum height of a window take any mode- or
588 ;; header-line into account.
594 window-min-height
598 "Return DELTA if DELTA lines can be added to WINDOW.
599 Optional argument HORIZONTAL non-nil means return DELTA if DELTA
600 columns can be added to WINDOW. A return value of zero means
601 that no lines (or columns) can be added to WINDOW.
603 This function looks only at WINDOW and, recursively, its child
604 windows. The function `window-resizable' looks at other windows
605 as well.
607 DELTA positive means WINDOW shall be enlarged by DELTA lines or
608 columns. If WINDOW cannot be enlarged by DELTA lines or columns
609 return the maximum value in the range 0..DELTA by which WINDOW
610 can be enlarged.
612 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
613 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
614 return the minimum value in the range DELTA..0 by which WINDOW
615 can be shrunk.
617 Optional argument IGNORE non-nil means ignore any restrictions
618 imposed by fixed size windows, `window-min-height' or
619 `window-min-width' settings. IGNORE equal `safe' means live
620 windows may get as small as `window-safe-min-height' lines and
621 `window-safe-min-width' columns. IGNORE any window means ignore
622 restrictions for that window only."
628 delta))
630 delta)
633 0
634 delta))
638 "Return t if WINDOW can be resized by DELTA lines.
639 For the meaning of the arguments of this function see the
640 doc-string of `window-sizable'."
647 "Internal function for `window-size-fixed-p'."
651 ;; WINDOW is an internal window.
653 ;; An iso-combination is fixed size if all its child
654 ;; windows are fixed-size.
658 ;; We found a non-fixed-size child window, so
659 ;; WINDOW's size is not fixed.
662 ;; All child windows are fixed-size, so WINDOW's size is
663 ;; fixed.
665 ;; An ortho-combination is fixed-size if at least one of its
666 ;; child windows is fixed-size.
669 ;; We found a fixed-size child window, so WINDOW's size
670 ;; is fixed.
673 ;; WINDOW is a live window.
680 "Return non-nil if WINDOW's height is fixed.
681 WINDOW can be an arbitrary window and defaults to the selected
682 window. Optional argument HORIZONTAL non-nil means return
683 non-nil if WINDOW's width is fixed.
685 If this function returns nil, this does not necessarily mean that
686 WINDOW can be resized in the desired direction. The function
687 `window-resizable' can tell that."
692 "Internal function for `window-min-delta'."
694 ;; If we can't go up, return zero.
695 0
696 ;; Else try to find a non-fixed-size sibling of WINDOW.
701 ;; In an iso-combination throw DELTA if we find at least one
702 ;; child window and that window is either not fixed-size or
703 ;; we can ignore fixed-sizeness.
713 ;; We found a non-fixed-size child window.
716 ;; In an ortho-combination set DELTA to the minimum value by
717 ;; which other child windows can shrink.
726 delta
730 "Return number of lines by which WINDOW can be shrunk.
731 WINDOW can be an arbitrary window and defaults to the selected
732 window. Return zero if WINDOW cannot be shrunk.
734 Optional argument HORIZONTAL non-nil means return number of
735 columns by which WINDOW can be shrunk.
737 Optional argument IGNORE non-nil means ignore any restrictions
738 imposed by fixed size windows, `window-min-height' or
739 `window-min-width' settings. IGNORE a window means ignore
740 restrictions for that window only. IGNORE equal `safe' means
741 live windows may get as small as `window-safe-min-height' lines
742 and `window-safe-min-width' columns.
744 Optional argument TRAIL `before' means only windows to the left
745 of or above WINDOW can be enlarged. Optional argument TRAIL
746 `after' means only windows to the right of or below WINDOW can be
747 enlarged.
749 Optional argument NOUP non-nil means don't go up in the window
750 tree but try to enlarge windows within WINDOW's combination only.
752 Optional argument NODOWN non-nil means don't check whether WINDOW
753 itself (and its child windows) can be shrunk; check only whether
754 at least one other window can be enlarged appropriately."
760 ;; If NODOWN is t, try to recover the entire size of WINDOW.
763 ;; If NODOWN is nil and WINDOW's size is already at its minimum,
764 ;; there's nothing to recover.
767 ;; Otherwise, try to recover whatever WINDOW is larger than its
768 ;; minimum size.
773 "Internal function of `window-max-delta'."
775 ;; Can't go up. Return DELTA.
776 delta
781 ;; For an iso-combination calculate how much we can get from
782 ;; other child windows.
791 (+ delta
795 ;; For an ortho-combination throw DELTA when at least one
796 ;; child window is fixed-size.
804 ;; When NOUP is nil, DELTA is all we can get.
805 delta
806 ;; Else try with parent of WINDOW, passing the DELTA we
807 ;; recovered so far.
811 "Return maximum number of lines WINDOW by which WINDOW can be enlarged.
812 WINDOW can be an arbitrary window and defaults to the selected
813 window. The return value is zero if WINDOW cannot be enlarged.
815 Optional argument HORIZONTAL non-nil means return maximum number
816 of columns by which WINDOW can be enlarged.
818 Optional argument IGNORE non-nil means ignore any restrictions
819 imposed by fixed size windows, `window-min-height' or
820 `window-min-width' settings. IGNORE a window means ignore
821 restrictions for that window only. IGNORE equal `safe' means
822 live windows may get as small as `window-safe-min-height' lines
823 and `window-safe-min-width' columns.
825 Optional argument TRAIL `before' means only windows to the left
826 of or below WINDOW can be shrunk. Optional argument TRAIL
827 `after' means only windows to the right of or above WINDOW can be
828 shrunk.
830 Optional argument NOUP non-nil means don't go up in the window
831 tree but try to obtain the entire space from windows within
832 WINDOW's combination.
834 Optional argument NODOWN non-nil means do not check whether
835 WINDOW itself (and its child windows) can be enlarged; check
836 only whether other windows can be shrunk appropriately."
840 ;; With IGNORE and NOWDON nil return zero if WINDOW has fixed
841 ;; size.
842 0
843 ;; WINDOW has no fixed size.
846 ;; Make NOUP also inhibit the min-size check.
848 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
849 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
850 can be resized horizontally by DELTA columns. A return value of
851 zero means that WINDOW is not resizable.
853 DELTA positive means WINDOW shall be enlarged by DELTA lines or
854 columns. If WINDOW cannot be enlarged by DELTA lines or columns,
855 return the maximum value in the range 0..DELTA by which WINDOW
856 can be enlarged.
858 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
859 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
860 return the minimum value in the range DELTA..0 that can be used
861 for shrinking WINDOW.
863 Optional argument IGNORE non-nil means ignore any restrictions
864 imposed by fixed size windows, `window-min-height' or
865 `window-min-width' settings. IGNORE a window means ignore
866 restrictions for that window only. IGNORE equal `safe' means
867 live windows may get as small as `window-safe-min-height' lines
868 and `window-safe-min-width' columns.
870 Optional argument TRAIL `before' means only windows to the left
871 of or below WINDOW can be shrunk. Optional argument TRAIL
872 `after' means only windows to the right of or above WINDOW can be
873 shrunk.
875 Optional argument NOUP non-nil means don't go up in the window
876 tree but check only whether space can be obtained from (or given
877 to) WINDOW's siblings.
879 Optional argument NODOWN non-nil means don't go down in the
880 window tree. This means do not check whether resizing would
881 violate size restrictions of WINDOW or its child windows."
886 delta))
889 delta))
893 "Return t if WINDOW can be resized vertically by DELTA lines.
894 For the meaning of the arguments of this function see the
895 doc-string of `window--resizable'."
899 delta)
901 delta)))
904 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
905 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
906 can be resized horizontally by DELTA columns. A return value of
907 zero means that WINDOW is not resizable.
909 DELTA positive means WINDOW shall be enlarged by DELTA lines or
910 columns. If WINDOW cannot be enlarged by DELTA lines or columns
911 return the maximum value in the range 0..DELTA by which WINDOW
912 can be enlarged.
914 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
915 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
916 return the minimum value in the range DELTA..0 that can be used
917 for shrinking WINDOW.
919 Optional argument IGNORE non-nil means ignore any restrictions
920 imposed by fixed size windows, `window-min-height' or
921 `window-min-width' settings. IGNORE a window means ignore
922 restrictions for that window only. IGNORE equal `safe' means
923 live windows may get as small as `window-safe-min-height' lines
924 and `window-safe-min-width' columns."
929 "Return the total height or width of window WINDOW.
930 If WINDOW is omitted or nil, it defaults to the selected window.
932 If HORIZONTAL is omitted or nil, return the total height of
933 WINDOW, in lines, like `window-total-height'. Otherwise return
934 the total width, in columns, like `window-total-width'."
939 ;; Eventually we should make `window-height' obsolete.
942 ;; See discussion in bug#4543.
944 "Return t if WINDOW is as high as the containing frame.
945 More precisely, return t if and only if the total height of
946 WINDOW equals the total height of the root window of WINDOW's
947 frame. WINDOW can be any window and defaults to the selected
948 one."
954 "Return t if WINDOW is as wide as the containing frame.
955 More precisely, return t if and only if the total width of WINDOW
956 equals the total width of the root window of WINDOW's frame.
957 WINDOW can be any window and defaults to the selected one."
963 "Return the height or width of WINDOW's text area.
964 If WINDOW is omitted or nil, it defaults to the selected window.
965 Signal an error if the window is not live.
967 If HORIZONTAL is omitted or nil, return the height of the text
968 area, like `window-body-height'. Otherwise, return the width of
969 the text area, like `window-body-width'."
974 ;; Eventually we should make `window-height' obsolete.
978 "Return the current scroll bar settings for WINDOW.
979 WINDOW must be a live window and defaults to the selected one.
981 The return value is a cons cell (VERTICAL . HORIZONTAL) where
982 VERTICAL specifies the current location of the vertical scroll
983 bars (`left', `right', or nil), and HORIZONTAL specifies the
984 current location of the horizontal scroll bars (`top', `bottom',
985 or nil).
987 Unlike `window-scroll-bars', this function reports the scroll bar
988 type actually used, once frame defaults and `scroll-bar-mode' are
989 taken into account."
1002 "Cycle through all live windows, calling FUN for each one.
1003 FUN must specify a function with a window as its sole argument.
1004 The optional arguments MINIBUF and ALL-FRAMES specify the set of
1005 windows to include in the walk.
1007 MINIBUF t means include the minibuffer window even if the
1008 minibuffer is not active. MINIBUF nil or omitted means include
1009 the minibuffer window only if the minibuffer is active. Any
1010 other value means do not include the minibuffer window even if
1011 the minibuffer is active.
1013 ALL-FRAMES nil or omitted means consider all windows on the
1014 selected frame, plus the minibuffer window if specified by the
1015 MINIBUF argument. If the minibuffer counts, consider all windows
1016 on all frames that share that minibuffer too. The following
1017 non-nil values of ALL-FRAMES have special meanings:
1019 - t means consider all windows on all existing frames.
1021 - `visible' means consider all windows on all visible frames on
1022 the current terminal.
1024 - 0 (the number zero) means consider all windows on all visible
1025 and iconified frames on the current terminal.
1027 - A frame means consider all windows on that frame only.
1029 Anything else means consider all windows on the selected frame
1030 and no others.
1032 This function changes neither the order of recently selected
1033 windows nor the buffer list."
1034 ;; If we start from the minibuffer window, don't fail to come
1035 ;; back to it.
1038 ;; Make sure to not mess up the order of recently selected
1039 ;; windows. Use `save-selected-window' and `select-window'
1040 ;; with second argument non-nil for this purpose.
1048 "Return value of WINDOW's point.
1049 WINDOW can be any live window and defaults to the selected one.
1051 This function is like `window-point' with one exception: If
1052 WINDOW is selected, it returns the value of `point' of WINDOW's
1053 buffer regardless of whether that buffer is current or not."
1061 "Set value of WINDOW's point to POS.
1062 WINDOW can be any live window and defaults to the selected one.
1064 This function is like `set-window-point' with one exception: If
1065 WINDOW is selected, it moves `point' of WINDOW's buffer to POS
1066 regardless of whether that buffer is current or not."
1074 "Return t if WINDOW is at SIDE of its containing frame.
1075 WINDOW can be any window and defaults to the selected one. SIDE
1076 can be any of the symbols `left', `top', `right' or `bottom'.
1077 The default value nil is handled like `bottom'."
1089 "Return list of all windows on SIDE of FRAME.
1090 FRAME must be a live frame and defaults to the selected frame.
1091 SIDE can be any of the symbols `left', `top', `right' or
1092 `bottom'. The default value nil is handled like `bottom'."
1099 frame)
1103 "Support function for `window-in-direction'."
1115 "Return window in DIRECTION as seen from WINDOW.
1116 DIRECTION must be one of `above', `below', `left' or `right'.
1117 WINDOW must be a live window and defaults to the selected one.
1118 IGNORE, when non-nil means a window can be returned even if its
1119 `no-other-window' parameter is non-nil."
1132 ;; The column / row value of `posn-at-point' can be nil for the
1133 ;; mini-window, guard against that.
1144 best best-2 best-diff-2-new)
1151 ;; Ignore ourselves.
1153 ;; Ignore W unless IGNORE is non-nil.
1159 ;; W is to the left or right of WINDOW and covers POSN.
1169 ;; W is to the left or right of WINDOW but does not
1170 ;; cover POSN.
1185 ;; W is above or below WINDOW and covers POSN.
1195 ;; W is above or below WINDOW but does not cover POSN.
1210 "Return a live window satisfying PREDICATE.
1211 More precisely, cycle through all windows calling the function
1212 PREDICATE on each one of them with the window as its sole
1213 argument. Return the first window for which PREDICATE returns
1214 non-nil. Windows are scanned starting with the window following
1215 the selected window. If no window satisfies PREDICATE, return
1216 DEFAULT.
1218 MINIBUF t means include the minibuffer window even if the
1219 minibuffer is not active. MINIBUF nil or omitted means include
1220 the minibuffer window only if the minibuffer is active. Any
1221 other value means do not include the minibuffer window even if
1222 the minibuffer is active.
1224 ALL-FRAMES nil or omitted means consider all windows on the selected
1225 frame, plus the minibuffer window if specified by the MINIBUF
1226 argument. If the minibuffer counts, consider all windows on all
1227 frames that share that minibuffer too. The following non-nil
1228 values of ALL-FRAMES have special meanings:
1230 - t means consider all windows on all existing frames.
1232 - `visible' means consider all windows on all visible frames on
1233 the current terminal.
1235 - 0 (the number zero) means consider all windows on all visible
1236 and iconified frames on the current terminal.
1238 - A frame means consider all windows on that frame only.
1240 Anything else means consider all windows on the selected frame
1241 and no others."
1245 minibuf all-frames))
1248 default))
1253 "Return the least recently used window on frames specified by ALL-FRAMES.
1254 Return a full-width window if possible. A minibuffer window is
1255 never a candidate. A dedicated window is never a candidate
1256 unless DEDICATED is non-nil, so if all windows are dedicated, the
1257 value is nil. Avoid returning the selected window if possible.
1259 The following non-nil values of the optional argument ALL-FRAMES
1260 have special meanings:
1262 - t means consider all windows on all existing frames.
1264 - `visible' means consider all windows on all visible frames on
1265 the current terminal.
1267 - 0 (the number zero) means consider all windows on all visible
1268 and iconified frames on the current terminal.
1270 - A frame means consider all windows on that frame only.
1272 Any other value of ALL-FRAMES means consider all windows on the
1273 selected frame and no others."
1289 "Return the most recently used window on frames specified by ALL-FRAMES.
1290 Do not return a minibuffer window.
1292 The following non-nil values of the optional argument ALL-FRAMES
1293 have special meanings:
1295 - t means consider all windows on all existing frames.
1297 - `visible' means consider all windows on all visible frames on
1298 the current terminal.
1300 - 0 (the number zero) means consider all windows on all visible
1301 and iconified frames on the current terminal.
1303 - A frame means consider all windows on that frame only.
1305 Any other value of ALL-FRAMES means consider all windows on the
1306 selected frame and no others."
1313 best-window))
1316 "Return the largest window on frames specified by ALL-FRAMES.
1317 A minibuffer window is never a candidate. A dedicated window is
1318 never a candidate unless DEDICATED is non-nil, so if all windows
1319 are dedicated, the value is nil.
1321 The following non-nil values of the optional argument ALL-FRAMES
1322 have special meanings:
1324 - t means consider all windows on all existing frames.
1326 - `visible' means consider all windows on all visible frames on
1327 the current terminal.
1329 - 0 (the number zero) means consider all windows on all visible
1330 and iconified frames on the current terminal.
1332 - A frame means consider all windows on that frame only.
1334 Any other value of ALL-FRAMES means consider all windows on the
1335 selected frame and no others."
1337 best-window size)
1345 best-window))
1348 "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
1349 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
1350 and defaults to the current buffer. Windows are scanned starting
1351 with the selected window.
1353 MINIBUF t means include the minibuffer window even if the
1354 minibuffer is not active. MINIBUF nil or omitted means include
1355 the minibuffer window only if the minibuffer is active. Any
1356 other value means do not include the minibuffer window even if
1357 the minibuffer is active.
1359 ALL-FRAMES nil or omitted means consider all windows on the
1360 selected frame, plus the minibuffer window if specified by the
1361 MINIBUF argument. If the minibuffer counts, consider all windows
1362 on all frames that share that minibuffer too. The following
1363 non-nil values of ALL-FRAMES have special meanings:
1365 - t means consider all windows on all existing frames.
1367 - `visible' means consider all windows on all visible frames on
1368 the current terminal.
1370 - 0 (the number zero) means consider all windows on all visible
1371 and iconified frames on the current terminal.
1373 - A frame means consider all windows on that frame only.
1375 Anything else means consider all windows on the selected frame
1376 and no others."
1378 windows)
1385 "Return t if WINDOW is the currently active minibuffer window."
1389 "Return the number of live windows on the selected frame.
1390 The optional argument MINIBUF specifies whether the minibuffer
1391 window shall be counted. See `walk-windows' for the precise
1392 meaning of this argument."
1394 \f
1395 ;;; Resizing windows.
1397 "Reset resize values for all windows on FRAME.
1398 FRAME defaults to the selected frame.
1400 This function stores the current value of `window-total-size' applied
1401 with argument HORIZONTAL in the new total size of all windows on
1402 FRAME. It also resets the new normal size of each of these
1403 windows."
1408 "Internal function of `window--resize-reset'."
1409 ;; Register old size in the new total size.
1411 ;; Reset new normal size.
1418 ;; The following routine is used to manually resize the minibuffer
1419 ;; window and is currently used, for example, by ispell.el.
1421 "Resize minibuffer window WINDOW by DELTA lines.
1422 If WINDOW cannot be resized by DELTA lines make it as large (or
1423 as small) as possible but don't signal an error."
1431 ;; Sanitize DELTA.
1438 ;; Resize now.
1440 ;; Ideally we should be able to resize just the last child of root
1441 ;; here. See the comment in `resize-root-window-vertically' for
1442 ;; why we do not do that.
1445 ;; The following routine catches the case where we want to resize
1446 ;; a minibuffer-only frame.
1450 "Resize WINDOW vertically by DELTA lines.
1451 WINDOW can be an arbitrary window and defaults to the selected
1452 one. An attempt to resize the root window of a frame will raise
1453 an error though.
1455 DELTA a positive number means WINDOW shall be enlarged by DELTA
1456 lines. DELTA negative means WINDOW shall be shrunk by -DELTA
1457 lines.
1459 Optional argument HORIZONTAL non-nil means resize WINDOW
1460 horizontally by DELTA columns. In this case a positive DELTA
1461 means enlarge WINDOW by DELTA columns. DELTA negative means
1462 WINDOW shall be shrunk by -DELTA columns.
1464 Optional argument IGNORE non-nil means ignore any restrictions
1465 imposed by fixed size windows, `window-min-height' or
1466 `window-min-width' settings. IGNORE any window means ignore
1467 restrictions for that window only. IGNORE equal `safe' means
1468 live windows may get as small as `window-safe-min-height' lines
1469 and `window-safe-min-width' columns.
1471 This function resizes other windows proportionally and never
1472 deletes any windows. If you want to move only the low (right)
1473 edge of WINDOW consider using `adjust-window-trailing-edge'
1474 instead."
1477 sibling)
1490 ;; If window-combination-resize is nil, WINDOW is part of an
1491 ;; iso-combination, and WINDOW's neighboring right or left
1492 ;; sibling can be resized as requested, resize that sibling.
1499 normal-delta))
1502 normal-delta)))
1503 ;; Otherwise, resize all other windows in the same combination.
1510 "Return non-nil if WINDOW shall be skipped by resizing routines."
1513 (defun window--resize-child-windows-normal (parent horizontal window this-delta &optional trail other-delta)
1514 "Recursively set new normal height of child windows of window PARENT.
1515 HORIZONTAL non-nil means set the new normal width of these
1516 windows. WINDOW specifies a child window of PARENT that has been
1517 resized by THIS-DELTA lines (columns).
1519 Optional argument TRAIL either 'before or 'after means set values
1520 for windows before or after WINDOW only. Optional argument
1521 OTHER-DELTA a number specifies that this many lines (columns)
1522 have been obtained from (or returned to) an ancestor window of
1523 PARENT in order to resize WINDOW."
1527 ;; When WINDOW gets deleted and we can return its entire
1528 ;; space to its siblings, use WINDOW's normal size as the
1529 ;; normal delta.
1531 ;; In any other case calculate the normal delta from the
1532 ;; relation of THIS-DELTA to the total size of PARENT.
1538 ;; Set parent-normal to the sum of the normal sizes of all child
1539 ;; windows of PARENT that shall be resized, excluding only WINDOW
1540 ;; and any windows specified by the optional TRAIL argument.
1551 ;; Set the new normal size of all child windows of PARENT from what
1552 ;; they should have contributed for recovering THIS-DELTA lines
1553 ;; (columns).
1567 delta-normal))
1568 ;; Don't drop below 0.
1573 ;; Set the new normal size of windows from what they should have
1574 ;; contributed for recovering OTHER-DELTA lines (columns).
1577 other-delta)))
1589 ;; Don't drop below 0.
1593 ;; Set the new normal size of WINDOW to what is left by the sum of
1594 ;; the normal sizes of its siblings.
1596 window
1607 ;; Don't get larger than 1 or smaller than 0.
1610 (defun window--resize-child-windows (parent delta &optional horizontal window ignore trail edge)
1611 "Resize child windows of window PARENT vertically by DELTA lines.
1612 PARENT must be a vertically combined internal window.
1614 Optional argument HORIZONTAL non-nil means resize child windows of
1615 PARENT horizontally by DELTA columns. In this case PARENT must
1616 be a horizontally combined internal window.
1618 WINDOW, if specified, must denote a child window of PARENT that
1619 is resized by DELTA lines.
1621 Optional argument IGNORE non-nil means ignore any restrictions
1622 imposed by fixed size windows, `window-min-height' or
1623 `window-min-width' settings. IGNORE equal `safe' means live
1624 windows may get as small as `window-safe-min-height' lines and
1625 `window-safe-min-width' columns. IGNORE any window means ignore
1626 restrictions for that window only.
1628 Optional arguments TRAIL and EDGE, when non-nil, restrict the set
1629 of windows that shall be resized. If TRAIL equals `before',
1630 resize only windows on the left or above EDGE. If TRAIL equals
1631 `after', resize only windows on the right or below EDGE. Also,
1632 preferably only resize windows adjacent to EDGE.
1634 Return the symbol `normalized' if new normal sizes have been
1635 already set by this routine."
1639 best-window best-value)
1651 sub)
1656 edge)
1661 edge)
1664 ;; Resize only windows adjacent to EDGE.
1667 sub delta horizontal ignore t trail edge)
1670 ;; Assign new normal sizes.
1679 ;; Return 'normalized to notify `window--resize-siblings' that
1680 ;; normal sizes have been already set.
1682 ;; Resize all windows proportionally.
1687 ;; Ignore windows to skip and fixed-size child windows -
1688 ;; in the latter case make it a window to skip.
1693 ;; When shrinking store the number of lines/cols we can get
1694 ;; from this window here together with the total/normal size
1695 ;; factor.
1697 sub
1699 ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
1702 parent-total)
1705 ;; When enlarging store the total/normal size factor only
1707 sub
1709 parent-total)
1716 ;; Shrink windows by delta.
1735 best-window
1740 parent-total)
1743 ;; Enlarge windows by delta.
1761 best-window
1763 parent-total)
1771 ;; Reset new normal size fields so `window-resize-apply'
1772 ;; won't use them to apply new sizes.
1776 ;; Resize this window's child windows (back-engineering
1777 ;; delta from sub's old and new total sizes).
1781 ;; For the TRAIL non-nil case we have to resize SUB
1782 ;; recursively even if it's size does not change.
1784 sub delta horizontal ignore nil trail edge))))
1788 "Resize other windows when WINDOW is resized vertically by DELTA lines.
1789 Optional argument HORIZONTAL non-nil means resize other windows
1790 when WINDOW is resized horizontally by DELTA columns. WINDOW
1791 itself is not resized by this function.
1793 Optional argument IGNORE non-nil means ignore any restrictions
1794 imposed by fixed size windows, `window-min-height' or
1795 `window-min-width' settings. IGNORE equal `safe' means live
1796 windows may get as small as `window-safe-min-height' lines and
1797 `window-safe-min-width' columns. IGNORE any window means ignore
1798 restrictions for that window only.
1800 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1801 of windows that shall be resized. If TRAIL equals `before',
1802 resize only windows on the left or above EDGE. If TRAIL equals
1803 `after', resize only windows on the right or below EDGE. Also,
1804 preferably only resize windows adjacent to EDGE."
1809 ;; In an iso-combination try to extract DELTA from WINDOW's
1810 ;; siblings.
1812 this-delta other-delta)
1813 ;; Decide which windows shall be left alone.
1817 ;; Make sure WINDOW is left alone when
1818 ;; resizing its siblings.
1822 ;; Make sure this sibling is left alone when
1823 ;; resizing its siblings.
1827 ;; Set this-delta to t to signal that we found a sibling
1828 ;; of WINDOW whose size is not fixed.
1833 ;; Set this-delta to what we can get from WINDOW's siblings.
1835 ;; A deletion, presumably. We must handle this case
1836 ;; specially since `window--resizable' can't be used.
1838 ;; There's at least one resizable sibling we can
1839 ;; give WINDOW's size to.
1841 ;; No resizable sibling exists.
1843 ;; Any other form of resizing.
1847 ;; Set other-delta to what we still have to get from
1848 ;; ancestor windows of parent.
1851 ;; Unless we got everything from WINDOW's siblings, PARENT
1852 ;; must be resized by other-delta lines or columns.
1856 ;; We haven't got anything from WINDOW's siblings but we
1857 ;; must update the normal sizes to respect other-delta.
1859 parent horizontal window this-delta trail other-delta)
1860 ;; We did get something from WINDOW's siblings which means
1861 ;; we have to resize their child windows.
1864 window ignore trail edge)
1865 ;; If `window--resize-child-windows' returns
1866 ;; 'normalized, this means it has set the
1867 ;; normal sizes already.
1869 ;; Set the normal sizes.
1871 parent horizontal window this-delta trail other-delta))
1872 ;; Set DELTA to what we still have to get from ancestor
1873 ;; windows.
1876 ;; In an ortho-combination all siblings of WINDOW must be
1877 ;; resized by DELTA.
1885 ;; "Go up."
1887 parent delta horizontal ignore trail edge)))))
1890 "Resize WINDOW vertically by DELTA lines.
1891 Optional argument HORIZONTAL non-nil means resize WINDOW
1892 horizontally by DELTA columns.
1894 Optional argument IGNORE non-nil means ignore any restrictions
1895 imposed by fixed size windows, `window-min-height' or
1896 `window-min-width' settings. IGNORE equal `safe' means live
1897 windows may get as small as `window-safe-min-height' lines and
1898 `window-safe-min-width' columns. IGNORE any window means ignore
1899 restrictions for that window only.
1901 Optional argument ADD non-nil means add DELTA to the new total
1902 size of WINDOW.
1904 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1905 of windows that shall be resized. If TRAIL equals `before',
1906 resize only windows on the left or above EDGE. If TRAIL equals
1907 `after', resize only windows on the right or below EDGE. Also,
1908 preferably only resize windows adjacent to EDGE.
1910 This function recursively resizes WINDOW's child windows to fit the
1911 new size. Make sure that WINDOW is `window--resizable' before
1912 calling this function. Note that this function does not resize
1913 siblings of WINDOW or WINDOW's parent window. You have to
1914 eventually call `window-resize-apply' in order to make resizing
1915 actually take effect."
1917 ;; Add DELTA to the new total size of WINDOW.
1924 ;; In an iso-combination resize child windows according to their
1925 ;; normal sizes.
1927 window delta horizontal nil ignore trail edge))
1928 ;; In an ortho-combination resize each child window by DELTA.
1932 sub delta horizontal ignore t trail edge)
1936 "Resize root window WINDOW vertically by DELTA lines.
1937 HORIZONTAL non-nil means resize root window WINDOW horizontally
1938 by DELTA columns.
1940 IGNORE non-nil means ignore any restrictions imposed by fixed
1941 size windows, `window-min-height' or `window-min-width' settings.
1943 This function is only called by the frame resizing routines. It
1944 resizes windows proportionally and never deletes any windows."
1951 "Resize root window WINDOW vertically by DELTA lines.
1952 If DELTA is less than zero and we can't shrink WINDOW by DELTA
1953 lines, shrink it as much as possible. If DELTA is greater than
1954 zero, this function can resize fixed-size windows in order to
1955 recover the necessary lines.
1957 Return the number of lines that were recovered.
1959 This function is only called by the minibuffer window resizing
1960 routines. It resizes windows proportionally and never deletes
1961 any windows."
1972 ;; Ideally, we would resize just the last window in a combination
1973 ;; but that's not feasible for the following reason: If we grow
1974 ;; the minibuffer window and the last window cannot be shrunk any
1975 ;; more, we shrink another window instead. But if we then shrink
1976 ;; the minibuffer window again, the last window might get enlarged
1977 ;; and the state after shrinking is not the state before growing.
1978 ;; So, in practice, we'd need a history variable to record how to
1979 ;; proceed. But I'm not sure how such a variable could work with
1980 ;; repeated minibuffer window growing steps.
1982 delta)))
1985 "Move WINDOW's bottom edge by DELTA lines.
1986 Optional argument HORIZONTAL non-nil means move WINDOW's right
1987 edge by DELTA columns. WINDOW defaults to the selected window.
1989 If DELTA is greater zero, then move the edge downwards or to the
1990 right. If DELTA is less than zero, move the edge upwards or to
1991 the left. If the edge can't be moved by DELTA lines or columns,
1992 move it as far as possible in the desired direction."
1996 left this-delta min-delta max-delta)
1997 ;; Find the edge we want to move.
2010 ;; Set LEFT to the first resizable window on the left. This step is
2011 ;; needed to handle fixed-size windows.
2024 ;; Set RIGHT to the first resizable window on the right. This step
2025 ;; is needed to handle fixed-size windows.
2038 ;; LEFT and RIGHT (which might be both internal windows) are now the
2039 ;; two windows we want to resize.
2045 ;; We can't get the whole DELTA - move as far as possible.
2048 ;; Start resizing.
2050 ;; Try to enlarge LEFT first.
2054 left this-delta horizontal nil t 'before
2058 ;; Shrink windows on right of LEFT.
2060 left delta horizontal nil 'after
2068 ;; We can't get the whole DELTA - move as far as possible.
2071 ;; Start resizing.
2073 ;; Try to enlarge RIGHT.
2077 right this-delta horizontal nil t 'after
2081 ;; Shrink windows on left of RIGHT.
2088 ;; Don't report an error in the standard case.
2090 ;; But do report an error if applying the changes fails.
2094 "Make selected window DELTA lines taller.
2095 Interactively, if no argument is given, make the selected window
2096 one line taller. If optional argument HORIZONTAL is non-nil,
2097 make selected window wider by DELTA columns. If DELTA is
2098 negative, shrink selected window by -DELTA lines or columns.
2099 Return nil."
2112 horizontal))))
2115 "Make selected window DELTA lines smaller.
2116 Interactively, if no argument is given, make the selected window
2117 one line smaller. If optional argument HORIZONTAL is non-nil,
2118 make selected window narrower by DELTA columns. If DELTA is
2119 negative, enlarge selected window by -DELTA lines or columns.
2120 Return nil."
2133 horizontal))))
2136 "Maximize WINDOW.
2137 Make WINDOW as large as possible without deleting any windows.
2138 WINDOW can be any window and defaults to the selected window."
2145 "Minimize WINDOW.
2146 Make WINDOW as small as possible without deleting any windows.
2147 WINDOW can be any window and defaults to the selected window."
2152 \f
2154 "Return non-nil if WINDOW is the root window of its frame."
2158 "Return window subtree rooted at WINDOW.
2159 Optional argument NEXT non-nil means include WINDOW's right
2160 siblings in the return value.
2162 See the documentation of `window-tree' for a description of the
2163 return value."
2176 list))
2181 "Return the window tree of frame FRAME.
2182 FRAME must be a live frame and defaults to the selected frame.
2183 The return value is a list of the form (ROOT MINI), where ROOT
2184 represents the window tree of the frame's root window, and MINI
2185 is the frame's minibuffer window.
2187 If the root window is not split, ROOT is the root window itself.
2188 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
2189 for a horizontal split, and t for a vertical split. EDGES gives
2190 the combined size and position of the child windows in the split,
2191 and the rest of the elements are the child windows in the split.
2192 Each of the child windows may again be a window or a list
2193 representing a window split, and so on. EDGES is a list (LEFT
2194 TOP RIGHT BOTTOM) as returned by `window-edges'."
2197 \f
2199 "Select another window in cyclic ordering of windows.
2200 COUNT specifies the number of windows to skip, starting with the
2201 selected window, before making the selection. If COUNT is
2202 positive, skip COUNT windows forwards. If COUNT is negative,
2203 skip -COUNT windows backwards. COUNT zero means do not skip any
2204 window, so select the selected window. In an interactive call,
2205 COUNT is the numeric prefix argument. Return nil.
2207 If the `other-window' parameter of the selected window is a
2208 function and `ignore-window-parameters' is nil, call that
2209 function with the arguments COUNT and ALL-FRAMES.
2211 This function does not select a window whose `no-other-window'
2212 window parameter is non-nil.
2214 This function uses `next-window' for finding the window to
2215 select. The argument ALL-FRAMES has the same meaning as in
2216 `next-window', but the MINIBUF argument of `next-window' is
2217 always effectively nil."
2222 old-window old-count)
2225 ;; `next-window' and `previous-window' may return a window we are
2226 ;; not allowed to select. Hence we need an exit strategy in case
2227 ;; all windows are non-selectable.
2234 ;; Keep out of infinite loops. When COUNT has not changed
2235 ;; since we last looked at `window' we're probably in one.
2239 ;; The first non-selectable window `next-window' got us:
2240 ;; Remember it and the current value of COUNT.
2250 ;; Keep out of infinite loops. When COUNT has not changed
2251 ;; since we last looked at `window' we're probably in one.
2255 ;; The first non-selectable window `previous-window' got
2256 ;; us: Remember it and the current value of COUNT.
2263 ;; Always return nil.
2264 nil))))
2266 ;; This should probably return non-nil when the selected window is part
2267 ;; of an atomic window whose root is the frame's root window.
2269 "Return non-nil if the selected window is the only window.
2270 Optional arg NOMINI non-nil means don't count the minibuffer
2271 even if it is active. Otherwise, the minibuffer is counted
2272 when it is active.
2274 Optional argument ALL-FRAMES specifies the set of frames to
2275 consider, see also `next-window'. ALL-FRAMES nil or omitted
2276 means consider windows on the selected frame only, plus the
2277 minibuffer window if specified by the NOMINI argument. If the
2278 minibuffer counts, consider all windows on all frames that share
2279 that minibuffer too. The remaining non-nil values of ALL-FRAMES
2280 with a special meaning are:
2282 - t means consider all windows on all existing frames.
2284 - `visible' means consider all windows on all visible frames on
2285 the current terminal.
2287 - 0 (the number zero) means consider all windows on all visible
2288 and iconified frames on the current terminal.
2290 - A frame means consider all windows on that frame only.
2292 Anything else means consider all windows on the selected frame
2293 and no others."
2299 \f
2300 ;;; Deleting windows.
2302 "Return t if WINDOW can be safely deleted from its frame.
2303 Return `frame' if deleting WINDOW should also delete its
2304 frame."
2308 ;; Handle atomicity.
2316 ;; WINDOW's frame can be deleted only if there are other frames
2317 ;; on the same terminal.
2323 ;; WINDOW can be deleted unless it is the main window of its
2324 ;; frame.
2325 t))))
2328 "Return t if WINDOW is either ROOT or a member of ROOT's subtree."
2338 "Delete WINDOW.
2339 WINDOW can be an arbitrary window and defaults to the selected
2340 one. Return nil.
2342 If the variable `ignore-window-parameters' is non-nil or the
2343 `delete-window' parameter of WINDOW equals t, do not process any
2344 parameters of WINDOW. Otherwise, if the `delete-window'
2345 parameter of WINDOW specifies a function, call that function with
2346 WINDOW as its sole argument and return the value returned by that
2347 function.
2349 Otherwise, if WINDOW is part of an atomic window, call
2350 `delete-window' with the root of the atomic window as its
2351 argument. If WINDOW is the only window on its frame or the last
2352 non-side window, signal an error."
2358 atom-root)
2361 ;; Handle window parameters.
2363 ;; Ignore window parameters if `ignore-window-parameters' tells
2364 ;; us so or `delete-window' equals t.
2367 ;; The `delete-window' parameter specifies the function to call.
2368 ;; If that function is `ignore' nothing is done. It's up to the
2369 ;; function called here to avoid infinite recursion.
2386 ;; Emacs 23 preferably gives WINDOW's space to its left
2387 ;; sibling.
2393 ;; Resize WINDOW's sibling.
2399 ;; Can do without resizing fixed-size windows.
2402 ;; Can't do without resizing fixed-size windows.
2404 ;; Actually delete WINDOW.
2409 ;; `delete-window-internal' has selected a window that should
2410 ;; not be selected, fix this here.
2414 ;; Always return nil.
2415 nil))))
2418 "Make WINDOW fill its frame.
2419 WINDOW may be any window and defaults to the selected one.
2420 Return nil.
2422 If the variable `ignore-window-parameters' is non-nil or the
2423 `delete-other-windows' parameter of WINDOW equals t, do not
2424 process any parameters of WINDOW. Otherwise, if the
2425 `delete-other-windows' parameter of WINDOW specifies a function,
2426 call that function with WINDOW as its sole argument and return
2427 the value returned by that function.
2429 Otherwise, if WINDOW is part of an atomic window, call this
2430 function with the root of the atomic window as its argument. If
2431 WINDOW is a non-side window, make WINDOW the only non-side window
2432 on the frame. Side windows are not deleted. If WINDOW is a side
2433 window signal an error."
2439 atom-root side-main)
2443 ;; Ignore window parameters if `ignore-window-parameters' is t or
2444 ;; `delete-other-windows' is t.
2447 ;; The `delete-other-windows' parameter specifies the function
2448 ;; to call. If the function is `ignore' no windows are deleted.
2449 ;; It's up to the function called to avoid infinite recursion.
2456 ;; Set side-main to the major non-side window.
2460 ;; If WINDOW is the main non-side window, do nothing.
2465 ;; Always return nil.
2466 nil)))
2469 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
2471 if you often split windows horizontally."
2483 ;;; Windows and buffers.
2485 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
2486 ;; for (1) determining which buffer to show in the window when its
2487 ;; buffer shall be buried or killed and (2) which buffer to show for
2488 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2490 ;; `prev-buffers' consists of <buffer, window-start, window-point>
2491 ;; triples. The entries on this list are ordered by the time their
2492 ;; buffer has been removed from the window, the most recently removed
2493 ;; buffer's entry being first. The window-start and window-point
2494 ;; components are `window-start' and `window-point' at the time the
2495 ;; buffer was removed from the window which implies that the entry must
2496 ;; be added when `set-window-buffer' removes the buffer from the window.
2498 ;; `next-buffers' is the list of buffers that have been replaced
2499 ;; recently by `switch-to-prev-buffer'. These buffers are the least
2500 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
2501 ;; candidates of `switch-to-next-buffer' to switch to. This list is
2502 ;; reset to nil by any action changing the window's buffer with the
2503 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
2504 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
2505 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
2507 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
2508 ;; if such a buffer was killed while the window was hidden within a
2509 ;; window configuration. Such killed buffers get removed whenever
2510 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
2512 ;; The following function is called by `set-window-buffer' _before_ it
2513 ;; replaces the buffer of the argument window with the new buffer.
2515 "Record WINDOW's buffer.
2516 WINDOW must be a live window and defaults to the selected one."
2520 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
2521 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2525 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
2529 ;; Don't record insignificant buffers.
2531 ;; Add an entry for buffer to WINDOW's previous buffers.
2538 ;; We have an entry, update marker positions.
2541 ;; Make new markers.
2549 "Unrecord BUFFER in WINDOW.
2550 WINDOW must be a live window and defaults to the selected one.
2551 BUFFER must be a live buffer and defaults to the buffer of
2552 WINDOW."
2561 "Set WINDOW's buffer to BUFFER.
2562 Optional argument START non-nil means set WINDOW's start position
2563 to START. Optional argument POINT non-nil means set WINDOW's
2564 point to POINT. If WINDOW is selected this also sets BUFFER's
2565 `point' to POINT. If WINDOW is selected and the buffer it showed
2566 before was current this also makes BUFFER the current buffer."
2573 ;; Don't force window-start here (even if POINT is nil).
2579 "In WINDOW switch to previous buffer.
2580 WINDOW must be a live window and defaults to the selected one.
2582 Optional argument BURY-OR-KILL non-nil means the buffer currently
2583 shown in WINDOW is about to be buried or killed and consequently
2584 shall not be switched to in future invocations of this command."
2588 ;; Save this since it's destroyed by `set-window-buffer'.
2590 entry new-buffer killed-buffers visible)
2595 ;; Scan WINDOW's previous buffers first, skipping entries of next
2596 ;; buffers.
2608 ;; Scan reverted buffer list of WINDOW's frame next, skipping
2609 ;; entries of next buffers. Note that when we bury or kill a
2610 ;; buffer we don't reverse the global buffer list to avoid showing
2611 ;; a buried buffer instead. Otherwise, we must reverse the global
2612 ;; buffer list in order to make sure that switching to the
2613 ;; previous/next buffer traverse it in opposite directions.
2622 ;; Try to avoid showing a buffer visible in some other window.
2628 ;; Scan reverted next buffers last (must not use nreverse
2629 ;; here!).
2631 ;; Actually, buffer _must_ be live here since otherwise it
2632 ;; would have been caught in the scan of previous buffers.
2643 ;; Show a buffer visible in another window.
2649 ;; Remove `old-buffer' from WINDOW's previous and (restored list
2650 ;; of) next buffers.
2655 ;; Move `old-buffer' to head of WINDOW's restored list of next
2656 ;; buffers.
2660 ;; Remove killed buffers from WINDOW's previous and next buffers.
2668 ;; Return new-buffer.
2669 new-buffer))
2672 "In WINDOW switch to next buffer.
2673 WINDOW must be a live window and defaults to the selected one."
2678 new-buffer entry killed-buffers visible)
2683 ;; Scan WINDOW's next buffers first.
2694 ;; Scan the buffer list of WINDOW's frame next, skipping previous
2695 ;; buffers entries.
2701 ;; Try to avoid showing a buffer visible in some other window.
2706 ;; Scan WINDOW's reverted previous buffers last (must not use
2707 ;; nreverse here!)
2718 ;; Show a buffer visible in another window.
2723 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
2726 ;; Remove killed buffers from WINDOW's previous and next buffers.
2734 ;; Return new-buffer.
2735 new-buffer))
2738 "Search LIST for a valid buffer to display in FRAME.
2739 Return nil when all buffers in LIST are undesirable for display,
2740 otherwise return the first suitable buffer in LIST.
2742 Buffers not visible in windows are preferred to visible buffers,
2743 unless VISIBLE-OK is non-nil.
2744 If the optional argument FRAME is nil, it defaults to the selected frame.
2745 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
2746 ;; This logic is more or less copied from other-buffer.
2749 found buf)
2762 "Return the last buffer in FRAME's buffer list.
2763 If BUFFER is the last buffer, return the preceding buffer
2764 instead. Buffers not visible in windows are preferred to visible
2765 buffers, unless optional argument VISIBLE-OK is non-nil.
2766 Optional third argument FRAME nil or omitted means use the
2767 selected frame's buffer list. If no such buffer exists, return
2768 the buffer `*scratch*', creating it if necessary."
2771 buffer visible-ok frame)
2775 scratch)))
2778 "Function called to automatically hide frames.
2779 The function is called with one argument - a frame.
2781 Functions affected by this option are those that bury a buffer
2782 shown in a separate frame like `quit-window' and `bury-buffer'."
2786 function)
2792 "Delete WINDOW if possible.
2793 WINDOW must be a live window and defaults to the selected one.
2794 Optional argument DEDICATED-ONLY non-nil means to delete WINDOW
2795 only if it's dedicated to its buffer. Optional argument KILL
2796 means the buffer shown in window will be killed. Return non-nil
2797 if WINDOW gets deleted or its frame is auto-hidden."
2812 t)))))
2815 "Put BUFFER-OR-NAME at the end of the list of all buffers.
2816 There it is the least likely candidate for `other-buffer' to
2818 select by default.
2820 You can specify a buffer name as BUFFER-OR-NAME, or an actual
2821 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
2822 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
2823 remove the current buffer from the selected window if it is
2824 displayed there."
2827 ;; If `buffer-or-name' is not on the selected frame we unrecord it
2828 ;; although it's not "here" (call it a feature).
2830 ;; Handle case where `buffer-or-name' is nil and the current buffer
2831 ;; is shown in the selected window.
2836 ;; Switch to another buffer in window.
2840 ;; Always return nil.
2841 nil))
2844 "Switch to the last buffer in the buffer list."
2849 "In selected window switch to next buffer."
2856 "In selected window switch to previous buffer."
2863 "Delete all windows showing BUFFER-OR-NAME.
2864 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2865 and defaults to the current buffer.
2867 The following non-nil values of the optional argument FRAME
2868 have special meanings:
2870 - t means consider all windows on the selected frame only.
2872 - `visible' means consider all windows on all visible frames on
2873 the current terminal.
2875 - 0 (the number zero) means consider all windows on all visible
2876 and iconified frames on the current terminal.
2878 - A frame means consider all windows on that frame only.
2880 Any other value of FRAME means consider all windows on all
2881 frames.
2883 When a window showing BUFFER-OR-NAME is dedicated and the only
2884 window of its frame, that frame is deleted when there are other
2885 frames left."
2888 ;; Handle the "inverted" meaning of the FRAME argument wrt other
2889 ;; `window-list-1' based function.
2896 ;; Delete frame if and only if window is dedicated.
2899 ;; Delete window.
2902 ;; In window switch to previous buffer.
2905 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
2909 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
2910 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2911 and defaults to the current buffer.
2913 When a window showing BUFFER-OR-NAME is dedicated, that window is
2914 deleted. If that window is the only window on its frame, the
2915 frame is deleted too when there are other frames left. If there
2916 are no other frames left, some other buffer is displayed in that
2917 window.
2919 This function removes the buffer denoted by BUFFER-OR-NAME from
2920 all window-local buffer lists."
2926 ;; Switch to another buffer in window.
2929 ;; Unrecord BUFFER in WINDOW.
2933 "Quit WINDOW and bury its buffer.
2934 WINDOW must be a live window and defaults to the selected one.
2935 With prefix argument KILL non-nil, kill the buffer instead of
2936 burying it.
2938 According to information stored in WINDOW's `quit-restore' window
2939 parameter either (1) delete WINDOW and its frame, (2) delete
2940 WINDOW, (3) restore the buffer previously displayed in WINDOW,
2941 or (4) make WINDOW display some other buffer than the present
2942 one. If non-nil, reset `quit-restore' parameter to nil."
2953 buffer))))
2954 prev-buffer)))
2955 quad resize)
2960 ;; Delete WINDOW if possible.
2962 ;; If the previously selected window is still alive, select it.
2968 ;; Show another buffer stored in quit-restore parameter.
2974 ;; Try to resize WINDOW to its old height but don't signal an
2975 ;; error.
2979 ;; Restore WINDOW's previous buffer, start and point position.
2982 ;; Unrecord WINDOW's buffer here (Bug#9937) to make sure it's not
2983 ;; re-recorded by `set-window-buffer'.
2985 ;; Reset the quit-restore parameter.
2987 ;; Select old window.
2991 ;; Show some other buffer in WINDOW and reset the quit-restore
2992 ;; parameter.
2994 ;; Make sure that WINDOW is no more dedicated.
2998 ;; Kill WINDOW's old-buffer if requested
3004 "Quit all windows showing BUFFER-OR-NAME.
3005 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
3006 and defaults to the current buffer. Optional argument KILL
3007 non-nil means to kill BUFFER-OR-NAME. KILL nil means to bury
3008 BUFFER-OR-NAME. Optional argument FRAME is handled as by
3009 `delete-windows-on'.
3011 This function calls `quit-window' on all candidate windows
3012 showing BUFFER-OR-NAME."
3015 ;; Handle the "inverted" meaning of the FRAME argument wrt other
3016 ;; `window-list-1' based function.
3021 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
3023 \f
3024 ;;; Splitting windows.
3026 "Return minimum height of any window when splitting windows.
3027 Optional argument HORIZONTAL non-nil means return minimum width."
3033 "Make a new window adjacent to WINDOW.
3034 WINDOW can be any window and defaults to the selected one.
3035 Return the new window which is always a live window.
3037 Optional argument SIZE a positive number means make WINDOW SIZE
3038 lines or columns tall. If SIZE is negative, make the new window
3039 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
3040 absolute value can be less than `window-min-height' or
3041 `window-min-width'; so this command can make a new window as
3042 small as one line or two columns. SIZE defaults to half of
3043 WINDOW's size. Interactively, SIZE is the prefix argument.
3045 Optional third argument SIDE nil (or `below') specifies that the
3046 new window shall be located below WINDOW. SIDE `above' means the
3047 new window shall be located above WINDOW. In both cases SIZE
3048 specifies the new number of lines for WINDOW (or the new window
3049 if SIZE is negative) including space reserved for the mode and/or
3050 header line.
3052 SIDE t (or `right') specifies that the new window shall be
3053 located on the right side of WINDOW. SIDE `left' means the new
3054 window shall be located on the left of WINDOW. In both cases
3055 SIZE specifies the new number of columns for WINDOW (or the new
3056 window provided SIZE is negative) including space reserved for
3057 fringes and the scrollbar or a divider column. Any other non-nil
3058 value for SIDE is currently handled like t (or `right').
3060 If the variable `ignore-window-parameters' is non-nil or the
3061 `split-window' parameter of WINDOW equals t, do not process any
3062 parameters of WINDOW. Otherwise, if the `split-window' parameter
3063 of WINDOW specifies a function, call that function with all three
3064 arguments and return the value returned by that function.
3067 root of that atomic window. The new window does not become a
3068 member of that atomic window.
3070 If WINDOW is live, properties of the new window like margins and
3071 scrollbars are inherited from WINDOW. If WINDOW is an internal
3072 window, these properties as well as the buffer displayed in the
3073 new window are inherited from the window selected on WINDOW's
3074 frame. The selected window is not changed by this function."
3086 ;; Rebind `window-combination-limit' since in some cases we may
3087 ;; have to override its value.
3089 atom-root)
3094 ;; Ignore window parameters if either `ignore-window-parameters'
3095 ;; is t or the `split-window' parameter equals t.
3098 ;; The `split-window' parameter specifies the function to call.
3099 ;; If that function is `ignore', do nothing.
3101 ;; If WINDOW is part of an atomic window, split the root window
3102 ;; of that atomic window instead.
3111 ;; WINDOW is a side root window. To make sure that a new parent
3112 ;; window gets created set `window-combination-limit' to t.
3116 ;; If `window-combination-resize' is non-nil and SIZE is a
3117 ;; non-negative integer, we cannot reasonably resize other
3118 ;; windows. Rather bind `window-combination-limit' to t to make
3119 ;; sure that subsequent window deletions are handled correctly.
3123 ;; `parent-size' is the size of WINDOW's parent, provided
3124 ;; it has one.
3126 ;; `resize' non-nil means we are supposed to resize other
3127 ;; windows in WINDOW's combination.
3130 ;; Resize makes sense in iso-combinations only.
3132 ;; `old-size' is the current size of WINDOW.
3134 ;; `new-size' is the specified or calculated size of the
3135 ;; new window.
3141 ;; When resizing try to give the new window the
3142 ;; average size of a window in its combination.
3145 (/ parent-size
3147 parent horizontal))))
3148 ;; Else try to give the new window half the size
3149 ;; of WINDOW (plus an eventual odd line).
3152 ;; SIZE non-negative specifies the new size of WINDOW.
3154 ;; Note: Specifying a non-negative SIZE is practically
3155 ;; always done as workaround for making the new window
3156 ;; appear above or on the left of the new window (the
3157 ;; ispell window is a typical example of that). In all
3158 ;; these cases the SIDE argument should be set to 'above
3159 ;; or 'left in order to support the 'resize option.
3160 ;; Here we have to nest the windows instead, see above.
3163 ;; SIZE negative specifies the size of the new window.
3165 new-parent new-normal)
3167 ;; Check SIZE.
3172 ;; SIZE unspecified, resizing.
3174 ;; Try again with minimum split size.
3180 ;; SIZE unspecified, no resizing.
3185 window-safe-min-width
3186 window-safe-min-width))))
3187 ;; SIZE specified as new size of old window. If the new size
3188 ;; is larger than the old size or the size of the new window
3189 ;; would be less than the safe minimum, signal an error.
3192 ;; SIZE specified, resizing.
3194 ;; If we cannot resize the parent give up.
3200 ;; SIZE specification violates minimum size restrictions.
3206 ;; Make new-parent non-nil if we need a new parent window;
3207 ;; either because we want to nest or because WINDOW is not
3208 ;; iso-combined.
3212 ;; Make new-normal the normal size of the new window.
3220 ;; Try to get space from OLD's siblings. We could go "up" and
3221 ;; try getting additional space from surrounding windows but
3222 ;; we won't be able to return space to those windows when we
3223 ;; delete the one we create here. Hence we do not go up.
3232 ;; Get entire space from WINDOW.
3237 new-normal)))
3240 ;; Inherit window-side parameters, if any.
3247 ;; Always return the new window.
3248 new)))))
3250 ;; I think this should be the default; I think people will prefer it--rms.
3253 If nil, adjust point in the two windows to minimize redisplay.
3254 This option applies only to `split-window-below' and functions
3255 that call it. The low-level `split-window' function always keeps
3256 the original point in both windows."
3261 "Split the selected window into two windows, one above the other.
3262 The selected window is above. The newly split-off window is
3263 below, and displays the same buffer. Return the new window.
3265 If optional argument SIZE is omitted or nil, both windows get the
3266 same height, or close to it. If SIZE is positive, the upper
3267 \(selected) window gets SIZE lines. If SIZE is negative, the
3268 lower (new) window gets -SIZE lines.
3270 If the variable `split-window-keep-point' is non-nil, both
3271 windows get the same value of point as the selected window.
3272 Otherwise, the window starts are chosen so as to minimize the
3273 amount of redisplay; this is convenient on slow terminals."
3278 moved-by-window-height moved new-window bottom)
3280 ;; `split-window' would not signal an error here.
3301 ;; Always copy quit-restore parameter in interactive use.
3305 new-window))
3310 "Split the selected window into two side-by-side windows.
3311 The selected window is on the left. The newly split-off window
3312 is on the right, and displays the same buffer. Return the new
3313 window.
3315 If optional argument SIZE is omitted or nil, both windows get the
3316 same width, or close to it. If SIZE is positive, the left-hand
3317 \(selected) window gets SIZE columns. If SIZE is negative, the
3318 right-hand (new) window gets -SIZE columns. Here, SIZE includes
3319 the width of the window's scroll bar; if there are no scroll
3320 bars, it includes the width of the divider column to the window's
3321 right, if any."
3325 new-window)
3327 ;; `split-window' would not signal an error here.
3330 ;; Always copy quit-restore parameter in interactive use.
3334 new-window))
3337 \f
3338 ;;; Balancing windows.
3340 ;; The following routine uses the recycled code from an old version of
3341 ;; `window--resize-child-windows'. It's not very pretty, but coding it the way the
3342 ;; new `window--resize-child-windows' code does would hardly make it any shorter or
3343 ;; more readable (FWIW we'd need three loops - one to calculate the
3344 ;; minimum sizes per window, one to enlarge or shrink windows until the
3345 ;; new parent-size matches, and one where we shrink the largest/enlarge
3346 ;; the smallest window).
3348 "Subroutine of `balance-windows-1'.
3349 WINDOW must be a vertical combination (horizontal if HORIZONTAL
3350 is non-nil."
3356 failed size sub-total sub-delta sub-amount rest)
3371 ;; Ignore child windows that should be ignored or are stuck.
3377 ;; Register the new total size for this child window.
3382 ;; We failed and need a new round.
3388 ;; Fix rounding by trying to enlarge non-stuck windows by one line
3389 ;; (column) until `rest' is zero.
3397 ;; Fix rounding by trying to enlarge stuck windows by one line
3398 ;; (column) until `rest' equals zero.
3408 ;; Record new normal sizes.
3414 ;; Recursively balance each window's child windows.
3419 "Subroutine of `balance-windows'."
3431 "Balance the sizes of windows of WINDOW-OR-FRAME.
3432 WINDOW-OR-FRAME is optional and defaults to the selected frame.
3433 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
3434 windows of that frame. If WINDOW-OR-FRAME denotes a window,
3435 recursively balance the sizes of all child windows of that
3436 window."
3445 window-or-frame)
3449 ;; Balance vertically.
3453 ;; Balance horizontally.
3459 "Return t if WINDOW cannot be resized in DIRECTION.
3460 WINDOW defaults to the selected window. DIRECTION can be
3461 nil (i.e. any), `height' or `width'."
3468 ;;; A different solution to balance-windows.
3470 "Factor by which the window area should be over-estimated.
3471 This is used by `balance-windows-area'.
3476 "Wrapper around `window-resize' with error checking.
3477 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
3478 ;; `window-resize' may fail if delta is too large.
3485 ;;(message "adjust: %s" (error-message-string err))
3489 "Make all visible windows the same area (approximately).
3490 See also `window-area-factor' to change the relative size of
3491 specific buffers."
3494 ;; Remove fixed-size windows.
3499 next)
3500 ;; Resizing a window changes the size of surrounding windows in complex
3501 ;; ways, so it's difficult to balance them all. The introduction of
3502 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
3503 ;; very difficult to do. `balance-window' above takes an off-line
3504 ;; approach: get the whole window tree, then balance it, then try to
3505 ;; adjust the windows so they fit the result.
3506 ;; Here, instead, we take a "local optimization" approach, where we just
3507 ;; go through all the windows several times until nothing needs to be
3508 ;; changed. The main problem with this approach is that it's difficult
3509 ;; to make sure it terminates, so we use some heuristic to try and break
3510 ;; off infinite loops.
3511 ;; After a round without any change, we allow a second, to give a chance
3512 ;; to the carry to propagate a minor imbalance from the end back to
3513 ;; the beginning.
3515 ;; (message "New round")
3521 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
3539 ;; Maybe diff is actually closer to 1 than to 0.
3543 ;; Change things smoothly.
3546 ;; Make sure negligible differences don't accumulate to
3547 ;; become significant.
3549 ;; This used `adjust-window-trailing-edge' before and uses
3550 ;; `window-resize' now. Error wrapping is still needed.
3552 ;; (sit-for 0.5)
3554 ;; If the same change has been seen already for this window,
3555 ;; we're most likely in an endless loop, so don't count it as
3556 ;; a change.
3560 ;; We've now basically balanced all the windows.
3561 ;; But there may be some minor off-by-one imbalance left over,
3562 ;; so let's do some fine tuning.
3563 ;; (bw-finetune wins)
3564 ;; (message "Done in %d rounds" round)
3565 ))
3567 ;;; Window states, how to get them and how to put them in a window.
3569 "Helper function for `window-state-get'."
3578 `(,type
3586 list)
3587 ;; Make copies of those window parameters whose
3588 ;; persistence property is `writable' if WRITABLE is
3589 ;; non-nil and non-nil if WRITABLE is nil.
3592 window-persistent-parameters))))
3595 ;; Add `clone-of' parameter if necessary.
3597 window-persistent-parameters))))
3604 ;; All buffer related things go in here.
3629 "Return state of WINDOW as a Lisp object.
3630 WINDOW can be any window and defaults to the root window of the
3631 selected frame.
3633 Optional argument WRITABLE non-nil means do not use markers for
3634 sampling `window-point' and `window-start'. Together, WRITABLE
3635 and the variable `window-persistent-parameters' specify which
3636 window parameters are saved by this function. WRITABLE should be
3637 non-nil when the return value shall be written to a file and read
3638 back in another session. Otherwise, an application may run into
3639 an `invalid-read-syntax' error while attempting to read back the
3640 value from file.
3642 The return value can be used as argument for `window-state-put'
3643 to put the state recorded here into an arbitrary window. The
3644 value can be also stored on disk and read back in a new session."
3648 window
3651 ;; The return value is a cons whose car specifies some constraints on
3652 ;; the size of WINDOW. The cdr lists the states of the child windows
3653 ;; of WINDOW.
3655 ;; Frame related things would go into a function, say `frame-state',
3656 ;; calling `window-state-get' to insert the frame's root window.
3669 "Helper function for `window-state-put'."
3674 ;; For a leaf window just add unprocessed entries to
3675 ;; `window-state-put-list'.
3681 size new)
3683 ;; Find the next child window. WINDOW always points to the
3684 ;; real window that we want to fill with what we find here.
3687 ;; The last child window. Below `window--state-put-1'
3688 ;; will put into it whatever ITEM has in store.
3690 ;; Not the last child window, prepare for splitting
3691 ;; WINDOW. SIZE is the new (and final) size of the old
3692 ;; window.
3695 ;; Use total size.
3697 ;; Use normalized size and round.
3701 item))))))
3703 ;; Use safe sizes, we try to resize later.
3705 window-safe-min-height
3706 window-safe-min-width)))
3711 ;; We must inherit the combination limit, otherwise
3712 ;; we might mess up handling of atomic and side
3713 ;; window.
3715 ;; Give up if we can't resize window down to safe sizes.
3720 ;; When creating the first child window add for parent
3721 ;; unprocessed entries to `window-state-put-list'.
3724 window-state-put-list))))
3726 ;; Now process the current window (either the one we've just
3727 ;; split or the last child of its parent).
3729 ;; Continue with the last window split off.
3733 "Helper function for `window-state-put'."
3741 ;; Reset window's parameters and assign saved ones (we might want
3742 ;; a `remove-window-parameters' function here).
3748 ;; Process buffer related state.
3750 ;; We don't want to raise an error here so we create a buffer if
3751 ;; there's none.
3763 ;; Adjust vertically.
3765 ;; A fixed height window, try to restore the original size.
3768 window-size-fixed)
3771 ;; Else check whether the window is not high enough.
3777 ;; Adjust horizontally.
3779 ;; A fixed width window, try to restore the original size.
3782 window-size-fixed)
3785 ;; Else check whether the window is not wide enough.
3791 ;; Set dedicated status.
3793 ;; Install positions (maybe we should do this after all windows
3794 ;; have been created and sized).
3798 ;; Select window if it's the selected one.
3803 "Put window state STATE into WINDOW.
3804 STATE should be the state of a window returned by an earlier
3805 invocation of `window-state-get'. Optional argument WINDOW must
3806 specify a live window and defaults to the selected one.
3808 Optional argument IGNORE non-nil means ignore minimum window
3809 sizes and fixed size restrictions. IGNORE equal `safe' means
3810 windows can get as small as `window-safe-min-height' and
3811 `window-safe-min-width'."
3815 ;; We check here (1) whether the total sizes of root window of
3816 ;; STATE and that of WINDOW are equal so we can avoid
3817 ;; calculating new sizes, and (2) if we do have to resize
3818 ;; whether we can do so without violating size restrictions.
3843 (> min-width
3845 ;; The check above might not catch all errors due to rounding
3846 ;; issues - so IGNORE equal 'safe might not always produce the
3847 ;; minimum possible state. But such configurations hardly make
3848 ;; sense anyway.
3852 ;; Work on the windows of a temporary buffer to make sure that
3853 ;; splitting proceeds regardless of any buffer local values of
3854 ;; `window-size-fixed'. Release that buffer after the buffers of
3855 ;; all live windows have been set by `window--state-put-2'.
3861 \f
3863 "Record information for window used by `display-buffer'.
3864 TYPE specifies the type of the calling operation and must be one
3865 of the symbols 'reuse (when WINDOW existed already and was
3866 reused for displaying BUFFER), 'window (when WINDOW was created
3867 on an already existing frame), or 'frame (when WINDOW was
3868 created on a new frame). WINDOW is the window used for or created
3869 by the `display-buffer' routines. BUFFER is the buffer that
3870 shall be displayed.
3872 This function installs or updates the quit-restore parameter of
3873 WINDOW. The quit-restore parameter is a list of four elements:
3874 The first element is one of the symbols 'window, 'frame, 'same or
3875 'other. The second element is either one of the symbols 'window
3876 or 'frame or a list whose elements are the buffer previously
3877 shown in the window, that buffer's window start and window point,
3878 and the window's height. The third element is the window
3879 selected at the time the parameter was created. The fourth
3880 element is BUFFER."
3884 ;; WINDOW shows BUFFER already.
3886 ;; If WINDOW has a quit-restore parameter, reset its car.
3888 ;; WINDOW shows another buffer.
3890 window 'quit-restore
3892 ;; A quadruple of WINDOW's buffer, start, point and height.
3897 ;; WINDOW has been created on an existing frame.
3899 window 'quit-restore
3902 ;; WINDOW has been created on a new frame.
3904 window 'quit-restore
3908 "If non-nil, function to call to handle `display-buffer'.
3909 It will receive two args, the buffer and a flag which if non-nil
3910 means that the currently selected window is not acceptable. It
3911 should choose or create a window, display the specified buffer in
3912 it, and return the window.
3914 The specified function should call `display-buffer-record-window'
3915 with corresponding arguments to set up the quit-restore parameter
3916 of the window used."
3923 "Alist of parameters for automatically generated new frames.
3924 You can set this in your init file; for example,
3926 (setq pop-up-frame-alist '((width . 80) (height . 20)))
3928 If non-nil, the value you specify here is used by the default
3929 `pop-up-frame-function' for the creation of new frames.
3931 Since `pop-up-frame-function' is used by `display-buffer' for
3932 making new frames, any value specified here by default affects
3933 the automatic generation of new frames via `display-buffer' and
3934 all functions based on it. The behavior of `make-frame' is not
3935 affected by this variable."
3943 "Function used by `display-buffer' for creating a new frame.
3944 This function is called with no arguments and should return a new
3945 frame. The default value calls `make-frame' with the argument
3946 `pop-up-frame-alist'."
3951 "List of names of buffers that should be displayed specially.
3952 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
3953 its name is in this list, displays the buffer in a way specified
3954 by `special-display-function'. `special-display-popup-frame'
3955 \(the default for `special-display-function') usually displays
3956 the buffer in a separate frame made with the parameters specified
3957 by `special-display-frame-alist'. If `special-display-function'
3958 has been set to some other function, that function is called with
3959 the buffer as first, and nil as second argument.
3961 Alternatively, an element of this list can be specified as
3962 \(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
3963 name and FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
3964 `special-display-popup-frame' will interpret such pairs as frame
3965 parameters when it creates a special frame, overriding the
3966 corresponding values from `special-display-frame-alist'.
3968 As a special case, if FRAME-PARAMETERS contains (same-window . t)
3969 `special-display-popup-frame' displays that buffer in the
3970 selected window. If FRAME-PARAMETERS contains (same-frame . t),
3971 it displays that buffer in a window on the selected frame.
3973 If `special-display-function' specifies some other function than
3974 `special-display-popup-frame', that function is called with the
3975 buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
3976 argument.
3978 Finally, an element of this list can be also specified as
3979 \(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
3980 `special-display-popup-frame' will call FUNCTION with the buffer
3981 named BUFFER-NAME as first argument, and OTHER-ARGS as the
3982 second.
3984 Any alternative function specified here is responsible for
3985 setting up the quit-restore parameter of the window used.
3988 name to it but the corresponding buffer is displayed in the
3989 selected window, look at the values of `same-window-buffer-names'
3990 and `same-window-regexps'. Those variables take precedence over
3991 this one.
3993 See also `special-display-regexps'."
4015 ;;;###autoload
4019 "List of regexps saying which buffers should be displayed specially.
4020 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
4021 any regexp in this list matches its name, displays it specially
4022 using `special-display-function'. `special-display-popup-frame'
4023 \(the default for `special-display-function') usually displays
4024 the buffer in a separate frame made with the parameters specified
4025 by `special-display-frame-alist'. If `special-display-function'
4026 has been set to some other function, that function is called with
4027 the buffer as first, and nil as second argument.
4029 Alternatively, an element of this list can be specified as
4030 \(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
4031 FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
4032 `special-display-popup-frame' will then interpret these pairs as
4033 frame parameters when creating a special frame for a buffer whose
4034 name matches REGEXP, overriding the corresponding values from
4035 `special-display-frame-alist'.
4037 As a special case, if FRAME-PARAMETERS contains (same-window . t)
4038 `special-display-popup-frame' displays buffers matching REGEXP in
4039 the selected window. (same-frame . t) in FRAME-PARAMETERS means
4040 to display such buffers in a window on the selected frame.
4042 If `special-display-function' specifies some other function than
4043 `special-display-popup-frame', that function is called with the
4044 buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
4045 as second argument.
4047 Finally, an element of this list can be also specified as
4048 \(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
4049 will then call FUNCTION with the buffer whose name matched
4050 REGEXP as first, and OTHER-ARGS as second argument.
4052 Any alternative function specified here is responsible for
4053 setting up the quit-restore parameter of the window used.
4056 name to it but the corresponding buffer is displayed in the
4057 selected window, look at the values of `same-window-buffer-names'
4058 and `same-window-regexps'. Those variables take precedence over
4059 this one.
4061 See also `special-display-buffer-names'."
4084 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
4085 More precisely, return t if `special-display-buffer-names' or
4086 `special-display-regexps' contain a string entry equaling or
4087 matching BUFFER-NAME. If `special-display-buffer-names' or
4088 `special-display-regexps' contain a list entry whose car equals
4089 or matches BUFFER-NAME, the return value is the cdr of that
4090 entry."
4095 t)
4110 "Alist of parameters for special frames.
4111 Special frames are used for buffers whose names are listed in
4112 `special-display-buffer-names' and for buffers whose names match
4113 one of the regular expressions in `special-display-regexps'.
4115 This variable can be set in your init file, like this:
4117 (setq special-display-frame-alist '((width . 80) (height . 20)))
4119 These supersede the values given in `default-frame-alist'."
4126 "Display BUFFER and return the window chosen.
4127 If BUFFER is already displayed in a visible or iconified frame,
4128 raise that frame. Otherwise, display BUFFER in a new frame.
4130 Optional argument ARGS is a list specifying additional
4131 information.
4133 If ARGS is an alist, use it as a list of frame parameters. If
4134 these parameters contain (same-window . t), display BUFFER in
4135 the selected window. If they contain (same-frame . t), display
4136 BUFFER in a window of the selected frame.
4138 If ARGS is a list whose car is a symbol, use (car ARGS) as a
4139 function to do the work. Pass it BUFFER as first argument,
4140 and (cdr ARGS) as second."
4145 ;; If we have a window already, make it visible.
4151 window))
4152 ;; Reuse the current window if the user requested it.
4157 ;; Stay on the same frame if requested.
4160 pop-up-frames
4161 special-display-buffer-names special-display-regexps)
4163 ;; If no window yet, make one in a new frame.
4169 ;; FIXME: Use window--display-buffer-2?
4171 ;; Reset list of WINDOW's previous buffers to nil.
4174 window)))))
4177 "Function to call for displaying special buffers.
4178 This function is called with two arguments - the buffer and,
4179 optionally, a list - and should return a window displaying that
4180 buffer. The default value usually makes a separate frame for the
4181 buffer using `special-display-frame-alist' to specify the frame
4182 parameters. See the definition of `special-display-popup-frame'
4183 for how to specify such a function.
4185 A buffer is special when its name is either listed in
4186 `special-display-buffer-names' or matches a regexp in
4187 `special-display-regexps'.
4189 The specified function should call `display-buffer-record-window'
4190 with corresponding arguments to set up the quit-restore parameter
4191 of the window used."
4197 `display-buffer' and `pop-to-buffer' show a buffer whose name is
4198 on this list in the selected rather than some other window.
4200 An element of this list can be a cons cell instead of just a
4201 string. In that case, the cell's car must be a string specifying
4202 the buffer name. This is for compatibility with
4203 `special-display-buffer-names'; the cdr of the cons cell is
4204 ignored.
4206 See also `same-window-regexps'."
4212 `display-buffer' and `pop-to-buffer' show a buffer whose name
4213 matches a regexp on this list in the selected rather than some
4214 other window.
4216 An element of this list can be a cons cell instead of just a
4217 string. In that case, the cell's car must be a regexp matching
4218 the buffer name. This is for compatibility with
4219 `special-display-regexps'; the cdr of the cons cell is ignored.
4221 See also `same-window-buffer-names'."
4227 This function returns non-nil if `display-buffer' or
4228 `pop-to-buffer' would show a buffer named BUFFER-NAME in the
4229 selected rather than (as usual) some other window. See
4230 `same-window-buffer-names' and `same-window-regexps'."
4233 ;; The elements of `same-window-buffer-names' can be buffer
4234 ;; names or cons cells whose cars are buffer names.
4239 ;; The elements of `same-window-regexps' can be regexps
4240 ;; or cons cells whose cars are regexps.
4248 "Whether `display-buffer' should make a separate frame.
4249 If nil, never make a separate frame.
4250 If the value is `graphic-only', make a separate frame
4251 on graphic displays only.
4252 Any other non-nil value means always make a separate frame."
4260 "Non-nil means `display-buffer' should reuse frames.
4261 If the buffer in question is already displayed in a frame, raise
4262 that frame."
4268 "Non-nil means `display-buffer' should make a new window."
4273 "Function called by `display-buffer' routines to split a window.
4274 This function is called with a window as single argument and is
4275 supposed to split that window and return the new window. If the
4276 window can (or shall) not be split, it is supposed to return nil.
4277 The default is to call the function `split-window-sensibly' which
4278 tries to split the window in a way which seems most suitable.
4279 You can customize the options `split-height-threshold' and/or
4280 `split-width-threshold' in order to have `split-window-sensibly'
4281 prefer either vertical or horizontal splitting.
4283 If you set this to any other function, bear in mind that the
4284 `display-buffer' routines may call this function two times. The
4285 argument of the first call is the largest window on its frame.
4286 If that call fails to return a live window, the function is
4287 called again with the least recently used window as argument. If
4288 that call fails too, `display-buffer' will use an existing window
4289 to display its buffer.
4291 The window selected at the time `display-buffer' was invoked is
4292 still selected when this function is called. Hence you can
4293 compare the window argument with the value of `selected-window'
4294 if you intend to split the selected window instead or if you do
4295 not want to split the selected window."
4301 "Minimum height for splitting windows sensibly.
4302 If this is an integer, `split-window-sensibly' may split a window
4303 vertically only if it has at least this many lines. If this is
4304 nil, `split-window-sensibly' is not allowed to split a window
4305 vertically. If, however, a window is the only window on its
4306 frame, `split-window-sensibly' may split it vertically
4307 disregarding the value of this variable."
4313 "Minimum width for splitting windows sensibly.
4314 If this is an integer, `split-window-sensibly' may split a window
4315 horizontally only if it has at least this many columns. If this
4316 is nil, `split-window-sensibly' is not allowed to split a window
4317 horizontally."
4323 "Return non-nil if `split-window-sensibly' may split WINDOW.
4324 Optional argument HORIZONTAL nil or omitted means check whether
4325 `split-window-sensibly' may split WINDOW vertically. HORIZONTAL
4326 non-nil means check whether WINDOW may be split horizontally.
4328 WINDOW may be split vertically when the following conditions
4329 hold:
4330 - `window-size-fixed' is either nil or equals `width' for the
4331 buffer of WINDOW.
4332 - `split-height-threshold' is an integer and WINDOW is at least as
4333 high as `split-height-threshold'.
4334 - When WINDOW is split evenly, the emanating windows are at least
4335 `window-min-height' lines tall and can accommodate at least one
4336 line plus - if WINDOW has one - a mode line.
4338 WINDOW may be split horizontally when the following conditions
4339 hold:
4340 - `window-size-fixed' is either nil or equals `height' for the
4341 buffer of WINDOW.
4342 - `split-width-threshold' is an integer and WINDOW is at least as
4343 wide as `split-width-threshold'.
4344 - When WINDOW is split evenly, the emanating windows are at least
4345 `window-min-width' or two (whichever is larger) columns wide."
4349 ;; A window can be split horizontally when its width is not
4350 ;; fixed, it is at least `split-width-threshold' columns wide
4351 ;; and at least twice as wide as `window-min-width' and 2 (the
4352 ;; latter value is hardcoded).
4354 ;; Testing `window-full-width-p' here hardly makes any
4355 ;; sense nowadays. This can be done more intuitively by
4356 ;; setting up `split-width-threshold' appropriately.
4361 ;; A window can be split vertically when its height is not
4362 ;; fixed, it is at least `split-height-threshold' lines high,
4363 ;; and it is at least twice as high as `window-min-height' and 2
4364 ;; if it has a modeline or 1.
4373 "Split WINDOW in a way suitable for `display-buffer'.
4374 If `split-height-threshold' specifies an integer, WINDOW is at
4375 least `split-height-threshold' lines tall and can be split
4376 vertically, split WINDOW into two windows one above the other and
4377 return the lower window. Otherwise, if `split-width-threshold'
4378 specifies an integer, WINDOW is at least `split-width-threshold'
4379 columns wide and can be split horizontally, split WINDOW into two
4380 windows side by side and return the window on the right. If this
4381 can't be done either and WINDOW is the only window on its frame,
4382 try to split WINDOW vertically disregarding any value specified
4383 by `split-height-threshold'. If that succeeds, return the lower
4384 window. Return nil otherwise.
4386 By default `display-buffer' routines call this function to split
4387 the largest or least recently used window. To change the default
4388 customize the option `split-window-preferred-function'.
4390 You can enforce this function to not split WINDOW horizontally,
4391 by setting (or binding) the variable `split-width-threshold' to
4392 nil. If, in addition, you set `split-height-threshold' to zero,
4393 chances increase that this function does split WINDOW vertically.
4395 In order to not split WINDOW vertically, set (or bind) the
4396 variable `split-height-threshold' to nil. Additionally, you can
4397 set `split-width-threshold' to zero to make a horizontal split
4398 more likely to occur.
4400 Have a look at the function `window-splittable-p' if you want to
4401 know how `split-window-sensibly' determines whether WINDOW can be
4402 split."
4404 ;; Split window vertically.
4408 ;; Split window horizontally.
4413 ;; If WINDOW is the only window on its frame and is not the
4414 ;; minibuffer window, try to split it vertically disregarding
4415 ;; the value of `split-height-threshold'.
4422 "Try to split WINDOW.
4423 Return value returned by `split-window-preferred-function' if it
4424 represents a live window, nil otherwise."
4428 ;; Since `split-window-preferred-function' might
4429 ;; throw an error use `condition-case'.
4436 "Return FRAME if it can be used to display a buffer."
4439 ;; `frame-root-window' may be an internal window which is considered
4440 ;; "dead" by `window-live-p'. Hence if `window' is not live we
4441 ;; implicitly know that `frame' has a visible window we can use.
4444 ;; If the window is soft-dedicated, the frame is usable.
4445 ;; Actually, even if the window is really dedicated,
4446 ;; the frame is still usable by splitting it.
4447 ;; At least Emacs-22 allowed it, and it is desirable
4448 ;; when displaying same-frame windows.
4449 nil ; (eq t (window-dedicated-p window))
4450 ))
4451 frame))))
4454 "If non-nil `display-buffer' will try to even window heights.
4455 Otherwise `display-buffer' will leave the window configuration
4456 alone. Heights are evened only when `display-buffer' chooses a
4457 window that appears above or below the selected window."
4462 "Even heights of WINDOW and selected window.
4463 Do this only if these windows are vertically adjacent to each
4464 other, `even-window-heights' is non-nil, and the selected window
4465 is higher than WINDOW."
4468 ;; Don't resize minibuffer windows.
4479 ;; Don't throw an error if we can't even window heights for
4480 ;; whatever reason.
4486 "Raise the frame containing WINDOW.
4487 Do not raise the selected frame. Return WINDOW."
4491 ;; Assume the selected frame is already visible enough.
4493 ;; Assume the frame from which we invoked the minibuffer
4494 ;; is visible.
4498 window))
4501 "Display BUFFER in WINDOW and make its frame visible.
4502 Set `window-dedicated-p' to DEDICATED if non-nil.
4503 Return WINDOW."
4510 ;; FIXME: Not implemented.
4511 ;; FIXME: By the way, there could be more levels of dedication:
4512 ;; - `barely' dedicated doesn't prevent reuse of the window, only records that
4513 ;; the window hasn't been used for something else yet.
4514 ;; - `softly' dedicated only allows reuse when asked explicitly.
4515 ;; - `strongly' never allows reuse.
4517 "If non-nil, `display-buffer' marks the windows it creates as dedicated.
4518 The actual non-nil value of this variable will be copied to the
4535 ,display-buffer--action-function-custom-type
4540 :key-type symbol
4545 "Overriding action to perform to display a buffer.
4546 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4547 function or a list of functions. Each function should accept two
4548 arguments: a buffer to display and an alist similar to ALIST.
4553 "Alist of conditional actions for `display-buffer'.
4554 This is a list of elements (CONDITION . ACTION), where:
4556 CONDITION is either a regexp matching buffer names, or a function
4557 that takes a buffer and returns a boolean.
4559 ACTION is a cons cell (FUNCTION . ALIST), where FUNCTION is a
4560 function or a list of functions. Each such function should
4561 accept two arguments: a buffer to display and an alist of the
4562 same form as ALIST. See `display-buffer' for details."
4565 regexp
4568 :risky t
4573 "User-specified default action for `display-buffer'.
4574 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4575 function or a list of functions. Each function should accept two
4576 arguments: a buffer to display and an alist similar to ALIST.
4577 See `display-buffer' for details."
4578 :type display-buffer--action-custom-type
4579 :risky t
4585 display-buffer-reuse-window
4586 display-buffer--maybe-pop-up-frame-or-window
4587 display-buffer-use-some-window
4588 ;; If all else fails, pop up a new frame.
4589 display-buffer-pop-up-frame))
4590 "Default fallback action for `display-buffer'.
4591 This is the action used by `display-buffer' if no other actions
4592 specified, e.g. by the user options `display-buffer-alist' or
4597 "Retrieve ALIST entry corresponding to BUFFER-NAME."
4615 display-buffer-pop-up-frame)
4622 "Display BUFFER-OR-NAME in some window, without selecting it.
4623 BUFFER-OR-NAME must be a buffer or the name of an existing
4624 buffer. Return the window chosen for displaying BUFFER-OR-NAME,
4625 or nil if no such window is found.
4627 Optional argument ACTION should have the form (FUNCTION . ALIST).
4628 FUNCTION is either a function or a list of functions.
4629 ALIST is an arbitrary association list (alist).
4631 Each such FUNCTION should accept two arguments: the buffer to
4632 display and an alist. Based on those arguments, it should either
4633 display the buffer and return the window, or return nil if unable
4634 to display the buffer.
4636 The `display-buffer' function builds a function list and an alist
4637 by combining the functions and alists specified in
4638 `display-buffer-overriding-action', `display-buffer-alist', the
4639 ACTION argument, `display-buffer-base-action', and
4640 `display-buffer-fallback-action' (in order). Then it calls each
4641 function in the combined function list in turn, passing the
4642 buffer as the first argument and the combined alist as the second
4643 argument, until one of the functions returns non-nil.
4645 Available action functions include:
4646 `display-buffer-same-window'
4647 `display-buffer-reuse-window'
4648 `display-buffer-pop-up-frame'
4649 `display-buffer-pop-up-window'
4650 `display-buffer-use-some-window'
4652 Recognized alist entries include:
4654 `inhibit-same-window' -- A non-nil value prevents the same
4655 window from being used for display.
4657 `reusable-frames' -- Value specifies frame(s) to search for a
4658 window that already displays the buffer.
4659 See `display-buffer-reuse-window'.
4661 The ACTION argument to `display-buffer' can also have a non-nil
4662 and non-list value. This means to display the buffer in a window
4663 other than the selected one, even if it is already displayed in
4664 the selected window. If called interactively with a prefix
4665 argument, ACTION is t.
4667 Optional argument FRAME, if non-nil, acts like an additional
4668 ALIST entry (reusable-frames . FRAME), specifying the frame(s) to
4669 search for a window that is already displaying the buffer. See
4670 `display-buffer-reuse-window'."
4674 buffer-or-name
4676 ;; Handle the old form of the first argument.
4680 ;; If `display-buffer-function' is defined, let it do the job.
4682 ;; Otherwise, use the defined actions.
4685 display-buffer-alist))
4687 ;; Extra actions from the arguments to this function:
4693 ;; Construct action function list and action alist.
4695 user-action special-action action extra-action
4696 display-buffer-base-action
4697 display-buffer-fallback-action))
4702 actions)))
4704 window)
4710 window))))
4713 "Display buffer BUFFER in another frame.
4714 This uses the function `display-buffer' as a subroutine; see
4715 its documentation for additional customization information."
4719 ;;; `display-buffer' action functions:
4722 "Display BUFFER in the selected window.
4723 This fails if ALIST has a non-nil `inhibit-same-window' entry, or
4724 if the selected window is a minibuffer window or is dedicated to
4725 another buffer; in that case, return nil. Otherwise, return the
4726 selected window."
4734 "Conditionally display BUFFER in the selected window.
4735 If `same-window-p' returns non-nil for BUFFER's name, call
4736 `display-buffer-same-window' and return its value. Otherwise,
4737 return nil."
4742 "Return a window that is already displaying BUFFER.
4743 Return nil if no usable window is found.
4745 If ALIST has a non-nil `inhibit-same-window' entry, the selected
4746 window is not eligible for reuse.
4748 If ALIST contains a `reusable-frames' entry, its value determines
4749 which frames to search for a reusable window:
4750 nil -- the selected frame (actually the last non-minibuffer frame)
4751 A frame -- just that frame
4752 `visible' -- all visible frames
4753 0 -- all frames on the current terminal
4754 t -- all frames.
4756 If ALIST contains no `reusable-frames' entry, search just the
4757 selected frame if `display-buffer-reuse-frames' and
4758 `pop-up-frames' are both nil; search all frames on the current
4759 terminal if either of those variables is non-nil."
4764 pop-up-frames)
4773 frames))))))
4779 "Return special display action for BUFFER, if any.
4780 If `special-display-p' returns non-nil for BUFFER, return an
4781 appropriate display action involving `special-display-function'.
4782 See `display-buffer' for the format of display actions."
4784 ;; `special-display-p' returns either t or a list of frame
4785 ;; parameters to pass to `special-display-function'.
4794 "Display BUFFER in a new frame.
4795 This works by calling `pop-up-frame-function'. If successful,
4796 return the window used; otherwise return nil."
4798 frame window)
4804 ;; Reset list of WINDOW's previous buffers to nil.
4806 window)))
4809 "Display BUFFER by popping up a new window.
4810 The new window is created on the selected frame, or in
4811 `last-nonminibuffer-frame' if no windows can be created there.
4812 If successful, return the new window; otherwise return nil."
4815 window)
4817 ;; If the selected frame cannot be split, look at
4818 ;; `last-nonminibuffer-frame'.
4823 ;; Attempt to split largest or least recently used window.
4830 ;; Reset list of WINDOW's previous buffers to nil.
4832 window)))
4835 "Try displaying BUFFER based on `pop-up-frames' or `pop-up-windows'.
4837 If `pop-up-frames' is non-nil (and not `graphic-only' on a
4838 text-only terminal), try with `display-buffer-pop-up-frame'.
4840 If that cannot be done, and `pop-up-windows' is non-nil, try
4841 again with `display-buffer-pop-up-window'."
4844 pop-up-frames)
4850 "Display BUFFER in an existing window.
4851 Search for a usable window, set that window to the buffer, and
4852 return the window. If no suitable window is found, return nil."
4855 ;; When NOT-THIS-WINDOW is non-nil, temporarily dedicate the
4856 ;; selected window to its buffer, to prevent any of the
4857 ;; `get-' routines below from choosing it. (Bug#1415)
4863 window)
4866 ;; Reuse an existing window.
4871 window))
4876 window))
4879 ;; Restore dedicated status of selected window.
4886 ;;; Display + selection commands:
4889 "Select buffer BUFFER in some window, preferably a different one.
4890 BUFFER may be a buffer, a string (a buffer name), or nil. If it
4891 is a string not naming an existent buffer, create a buffer with
4892 that name. If BUFFER is nil, choose some other buffer. Return
4893 the buffer.
4895 This uses `display-buffer' as a subroutine. The optional ACTION
4896 argument is passed to `display-buffer' as its ACTION argument.
4897 See `display-buffer' for more information. ACTION is t if called
4898 interactively with a prefix argument, which means to pop to a
4899 window other than the selected one even if the buffer is already
4900 displayed in the selected window.
4902 If the window to show BUFFER is not on the selected
4903 frame, raise that window's frame and give it input focus.
4905 Optional third arg NORECORD non-nil means do not put this buffer
4906 at the front of the list of recently selected ones."
4914 ;; If we chose another frame, make sure it gets input focus.
4917 ;; Make sure new window is selected (Bug#8615), (Bug#6954).
4919 buffer))
4922 "Select buffer BUFFER in some window, preferably the same one.
4923 This function behaves much like `switch-to-buffer', except it
4924 displays with `special-display-function' if BUFFER has a match in
4925 `special-display-buffer-names' or `special-display-regexps'.
4927 Unlike `pop-to-buffer', this function prefers using the selected
4928 window over popping up a new window or frame.
4930 BUFFER may be a buffer, a string (a buffer name), or nil. If it
4931 is a string not naming an existent buffer, create a buffer with
4932 that name. If BUFFER is nil, choose some other buffer. Return
4933 the buffer.
4935 NORECORD, if non-nil means do not put this buffer at the front of
4936 the list of recently selected ones."
4940 "Read the name of a buffer to switch to, prompting with PROMPT.
4941 Return the name of the buffer as a string.
4943 This function is intended for the `switch-to-buffer' family of
4944 commands since these need to omit the name of the current buffer
4945 from the list of completions and default values."
4950 ;; Since rbts-completion-table is built dynamically, we
4951 ;; can't just add it to the default value of
4952 ;; icomplete-with-completion-tables, so we add it
4953 ;; here manually.
4958 icomplete-with-completion-tables))))
4963 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
4964 If BUFFER-OR-NAME is nil, return the buffer returned by
4965 `other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
4966 exists, return that buffer. If no such buffer exists, create a
4967 buffer with the name BUFFER-OR-NAME and return that buffer."
4972 buffer))
4976 "Switch to buffer BUFFER-OR-NAME in the selected window.
4977 If called interactively, prompt for the buffer name using the
4978 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
4979 determines whether to request confirmation before creating a new
4980 buffer.
4982 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
4983 nil. If BUFFER-OR-NAME is a string that does not identify an
4984 existing buffer, create a buffer with that name. If
4985 BUFFER-OR-NAME is nil, switch to the buffer returned by
4986 `other-buffer'.
4988 Optional argument NORECORD non-nil means do not put the buffer
4989 specified by BUFFER-OR-NAME at the front of the buffer list and
4990 do not make the window displaying it the most recently selected
4991 one.
4993 If FORCE-SAME-WINDOW is non-nil, BUFFER-OR-NAME must be displayed
4994 in the selected window; signal an error if that is
4995 impossible (e.g. if the selected window is minibuffer-only). If
4996 nil, BUFFER-OR-NAME may be displayed in another window.
4998 Return the buffer switched to."
5003 ;; Don't call set-window-buffer if it's not needed since it
5004 ;; might signal an error (e.g. if the window is dedicated).
5021 "Select the buffer specified by BUFFER-OR-NAME in another window.
5022 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5023 nil. Return the buffer switched to.
5025 If called interactively, prompt for the buffer name using the
5026 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5027 determines whether to request confirmation before creating a new
5028 buffer.
5030 If BUFFER-OR-NAME is a string and does not identify an existing
5031 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5032 nil, switch to the buffer returned by `other-buffer'.
5034 Optional second argument NORECORD non-nil means do not put this
5035 buffer at the front of the list of recently selected ones.
5037 This uses the function `display-buffer' as a subroutine; see its
5038 documentation for additional customization information."
5045 "Switch to buffer BUFFER-OR-NAME in another frame.
5046 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5047 nil. Return the buffer switched to.
5049 If called interactively, prompt for the buffer name using the
5050 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5051 determines whether to request confirmation before creating a new
5052 buffer.
5054 If BUFFER-OR-NAME is a string and does not identify an existing
5055 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5056 nil, switch to the buffer returned by `other-buffer'.
5058 Optional second arg NORECORD non-nil means do not put this
5059 buffer at the front of the list of recently selected ones.
5061 This uses the function `display-buffer' as a subroutine; see its
5062 documentation for additional customization information."
5066 \f
5068 "Set the height in lines of the text display area of WINDOW to HEIGHT.
5069 WINDOW must be a live window. HEIGHT doesn't include the mode
5070 line or header line, if any, or any partial-height lines in the
5071 text display area.
5073 Note that the current implementation of this function cannot
5074 always set the height exactly, but attempts to be conservative,
5075 by allocating more lines than are actually needed in the case
5076 where some error may be present."
5080 ;; Setting window-min-height to a value like 1 can lead to very
5081 ;; bizarre displays because it also allows Emacs to make *other*
5082 ;; windows 1-line tall, which means that there's no more space for
5083 ;; the modeline.
5088 "Make selected window DELTA columns wider.
5089 Interactively, if no argument is given, make selected window one
5090 column wider."
5095 "Make selected window DELTA columns narrower.
5096 Interactively, if no argument is given, make selected window one
5097 column narrower."
5102 "Return the number of screen lines in the region.
5103 The number of screen lines may be different from the number of actual lines,
5104 due to line breaking, display table, etc.
5106 Optional arguments BEG and END default to `point-min' and `point-max'
5107 respectively.
5109 If region ends with a newline, ignore it unless optional third argument
5110 COUNT-FINAL-NEWLINE is non-nil.
5112 The optional fourth argument WINDOW specifies the window used for obtaining
5113 parameters such as width, horizontal scrolling, and so on. The default is
5114 to use the selected window's parameters.
5116 Like `vertical-motion', `count-screen-lines' always uses the current buffer,
5117 regardless of which buffer is displayed in WINDOW. This makes possible to use
5118 `count-screen-lines' in any buffer, whether or not it is currently displayed
5119 in some window."
5125 0
5138 "Return the height (in screen lines) of the buffer that WINDOW is displaying."
5142 ;; If buffer ends with a newline, ignore it when
5143 ;; counting height unless point is after it.
5145 window))))
5147 ;;; Resizing buffers to fit their contents exactly.
5149 "Adjust height of WINDOW to display its buffer's contents exactly.
5150 WINDOW can be any live window and defaults to the selected one.
5152 Optional argument MAX-HEIGHT specifies the maximum height of
5153 WINDOW and defaults to the height of WINDOW's frame. Optional
5154 argument MIN-HEIGHT specifies the minimum height of WINDOW and
5155 defaults to `window-min-height'. Both MAX-HEIGHT and MIN-HEIGHT
5156 are specified in lines and include the mode line and header line,
5157 if any.
5159 Optional argument OVERRIDE non-nil means override restrictions
5160 imposed by `window-min-height' and `window-min-width' on the size
5161 of WINDOW.
5163 Return the number of lines by which WINDOW was enlarged or
5164 shrunk. If an error occurs during resizing, return nil but don't
5165 signal an error.
5167 Note that even if this function makes WINDOW large enough to show
5168 _all_ lines of its buffer you might not see the first lines when
5169 WINDOW was scrolled."
5171 ;; Do all the work in WINDOW and its buffer and restore the selected
5172 ;; window and the current buffer when we're done.
5174 ;; Can't resize a full height or fixed-size window.
5177 ;; `with-selected-window' should orderly restore the current buffer.
5179 ;; We are in WINDOW's buffer now.
5185 window-safe-min-height)))
5188 ;; Adjust MAX-HEIGHT.
5191 max-window-height
5193 ;; Make `desired-height' the height necessary to show
5194 ;; all of WINDOW's buffer, constrained by MIN-HEIGHT
5195 ;; and MAX-HEIGHT.
5200 ;; For non-minibuffers count the mode line, if any.
5202 mode-line-format)
5203 1
5205 ;; Count the header line, if any.
5207 max-height)
5208 min-height))
5217 ;; This `condition-case' shouldn't be necessary, but who knows?
5220 ;; Return zero if DELTA became zero in the process.
5221 0
5222 ;; Don't try to redisplay with the cursor at the end on its
5223 ;; own line--that would force a scroll and spoil things.
5225 ;; It's silly to put `point' at the end of the previous
5226 ;; line and so maybe force horizontal scrolling.
5228 ;; Call `window-resize' with OVERRIDE argument equal WINDOW.
5230 ;; Check if the last line is surely fully visible. If
5231 ;; not, enlarge the window.
5235 ;; Don't include final newline.
5238 ;; If line-wrapping is turned off, test the
5239 ;; beginning of the last line for
5240 ;; visibility instead of the end, as the
5241 ;; end of the line could be invisible by
5242 ;; virtue of extending past the edge of the
5243 ;; window.
5247 ;; This loop might in some rare pathological cases raise
5248 ;; an error - another reason for the `condition-case'.
5255 delta))))
5258 "Return t if WINDOW can be shrunk without shrinking other windows.
5259 WINDOW defaults to the selected window."
5266 "Shrink height of WINDOW if its buffer doesn't need so many lines.
5267 More precisely, shrink WINDOW vertically to be as small as
5268 possible, while still showing the full contents of its buffer.
5269 WINDOW defaults to the selected window.
5271 Do not shrink WINDOW to less than `window-min-height' lines. Do
5272 nothing if the buffer contains more lines than the present window
5273 height, or if some of the window's contents are scrolled out of
5274 view, or if shrinking this window would also shrink another
5275 window, or if the window is the only window of its frame.
5277 Return non-nil if the window was shrunk, nil otherwise."
5280 ;; Make sure that WINDOW is vertically combined and `point-min' is
5281 ;; visible (for whatever reason that's needed). The remaining issues
5282 ;; should be taken care of by `fit-window-to-buffer'.
5286 \f
5288 "Kill the current buffer and delete the selected window."
5297 ;; If `delete-window' failed before, we rerun it to regenerate
5298 ;; the error so it can be seen in the echo area.
5301 ;; If the buffer is not dead for some reason (probably because
5302 ;; of a `quit' signal), remove the hook again.
5307 \f
5309 "Indicates the last recenter operation performed.
5313 "Cycling order for `recenter-top-bottom'.
5314 A list of elements with possible values `top', `middle', `bottom',
5315 integer or float numbers that define the cycling order for
5316 the command `recenter-top-bottom'.
5318 Top and bottom destinations are `scroll-margin' lines from the true
5319 window top and bottom. Middle redraws the frame and centers point
5320 vertically within the window. Integer number moves current line to
5321 the specified absolute window-line. Float number between 0.0 and 1.0
5322 means the percentage of the screen space from the top. The default
5323 cycling order is middle -> top -> bottom."
5334 "Move current buffer line to the specified window line.
5335 With no prefix argument, successive calls place point according
5336 to the cycling order defined by `recenter-positions'.
5338 A prefix argument is handled like `recenter':
5339 With numeric prefix ARG, move current line to window-line ARG.
5340 With plain `C-u', move current line to window center."
5348 recenter-positions))
5367 "Position point relative to window.
5369 With a prefix argument ARG, acts like `move-to-window-line'.
5371 With no argument, positions point at center of window.
5372 Successive calls position point at positions defined
5373 by `recenter-positions'."
5381 recenter-positions))
5398 \f
5399 ;;; Scrolling commands.
5401 ;;; Scrolling commands which do not signal errors at top/bottom
5402 ;;; of buffer at first key-press (instead move to top/bottom
5403 ;;; of buffer).
5406 "Move point to top/bottom of buffer before signaling a scrolling error.
5407 A value of nil means just signal an error if no more scrolling possible.
5408 A value of t means point moves to the beginning or the end of the buffer
5409 \(depending on scrolling direction) when no more scrolling possible.
5410 When point is already on that position, then signal an error."
5416 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
5417 If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
5418 scroll window further, move cursor to the bottom line.
5419 When point is already on that position, then signal an error.
5420 A near full screen is `next-screen-context-lines' less than a full screen.
5421 Negative ARG means scroll downward.
5422 If ARG is the atom `-', scroll downward by nearly full screen."
5438 ;; When scrolling by ARG lines can't be done,
5439 ;; move by ARG lines instead.
5441 ;; When ARG is nil for full-screen scrolling,
5442 ;; move to the bottom of the buffer.
5448 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
5449 If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
5450 scroll window further, move cursor to the top line.
5451 When point is already on that position, then signal an error.
5452 A near full screen is `next-screen-context-lines' less than a full screen.
5453 Negative ARG means scroll upward.
5454 If ARG is the atom `-', scroll upward by nearly full screen."
5470 ;; When scrolling by ARG lines can't be done,
5471 ;; move by ARG lines instead.
5473 ;; When ARG is nil for full-screen scrolling,
5474 ;; move to the top of the buffer.
5479 ;;; Scrolling commands which scroll a line instead of full screen.
5482 "Scroll text of selected window upward ARG lines; or one line if no ARG.
5483 If ARG is omitted or nil, scroll upward by one line.
5484 This is different from `scroll-up-command' that scrolls a full screen."
5491 "Scroll text of selected window down ARG lines; or one line if no ARG.
5492 If ARG is omitted or nil, scroll down by one line.
5493 This is different from `scroll-down-command' that scrolls a full screen."
5499 \f
5502 For more details, see the documentation for `scroll-other-window'."
5505 ;; Just invert the argument's meaning.
5506 ;; We can do that without knowing which window it will be.
5512 "Move point to the beginning of the buffer in the other window.
5513 Leave mark at previous position.
5514 With arg N, put point N/10 of the way from the true beginning."
5518 ;; We use unwind-protect rather than save-window-excursion
5519 ;; because the latter would preserve the things we want to change.
5523 ;; Set point and mark in that window's buffer.
5526 ;; Set point accordingly.
5531 "Move point to the end of the buffer in the other window.
5532 Leave mark at previous position.
5533 With arg N, put point N/10 of the way from the true end."
5535 ;; See beginning-of-buffer-other-window for comments.
5545 \f
5556 "When non-nil, special state of delayed window autoselection.
5557 Possible values are `suspend' (suspend autoselection after a menu or
5558 scrollbar interaction) and `select' (the next invocation of
5562 "Cancel delayed window autoselection.
5563 Optional argument FORCE means cancel unconditionally."
5565 ;; Don't cancel for select-window or select-frame events
5566 ;; or when the user drags a scroll bar.
5578 "Start delayed window autoselection.
5579 MOUSE-POSITION is the last position where the mouse was seen as returned
5580 by `mouse-position'. Optional argument WINDOW non-nil denotes the
5581 window where the mouse was seen. Optional argument SUSPEND non-nil
5582 means suspend autoselection."
5583 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
5587 ;; Install timer which runs `mouse-autoselect-window-select' after
5588 ;; `mouse-autoselect-window' seconds.
5594 "Select window with delayed window autoselection.
5595 If the mouse position has stabilized in a non-selected window, select
5596 that window. The minibuffer window is selected only if the minibuffer
5597 is active. This function is run by `mouse-autoselect-window-timer'."
5608 ;; A menu / popup dialog is active or the mouse is on the scroll-bar
5609 ;; of WINDOW, temporarily suspend delayed autoselection.
5612 ;; Delayed autoselection was temporarily suspended, reenable it.
5617 ;; If `mouse-autoselect-window' is positive, select
5618 ;; window if the window is the same as before.
5620 ;; Otherwise select window if the mouse is at the same
5621 ;; position as before. Observe that the first test after
5622 ;; starting autoselection usually fails since the value of
5623 ;; `mouse-autoselect-window-position' recorded there is the
5624 ;; position where the mouse has entered the new window and
5625 ;; not necessarily where the mouse has stopped moving.
5627 ;; The minibuffer is a candidate window if it's active.
5630 ;; Mouse position has stabilized in non-selected window: Cancel
5631 ;; delayed autoselection and try to select that window.
5633 ;; Select window where mouse appears unless the selected window is the
5634 ;; minibuffer. Use `unread-command-events' in order to execute pre-
5635 ;; and post-command hooks and trigger idle timers. To avoid delaying
5636 ;; autoselection again, set `mouse-autoselect-window-state'."
5641 unread-command-events))))
5645 ;; Mouse position has either stabilized in the selected window or at
5646 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
5649 ;; Mouse position has not stabilized yet, resume delayed
5650 ;; autoselection.
5654 "Handle select-window events."
5658 ;; Don't switch if we're currently in the minibuffer.
5659 ;; This tries to work around problems where the
5660 ;; minibuffer gets unselected unexpectedly, and where
5661 ;; you then have to move your mouse all the way down to
5662 ;; the minibuffer to select it.
5664 ;; Don't switch to minibuffer window unless it's active.
5667 ;; Don't switch when autoselection shall be delayed.
5672 ;; Cancel any delayed autoselection.
5674 ;; Start delayed autoselection from current mouse
5675 ;; position and window.
5677 ;; Executing a command cancels delayed autoselection.
5681 ;; Reset state of delayed autoselection.
5683 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
5688 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
5689 WINDOW defaults to the selected window.
5690 Return nil if WINDOW is not a partial-width window
5691 (regardless of the value of `truncate-lines').
5692 Otherwise, consult the value of `truncate-partial-width-windows'
5693 for the buffer shown in WINDOW."
5701 t-p-w-w))))
5702 \f
5703 ;; Some of these are in tutorial--default-keys, so update that if you
5704 ;; change these.
5717 ;;; window.el ends here