| blob | 999e408bdb112a800ae58404a84b66f85151f949 |
1 ;;; window.el --- GNU Emacs window commands aside from those written in C
3 ;; Copyright (C) 1985, 1989, 1992-1994, 2000-2011
4 ;; Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: internal
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; Window tree functions.
29 ;;; Code:
34 "Execute BODY, then select the previously selected window.
35 The value returned is the value of the last form in BODY.
37 This macro saves and restores the selected window, as well as the
38 selected window in each frame. If the previously selected window
39 is no longer live, then whatever window is selected at the end of
40 BODY remains selected. If the previously selected window of some
41 frame is no longer live at the end of BODY, that frame's selected
42 window is left alone.
44 This macro saves and restores the current buffer, since otherwise
45 its normal operation could make a different buffer current. The
46 order of recently selected windows and the buffer list ordering
47 are not altered by this macro (unless they are altered in BODY)."
50 ;; It is necessary to save all of these, because calling
51 ;; select-window changes frame-selected-window for whatever
52 ;; frame that window is in.
66 ;; The following two functions are like `window-next-sibling' and
67 ;; `window-prev-sibling' but the WINDOW argument is _not_ optional (so
68 ;; they don't substitute the selected window for nil), and they return
69 ;; nil when WINDOW doesn't have a parent (like a frame's root window or
70 ;; a minibuffer window).
72 "Return WINDOW's right sibling.
73 Return nil if WINDOW is the root window of its frame. WINDOW can
74 be any window."
78 "Return WINDOW's left sibling.
79 Return nil if WINDOW is the root window of its frame. WINDOW can
80 be any window."
84 "Return WINDOW's first child window."
88 "Return number of WINDOW's child windows."
94 count))
97 "Return last child window of WINDOW."
101 window)
104 "Return t if OBJECT denotes a live or internal window."
107 t))
110 "Return buffer specified by BUFFER-OR-NAME.
111 BUFFER-OR-NAME must be either a buffer or a string naming a live
112 buffer and defaults to the current buffer."
118 buffer-or-name
125 "Return frame specified by FRAME.
126 FRAME must be a live frame and defaults to the selected frame."
129 frame
134 "Return window specified by WINDOW.
135 WINDOW must be a window that has not been deleted and defaults to
136 the selected window."
139 window
144 "Return live window specified by WINDOW.
145 WINDOW must be a live window and defaults to the selected one."
148 window
153 "If non-nil, standard functions ignore window parameters.
154 The functions currently affected by this are `split-window',
155 `delete-window', `delete-other-windows' and `other-window'.
157 An application may bind this to a non-nil value around calls to
161 "The absolut minimum number of lines of a window.
165 "The minimum number of lines of any window.
166 The value has to accommodate a mode- or header-line if present.
167 A value less than `window-safe-min-height' is ignored. The value
168 of this variable is honored when windows are resized or split.
170 Applications should never rebind this variable. To resize a
171 window to a height less than the one specified here, an
172 application should instead call `window-resize' with a non-nil
173 IGNORE argument. In order to have `split-window' make a window
174 shorter, explictly specify the SIZE argument of that function."
180 "The absolut minimum number of columns of a window.
184 "The minimum number of columns of any window.
185 The value has to accomodate margins, fringes, or scrollbars if
186 present. A value less than `window-safe-min-width' is ignored.
187 The value of this variable is honored when windows are resized or
188 split.
190 Applications should never rebind this variable. To resize a
191 window to a width less than the one specified here, an
192 application should instead call `window-resize' with a non-nil
193 IGNORE argument. In order to have `split-window' make a window
194 narrower, explictly specify the SIZE argument of that function."
200 "If WINDOW is a vertical combination return WINDOW's first child.
201 WINDOW can be any window and defaults to the selected one.
202 Optional argument HORIZONTAL non-nil means return WINDOW's first
203 child if WINDOW is a horizontal combination."
210 "Return non-nil if and only if WINDOW is vertically combined.
211 WINDOW can be any window and defaults to the selected one.
212 Optional argument HORIZONTAL non-nil means return non-nil if and
213 only if WINDOW is horizontally combined."
219 "Return largest number of vertically arranged subwindows of WINDOW.
220 WINDOW can be any window and defaults to the selected one.
221 Optional argument HORIZONTAL non-nil means to return the largest
222 number of horizontally arranged subwindows of WINDOW."
226 ;; If WINDOW is live, return 1.
229 ;; If WINDOW is iso-combined, return the sum of the values for all
230 ;; subwindows of WINDOW.
236 count))
238 count))
240 ;; If WINDOW is not iso-combined, return the maximum value of any
241 ;; subwindow of WINDOW.
247 count))
249 count))))
252 "Helper function for `walk-window-tree' and `walk-window-subtree'."
270 "Run function PROC on each live window of FRAME.
271 PROC must be a function with one argument - a window. FRAME must
272 be a live frame and defaults to the selected one. ANY, if
273 non-nil means to run PROC on all live and internal windows of
274 FRAME.
276 This function performs a pre-order, depth-first traversal of the
277 window tree. If PROC changes the window tree, the result is
278 unpredictable."
284 "Run function PROC on each live subwindow of WINDOW.
285 WINDOW defaults to the selected window. PROC must be a function
286 with one argument - a window. ANY, if non-nil means to run PROC
287 on all live and internal subwindows of WINDOW.
289 This function performs a pre-order, depth-first traversal of the
290 window tree rooted at WINDOW. If PROC changes that window tree,
291 the result is unpredictable."
296 "Return a list of all windows on FRAME with PARAMETER non-nil.
297 FRAME defaults to the selected frame. Optional argument VALUE
298 non-nil means only return windows whose window-parameter value of
299 PARAMETER equals VALUE \(comparison is done using `equal').
300 Optional argument ANY non-nil means consider internal windows
301 too. Optional argument VALUES non-nil means return a list of cons
302 cells whose car is the value of the parameter and whose cdr is
303 the window."
313 frame any)
318 "Return first window on FRAME with PARAMETER non-nil.
319 FRAME defaults to the selected frame. Optional argument VALUE
320 non-nil means only return a window whose window-parameter value
321 for PARAMETER equals VALUE \(comparison is done with `equal').
322 Optional argument ANY non-nil means consider internal windows
323 too."
331 frame any))))
333 ;;; Atomic windows.
335 "Return root of atomic window WINDOW is a part of.
336 WINDOW can be any window and defaults to the selected one.
337 Return nil if WINDOW is not part of a atomic window."
343 root))
346 "Make WINDOW an atomic window.
347 WINDOW must be an internal window. Return WINDOW."
353 window t)
354 window))
357 "Subroutine of `window-atom-check'."
367 window t))
368 ;; count >= 1 must hold here. If there's no other
369 ;; window around dissolve this atomic window.
371 ;; Dissolve atomic window.
375 window t)))
376 ;; Check children.
380 ;; Check right sibling
384 "Check atomicity of all windows on FRAME.
385 FRAME defaults to the selected frame. If an atomic window is
386 wrongly configured, reset the atomicity of all its subwindows to
387 nil. An atomic window is wrongly configured if it has no
388 subwindows or one of its subwindows is not atomic."
391 ;; Side windows.
396 "If non-nil, left and right side windows are full height.
397 Otherwise, top and bottom side windows are full width."
403 "Maximum number of side window slots.
404 The value is a list of four elements specifying the number of
405 side window slots on \(in this order) the left, top, right and
406 bottom side of each frame. If an element is a number, this means
407 to display at most that many side windows on the corresponding
408 side. If an element is nil, this means there's no bound on the
409 number of slots on that side."
410 :risky t
411 :type
417 :value nil
424 :value nil
431 :value nil
438 :value nil
445 "Check the window-side parameter of all windows on FRAME.
446 FRAME defaults to the selected frame. If the configuration is
447 invalid, reset all window-side parameters to nil.
449 A valid configuration has to preserve the following invariant:
451 - If a window has a non-nil window-side parameter, it must have a
452 parent window and the parent window's window-side parameter
453 must be either nil or the same as for window.
455 - If windows with non-nil window-side parameters exist, there
456 must be at most one window of each side and non-side with a
457 parent whose window-side parameter is nil and there must be no
458 leaf window whose window-side parameter is nil."
460 side parent parent-side code)
468 ;; The following `cond' seems a bit tedious, but I'd
469 ;; rather stick to using just the stack.
473 ;; A parent whose window-side is non-nil must
474 ;; have a child with the same window-side.
476 ;; Now check that there's more than one main window
477 ;; for any of none, left, top, right and bottom.
499 ;; A leaf window without window-side parameter,
500 ;; record its existence.
502 frame t))
504 ;; At least one non-side window exists, so there must
505 ;; be at least one side-window and no normal window.
507 ;; No non-side window exists, so there must be no side
508 ;; window either.
513 frame t))))
516 "Check atomic and side windows on FRAME.
517 FRAME defaults to the selected frame."
521 ;;; Window sizes.
523 "Non-nil in a buffer means windows displaying the buffer are fixed-size.
524 If the value is `height', then only the window's height is fixed.
525 If the value is `width', then only the window's width is fixed.
526 Any other non-nil value fixes both the width and the height.
528 Emacs won't change the size of any window displaying that buffer,
529 unless it has no other choice \(like when deleting a neighboring
534 "Return non-nil if IGNORE says to ignore size restrictions for WINDOW."
538 "Return the minimum number of lines of WINDOW.
539 WINDOW can be an arbitrary window and defaults to the selected
540 one. Optional argument HORIZONTAL non-nil means return the
541 minimum number of columns of WINDOW.
543 Optional argument IGNORE non-nil means ignore any restrictions
544 imposed by fixed size windows, `window-min-height' or
545 `window-min-width' settings. IGNORE equal `safe' means live
546 windows may get as small as `window-safe-min-height' lines and
547 `window-safe-min-width' columns. IGNORE a window means ignore
548 restrictions for that window only."
553 "Internal function of `window-min-size'."
557 ;; WINDOW is an internal window.
559 ;; The minimum size of an iso-combination is the sum of
560 ;; the minimum sizes of its subwindows.
565 ;; The minimum size of an ortho-combination is the maximum of
566 ;; the minimum sizes of its subwindows.
571 value)
576 ;; The minimum size of a fixed size window is its size.
579 ;; If IGNORE equals `safe' or WINDOW return the safe values.
582 ;; For the minimum width of a window take fringes and
583 ;; scroll-bars into account. This is questionable and should
584 ;; be removed as soon as we are able to split (and resize)
585 ;; windows such that the new (or resized) windows can get a
586 ;; size less than the user-specified `window-min-height' and
587 ;; `window-min-width'.
592 (+ window-safe-min-width
605 window-min-width
608 ;; For the minimum height of a window take any mode- or
609 ;; header-line into account.
615 window-min-height
619 "Return DELTA if DELTA lines can be added to WINDOW.
620 Optional argument HORIZONTAL non-nil means return DELTA if DELTA
621 columns can be added to WINDOW. A return value of zero means
622 that no lines (or columns) can be added to WINDOW.
624 This function looks only at WINDOW and its subwindows. The
625 function `window-resizable' looks at other windows as well.
627 DELTA positive means WINDOW shall be enlarged by DELTA lines or
628 columns. If WINDOW cannot be enlarged by DELTA lines or columns
629 return the maximum value in the range 0..DELTA by which WINDOW
630 can be enlarged.
632 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
633 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
634 return the minimum value in the range DELTA..0 by which WINDOW
635 can be shrunk.
637 Optional argument IGNORE non-nil means ignore any restrictions
638 imposed by fixed size windows, `window-min-height' or
639 `window-min-width' settings. IGNORE equal `safe' means live
640 windows may get as small as `window-safe-min-height' lines and
641 `window-safe-min-width' columns. IGNORE any window means ignore
642 restrictions for that window only."
648 delta))
650 delta)
653 0
654 delta))
658 "Return t if WINDOW can be resized by DELTA lines.
659 For the meaning of the arguments of this function see the
660 doc-string of `window-sizable'."
667 "Internal function for `window-size-fixed-p'."
671 ;; WINDOW is an internal window.
673 ;; An iso-combination is fixed size if all its subwindows
674 ;; are fixed-size.
678 ;; We found a non-fixed-size subwindow, so WINDOW's
679 ;; size is not fixed.
682 ;; All subwindows are fixed-size, so WINDOW's size is
683 ;; fixed.
685 ;; An ortho-combination is fixed-size if at least one of its
686 ;; subwindows is fixed-size.
689 ;; We found a fixed-size subwindow, so WINDOW's size is
690 ;; fixed.
693 ;; WINDOW is a live window.
700 "Return non-nil if WINDOW's height is fixed.
701 WINDOW can be an arbitrary window and defaults to the selected
702 window. Optional argument HORIZONTAL non-nil means return
703 non-nil if WINDOW's width is fixed.
705 If this function returns nil, this does not necessarily mean that
706 WINDOW can be resized in the desired direction. The functions
707 `window-resizable' and `window-resizable-p' will tell that."
712 "Internal function for `window-min-delta'."
714 ;; If we can't go up, return zero.
715 0
716 ;; Else try to find a non-fixed-size sibling of WINDOW.
721 ;; In an iso-combination throw DELTA if we find at least one
722 ;; subwindow and that subwindow is either not of fixed-size
723 ;; or we can ignore fixed-sizeness.
733 ;; We found a non-fixed-size subwindow.
736 ;; In an ortho-combination set DELTA to the minimum value by
737 ;; which other subwindows can shrink.
746 delta
750 "Return number of lines by which WINDOW can be shrunk.
751 WINDOW can be an arbitrary window and defaults to the selected
752 window. Return zero if WINDOW cannot be shrunk.
754 Optional argument HORIZONTAL non-nil means return number of
755 columns by which WINDOW can be shrunk.
757 Optional argument IGNORE non-nil means ignore any restrictions
758 imposed by fixed size windows, `window-min-height' or
759 `window-min-width' settings. IGNORE a window means ignore
760 restrictions for that window only. IGNORE equal `safe' means
761 live windows may get as small as `window-safe-min-height' lines
762 and `window-safe-min-width' columns.
764 Optional argument TRAIL `before' means only windows to the left
765 of or above WINDOW can be enlarged. Optional argument TRAIL
766 `after' means only windows to the right of or below WINDOW can be
767 enlarged.
769 Optional argument NOUP non-nil means don't go up in the window
770 tree but try to enlarge windows within WINDOW's combination only.
772 Optional argument NODOWN non-nil means don't check whether WINDOW
773 itself \(and its subwindows) can be shrunk; check only whether at
774 least one other windows can be enlarged appropriately."
780 ;; If NODOWN is t, try to recover the entire size of WINDOW.
783 ;; If NODOWN is nil and WINDOW's size is already at its minimum,
784 ;; there's nothing to recover.
787 ;; Otherwise, try to recover whatever WINDOW is larger than its
788 ;; minimum size.
793 "Internal function of `window-max-delta'."
795 ;; Can't go up. Return DELTA.
796 delta
801 ;; For an iso-combination calculate how much we can get from
802 ;; other subwindows.
811 (+ delta
815 ;; For an ortho-combination throw DELTA when at least one
816 ;; subwindow is fixed-size.
824 ;; When NOUP is nil, DELTA is all we can get.
825 delta
826 ;; Else try with parent of WINDOW, passing the DELTA we
827 ;; recovered so far.
831 "Return maximum number of lines WINDOW by which WINDOW can be enlarged.
832 WINDOW can be an arbitrary window and defaults to the selected
833 window. The return value is zero if WINDOW cannot be enlarged.
835 Optional argument HORIZONTAL non-nil means return maximum number
836 of columns by which WINDOW can be enlarged.
838 Optional argument IGNORE non-nil means ignore any restrictions
839 imposed by fixed size windows, `window-min-height' or
840 `window-min-width' settings. IGNORE a window means ignore
841 restrictions for that window only. IGNORE equal `safe' means
842 live windows may get as small as `window-safe-min-height' lines
843 and `window-safe-min-width' columns.
845 Optional argument TRAIL `before' means only windows to the left
846 of or below WINDOW can be shrunk. Optional argument TRAIL
847 `after' means only windows to the right of or above WINDOW can be
848 shrunk.
850 Optional argument NOUP non-nil means don't go up in the window
851 tree but try to obtain the entire space from windows within
852 WINDOW's combination.
854 Optional argument NODOWN non-nil means do not check whether
855 WINDOW itself \(and its subwindows) can be enlarged; check only
856 whether other windows can be shrunk appropriately."
860 ;; With IGNORE and NOWDON nil return zero if WINDOW has fixed
861 ;; size.
862 0
863 ;; WINDOW has no fixed size.
866 ;; Make NOUP also inhibit the min-size check.
868 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
869 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
870 can be resized horizontally by DELTA columns. A return value of
871 zero means that WINDOW is not resizable.
873 DELTA positive means WINDOW shall be enlarged by DELTA lines or
874 columns. If WINDOW cannot be enlarged by DELTA lines or columns
875 return the maximum value in the range 0..DELTA by which WINDOW
876 can be enlarged.
878 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
879 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
880 return the minimum value in the range DELTA..0 that can be used
881 for shrinking WINDOW.
883 Optional argument IGNORE non-nil means ignore any restrictions
884 imposed by fixed size windows, `window-min-height' or
885 `window-min-width' settings. IGNORE a window means ignore
886 restrictions for that window only. IGNORE equal `safe' means
887 live windows may get as small as `window-safe-min-height' lines
888 and `window-safe-min-width' columns.
890 Optional argument TRAIL `before' means only windows to the left
891 of or below WINDOW can be shrunk. Optional argument TRAIL
892 `after' means only windows to the right of or above WINDOW can be
893 shrunk.
895 Optional argument NOUP non-nil means don't go up in the window
896 tree but try to distribute the space among the other windows
897 within WINDOW's combination.
899 Optional argument NODOWN non-nil means don't check whether WINDOW
900 and its subwindows can be resized."
905 delta))
908 delta))
912 "Return t if WINDOW can be resized vertically by DELTA lines.
913 For the meaning of the arguments of this function see the
914 doc-string of `window-resizable'."
918 delta)
920 delta)))
923 "Return the total number of lines of WINDOW.
924 WINDOW can be any window and defaults to the selected one. The
925 return value includes WINDOW's mode line and header line, if any.
926 If WINDOW is internal the return value is the sum of the total
927 number of lines of WINDOW's child windows if these are vertically
928 combined and the height of WINDOW's first child otherwise.
930 Note: This function does not take into account the value of
931 `line-spacing' when calculating the number of lines in WINDOW."
934 ;; Eventually we should make `window-height' obsolete.
937 ;; See discussion in bug#4543.
939 "Return t if WINDOW is as high as the containing frame.
940 More precisely, return t if and only if the total height of
941 WINDOW equals the total height of the root window of WINDOW's
942 frame. WINDOW can be any window and defaults to the selected
943 one."
949 "Return the total number of columns of WINDOW.
950 WINDOW can be any window and defaults to the selected one. The
951 return value includes any vertical dividers or scrollbars of
952 WINDOW. If WINDOW is internal, the return value is the sum of
953 the total number of columns of WINDOW's child windows if these
954 are horizontally combined and the width of WINDOW's first child
955 otherwise."
959 "Return t if WINDOW is as wide as the containing frame.
960 More precisely, return t if and only if the total width of WINDOW
961 equals the total width of the root window of WINDOW's frame.
962 WINDOW can be any window and defaults to the selected one."
968 "Return the number of lines of WINDOW's body.
969 WINDOW must be a live window and defaults to the selected one.
971 The return value does not include WINDOW's mode line and header
972 line, if any. If a line at the bottom of the window is only
973 partially visible, that line is included in the return value. If
974 you do not want to include a partially visible bottom line in the
975 return value, use `window-text-height' instead."
979 "Return the number of columns of WINDOW's body.
980 WINDOW must be a live window and defaults to the selected one.
982 The return value does not include any vertical dividers or scroll
983 bars owned by WINDOW. On a window-system the return value does
984 not include the number of columns used for WINDOW's fringes or
985 display margins either."
988 ;; Eventually we should make `window-height' obsolete.
992 "Return the current scroll bar settings for WINDOW.
993 WINDOW must be a live window and defaults to the selected one.
995 The return value is a cons cell (VERTICAL . HORIZONTAL) where
996 VERTICAL specifies the current location of the vertical scroll
997 bars (`left', `right', or nil), and HORIZONTAL specifies the
998 current location of the horizontal scroll bars (`top', `bottom',
999 or nil).
1001 Unlike `window-scroll-bars', this function reports the scroll bar
1002 type actually used, once frame defaults and `scroll-bar-mode' are
1003 taken into account."
1016 "Cycle through all live windows, calling PROC for each one.
1017 PROC must specify a function with a window as its sole argument.
1018 The optional arguments MINIBUF and ALL-FRAMES specify the set of
1019 windows to include in the walk.
1021 MINIBUF t means include the minibuffer window even if the
1022 minibuffer is not active. MINIBUF nil or omitted means include
1023 the minibuffer window only if the minibuffer is active. Any
1024 other value means do not include the minibuffer window even if
1025 the minibuffer is active.
1027 ALL-FRAMES nil or omitted means consider all windows on the
1028 selected frame, plus the minibuffer window if specified by the
1029 MINIBUF argument. If the minibuffer counts, consider all windows
1030 on all frames that share that minibuffer too. The following
1031 non-nil values of ALL-FRAMES have special meanings:
1033 - t means consider all windows on all existing frames.
1035 - `visible' means consider all windows on all visible frames on
1036 the current terminal.
1038 - 0 (the number zero) means consider all windows on all visible
1039 and iconified frames on the current terminal.
1041 - A frame means consider all windows on that frame only.
1043 Anything else means consider all windows on the selected frame
1044 and no others.
1046 This function changes neither the order of recently selected
1047 windows nor the buffer list."
1048 ;; If we start from the minibuffer window, don't fail to come
1049 ;; back to it.
1052 ;; Make sure to not mess up the order of recently selected
1053 ;; windows. Use `save-selected-window' and `select-window'
1054 ;; with second argument non-nil for this purpose.
1062 "Support function for `window-in-direction'."
1074 "Return window in DIRECTION as seen from WINDOW.
1075 DIRECTION must be one of `above', `below', `left' or `right'.
1076 WINDOW must be a live window and defaults to the selected one.
1077 IGNORE, when non-nil means a window can be returned even if its
1078 `no-other-window' parameter is non-nil."
1091 ;; The column / row value of `posn-at-point' can be nil for the
1092 ;; mini-window, guard against that.
1103 best best-2 best-diff-2-new)
1110 ;; Ignore ourselves.
1112 ;; Ignore W unless IGNORE is non-nil.
1118 ;; W is to the left or right of WINDOW and covers POSN.
1128 ;; W is to the left or right of WINDOW but does not
1129 ;; cover POSN.
1144 ;; W is above or below WINDOW and covers POSN.
1154 ;; W is above or below WINDOW but does not cover POSN.
1169 "Return a live window satisfying PREDICATE.
1170 More precisely, cycle through all windows calling the function
1171 PREDICATE on each one of them with the window as its sole
1172 argument. Return the first window for which PREDICATE returns
1173 non-nil. Windows are scanned starting with the window following
1174 the selcted window. If no window satisfies PREDICATE, return
1175 DEFAULT.
1177 MINIBUF t means include the minibuffer window even if the
1178 minibuffer is not active. MINIBUF nil or omitted means include
1179 the minibuffer window only if the minibuffer is active. Any
1180 other value means do not include the minibuffer window even if
1181 the minibuffer is active.
1183 ALL-FRAMES nil or omitted means consider all windows on the selected
1184 frame, plus the minibuffer window if specified by the MINIBUF
1185 argument. If the minibuffer counts, consider all windows on all
1186 frames that share that minibuffer too. The following non-nil
1187 values of ALL-FRAMES have special meanings:
1189 - t means consider all windows on all existing frames.
1191 - `visible' means consider all windows on all visible frames on
1192 the current terminal.
1194 - 0 (the number zero) means consider all windows on all visible
1195 and iconified frames on the current terminal.
1197 - A frame means consider all windows on that frame only.
1199 Anything else means consider all windows on the selected frame
1200 and no others."
1204 minibuf all-frames))
1207 default))
1212 "Return the least recently used window on frames specified by ALL-FRAMES.
1213 Return a full-width window if possible. A minibuffer window is
1214 never a candidate. A dedicated window is never a candidate
1215 unless DEDICATED is non-nil, so if all windows are dedicated, the
1216 value is nil. Avoid returning the selected window if possible.
1218 The following non-nil values of the optional argument ALL-FRAMES
1219 have special meanings:
1221 - t means consider all windows on all existing frames.
1223 - `visible' means consider all windows on all visible frames on
1224 the current terminal.
1226 - 0 (the number zero) means consider all windows on all visible
1227 and iconified frames on the current terminal.
1229 - A frame means consider all windows on that frame only.
1231 Any other value of ALL-FRAMES means consider all windows on the
1232 selected frame and no others."
1248 "Return the most recently used window on frames specified by ALL-FRAMES.
1249 Do not return a minibuffer window.
1251 The following non-nil values of the optional argument ALL-FRAMES
1252 have special meanings:
1254 - t means consider all windows on all existing frames.
1256 - `visible' means consider all windows on all visible frames on
1257 the current terminal.
1259 - 0 (the number zero) means consider all windows on all visible
1260 and iconified frames on the current terminal.
1262 - A frame means consider all windows on that frame only.
1264 Any other value of ALL-FRAMES means consider all windows on the
1265 selected frame and no others."
1272 best-window))
1275 "Return the largest window on frames specified by ALL-FRAMES.
1276 A minibuffer window is never a candidate. A dedicated window is
1277 never a candidate unless DEDICATED is non-nil, so if all windows
1278 are dedicated, the value is nil.
1280 The following non-nil values of the optional argument ALL-FRAMES
1281 have special meanings:
1283 - t means consider all windows on all existing frames.
1285 - `visible' means consider all windows on all visible frames on
1286 the current terminal.
1288 - 0 (the number zero) means consider all windows on all visible
1289 and iconified frames on the current terminal.
1291 - A frame means consider all windows on that frame only.
1293 Any other value of ALL-FRAMES means consider all windows on the
1294 selected frame and no others."
1296 best-window size)
1304 best-window))
1307 "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
1308 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
1309 and defaults to the current buffer. Windows are scanned starting
1310 with the selected window.
1312 MINIBUF t means include the minibuffer window even if the
1313 minibuffer is not active. MINIBUF nil or omitted means include
1314 the minibuffer window only if the minibuffer is active. Any
1315 other value means do not include the minibuffer window even if
1316 the minibuffer is active.
1318 ALL-FRAMES nil or omitted means consider all windows on the
1319 selected frame, plus the minibuffer window if specified by the
1320 MINIBUF argument. If the minibuffer counts, consider all windows
1321 on all frames that share that minibuffer too. The following
1322 non-nil values of ALL-FRAMES 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 Anything else means consider all windows on the selected frame
1335 and no others."
1337 windows)
1344 "Return t if WINDOW is the currently active minibuffer window."
1348 "Return the number of live windows on the selected frame.
1349 The optional argument MINIBUF specifies whether the minibuffer
1350 window shall be counted. See `walk-windows' for the precise
1351 meaning of this argument."
1353 \f
1354 ;;; Resizing windows.
1356 "Reset resize values for all windows on FRAME.
1357 FRAME defaults to the selected frame.
1359 This function stores the current value of `window-total-size' applied
1360 with argument HORIZONTAL in the new total size of all windows on
1361 FRAME. It also resets the new normal size of each of these
1362 windows."
1367 "Internal function of `window--resize-reset'."
1368 ;; Register old size in the new total size.
1370 ;; Reset new normal size.
1377 ;; The following routine is used to manually resize the minibuffer
1378 ;; window and is currently used, for example, by ispell.el.
1380 "Resize minibuffer window WINDOW by DELTA lines.
1381 If WINDOW cannot be resized by DELTA lines make it as large \(or
1382 as small) as possible but don't signal an error."
1390 ;; Sanitize DELTA.
1397 ;; Resize now.
1399 ;; Ideally we should be able to resize just the last subwindow of
1400 ;; root here. See the comment in `resize-root-window-vertically'
1401 ;; for why we do not do that.
1404 ;; The following routine catches the case where we want to resize
1405 ;; a minibuffer-only frame.
1409 "Resize WINDOW vertically by DELTA lines.
1410 WINDOW can be an arbitrary window and defaults to the selected
1411 one. An attempt to resize the root window of a frame will raise
1412 an error though.
1414 DELTA a positive number means WINDOW shall be enlarged by DELTA
1415 lines. DELTA negative means WINDOW shall be shrunk by -DELTA
1416 lines.
1418 Optional argument HORIZONTAL non-nil means resize WINDOW
1419 horizontally by DELTA columns. In this case a positive DELTA
1420 means enlarge WINDOW by DELTA columns. DELTA negative means
1421 WINDOW shall be shrunk by -DELTA columns.
1423 Optional argument IGNORE non-nil means ignore any restrictions
1424 imposed by fixed size windows, `window-min-height' or
1425 `window-min-width' settings. IGNORE any window means ignore
1426 restrictions for that window only. IGNORE equal `safe' means
1427 live windows may get as small as `window-safe-min-height' lines
1428 and `window-safe-min-width' columns.
1430 This function resizes other windows proportionally and never
1431 deletes any windows. If you want to move only the low (right)
1432 edge of WINDOW consider using `adjust-window-trailing-edge'
1433 instead."
1436 sibling)
1449 ;; If window-splits returns nil for WINDOW, WINDOW is part of
1450 ;; an iso-combination, and WINDOW's neighboring right or left
1451 ;; sibling can be resized as requested, resize that sibling.
1458 normal-delta))
1461 normal-delta)))
1462 ;; Otherwise, resize all other windows in the same combination.
1469 "Return non-nil if WINDOW shall be skipped by resizing routines."
1472 (defun window--resize-subwindows-normal (parent horizontal window this-delta &optional trail other-delta)
1473 "Set the new normal height of subwindows of window PARENT.
1474 HORIZONTAL non-nil means set the new normal width of these
1475 windows. WINDOW specifies a subwindow of PARENT that has been
1476 resized by THIS-DELTA lines \(columns).
1478 Optional argument TRAIL either 'before or 'after means set values
1479 for windows before or after WINDOW only. Optional argument
1480 OTHER-DELTA a number specifies that this many lines \(columns)
1481 have been obtained from \(or returned to) an ancestor window of
1482 PARENT in order to resize WINDOW."
1486 ;; When WINDOW gets deleted and we can return its entire
1487 ;; space to its siblings, use WINDOW's normal size as the
1488 ;; normal delta.
1490 ;; In any other case calculate the normal delta from the
1491 ;; relation of THIS-DELTA to the total size of PARENT.
1497 ;; Set parent-normal to the sum of the normal sizes of all
1498 ;; subwindows of PARENT that shall be resized, excluding only WINDOW
1499 ;; and any windows specified by the optional TRAIL argument.
1510 ;; Set the new normal size of all subwindows of PARENT from what
1511 ;; they should have contributed for recovering THIS-DELTA lines
1512 ;; (columns).
1526 delta-normal))
1527 ;; Don't drop below 0.
1532 ;; Set the new normal size of windows from what they should have
1533 ;; contributed for recovering OTHER-DELTA lines (columns).
1536 other-delta)))
1548 ;; Don't drop below 0.
1552 ;; Set the new normal size of WINDOW to what is left by the sum of
1553 ;; the normal sizes of its siblings.
1555 window
1566 ;; Don't get larger than 1 or smaller than 0.
1570 "Resize subwindows of window PARENT vertically by DELTA lines.
1571 PARENT must be a vertically combined internal window.
1573 Optional argument HORIZONTAL non-nil means resize subwindows of
1574 PARENT horizontally by DELTA columns. In this case PARENT must
1575 be a horizontally combined internal window.
1577 WINDOW, if specified, must denote a child window of PARENT that
1578 is resized by DELTA lines.
1580 Optional argument IGNORE non-nil means ignore any restrictions
1581 imposed by fixed size windows, `window-min-height' or
1582 `window-min-width' settings. IGNORE equal `safe' means live
1583 windows may get as small as `window-safe-min-height' lines and
1584 `window-safe-min-width' columns. IGNORE any window means ignore
1585 restrictions for that window only.
1587 Optional arguments TRAIL and EDGE, when non-nil, restrict the set
1588 of windows that shall be resized. If TRAIL equals `before',
1589 resize only windows on the left or above EDGE. If TRAIL equals
1590 `after', resize only windows on the right or below EDGE. Also,
1591 preferably only resize windows adjacent to EDGE.
1593 Return the symbol `normalized' if new normal sizes have been
1594 already set by this routine."
1598 best-window best-value)
1610 sub)
1615 edge)
1620 edge)
1623 ;; Resize only windows adjacent to EDGE.
1626 sub delta horizontal ignore t trail edge)
1629 ;; Assign new normal sizes.
1638 ;; Return 'normalized to notify `window--resize-siblings' that
1639 ;; normal sizes have been already set.
1641 ;; Resize all windows proportionally.
1646 ;; Ignore windows to skip and fixed-size subwindows - in
1647 ;; the latter case make it a window to skip.
1652 ;; When shrinking store the number of lines/cols we can get
1653 ;; from this window here together with the total/normal size
1654 ;; factor.
1656 sub
1658 ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
1661 parent-total)
1664 ;; When enlarging store the total/normal size factor only
1666 sub
1668 parent-total)
1675 ;; Shrink windows by delta.
1694 best-window
1699 parent-total)
1702 ;; Enlarge windows by delta.
1720 best-window
1722 parent-total)
1730 ;; Reset new normal size fields so `window-resize-apply'
1731 ;; won't use them to apply new sizes.
1735 ;; Resize this subwindow's subwindows (back-engineering
1736 ;; delta from sub's old and new total sizes).
1740 ;; For the TRAIL non-nil case we have to resize SUB
1741 ;; recursively even if it's size does not change.
1743 sub delta horizontal ignore nil trail edge))))
1747 "Resize other windows when WINDOW is resized vertically by DELTA lines.
1748 Optional argument HORIZONTAL non-nil means resize other windows
1749 when WINDOW is resized horizontally by DELTA columns. WINDOW
1750 itself is not resized by this function.
1752 Optional argument IGNORE non-nil means ignore any restrictions
1753 imposed by fixed size windows, `window-min-height' or
1754 `window-min-width' settings. IGNORE equal `safe' means live
1755 windows may get as small as `window-safe-min-height' lines and
1756 `window-safe-min-width' columns. IGNORE any window means ignore
1757 restrictions for that window only.
1759 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1760 of windows that shall be resized. If TRAIL equals `before',
1761 resize only windows on the left or above EDGE. If TRAIL equals
1762 `after', resize only windows on the right or below EDGE. Also,
1763 preferably only resize windows adjacent to EDGE."
1768 ;; In an iso-combination try to extract DELTA from WINDOW's
1769 ;; siblings.
1772 this-delta other-delta)
1773 ;; Decide which windows shall be left alone.
1777 ;; Make sure WINDOW is left alone when
1778 ;; resizing its siblings.
1782 ;; Make sure this sibling is left alone when
1783 ;; resizing its siblings.
1787 ;; Set this-delta to t to signal that we found a sibling
1788 ;; of WINDOW whose size is not fixed.
1793 ;; Set this-delta to what we can get from WINDOW's siblings.
1795 ;; A deletion, presumably. We must handle this case
1796 ;; specially since `window-resizable' can't be used.
1798 ;; There's at least one resizable sibling we can
1799 ;; give WINDOW's size to.
1801 ;; No resizable sibling exists.
1803 ;; Any other form of resizing.
1807 ;; Set other-delta to what we still have to get from
1808 ;; ancestor windows of parent.
1811 ;; Unless we got everything from WINDOW's siblings, PARENT
1812 ;; must be resized by other-delta lines or columns.
1816 ;; We haven't got anything from WINDOW's siblings but we
1817 ;; must update the normal sizes to respect other-delta.
1819 parent horizontal window this-delta trail other-delta)
1820 ;; We did get something from WINDOW's siblings which means
1821 ;; we have to resize their subwindows.
1824 window ignore trail edge)
1825 ;; If `window--resize-subwindows' returns
1826 ;; 'normalized, this means it has set the
1827 ;; normal sizes already.
1829 ;; Set the normal sizes.
1831 parent horizontal window this-delta trail other-delta))
1832 ;; Set DELTA to what we still have to get from ancestor
1833 ;; windows.
1836 ;; In an ortho-combination all siblings of WINDOW must be
1837 ;; resized by DELTA.
1845 ;; "Go up."
1847 parent delta horizontal ignore trail edge)))))
1850 "Resize WINDOW vertically by DELTA lines.
1851 Optional argument HORIZONTAL non-nil means resize WINDOW
1852 horizontally by DELTA columns.
1854 Optional argument IGNORE non-nil means ignore any restrictions
1855 imposed by fixed size windows, `window-min-height' or
1856 `window-min-width' settings. IGNORE equal `safe' means live
1857 windows may get as small as `window-safe-min-height' lines and
1858 `window-safe-min-width' columns. IGNORE any window means ignore
1859 restrictions for that window only.
1861 Optional argument ADD non-nil means add DELTA to the new total
1862 size of WINDOW.
1864 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1865 of windows that shall be resized. If TRAIL equals `before',
1866 resize only windows on the left or above EDGE. If TRAIL equals
1867 `after', resize only windows on the right or below EDGE. Also,
1868 preferably only resize windows adjacent to EDGE.
1870 This function recursively resizes WINDOW's subwindows to fit the
1871 new size. Make sure that WINDOW is `window-resizable' before
1872 calling this function. Note that this function does not resize
1873 siblings of WINDOW or WINDOW's parent window. You have to
1874 eventually call `window-resize-apply' in order to make resizing
1875 actually take effect."
1877 ;; Add DELTA to the new total size of WINDOW.
1884 ;; In an iso-combination resize subwindows according to their
1885 ;; normal sizes.
1887 window delta horizontal nil ignore trail edge))
1888 ;; In an ortho-combination resize each subwindow by DELTA.
1892 sub delta horizontal ignore t trail edge)
1896 "Resize root window WINDOW vertically by DELTA lines.
1897 HORIZONTAL non-nil means resize root window WINDOW horizontally
1898 by DELTA columns.
1900 IGNORE non-nil means ignore any restrictions imposed by fixed
1901 size windows, `window-min-height' or `window-min-width' settings.
1903 This function is only called by the frame resizing routines. It
1904 resizes windows proportionally and never deletes any windows."
1911 "Resize root window WINDOW vertically by DELTA lines.
1912 If DELTA is less than zero and we can't shrink WINDOW by DELTA
1913 lines, shrink it as much as possible. If DELTA is greater than
1914 zero, this function can resize fixed-size subwindows in order to
1915 recover the necessary lines.
1917 Return the number of lines that were recovered.
1919 This function is only called by the minibuffer window resizing
1920 routines. It resizes windows proportionally and never deletes
1921 any windows."
1932 ;; Ideally, we would resize just the last window in a combination
1933 ;; but that's not feasible for the following reason: If we grow
1934 ;; the minibuffer window and the last window cannot be shrunk any
1935 ;; more, we shrink another window instead. But if we then shrink
1936 ;; the minibuffer window again, the last window might get enlarged
1937 ;; and the state after shrinking is not the state before growing.
1938 ;; So, in practice, we'd need a history variable to record how to
1939 ;; proceed. But I'm not sure how such a variable could work with
1940 ;; repeated minibuffer window growing steps.
1942 delta)))
1945 "Move WINDOW's bottom edge by DELTA lines.
1946 Optional argument HORIZONTAL non-nil means move WINDOW's right
1947 edge by DELTA columns. WINDOW defaults to the selected window.
1949 If DELTA is greater zero, then move the edge downwards or to the
1950 right. If DELTA is less than zero, move the edge upwards or to
1951 the left. If the edge can't be moved by DELTA lines or columns,
1952 move it as far as possible in the desired direction."
1956 left this-delta min-delta max-delta failed)
1957 ;; Find the edge we want to move.
1970 ;; Set LEFT to the first resizable window on the left. This step is
1971 ;; needed to handle fixed-size windows.
1984 ;; Set RIGHT to the first resizable window on the right. This step
1985 ;; is needed to handle fixed-size windows.
1998 ;; LEFT and RIGHT (which might be both internal windows) are now the
1999 ;; two windows we want to resize.
2005 ;; We can't get the whole DELTA - move as far as possible.
2008 ;; Start resizing.
2010 ;; Try to enlarge LEFT first.
2014 left this-delta horizontal nil t 'before
2018 ;; Shrink windows on right of LEFT.
2020 left delta horizontal nil 'after
2028 ;; We can't get the whole DELTA - move as far as possible.
2031 ;; Start resizing.
2033 ;; Try to enlarge RIGHT.
2037 right this-delta horizontal nil t 'after
2041 ;; Shrink windows on left of RIGHT.
2048 ;; Don't report an error in the standard case.
2050 ;; But do report an error if applying the changes fails.
2054 "Make selected window DELTA lines taller.
2055 Interactively, if no argument is given, make the selected window
2056 one line taller. If optional argument HORIZONTAL is non-nil,
2057 make selected window wider by DELTA columns. If DELTA is
2058 negative, shrink selected window by -DELTA lines or columns.
2059 Return nil."
2072 horizontal))))
2075 "Make selected window DELTA lines smaller.
2076 Interactively, if no argument is given, make the selected window
2077 one line smaller. If optional argument HORIZONTAL is non-nil,
2078 make selected window narrower by DELTA columns. If DELTA is
2079 negative, enlarge selected window by -DELTA lines or columns.
2080 Return nil."
2093 horizontal))))
2096 "Maximize WINDOW.
2097 Make WINDOW as large as possible without deleting any windows.
2098 WINDOW can be any window and defaults to the selected window."
2105 "Minimize WINDOW.
2106 Make WINDOW as small as possible without deleting any windows.
2107 WINDOW can be any window and defaults to the selected window."
2112 \f
2114 "Return non-nil if WINDOW is the root window of its frame."
2118 "Return window tree rooted at WINDOW.
2119 Optional argument NEXT non-nil means include windows right
2120 siblings in the return value.
2122 See the documentation of `window-tree' for a description of the
2123 return value."
2136 list))
2141 "Return the window tree of frame FRAME.
2142 FRAME must be a live frame and defaults to the selected frame.
2143 The return value is a list of the form (ROOT MINI), where ROOT
2144 represents the window tree of the frame's root window, and MINI
2145 is the frame's minibuffer window.
2147 If the root window is not split, ROOT is the root window itself.
2148 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
2149 for a horizontal split, and t for a vertical split. EDGES gives
2150 the combined size and position of the subwindows in the split,
2151 and the rest of the elements are the subwindows in the split.
2152 Each of the subwindows may again be a window or a list
2153 representing a window split, and so on. EDGES is a list \(LEFT
2154 TOP RIGHT BOTTOM) as returned by `window-edges'."
2157 \f
2159 "Select another window in cyclic ordering of windows.
2160 COUNT specifies the number of windows to skip, starting with the
2161 selected window, before making the selection. If COUNT is
2162 positive, skip COUNT windows forwards. If COUNT is negative,
2163 skip -COUNT windows backwards. COUNT zero means do not skip any
2164 window, so select the selected window. In an interactive call,
2165 COUNT is the numeric prefix argument. Return nil.
2167 If the `other-window' parameter of WINDOW is a function and
2168 `ignore-window-parameters' is nil, call that function with the
2169 arguments COUNT and ALL-FRAMES.
2171 This function does not select a window whose `no-other-window'
2172 window parameter is non-nil.
2174 This function uses `next-window' for finding the window to
2175 select. The argument ALL-FRAMES has the same meaning as in
2176 `next-window', but the MINIBUF argument of `next-window' is
2177 always effectively nil."
2182 old-window old-count)
2185 ;; `next-window' and `previous-window' may return a window we are
2186 ;; not allowed to select. Hence we need an exit strategy in case
2187 ;; all windows are non-selectable.
2194 ;; Keep out of infinite loops. When COUNT has not changed
2195 ;; since we last looked at `window' we're probably in one.
2199 ;; The first non-selectable window `next-window' got us:
2200 ;; Remember it and the current value of COUNT.
2210 ;; Keep out of infinite loops. When COUNT has not changed
2211 ;; since we last looked at `window' we're probably in one.
2215 ;; The first non-selectable window `previous-window' got
2216 ;; us: Remember it and the current value of COUNT.
2223 ;; Always return nil.
2224 nil))))
2226 ;; This should probably return non-nil when the selected window is part
2227 ;; of an atomic window whose root is the frame's root window.
2229 "Return non-nil if the selected window is the only window.
2230 Optional arg NOMINI non-nil means don't count the minibuffer
2231 even if it is active. Otherwise, the minibuffer is counted
2232 when it is active.
2234 Optional argument ALL-FRAMES specifies the set of frames to
2235 consider, see also `next-window'. ALL-FRAMES nil or omitted
2236 means consider windows on the selected frame only, plus the
2237 minibuffer window if specified by the NOMINI argument. If the
2238 minibuffer counts, consider all windows on all frames that share
2239 that minibuffer too. The remaining non-nil values of ALL-FRAMES
2240 with a special meaning are:
2242 - t means consider all windows on all existing frames.
2244 - `visible' means consider all windows on all visible frames on
2245 the current terminal.
2247 - 0 (the number zero) means consider all windows on all visible
2248 and iconified frames on the current terminal.
2250 - A frame means consider all windows on that frame only.
2252 Anything else means consider all windows on the selected frame
2253 and no others."
2259 \f
2260 ;;; Deleting windows.
2262 "If non-nil, quitting a window can delete it's frame.
2263 If this variable is nil, functions that quit a window never
2264 delete the associated frame. If this variable equals the symbol
2265 `automatic', a frame is deleted only if it the window is
2266 dedicated or was created by `display-buffer'. If this variable
2267 is t, a frame can be always deleted, even if it was created by
2268 `make-frame-command'. Other values should not be used.
2270 Note that a frame will be effectively deleted if and only if
2271 another frame still exists.
2273 Functions quitting a window and consequently affected by this
2274 variable are `switch-to-prev-buffer', `delete-windows-on',
2275 `replace-buffer-in-windows' and `quit-restore-window'."
2284 "Return t if WINDOW can be safely deleted from its frame.
2285 Return `frame' if deleting WINDOW should delete its frame
2286 instead."
2289 ;; Handle atomicity.
2305 ;; WINDOW is the root window of its frame. Return `frame' but
2306 ;; only if WINDOW is (1) either dedicated or quit-restore's car
2307 ;; is new-frame and the window still displays the same buffer
2308 ;; and (2) there are other frames left.
2314 ;; Can't delete last main window.
2315 nil)
2319 "Return t if SUBWINDOW is either WINDOW or a subwindow of WINDOW."
2329 "Delete WINDOW.
2330 WINDOW can be an arbitrary window and defaults to the selected
2331 one. Return nil.
2333 If the variable `ignore-window-parameters' is non-nil or the
2334 `delete-window' parameter of WINDOW equals t, do not process any
2335 parameters of WINDOW. Otherwise, if the `delete-window'
2336 parameter of WINDOW specifies a function, call that function with
2337 WINDOW as its sole argument and return the value returned by that
2338 function.
2340 Otherwise, if WINDOW is part of an atomic window, call
2341 `delete-window' with the root of the atomic window as its
2342 argument. If WINDOW is the only window on its frame or the last
2343 non-side window, signal an error."
2349 atom-root)
2352 ;; Handle window parameters.
2354 ;; Ignore window parameters if `ignore-window-parameters' tells
2355 ;; us so or `delete-window' equals t.
2358 ;; The `delete-window' parameter specifies the function to call.
2359 ;; If that function is `ignore' nothing is done. It's up to the
2360 ;; function called here to avoid infinite recursion.
2377 ;; Emacs 23 preferably gives WINDOW's space to its left
2378 ;; sibling.
2384 ;; Resize WINDOW's sibling.
2390 ;; Can do without resizing fixed-size windows.
2393 ;; Can't do without resizing fixed-size windows.
2395 ;; Actually delete WINDOW.
2400 ;; `delete-window-internal' has selected a window that should
2401 ;; not be selected, fix this here.
2405 ;; Always return nil.
2406 nil))))
2409 "Make WINDOW fill its frame.
2410 WINDOW may be any window and defaults to the selected one.
2411 Return nil.
2413 If the variable `ignore-window-parameters' is non-nil or the
2414 `delete-other-windows' parameter of WINDOW equals t, do not
2415 process any parameters of WINDOW. Otherwise, if the
2416 `delete-other-windows' parameter of WINDOW specifies a function,
2417 call that function with WINDOW as its sole argument and return
2418 the value returned by that function.
2420 Otherwise, if WINDOW is part of an atomic window, call this
2421 function with the root of the atomic window as its argument. If
2422 WINDOW is a non-side window, make WINDOW the only non-side window
2423 on the frame. Side windows are not deleted. If WINDOW is a side
2424 window signal an error."
2430 atom-root side-main)
2434 ;; Ignore window parameters if `ignore-window-parameters' is t or
2435 ;; `delete-other-windows' is t.
2438 ;; The `delete-other-windows' parameter specifies the function
2439 ;; to call. If the function is `ignore' no windows are deleted.
2440 ;; It's up to the function called to avoid infinite recursion.
2447 ;; Set side-main to the major non-side window.
2451 ;; If WINDOW is the main non-side window, do nothing.
2456 ;; Always return nil.
2457 nil)))
2460 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
2462 if you often split windows horizontally."
2474 ;;; Windows and buffers.
2476 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
2477 ;; for (1) determining which buffer to show in the window when its
2478 ;; buffer shall be buried or killed and (2) which buffer to show for
2479 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2481 ;; `prev-buffers' consists of <buffer, window-start, window-point>
2482 ;; triples. The entries on this list are ordered by the time their
2483 ;; buffer has been removed from the window, the most recently removed
2484 ;; buffer's entry being first. The window-start and window-point
2485 ;; components are `window-start' and `window-point' at the time the
2486 ;; buffer was removed from the window which implies that the entry must
2487 ;; be added when `set-window-buffer' removes the buffer from the window.
2489 ;; `next-buffers' is the list of buffers that have been replaced
2490 ;; recently by `switch-to-prev-buffer'. These buffers are the least
2491 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
2492 ;; candidates of `switch-to-next-buffer' to switch to. This list is
2493 ;; reset to nil by any action changing the window's buffer with the
2494 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
2495 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
2496 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
2498 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
2499 ;; if such a buffer was killed while the window was hidden within a
2500 ;; window configuration. Such killed buffers get removed whenever
2501 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
2503 ;; The following function is called by `set-window-buffer' _before_ it
2504 ;; replaces the buffer of the argument window with the new buffer.
2506 "Record WINDOW's buffer.
2507 WINDOW must be a live window and defaults to the selected one."
2511 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
2512 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2516 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
2520 ;; Don't record insignificant buffers.
2522 ;; Add an entry for buffer to WINDOW's previous buffers.
2529 ;; We have an entry, update marker positions.
2532 ;; Make new markers.
2540 "Unrecord BUFFER in WINDOW.
2541 WINDOW must be a live window and defaults to the selected one.
2542 BUFFER must be a live buffer and defaults to the buffer of
2543 WINDOW."
2552 "Set WINDOW's buffer to BUFFER.
2553 Optional argument START non-nil means set WINDOW's start position
2554 to START. Optional argument POINT non-nil means set WINDOW's
2555 point to POINT. If WINDOW is selected this also sets BUFFER's
2556 `point' to POINT. If WINDOW is selected and the buffer it showed
2557 before was current this also makes BUFFER the current buffer."
2572 "In WINDOW switch to previous buffer.
2573 WINDOW must be a live window and defaults to the selected one.
2575 Optional argument BURY-OR-KILL non-nil means the buffer currently
2576 shown in WINDOW is about to be buried or killed and consequently
2577 shall not be switched to in future invocations of this command."
2581 ;; Save this since it's destroyed by `set-window-buffer'.
2583 entry new-buffer killed-buffers deletable visible)
2585 ;; When BURY-OR-KILL is non-nil, there's no previous buffer for
2586 ;; this window, and we can delete the window (or the frame) do
2587 ;; that.
2601 ;; Scan WINDOW's previous buffers first, skipping entries of next
2602 ;; buffers.
2614 ;; Scan reverted buffer list of WINDOW's frame next, skipping
2615 ;; entries of next buffers. Note that when we bury or kill a
2616 ;; buffer we don't reverse the global buffer list to avoid showing
2617 ;; a buried buffer instead. Otherwise, we must reverse the global
2618 ;; buffer list in order to make sure that switching to the
2619 ;; previous/next buffer traverse it in opposite directions.
2628 ;; Try to avoid showing a buffer visible in some other window.
2634 ;; Scan reverted next buffers last (must not use nreverse
2635 ;; here!).
2637 ;; Actually, buffer _must_ be live here since otherwise it
2638 ;; would have been caught in the scan of previous buffers.
2649 ;; Show a buffer visible in another window.
2655 ;; Remove `old-buffer' from WINDOW's previous and (restored list
2656 ;; of) next buffers.
2661 ;; Move `old-buffer' to head of WINDOW's restored list of next
2662 ;; buffers.
2666 ;; Remove killed buffers from WINDOW's previous and next buffers.
2674 ;; Return new-buffer.
2675 new-buffer))
2678 "In WINDOW switch to next buffer.
2679 WINDOW must be a live window and defaults to the selected one."
2684 new-buffer entry killed-buffers visible)
2689 ;; Scan WINDOW's next buffers first.
2700 ;; Scan the buffer list of WINDOW's frame next, skipping previous
2701 ;; buffers entries.
2707 ;; Try to avoid showing a buffer visible in some other window.
2712 ;; Scan WINDOW's reverted previous buffers last (must not use
2713 ;; nreverse here!)
2724 ;; Show a buffer visible in another window.
2729 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
2732 ;; Remove killed buffers from WINDOW's previous and next buffers.
2740 ;; Return new-buffer.
2741 new-buffer))
2744 "Search LIST for a valid buffer to display in FRAME.
2745 Return nil when all buffers in LIST are undesirable for display,
2746 otherwise return the first suitable buffer in LIST.
2748 Buffers not visible in windows are preferred to visible buffers,
2749 unless VISIBLE-OK is non-nil.
2750 If the optional argument FRAME is nil, it defaults to the selected frame.
2751 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
2752 ;; This logic is more or less copied from other-buffer.
2755 found buf)
2768 "Return the last buffer in FRAME's buffer list.
2769 If BUFFER is the last buffer, return the preceding buffer
2770 instead. Buffers not visible in windows are preferred to visible
2771 buffers, unless optional argument VISIBLE-OK is non-nil.
2772 Optional third argument FRAME nil or omitted means use the
2773 selected frame's buffer list. If no such buffer exists, return
2774 the buffer `*scratch*', creating it if necessary."
2777 buffer visible-ok frame)
2781 scratch)))
2784 "Put BUFFER-OR-NAME at the end of the list of all buffers.
2785 There it is the least likely candidate for `other-buffer' to
2787 select by default.
2789 You can specify a buffer name as BUFFER-OR-NAME, or an actual
2790 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
2791 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
2792 remove the current buffer from the selected window if it is
2793 displayed there."
2796 ;; If `buffer-or-name' is not on the selected frame we unrecord it
2797 ;; although it's not "here" (call it a feature).
2799 ;; Handle case where `buffer-or-name' is nil and the current buffer
2800 ;; is shown in the selected window.
2806 ;; Don't iconify if it's the only frame.
2811 ;; Always return nil.
2812 nil))
2815 "Switch to the last buffer in the buffer list."
2820 "In selected window switch to next buffer."
2827 "In selected window switch to previous buffer."
2834 "Delete all windows showing BUFFER-OR-NAME.
2835 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2836 and defaults to the current buffer.
2838 The following non-nil values of the optional argument FRAME
2839 have special meanings:
2841 - t means consider all windows on the selected frame only.
2843 - `visible' means consider all windows on all visible frames on
2844 the current terminal.
2846 - 0 (the number zero) means consider all windows on all visible
2847 and iconified frames on the current terminal.
2849 - A frame means consider all windows on that frame only.
2851 Any other value of FRAME means consider all windows on all
2852 frames.
2854 When a window showing BUFFER-OR-NAME is dedicated and the only
2855 window of its frame, that frame is deleted when there are other
2856 frames left."
2859 ;; Handle the "inverted" meaning of the FRAME argument wrt other
2860 ;; `window-list-1' based function.
2867 ;; Delete frame.
2870 ;; Delete window only.
2873 ;; In window switch to previous buffer.
2876 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
2880 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
2881 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2882 and defaults to the current buffer.
2884 When a window showing BUFFER-OR-NAME is either dedicated, or the
2885 window has no previous buffer, that window is deleted. If that
2886 window is the only window on its frame, the frame is deleted too
2887 when there are other frames left. If there are no other frames
2888 left, some other buffer is displayed in that window.
2890 This function removes the buffer denoted by BUFFER-OR-NAME from
2891 all window-local buffer lists."
2898 ;; Delete frame.
2901 ;; Delete window.
2904 ;; Switch to another buffer in window.
2907 ;; Unrecord BUFFER in WINDOW.
2911 "Quit WINDOW in some way.
2912 WINDOW must be a live window and defaults to the selected window.
2913 Return nil.
2915 According to information stored in WINDOW's `quit-restore' window
2916 parameter either \(1) delete WINDOW and its frame, \(2) delete
2917 WINDOW, \(3) restore the buffer previously displayed in WINDOW,
2918 or \(4) make WINDOW display some other buffer than the present
2919 one. If non-nil, reset `quit-restore' parameter to nil.
2921 Optional argument KILL non-nil means in addition kill WINDOW's
2922 buffer. If KILL is nil, put WINDOW's buffer at the end of the
2923 buffer list. Interactively, KILL is the prefix argument."
2928 deletable resize)
2931 ;; Check that WINDOW's buffer is still the same.
2935 ;; WINDOW can be deleted.
2938 ;; WINDOW's frame can be deleted.
2940 ;; Just delete WINDOW.
2942 ;; If the previously selected window is still alive, select it.
2946 ;; The buffer currently shown in WINDOW must still be the
2947 ;; buffer shown when its `quit-restore' parameter was created
2948 ;; in the first place.
2951 ;; Unrecord buffer.
2954 ;; Display buffer stored in the quit-restore parameter.
2962 ;; Reset the quit-restore parameter.
2967 ;; Otherwise, show another buffer in WINDOW and reset the
2968 ;; quit-restore parameter.
2973 ;; Kill WINDOW's old-buffer if requested
2975 nil))
2976 \f
2977 ;;; Splitting windows.
2979 "Return minimum height of any window when splitting windows.
2980 Optional argument HORIZONTAL non-nil means return minimum width."
2986 "Make a new window adjacent to WINDOW.
2987 WINDOW can be any window and defaults to the selected one.
2988 Return the new window which is always a live window.
2990 Optional argument SIZE a positive number means make WINDOW SIZE
2991 lines or columns tall. If SIZE is negative, make the new window
2992 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
2993 absolute value can be less than `window-min-height' or
2994 `window-min-width'; so this command can make a new window as
2995 small as one line or two columns. SIZE defaults to half of
2996 WINDOW's size. Interactively, SIZE is the prefix argument.
2998 Optional third argument SIDE nil (or `below') specifies that the
2999 new window shall be located below WINDOW. SIDE `above' means the
3000 new window shall be located above WINDOW. In both cases SIZE
3001 specifies the new number of lines for WINDOW \(or the new window
3002 if SIZE is negative) including space reserved for the mode and/or
3003 header line.
3005 SIDE t (or `right') specifies that the new window shall be
3006 located on the right side of WINDOW. SIDE `left' means the new
3007 window shall be located on the left of WINDOW. In both cases
3008 SIZE specifies the new number of columns for WINDOW \(or the new
3009 window provided SIZE is negative) including space reserved for
3010 fringes and the scrollbar or a divider column. Any other non-nil
3011 value for SIDE is currently handled like t (or `right').
3013 If the variable `ignore-window-parameters' is non-nil or the
3014 `split-window' parameter of WINDOW equals t, do not process any
3015 parameters of WINDOW. Otherwise, if the `split-window' parameter
3016 of WINDOW specifies a function, call that function with all three
3017 arguments and return the value returned by that function.
3020 root of that atomic window. The new window does not become a
3021 member of that atomic window.
3023 If WINDOW is live, properties of the new window like margins and
3024 scrollbars are inherited from WINDOW. If WINDOW is an internal
3025 window, these properties as well as the buffer displayed in the
3026 new window are inherited from the window selected on WINDOW's
3027 frame. The selected window is not changed by this function."
3039 ;; Rebind `window-nest' since in some cases we may have to
3040 ;; override its value.
3042 atom-root)
3047 ;; Ignore window parameters if either `ignore-window-parameters'
3048 ;; is t or the `split-window' parameter equals t.
3051 ;; The `split-window' parameter specifies the function to call.
3052 ;; If that function is `ignore', do nothing.
3054 ;; If WINDOW is a subwindow of an atomic window, split the root
3055 ;; window of that atomic window instead.
3064 ;; WINDOW is a side root window. To make sure that a new parent
3065 ;; window gets created set `window-nest' to t.
3069 ;; If `window-splits' is non-nil and SIZE is a non-negative
3070 ;; integer, we cannot reasonably resize other windows. Rather
3071 ;; bind `window-nest' to t to make sure that subsequent window
3072 ;; deletions are handled correctly.
3076 ;; `parent-size' is the size of WINDOW's parent, provided
3077 ;; it has one.
3079 ;; `resize' non-nil means we are supposed to resize other
3080 ;; windows in WINDOW's combination.
3083 ;; Resize makes sense in iso-combinations only.
3085 ;; `old-size' is the current size of WINDOW.
3087 ;; `new-size' is the specified or calculated size of the
3088 ;; new window.
3094 ;; When resizing try to give the new window the
3095 ;; average size of a window in its combination.
3098 (/ parent-size
3100 parent horizontal))))
3101 ;; Else try to give the new window half the size
3102 ;; of WINDOW (plus an eventual odd line).
3105 ;; SIZE non-negative specifies the new size of WINDOW.
3107 ;; Note: Specifying a non-negative SIZE is practically
3108 ;; always done as workaround for making the new window
3109 ;; appear above or on the left of the new window (the
3110 ;; ispell window is a typical example of that). In all
3111 ;; these cases the SIDE argument should be set to 'above
3112 ;; or 'left in order to support the 'resize option.
3113 ;; Here we have to nest the windows instead, see above.
3116 ;; SIZE negative specifies the size of the new window.
3118 new-parent new-normal)
3120 ;; Check SIZE.
3125 ;; SIZE unspecified, resizing.
3127 ;; Try again with minimum split size.
3133 ;; SIZE unspecified, no resizing.
3138 window-safe-min-width
3139 window-safe-min-width))))
3140 ;; SIZE specified as new size of old window. If the new size
3141 ;; is larger than the old size or the size of the new window
3142 ;; would be less than the safe minimum, signal an error.
3145 ;; SIZE specified, resizing.
3147 ;; If we cannot resize the parent give up.
3153 ;; SIZE specification violates minimum size restrictions.
3159 ;; Make new-parent non-nil if we need a new parent window;
3160 ;; either because we want to nest or because WINDOW is not
3161 ;; iso-combined.
3164 ;; Make new-normal the normal size of the new window.
3172 ;; Try to get space from OLD's siblings. We could go "up" and
3173 ;; try getting additional space from surrounding windows but
3174 ;; we won't be able to return space to those windows when we
3175 ;; delete the one we create here. Hence we do not go up.
3184 ;; Get entire space from WINDOW.
3189 new-normal)))
3192 ;; Inherit window-side parameters, if any.
3199 ;; Always return the new window.
3200 new)))))
3202 ;; I think this should be the default; I think people will prefer it--rms.
3205 in both children.
3206 This is often more convenient for editing.
3207 If nil, adjust point in each of the two windows to minimize redisplay.
3208 This is convenient on slow terminals, but point can move strangely.
3210 This option applies only to `split-window-above-each-other' and
3211 functions that call it. `split-window' always keeps the original
3212 point in both children."
3217 "Split selected window into two windows, one above the other.
3218 The upper window gets SIZE lines and the lower one gets the rest.
3219 SIZE negative means the lower window gets -SIZE lines and the
3220 upper one the rest. With no argument, split windows equally or
3221 close to it. Both windows display the same buffer, now current.
3223 If the variable `split-window-keep-point' is non-nil, both new
3224 windows will get the same value of point as the selected window.
3225 This is often more convenient for editing. The upper window is
3226 the selected window.
3228 Otherwise, we choose window starts so as to minimize the amount of
3229 redisplay; this is convenient on slow terminals. The new selected
3230 window is the one that the current value of point appears in. The
3231 value of point can change if the text around point is hidden by the
3232 new mode line.
3234 Regardless of the value of `split-window-keep-point', the upper
3235 window is the original one and the return value is the new, lower
3236 window."
3241 moved-by-window-height moved new-window bottom)
3243 ;; `split-window' would not signal an error here.
3264 ;; Always copy quit-restore parameter in interactive use.
3268 new-window))
3273 "Split selected window into two windows side by side.
3274 The selected window becomes the left one and gets SIZE columns.
3275 SIZE negative means the right window gets -SIZE lines.
3277 SIZE includes the width of the window's scroll bar; if there are
3278 no scroll bars, it includes the width of the divider column to
3279 the window's right, if any. SIZE omitted or nil means split
3280 window equally.
3282 The selected window remains selected. Return the new window."
3286 new-window)
3288 ;; `split-window' would not signal an error here.
3291 ;; Always copy quit-restore parameter in interactive use.
3295 new-window))
3298 \f
3299 ;;; Balancing windows.
3301 ;; The following routine uses the recycled code from an old version of
3302 ;; `window--resize-subwindows'. It's not very pretty, but coding it the way the
3303 ;; new `window--resize-subwindows' code does would hardly make it any shorter or
3304 ;; more readable (FWIW we'd need three loops - one to calculate the
3305 ;; minimum sizes per window, one to enlarge or shrink windows until the
3306 ;; new parent-size matches, and one where we shrink the largest/enlarge
3307 ;; the smallest window).
3309 "Subroutine of `balance-windows-1'.
3310 WINDOW must be an iso-combination."
3316 found failed size sub-total sub-delta sub-amount rest)
3331 ;; Ignore subwindows that should be ignored or are stuck.
3338 ;; Register the new total size for this subwindow.
3343 ;; We failed and need a new round.
3349 ;; Fix rounding by trying to enlarge non-stuck windows by one line
3350 ;; (column) until `rest' is zero.
3358 ;; Fix rounding by trying to enlarge stuck windows by one line
3359 ;; (column) until `rest' equals zero.
3369 ;; Record new normal sizes.
3375 ;; Recursively balance each subwindow's subwindows.
3380 "Subroutine of `balance-windows'."
3392 "Balance the sizes of subwindows of WINDOW-OR-FRAME.
3393 WINDOW-OR-FRAME is optional and defaults to the selected frame.
3394 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
3395 subwindows of that frame's root window. If WINDOW-OR-FRAME
3396 denots a window, balance the sizes of all subwindows of that
3397 window."
3406 window-or-frame)
3410 ;; Balance vertically.
3414 ;; Balance horizontally.
3420 "Return t if WINDOW cannot be resized in DIRECTION.
3421 WINDOW defaults to the selected window. DIRECTION can be
3422 nil (i.e. any), `height' or `width'."
3429 ;;; A different solution to balance-windows.
3431 "Factor by which the window area should be over-estimated.
3432 This is used by `balance-windows-area'.
3437 "Wrapper around `window-resize' with error checking.
3438 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
3439 ;; `window-resize' may fail if delta is too large.
3446 ;;(message "adjust: %s" (error-message-string err))
3450 "Make all visible windows the same area (approximately).
3451 See also `window-area-factor' to change the relative size of
3452 specific buffers."
3455 ;; Remove fixed-size windows.
3460 next)
3461 ;; Resizing a window changes the size of surrounding windows in complex
3462 ;; ways, so it's difficult to balance them all. The introduction of
3463 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
3464 ;; very difficult to do. `balance-window' above takes an off-line
3465 ;; approach: get the whole window tree, then balance it, then try to
3466 ;; adjust the windows so they fit the result.
3467 ;; Here, instead, we take a "local optimization" approach, where we just
3468 ;; go through all the windows several times until nothing needs to be
3469 ;; changed. The main problem with this approach is that it's difficult
3470 ;; to make sure it terminates, so we use some heuristic to try and break
3471 ;; off infinite loops.
3472 ;; After a round without any change, we allow a second, to give a chance
3473 ;; to the carry to propagate a minor imbalance from the end back to
3474 ;; the beginning.
3476 ;; (message "New round")
3482 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
3500 ;; Maybe diff is actually closer to 1 than to 0.
3504 ;; Change things smoothly.
3507 ;; Make sure negligible differences don't accumulate to
3508 ;; become significant.
3510 ;; This used `adjust-window-trailing-edge' before and uses
3511 ;; `window-resize' now. Error wrapping is still needed.
3513 ;; (sit-for 0.5)
3515 ;; If the same change has been seen already for this window,
3516 ;; we're most likely in an endless loop, so don't count it as
3517 ;; a change.
3521 ;; We've now basically balanced all the windows.
3522 ;; But there may be some minor off-by-one imbalance left over,
3523 ;; so let's do some fine tuning.
3524 ;; (bw-finetune wins)
3525 ;; (message "Done in %d rounds" round)
3526 ))
3528 ;;; Window states, how to get them and how to put them in a window.
3530 "Like LIST but do not add nil elements of ARGS."
3537 "Helper function for `window-state-get'."
3547 type
3558 window-state-ignored-parameters)
3561 ;; Make a clone-of parameter.
3566 ;; All buffer related things go in here - make the buffer
3567 ;; current when retrieving `point' and `mark'.
3597 "Return state of WINDOW as a Lisp object.
3598 WINDOW can be any window and defaults to the root window of the
3599 selected frame.
3601 Optional argument MARKERS non-nil means use markers for sampling
3602 positions like `window-point' or `window-start'. MARKERS should
3603 be non-nil only if the value is used for putting the state back
3604 in the same session (note that markers slow down processing).
3606 The return value can be used as argument for `window-state-put'
3607 to put the state recorded here into an arbitrary window. The
3608 value can be also stored on disk and read back in a new session."
3612 window
3615 ;; The return value is a cons whose car specifies some constraints on
3616 ;; the size of WINDOW. The cdr lists the states of the subwindows of
3617 ;; WINDOW.
3619 ;; Frame related things would go into a function, say `frame-state',
3620 ;; calling `window-state-get' to insert the frame's root window.
3628 ;; These are probably not needed.
3637 "Helper function for `window-state-put'."
3642 ;; For a leaf window just add unprocessed entries to
3643 ;; `window-state-put-list'.
3650 size new)
3652 ;; Find the next child window. WINDOW always points to the
3653 ;; real window that we want to fill with what we find here.
3656 ;; The last child window. Below `window-state-put-1'
3657 ;; will put into it whatever ITEM has in store.
3659 ;; Not the last child window, prepare for splitting
3660 ;; WINDOW. SIZE is the new (and final) size of the old
3661 ;; window.
3664 ;; Use total size.
3666 ;; Use normalized size and round.
3670 item))))))
3672 ;; Use safe sizes, we try to resize later.
3674 window-safe-min-height
3675 window-safe-min-width)))
3679 ;; We must inherit the nesting, otherwise we might mess
3680 ;; up handling of atomic and side window.
3682 ;; Give up if we can't resize window down to safe sizes.
3687 ;; When creating the first child window add for parent
3688 ;; unprocessed entries to `window-state-put-list'.
3691 window-state-put-list))))
3693 ;; Now process the current window (either the one we've just
3694 ;; split or the last child of its parent).
3696 ;; Continue with the last window split off.
3700 "Helper function for `window-state-put'."
3709 ;; Process parameters.
3713 ;; Process buffer related state.
3715 ;; We don't want to raise an error here so we create a buffer if
3716 ;; there's none.
3728 ;; Adjust vertically.
3730 ;; A fixed height window, try to restore the original size.
3733 window-size-fixed)
3736 ;; Else check whether the window is not high enough.
3742 ;; Adjust horizontally.
3744 ;; A fixed width window, try to restore the original size.
3747 window-size-fixed)
3750 ;; Else check whether the window is not wide enough.
3756 ;; Set dedicated status.
3758 ;; Install positions (maybe we should do this after all windows
3759 ;; have been created and sized).
3763 ;; I'm not sure whether we should set the mark here, but maybe
3764 ;; it can be used.
3767 ;; Select window if it's the selected one.
3772 "Put window state STATE into WINDOW.
3773 STATE should be the state of a window returned by an earlier
3774 invocation of `window-state-get'. Optional argument WINDOW must
3775 specify a live window and defaults to the selected one.
3777 Optional argument IGNORE non-nil means ignore minimum window
3778 sizes and fixed size restrictions. IGNORE equal `safe' means
3779 subwindows can get as small as `window-safe-min-height' and
3780 `window-safe-min-width'."
3784 ;; We check here (1) whether the total sizes of root window of
3785 ;; STATE and that of WINDOW are equal so we can avoid
3786 ;; calculating new sizes, and (2) if we do have to resize
3787 ;; whether we can do so without violating size restrictions.
3795 window-splits selected)
3813 (> min-width
3815 ;; The check above might not catch all errors due to rounding
3816 ;; issues - so IGNORE equal 'safe might not always produce the
3817 ;; minimum possible state. But such configurations hardly make
3818 ;; sense anyway.
3822 ;; Work on the windows of a temporary buffer to make sure that
3823 ;; splitting proceeds regardless of any buffer local values of
3824 ;; `window-size-fixed'. Release that buffer after the buffers of
3825 ;; all live windows have been set by `window-state-put-2'.
3831 \f
3834 ;; Use the same window.
3837 ;; Avoid other frames.
3842 ;; Avoid other frames and selected window.
3847 ;; Avoid selected frame.
3854 "List associating buffer identifiers with display specifiers.
3855 The car of each element of this list is built from a set of cons
3856 cells called buffer identifiers. `display-buffer' shows a buffer
3857 according to the display specifiers in the element's cdr
3858 \(elements are true lists) if at least one of the identifiers
3859 matches the first or third argument of `display-buffer'. Such a
3860 match occurs in one of the following three cases:
3862 - The car of the buffer identifier is the symbol `name' and its
3863 cdr is a string equalling the name of the buffer specified by
3864 the first \(BUFFER-OR-NAME) argument of `display-buffer'.
3866 - The car is the symbol `regexp' and the cdr is a regular
3867 expression matching the name of the buffer specified by the
3868 first \(BUFFER-OR-NAME) argument of `display-buffer'.
3870 - The car is the symbol `label' and the cdr is a symbol equalling
3871 the third \(LABEL) argument of `display-buffer'.
3873 Display specifiers are either symbols, cons cells, or lists.
3874 Five specifiers have been reserved to indicate the basic method
3875 for displaying the buffer: `reuse-window', `pop-up-window',
3876 `pop-up-frame', `use-side-window', and `function'.
3878 A list whose car is the symbol `reuse-window' indicates that an
3879 existing window shall be reused for displaying the buffer. The
3880 second element of this list specifies the window to use and can
3881 be one of the following symbols:
3883 nil stands for any window.
3885 `same' stands for the selected window.
3887 `other' stands for any but the selected window.
3889 The third element specifies whether the buffer shown in a window
3890 that shall be reused must be the same buffer that shall be
3891 displayed or another buffer and can be one of the following:
3893 nil means to not care about the window's buffer.
3895 `same' means the window must show the buffer already.
3897 `other' means the window must not show the buffer yet.
3899 The fourth element specifies the set of frames to search for a
3900 suitable window and can be one of the following:
3902 nil to reuse a window on the selected frame.
3904 `visible' to search visible frames on the current terminal.
3906 `other' stands for any visible frame but the selected one.
3908 0 \(the number zero) to search visible and iconified frames on
3909 the current terminal.
3911 t to search arbitrary frames including invisible ones.
3913 If more than one window fits the constraints imposed by these
3914 elements, the least recently used candidate is chosen. A side
3915 window is never reused unless it already shows the buffer.
3917 The following two specifiers are useful when the method equals
3918 `reuse-window':
3920 - A cons cell whose car is the symbol `reuse-window-even-sizes'
3921 and whose cdr is non-nil means to even out the sizes of a
3922 reused window and the selected window provided they (1) appear
3923 adjacent to each other and (2) the selected window is larger
3924 than the window chosen. If the cdr is nil, this means that the
3925 window sizes are left alone.
3927 - A cons cell whose car is the symbol `reuse-window-dedicated'
3928 and whose cdr is non-nil means that a window can be reused even
3929 if it's weakly dedicated to its buffer. If the cdr is t, a
3930 strongly dedicated window can be reused to show the buffer.
3931 Any other non-nil value means only weakly dedicated windows can
3932 be reused. If the cdr is nil, dedicated windows are not
3933 reused.
3935 This specifier should be used in emergency cases only since
3936 windows are usually made dedicated in order to prevent
3937 `display-buffer' from reusing them.
3939 A list whose car is the symbol `pop-up-window' and whose cdr is
3940 built from cons cells representing window/side tuples indicates
3941 that a new window shall be made for displaying the buffer on the
3942 selected frame.
3944 Window/side tuples are cons cells. The car of such a tuple
3945 identifies the window that shall be split. Possible values are
3946 `largest', `lru', `selected', and `root' to split the largest,
3947 least recently used, selected or root window of the selected
3948 frame.
3950 If the frame has side windows, these values do allow to split
3951 only the selected frame's main window or one of its subwindows.
3952 Setting the car to one of `left', `top', `right' and `bottom'
3953 splits the corresponding side window, provided such a window
3954 exists.
3956 The cdr of each pair specifies on which side of the window to
3957 split the new window shall appear and can be one of `below',
3958 `right', `above', or `left' with the obvious meanings. If the
3959 cdr is nil, the window is split in a fashion suitable for its
3960 current dimensions. If the cdr specifies a function, that
3961 function is called with one argument - the window to split. The
3962 function is supposed to split that window and return the new
3963 window.
3965 `display-buffer' scans these tuples until it can either produce a
3966 suitable window or fails. The default value for
3967 `display-buffer-alist' contains the tuples \(largest . nil) and
3968 \(lru . nil) in order to split the largest window first and, if
3969 that fails, the least recently used one.
3971 The following specifiers are useful if the method specifier is
3972 `pop-up-window'.
3974 - A cons cell whose car is the symbol `pop-up-window-min-height'
3975 specifiies the minimum height of the new window. If the cdr is
3976 an integer number, it specifies the minimum number of lines of
3977 the window. A floating point number gives the minimum fraction
3978 of the window height with respect to the height of the frame's
3979 root window. A new window is created only if it can be made at
3980 least as high as specified by the number. If the cdr is nil,
3981 this means to use the value of `window-min-height'.
3983 - A cons cell whose car is the symbol `pop-up-window-min-width'
3984 specifies the minimum width of the new window. If the cdr is
3985 an integer number, it specifies the minimum number of columns
3986 of the window. A floating point number gives the minimum
3987 fraction of the window width with respect to the width of the
3988 frame's root window. A new window is created only if it can be
3989 made at least as wide as specified by the number. If the cdr
3990 is nil, this means to use the value of `window-min-width'.
3992 - A cons cell whose car is `pop-up-window-set-height' with
3993 the following interpretations for the cdr:
3995 - nil means leave the height of the new window alone.
3997 - A number specifies the desired height of the new window. An
3998 integer number specifies the number of lines of the window.
3999 A floating point number gives the fraction of the window
4000 height with respect to the height of the frame's root window.
4002 - If the cdr specifies a function, that function is called with
4003 one argument - the new window. The function is supposed to
4004 adjust the height of the window; its return value is ignored.
4005 Suitable functions are `shrink-window-if-larger-than-buffer'
4006 and `fit-window-to-buffer'.
4008 - A cons cell whose car equals `pop-up-window-set-width' with
4009 the following interpretations for the cdr:
4011 - nil means leave the width of the new window alone.
4013 - A number specifies the desired width of the new window. An
4014 integer number specifies the number of columns of the window.
4015 A floating point number gives the fraction of the window
4016 width with respect to the width of the frame's root window.
4018 - If the cdr specifies a function, that function is called with
4019 one argument - the new window. The function is supposed to
4020 adjust the width of the window; its return value is ignored.
4022 Observe that specifying `pop-up-window-set-height' or
4023 `pop-up-window-set-width' may override restrictions given by
4024 the `pop-up-window-min-height' and `pop-up-window-min-width'
4025 specifiers.
4027 - A cons cell whose car is `pop-up-window-split-unsplittable' and
4028 whose cdr is non-nil allows to make a new window on an
4029 unsplittable frame. If the cdr is nil, unsplittable frames are
4030 not split. This specifier should be used in special cases only
4031 since frames are usually made unsplittable in order to prevent
4032 `display-buffer' from splitting them.
4034 A list whose car is the symbol `pop-up-frame' specifies that a
4035 new frame shall be made for displaying the buffer. The second
4036 element, if non-nil, allows popping up a new frame on graphic
4037 displays only.
4039 The following specifiers are useful if the method specifier is
4040 `pop-up-frame'.
4042 - A list whose car is the symbol `pop-up-frame-function' together
4043 with a valid function as cdr specifies the function for
4044 creating a new frame. If the cdr is nil, the default function
4045 `make-frame' is called. The function is called with the
4046 parameters and values provided by the specifier described next.
4048 - A list whose car is the symbol `pop-up-frame-alist' followed by
4049 an arbitrary number of frame parameter/value tuples, each given
4050 as a cons cell, specifies the parameters passed to the pop-up
4051 frame function.
4053 A list of three elements whose car is the symbol
4054 `use-side-window' specifies that the buffer shall be displayed in
4055 a side window of the selected frame. The second element denotes
4056 the side of the frame where the window appears or shall be made.
4057 The third element denotes the slot used by the window. If a side
4058 window with the specified slot exists already, that window is
4059 reused. If no such window exists it is created.
4061 The following specifiers are useful in connection with the
4062 `use-side-window' method specifier: `reuse-window-dedicated',
4063 `pop-up-window-min-height', `pop-up-window-min-width',
4064 `pop-up-window-set-height' and `pop-up-window-set-width'.
4066 A list whose car is the symbol `function' specifies that the
4067 function specified in the second element of the list is
4068 responsible for displaying the buffer. `display-buffer' calls
4069 this function with the buffer as first argument and the remaining
4070 elements of the list as the second.
4072 The function should choose or create a window, display the buffer
4073 in it, and return the window. It is also responsible for giving
4074 the variable `display-buffer-window' and the `quit-restore'
4075 parameter of the window used a meaningful value.
4077 Within the body of this function avoid calling `display-buffer'
4078 with the same buffer as argument since this may lead to endless
4079 recursion.
4081 Instead of supplying basic method specifiers, it's sometimes more
4082 convenient to use macro specifiers. They provide some commonly
4083 used display methods but do not support the fine control provided
4084 by the basic method specifiers. Macro specifiers are symbols.
4085 The following macro specifiers are provided:
4087 `same-window' to display the buffer in the selected window.
4089 `same-frame' to display the buffer on the selected frame.
4091 `other-window' to display the buffer in any window but the
4092 selected one.
4094 `same-frame-other-window' as `other-window' but stay on the
4095 selected frame.
4097 `other-frame' to display the buffer on another visible
4098 frame.
4100 `default' to use the default value of `display-buffer-alist'.
4102 One specifier is useful with any method specifier: A list whose
4103 car is the symbol `dedicate' and whose cdr is non-nil will
4104 dedicate the window to its buffer. The following values are
4105 supported:
4107 - nil to not dedicate the window to the buffer.
4109 - `weak' to weakly dedicate the window to the buffer.
4111 - t to strongly dedicate the window to the buffer.
4113 A cons cell whose car is `other-window-means-other-frame' and
4114 whose cdr is non-nil means that you want calls of
4115 `display-buffer' with the second argument t or the symbol
4116 `other-window' to display the buffer in another frame. This
4117 means, for example, that you prefer functions like
4118 `find-file-other-window' or `switch-to-buffer-other-window' to
4119 make a new frame instead of a new window on the selected frame.
4121 Usually, applications are free to override the specifiers of
4122 `display-buffer-alist' by passing their own specifiers as second
4123 argument of `display-buffer'. For every `display-buffer-alist'
4124 entry you can, however, add a cons cell whose car is the symbol
4125 `override' and whose cdr is non-nil, to explicitly override any
4126 value supplied by the application.
4128 Overriding specifiers supplied by the calling application is, in
4129 general, not advisable. It permits, for example, to change the
4130 semantics of a function like `display-buffer-other-window' by
4131 using the location specifiers `same-window' or `other-frame'."
4132 :risky t
4133 :type
4136 ;; Associations of buffer identifiers and display specifiers.
4139 ;; Buffer identifiers.
4164 ;; Display specifiers.
4168 :inline t
4170 :inline t
4177 :inline t
4181 ;; Reuse window specifiers.
4188 :inline t
4189 ;; For customization purposes only.
4193 :inline t
4194 ;; The window to reuse.
4198 ;; The window type.
4202 :value nil
4207 ;; The window's buffer.
4211 :value t
4216 ;; The window's frame.
4220 :value nil
4227 ;; Whether window sizes should be evened out.
4235 :value t
4239 ;; Whether to reuse a dedicated window
4251 ;; Pop-up window specifiers.
4256 :inline t
4260 :inline t
4261 ;; Pop-up window list.
4268 :inline t
4274 :value largest
4287 :value nil
4296 ;; Minimum height of pop-up windows.
4306 ;; Minimum width of pop-up windows.
4316 ;; Desired height of pop-up windows.
4327 ;; Desired width of pop-up windows.
4338 ;; Split unsplittable frames.
4348 ;; Pop-up frame specifiers.
4354 :inline t
4358 :inline t
4359 ;; Pop-up frame.
4371 ;; Pop-up frame function.
4377 :value nil
4382 :value make-frame
4385 ;; Pop-up frame alist.
4391 :inline t
4403 ;; Use side-window specifiers.
4408 :inline t
4409 ;; For customization purposes only.
4413 :inline t
4414 ;; Side and slot.
4419 ;; The side.
4423 :value bottom
4429 ;; The slot
4435 ;; Whether to reuse a dedicated side window
4446 ;; Minimum height of pop-up side windows.
4456 ;; Minimum width of pop-up windows.
4466 ;; Desired height of pop-up windows.
4477 ;; Desired width of pop-up windows.
4489 ;; Function with argument specifiers.
4494 :inline t
4495 ;; For customization purposes only.
4499 :inline t
4509 :inline t
4514 ;; Macro specifiers.
4518 :inline t
4523 :inline t
4528 :inline t
4533 :inline t
4538 :inline t
4543 :inline t
4548 :inline t
4549 ;; Dedicate window to buffer.
4559 ;; No other window.
4568 ;; Other window means other frame.
4577 ;; Overriding.
4590 "If non-nil, function to call to display a buffer.
4591 `display-buffer' calls this function with two arguments, the
4592 buffer to display and a list of buffer display specifiers, see
4593 `display-buffer-alist'.
4595 The function is supposed to choose or create a window, display
4596 the specified buffer in it, and return the window. It is also
4597 responsible for giving the variable `display-buffer-window' and
4598 the `quit-restore' parameter of the window used a meaningful
4599 value.
4601 The function specified here overrides all specifiers of the
4602 variable `display-buffer-alist' any specifiers passed to
4603 `display-buffer'.
4605 If you call `display-buffer' within the body of the function,
4606 bind the value of `display-buffer-function' to nil around that
4607 call to avoid that the function recursively calls itself."
4613 ;; The following is a global variable which is used externally (by
4614 ;; help.el) to (1) know which window was used for displaying a buffer
4615 ;; and (2) whether the window was new or reused.
4617 "Window used by `display-buffer' and related information.
4618 After `display-buffer' displays a buffer in some window this
4619 variable is a cons cell whose car denotes the window used to
4620 display the buffer. The cdr is supposed to be one of the symbols
4621 `reuse-buffer-window', `reuse-other-window', `new-window' or
4622 `new-frame'.
4624 If the buffer display location specifier is one of 'same-window,
4625 'same-frame, or 'other-frame, the `display-buffer' routines
4626 assign the value of this variable. If the location specifier is
4627 a function, that function becomes responsible for assigning a
4628 meaningful value to this variable. See the functions
4629 `display-buffer-reuse-window', `display-buffer-pop-up-window' and
4633 "Even sizes of WINDOW and selected window according to SPECIFIERS.
4634 SPECIFIERS must be a list of buffer display specifiers, see the
4635 documentation of `display-buffer-alist' for a description.
4637 Sizes are evened out if and only if WINDOW and the selected
4638 window appear next to each other and the selected window is
4639 larger than WINDOW."
4642 ;; Don't resize minibuffer windows.
4644 ;; WINDOW must be adjacent to the selected one.
4648 ;; Resize iff the selected window is higher than WINDOW.
4650 ;; Don't throw an error if we can't even window heights for
4651 ;; whatever reason. In any case, enlarging the selected window
4652 ;; might fail anyway if there are other windows above or below
4653 ;; WINDOW and the selected one. But for a simple two windows
4654 ;; configuration the present behavior is good enough so why care?
4660 ;; Resize iff the selected window is wider than WINDOW.
4662 ;; Don't throw an error if we can't even window widths, see
4663 ;; comment above.
4670 "Adjust height of WINDOW according to SPECIFIERS.
4671 SPECIFIERS must be a list of buffer display specifiers, see the
4672 documentation of `display-buffer-alist' for a description."
4677 set-height
4680 set-height))))
4689 "Adjust width of WINDOW according to SPECIFIERS.
4690 SPECIFIERS must be a list of buffer display specifiers, see the
4691 documentation of `display-buffer-alist' for a description."
4696 set-width
4699 set-width))))
4708 "Display BUFFER in WINDOW and raise its frame if needed.
4709 WINDOW must be a live window and defaults to the selected one.
4710 Return WINDOW.
4712 SPECIFIERS must be a list of buffer display specifiers, see the
4713 documentation of `display-buffer-alist' for a description."
4720 ;; Show BUFFER in WINDOW.
4722 ;; If we show another buffer in WINDOW, undedicate it first.
4731 ;; Assume the selected frame is already visible enough.
4733 ;; Assume the frame from which we invoked the minibuffer
4734 ;; is visible.
4739 ;; Return window.
4740 window))
4743 "Display BUFFER in an existing window.
4744 METHOD must be a list in the form of the cdr of a `reuse-window'
4745 buffer display specifier, see `display-buffer-alist' for an
4746 explanation. The first element must specifiy the window to use,
4747 and can be either nil, `same', `other', or a live window. The
4748 second element must specify the window's buffer and can be either
4749 nil, `same', `other', or a live buffer. The third element is the
4750 frame to use - either nil, 0, `visible', `other', t, or a live
4751 frame.
4753 Optional argument SPECIFIERS must be a list of valid display
4754 specifiers. Optional argument OTHER-WINDOW, if non-nil, means do
4755 not use the selected window. Return the window chosen to display
4756 BUFFER, nil if none was found."
4761 windows other-frame dedicated time best-window best-time)
4763 ;; `other' is not handled by `window-list-1'.
4769 ;; Don't reuse a side window.
4778 ;; Special case for applications that specifiy
4779 ;; the window explicitly.
4786 ;; Special case for applications that specifiy
4787 ;; the window's buffer explicitly.
4791 ;; Handle dedicatedness.
4793 ;; The window does not show the same buffer.
4795 ;; If the window is weakly dedicated to its
4796 ;; buffer, reuse-dedicated must be non-nil.
4798 ;; If the window is strongly dedicated to its
4799 ;; buffer, reuse-dedicated must be t.
4804 ;; When reusing a window on the same buffer use the lru one.
4810 ;; Otherwise, sort windows according to their use-time.
4817 ;; Try to get a full-width window (this is silly and can
4818 ;; get us to another frame but let's ignore these issues
4819 ;; for the moment).
4824 ;; If there's no full-width window return the lru window.
4829 ;; Never change the quit-restore parameter of a window here.
4836 ;; Don't overwrite an existing quit-restore entry.
4838 best-window 'quit-restore
4852 "Subroutine of `display-buffer-split-window'."
4857 ;; We either resize WINDOW or its parent.
4859 new-size)
4860 ;; We don't call split-window-vertically/-horizontally any more
4861 ;; here. If for some reason it's needed we can always do so
4862 ;; (provided we give it an optional SIDE argument).
4865 ;; When we resize a combination, the new window must be at least
4866 ;; MIN-SIZE large after the split.
4870 (/ old-size
4871 ;; Try to make the size of the new window
4872 ;; proportional to the number of iso-arranged
4873 ;; windows in the combination.
4879 ;; When WINDOW is live, the old _and_ the new window must be at
4880 ;; least MIN-SIZE large after the split.
4883 ;; Do an even split to make Stepan happy.
4886 ;; When WINDOW is internal, the new window must be at least
4887 ;; MIN-SIZE large after the split.
4890 (/ old-size
4891 ;; Try to make the size of the new window
4892 ;; proportional to the number of iso-arranged
4893 ;; subwindows of WINDOW.
4899 "Split WINDOW in a way suitable for `display-buffer'.
4900 Optional argument SIDE must be a side specifier \(one of the
4901 symbols below, right, above, left, or nil). SPECIFIERS must be a
4902 list of buffer display specifiers, see the documentation of
4903 `display-buffer-alist' for a description.
4905 Return the new window, nil if it could not be created."
4908 size)
4909 ;; Normalize min-height and min-width, we might need both.
4911 ;; If min-height is specified, it can be as small as
4912 ;; `window-safe-min-height'.
4916 min-height)
4924 height))))
4927 ;; If min-width is specified, it can be as small as
4928 ;; `window-safe-min-width'.
4932 min-width)
4940 width))))
4946 ;; If SIDE is nil and vertical splitting failed, we try again
4947 ;; splitting horizontally this time.
4951 ;; If WINDOW is live and the root window of its frame, try once
4952 ;; more splitting vertically, disregarding the min-height
4953 ;; specifier this time and using `window-min-height' instead.
4962 "Make WINDOW part of an atomic window."
4966 root new new-parent)
4968 ;; We are in an atomic window.
4970 ;; Split the root window.
4975 ;; WINDOW is or becomes atomic.
4980 window t))
4981 ;; New window and any new parent get their window-atom parameter
4982 ;; set too.
4985 new)))
4988 "Display BUFFER in a new window.
4989 Return the window displaying BUFFER, nil if popping up the window
4990 failed. METHODS must be a list of window/side tuples like those
4991 forming the cdr of the `pop-up-window' buffer display specifier.
4992 As a special case, the car of such a tuple can be also a live
4993 window.
4995 Optional argument SPECIFIERS must be a list of buffer display
4996 specifiers, see the doc-string of `display-buffer-alist' for a
4997 description."
5000 cand window side atomic)
5002 ;; Don't split an unsplittable frame unless
5003 ;; SPECIFIERS allow it.
5012 ;; The largest window.
5015 ;; The least recently used window.
5018 ;; The selected window.
5021 ;; If there are side windows, split the main window
5022 ;; else the frame's root window.
5026 ;; This should gets us the "root" side window if there
5027 ;; exists more than one window on that side.
5030 ;; A window, directly specified.
5031 cand)))
5034 ;; The window must be on the correct frame,
5036 ;; and must be neither a minibuffer window
5038 ;; nor a side window.
5050 ;; Don't pass any specifiers to this function.
5054 ;; Adjust sizes if asked for.
5065 "Make a new frame for displaying BUFFER.
5066 Return the window displaying BUFFER if creating the new frame was
5067 successful, nil otherwise. Optional argument GRAPHIC-ONLY
5068 non-nil means to make a new frame on graphic displays only.
5070 SPECIFIERS must be a list of buffer display specifiers, see the
5071 documentation of `display-buffer-alist' for a description."
5073 noninteractive)
5092 "Display BUFFER in a new window on SIDE of the selected frame.
5093 SLOT specifies the slot to use. SPECIFIERS must be a list of
5094 buffer display specifiers.
5096 Return the window displaying BUFFER, nil if popping up the window
5097 failed."
5105 main
5106 root))
5114 fun)
5119 ;; Make all main-or-root subwindows main windows.
5121 main-or-root t))
5122 ;; Make sure that parent's window-side is nil.
5124 ;; Initialize side.
5126 ;; Adjust sizes if asked for.
5129 ;; Set window parameters.
5136 window)))
5139 "Display BUFFER in a window on SIDE of the selected frame.
5140 SLOT, if non-nil, specifies the window slot where to display the
5141 BUFFER. SLOT zero or nil means use the central slot on SIDE.
5142 SLOT negative means use a slot preceding the central window.
5143 SLOT positive means use a slot following the central window.
5145 SPECIFIERS must be a list of buffer display specifiers."
5149 ;; `major' is the major window on SIDE, `windows' the life
5150 ;; windows on SIDE.
5160 window-sides-slots))
5162 window this-window this-slot prev-window next-window
5163 best-window best-slot abs-slot dedicated)
5168 ;; No suitable side window exists, make one.
5170 ;; Scan windows on SIDE.
5177 ;; Dedicatedness check.
5179 ;; If the window is weakly dedicated to its
5180 ;; buffer, reuse-dedicated must be non-nil.
5182 ;; If the window is strongly dedicated to its
5183 ;; buffer, reuse-dedicated must be t.
5185 ;; Window with matching SLOT, use it.
5199 ;; `this-window' is the first window with the same SLOT.
5200 ;; `prev-window' is the window with the largest slot < SLOT. A new
5201 ;; window will be created after it.
5202 ;; `next-window' is the window with the smallest slot > SLOT. A new
5203 ;; window will be created before it.
5204 ;; `best-window' is the window with the smallest absolute difference
5205 ;; of its slot and SLOT.
5207 ;; Reuse this window.
5216 ;; Don't overwrite an existing quit-restore entry.
5218 window 'quit-restore
5224 ;; Make new window before next-window.
5228 next-window next-side specifiers))))
5230 ;; Make new window after prev-window.
5234 prev-window prev-side specifiers)))))
5239 window 'quit-restore
5242 window))
5245 ;; Reuse best window (the window nearest to SLOT).
5253 ;; Don't overwrite an existing quit-restore entry.
5255 window 'quit-restore
5259 window))
5263 ;; Don't change exisiting slot value.
5268 "Normalize BUFFER-OR-NAME argument for buffer display functions.
5269 If BUFFER-OR-NAME is nil, return the curent buffer. Else, if a
5270 buffer specified by BUFFER-OR-NAME exists, return that buffer.
5271 If no such buffer exists, create a buffer with the name
5272 BUFFER-OR-NAME and return that buffer."
5277 buffer))
5281 "Return non-nil if BUFFER shall be preferably displayed in another frame.
5282 BUFFER must be a live buffer or the name of a live buffer.
5284 Return nil if BUFFER shall be preferably displayed in another
5285 window on the selected frame. Return non-nil if BUFFER shall be
5286 preferably displayed in a window on any but the selected frame.
5288 Optional argument LABEL is like the same argument of
5289 `display-buffer'.
5291 The calculation of the return value is exclusively based on the
5292 user preferences expressed in `display-buffer-alist'."
5301 "Return buffer display specifiers for `special-display-frame-alist'."
5304 ;; Note: `display-buffer' funcalls this so take "(nth 1 args)"
5305 ;; where `special-display-popup-frame' (which uses apply) takes
5306 ;; "(cdr args)".
5318 ;; Don't make anything created above dedicated unless requested.
5319 ;; Otherwise the dedication request below gets in our way.
5324 special-display-frame-alist)
5328 "Subroutine of `display-buffer-normalize-specifiers'.
5329 BUFFER-OR-NAME is the buffer to display.
5331 This routine provides a compatibility layer for the obsolete
5332 Emacs 23 buffer display options to set up the corresponding
5333 buffer display specifiers."
5341 pop-up-frames)))
5342 specifiers args)
5343 ;; `other-window-means-other-frame'
5348 ;; `even-window-heights'
5354 ;; `display-buffer-mark-dedicated'
5356 display-buffer-mark-dedicated)
5359 specifiers)))
5361 ;; `pop-up-window-min-height'
5370 specifiers)))
5372 ;; `pop-up-window-min-width'
5381 specifiers)))
5383 ;; `pop-up-window'
5388 split-window-preferred-function)))
5389 ;; `pop-up-window'
5393 specifiers))))
5395 ;; `pop-up-frame-function'
5402 specifiers)))
5404 ;; `pop-up-frame-alist'
5408 specifiers)))
5410 ;; `pop-up-frame'
5412 ;; `pop-up-frame-function'. If `pop-up-frame-function' uses the
5413 ;; now obsolete `pop-up-frame-alist' it will continue to do so.
5414 ;; `pop-up-frame'
5416 ;; Maybe we should merge graphic-only into the following?
5419 ;; `special-display'
5421 special-display-function
5424 ;; `special-display-p' returns either t or a list of arguments
5425 ;; to pass to `special-display-function'.
5429 specifiers))
5433 specifiers))))
5435 ;; Reuse window showing same buffer on visible or iconified frame.
5436 ;; `pop-up-frames', `display-buffer-reuse-frames' means search for
5437 ;; a window showing the buffer on some visible or iconfied frame.
5438 ;; `last-nonminibuffer-frame' non-nil means search that frame.
5441 display-buffer-reuse-frames)
5443 ;; All visible or iconfied frames.
5445 ;; The following usually returns the same frame
5446 ;; so we implicitly search for a window showing
5447 ;; the buffer on the same frame already.
5452 specifiers))))
5454 ;; `same-window'
5456 ;; Try to reuse the same (selected) window.
5460 ;; Same window if showing this buffer already. Can be overridden
5461 ;; by `other-window' argument if the buffer is already shown in
5462 ;; the same window.
5466 specifiers)))
5468 (defun display-buffer-normalize-argument (buffer-name specifiers other-window-means-other-frame)
5469 "Normalize second argument of `display-buffer'.
5470 BUFFER-NAME is the name of the buffer that shall be displayed,
5471 SPECIFIERS is the second argument of `display-buffer'.
5472 OTHER-WINDOW-MEANS-OTHER-FRAME non-nil means use other-frame for
5473 other-window."
5478 nil)
5480 ;; If SPECIFIERS is a list, we assume it is a list of valid
5481 ;; specifiers.
5487 ;; `other-window' must be treated separately.
5489 'other-frame
5491 display-buffer-macro-specifiers)))
5495 ;; Might be a macro specifier, try to expand it (the cdr is a
5496 ;; list and we have to reverse it later, so do it one at a
5497 ;; time).
5501 ;; Reverse list.
5504 ;; A macro specifier.
5507 ;; Anything else means use another window according to the
5508 ;; non-overriding specifiers of `display-buffer-alist' and the
5509 ;; specifiers produced by `display-buffer-normalize-default'.
5513 "Subroutine of `display-buffer-normalize-alist'.
5514 SPECIFIERS is a list of buffer display specfiers. LABEL is the
5515 same argument of `display-buffer'."
5519 nil)
5521 ;; If SPECIFIERS is a list, we assume it is a list of specifiers.
5527 ;; Might be a macro specifier, try to expand it (the cdr is a
5528 ;; list and we have to reverse it later, so do it one at a
5529 ;; time).
5533 ;; Reverse list.
5536 ;; A macro specifier.
5540 "Normalize `display-buffer-alist'.
5541 BUFFER-NAME must be the name of the buffer that shall be displayed.
5542 LABEL the corresponding argument of `display-buffer'."
5564 normalized))
5568 normalized))))))
5573 "Return normalized specifiers for a buffer matching BUFFER-NAME or LABEL.
5574 BUFFER-NAME must be a string specifying a valid buffer name.
5575 SPECIFIERS and LABEL are the homonymous arguments of
5576 `display-buffer'.
5578 The method for displaying the buffer specified by BUFFER-NAME or
5579 LABEL is established by appending the following four lists of
5580 specifiers:
5582 - The specifiers in `display-buffer-alist' whose buffer
5583 identifier matches BUFFER-NAME or LABEL and whose 'override
5584 component is set.
5586 - SPECIFIERS.
5588 - The specifiers in `display-buffer-alist' whose buffer
5589 identifier matches BUFFER-NAME or LABEL and whose 'override
5590 component is not set."
5597 buffer-name specifiers other-window-means-other-frame))
5599 ;; Handle special meaning of the LABEL argument of
5600 ;; `display-buffer'.
5602 ;; LABEL must be one of visible (any visible frame), 0 (any
5603 ;; visible or iconfied frame), t (any frame), or a live
5604 ;; frame.
5607 ;; Overriding user specifiers.
5609 ;; Special value of third argument of display-buffer.
5610 arg3
5611 ;; Second argument of display-buffer.
5612 arg2
5613 ;; Non-overriding user specifiers.
5615 ;; Default specifiers.
5616 default)))
5618 ;; Minibuffer-only frames should be documented better. They really
5619 ;; deserve a separate section in the manual. Also
5620 ;; `last-nonminibuffer-frame' is nowhere documented in the manual.
5622 "Return FRAME if it is live and not a minibuffer-only frame.
5623 Return the value of `last-nonminibuffer-frame' otherwise."
5626 ;; A not very nice way to get that information.
5628 frame
5632 "Make the buffer specified by BUFFER-OR-NAME appear in some window.
5633 Optional argument BUFFER-OR-NAME may be a buffer, a string \(a
5634 buffer name), or nil. If BUFFER-OR-NAME is a string not naming
5635 an existent buffer, create a buffer with that name. If
5636 BUFFER-OR-NAME is nil or omitted, display the current buffer.
5637 Interactively, prompt for the buffer name using the minibuffer.
5639 Return the window chosen to display the buffer or nil if no such
5640 window is found. Do not change the selected window unless the
5641 buffer is shown on a different frame than the selected one.
5643 Optional argument SPECIFIERS must be a list of buffer display
5644 specifiers, see the documentation of `display-buffer-alist' for a
5645 description.
5647 For convenience, SPECIFIERS may also consist of a single buffer
5648 display location specifier or t, where the latter means to
5649 display the buffer in any but the selected window. If SPECIFIERS
5650 is nil or omitted, this means to exclusively use the specifiers
5651 provided by the variable `display-buffer-alist' and the function
5652 `display-buffer-normalize-default'.
5654 As a special case, the `reuse-window' specifier allows to specify
5655 as second element an arbitrary window, as third element an
5656 arbitrary buffer, and as fourth element an arbitrary frame. As
5657 first element of a window/side pair of the `pop-up-window'
5658 specifier you can specifiy an arbitrary window.
5660 The optional third argument LABEL, if non-nil, must be a symbol
5661 specifiying the buffer display label. Applications should set
5662 this when the buffer shall be displayed in some special way but
5663 BUFFER-OR-NAME does not identify the buffer as special. Typical
5664 buffers that fit into this category are those whose names are
5665 derived from the name of the file they are visiting. A user can
5666 override SPECIFIERS by adding an entry to `display-buffer-alist'
5667 whose car contains LABEL and whose cdr specifies the preferred
5668 alternative display method.
5670 The following values of LABEL have a special meaning and allow to
5671 specify the set of frames to investigate when the buffer already
5672 appears in a window:
5674 `visible' - the set of visible frames.
5676 0 - the set of visible or iconified frames.
5678 t - the set of all frames.
5680 A live frame - the set containing that frame as its only element.
5682 If the buffer is already displayed in a window on a frame in the
5683 specified set, return that window.
5685 The method to display the buffer is derived by combining the
5686 values of `display-buffer-alist' and SPECIFIERS. Highest
5687 priority is given to overriding elements of
5688 `display-buffer-alist'. Next come the elements specified by
5689 SPECIFIERS, followed by the non-overriding elements of
5690 `display-buffer-alist'.
5692 The result must be a list of valid buffer display specifiers. If
5693 `display-buffer-function' is non-nil, call it with the buffer and
5694 this list as arguments."
5699 ;; Normalize specifiers.
5701 ;; Don't use a minibuffer frame.
5703 ;; `window' is the window we use for showing `buffer'.
5704 window specifier method other-window)
5705 ;; Reset this.
5708 ;; Let `display-buffer-function' do the job.
5710 ;; Retrieve the next location specifier while there a specifiers
5711 ;; left and we don't have a valid window.
5735 ;; If we don't have a window yet, try a fallback method. All
5736 ;; specifiers have been used up by now. Try reusing a window
5738 ;; on the selected frame,
5741 ;; showing BUFFER on any visible frame,
5744 ;; not showing BUFFER on any visible frame,
5747 ;; showing BUFFER on any visible or iconified frame,
5750 ;; not showing BUFFER on any visible or iconified frame.
5753 ;; If everything failed so far, try popping up a new frame
5754 ;; regardless of graphic-only restrictions.
5758 "Display buffer specified by BUFFER-OR-NAME in the selected window.
5759 Another window will be used only if the buffer can't be shown in
5760 the selected window, usually because it is dedicated to another
5761 buffer. Optional argument BUFFER-OR-NAME and LABEL are as for
5762 `display-buffer'."
5767 "Display buffer specified by BUFFER-OR-NAME in a window on the same frame.
5768 Another frame will be used only if there is no other choice.
5769 Optional argument BUFFER-OR-NAME and LABEL are as for
5770 `display-buffer'."
5775 "Display buffer specified by BUFFER-OR-NAME in another window.
5776 The selected window will be used only if there is no other
5777 choice. Windows on the selected frame are preferred to windows
5778 on other frames. Optional argument BUFFER-OR-NAME and LABEL are as
5779 for `display-buffer'."
5784 "Display buffer specified by BUFFER-OR-NAME in another window on the same frame.
5785 The selected window or another frame will be used only if there
5786 is no other choice. Optional argument BUFFER-OR-NAME and LABEL are
5787 as for `display-buffer'."
5792 "Display buffer specified by BUFFER-OR-NAME on another frame.
5793 The selected frame will be used only if there is no other choice.
5794 Optional argument BUFFER-OR-NAME and LABEL are as for
5795 `display-buffer'.
5797 If this command uses another frame, it will also select that frame."
5802 "Display buffer specified by BUFFER-OR-NAME and select the window used.
5803 Optional argument BUFFER-OR-NAME may be a buffer, a string \(a
5804 buffer name), or nil. If BUFFER-OR-NAME is a string naming a buffer
5805 that does not exist, create a buffer with that name. If
5806 BUFFER-OR-NAME is nil or omitted, display the current buffer.
5807 Interactively, prompt for the buffer name using the minibuffer.
5809 Optional second argument SPECIFIERS can be: a list of buffer
5810 display specifiers (see `display-buffer-alist'); a single
5811 location specifier; t, which means to display the buffer in any
5812 but the selected window; or nil, which means to exclusively apply
5813 the specifiers customized by the user. See `display-buffer' for
5814 more details.
5816 Optional argument NORECORD non-nil means do not put the displayed
5817 buffer at the front of the buffer list, and do not make the window
5818 displaying it the most recently selected one.
5820 The optional argument LABEL, if non-nil, is a symbol specifying the
5821 display purpose. Applications should set this when the buffer
5822 should be displayed in a special way but BUFFER-OR-NAME does not
5823 identify the buffer as special. Buffers that typically fit into
5824 this category are those whose names have been derived from the
5825 name of the file they are visiting.
5827 Returns the displayed buffer, or nil if displaying the buffer failed.
5829 This uses the function `display-buffer' as a subroutine; see the
5830 documentations of `display-buffer' and `display-buffer-alist' for
5831 additional information."
5836 new-window new-frame)
5840 ;; `display-buffer' has chosen another window, select it.
5844 ;; `display-buffer' has chosen another frame, make sure it gets
5845 ;; input focus and is risen.
5848 buffer))
5851 "Pop to buffer specified by BUFFER-OR-NAME in the selected window.
5852 Another window will be used only if the buffer can't be shown in
5853 the selected window, usually because it is dedicated to another
5854 buffer. Optional arguments BUFFER-OR-NAME, NORECORD and LABEL are
5855 as for `pop-to-buffer'."
5860 "Pop to buffer specified by BUFFER-OR-NAME in a window on the selected frame.
5861 Another frame will be used only if there is no other choice.
5862 Optional arguments BUFFER-OR-NAME, NORECORD and LABEL are as for
5863 `pop-to-buffer'."
5868 "Pop to buffer specified by BUFFER-OR-NAME in another window.
5869 The selected window will be used only if there is no other
5870 choice. Windows on the selected frame are preferred to windows
5871 on other frames. Optional arguments BUFFER-OR-NAME, NORECORD and
5872 LABEL are as for `pop-to-buffer'."
5877 "Pop to buffer specified by BUFFER-OR-NAME in another window on the selected frame.
5878 The selected window or another frame will be used only if there
5879 is no other choice. Optional arguments BUFFER-OR-NAME, NORECORD
5880 and LABEL are as for `pop-to-buffer'."
5885 "Pop to buffer specified by BUFFER-OR-NAME on another frame.
5886 The selected frame will be used only if there's no other choice.
5887 Optional arguments BUFFER-OR-NAME, NORECORD and LABEL are as for
5888 `pop-to-buffer'."
5893 "Read the name of a buffer to switch to, prompting with PROMPT.
5894 Return the neame of the buffer as a string.
5896 This function is intended for the `switch-to-buffer' family of
5897 commands since these need to omit the name of the current buffer
5898 from the list of completions and default values."
5903 ;; Since rbts-completion-table is built dynamically, we
5904 ;; can't just add it to the default value of
5905 ;; icomplete-with-completion-tables, so we add it
5906 ;; here manually.
5911 icomplete-with-completion-tables))))
5916 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
5917 If BUFFER-OR-NAME is nil, return the buffer returned by
5918 `other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
5919 exists, return that buffer. If no such buffer exists, create a
5920 buffer with the name BUFFER-OR-NAME and return that buffer."
5925 buffer))
5929 "Switch to buffer BUFFER-OR-NAME in the selected window.
5930 If called interactively, prompt for the buffer name using the
5931 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5932 determines whether to request confirmation before creating a new
5933 buffer.
5935 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
5936 nil. If BUFFER-OR-NAME is a string that does not identify an
5937 existing buffer, create a buffer with that name. If
5938 BUFFER-OR-NAME is nil, switch to the buffer returned by
5939 `other-buffer'.
5941 Optional argument NORECORD non-nil means do not put the buffer
5942 specified by BUFFER-OR-NAME at the front of the buffer list and
5943 do not make the window displaying it the most recently selected
5944 one. Return the buffer switched to.
5946 This function is intended for interactive use only. Lisp
5947 functions should call `pop-to-buffer-same-window' instead."
5952 ;; Don't call set-window-buffer if it's not needed since it
5953 ;; might signal an error (e.g. if the window is dedicated).
5965 "Switch to buffer BUFFER-OR-NAME in a window on the selected frame.
5966 Another frame will be used only if there is no other choice.
5967 Arguments BUFFER-OR-NAME and NORECORD have the same meaning as
5968 for `switch-to-buffer'.
5970 This function is intended for interactive use only. Lisp
5971 functions should call `pop-to-buffer-same-frame' instead."
5978 "Switch to buffer BUFFER-OR-NAME in another window.
5979 The selected window will be used only if there is no other
5980 choice. Windows on the selected frame are preferred to windows
5981 on other frames. Arguments BUFFER-OR-NAME and NORECORD have the
5982 same meaning as for `switch-to-buffer'.
5984 This function is intended for interactive use only. Lisp
5985 functions should call `pop-to-buffer-other-window' instead."
5992 "Switch to buffer BUFFER-OR-NAME in another window on the selected frame.
5993 The selected window or another frame will be used only if there
5994 is no other choice. Arguments BUFFER-OR-NAME and NORECORD have
5995 the same meaning as for `switch-to-buffer'.
5997 This function is intended for interactive use only. Lisp
5998 functions should call `pop-to-buffer-other-window-same-frame'
5999 instead."
6006 "Switch to buffer BUFFER-OR-NAME on another frame.
6007 The same frame will be used only if there is no other choice.
6008 Arguments BUFFER-OR-NAME and NORECORD have the same meaning
6009 as for `switch-to-buffer'.
6011 This function is intended for interactive use only. Lisp
6012 functions should call `pop-to-buffer-other-frame' instead."
6018 ;;; Obsolete definitions of `display-buffer' below.
6021 `display-buffer' and `pop-to-buffer' show a buffer whose name is
6022 on this list in the selected rather than some other window.
6024 An element of this list can be a cons cell instead of just a
6025 string. In that case, the cell's car must be a string specifying
6026 the buffer name. This is for compatibility with
6027 `special-display-buffer-names'; the cdr of the cons cell is
6028 ignored.
6030 See also `same-window-regexps'."
6033 ;; (make-obsolete-variable
6034 ;; 'same-window-buffer-names
6035 ;; "use 2nd arg of `display-buffer' instead." "24.1")
6039 `display-buffer' and `pop-to-buffer' show a buffer whose name
6040 matches a regexp on this list in the selected rather than some
6041 other window.
6043 An element of this list can be a cons cell instead of just a
6044 string. In that case, the cell's car must be a regexp matching
6045 the buffer name. This is for compatibility with
6046 `special-display-regexps'; the cdr of the cons cell is ignored.
6048 See also `same-window-buffer-names'."
6051 ;; (make-obsolete-variable
6052 ;; 'same-window-regexps
6053 ;; "use 2nd arg of `display-buffer' instead." "24.1")
6057 This function returns non-nil if `display-buffer' or
6058 `pop-to-buffer' would show a buffer named BUFFER-NAME in the
6059 selected rather than \(as usual\) some other window. See
6060 `same-window-buffer-names' and `same-window-regexps'."
6065 ;; The elements of `same-window-buffer-names' can be buffer
6066 ;; names or cons cells whose cars are buffer names.
6071 ;; The elements of `same-window-regexps' can be regexps
6072 ;; or cons cells whose cars are regexps.
6078 ;; (make-obsolete
6079 ;; 'same-window-p "pass argument to buffer display function instead." "24.1")
6083 "Alist of parameters for special frames.
6084 Special frames are used for buffers whose names are listed in
6085 `special-display-buffer-names' and for buffers whose names match
6086 one of the regular expressions in `special-display-regexps'.
6088 This variable can be set in your init file, like this:
6090 (setq special-display-frame-alist '((width . 80) (height . 20)))
6092 These supersede the values given in `default-frame-alist'."
6097 ;; (make-obsolete-variable
6098 ;; 'special-display-frame-alist
6099 ;; "use 2nd arg of `display-buffer' instead." "24.1")
6102 "Display BUFFER in a special frame and return the window chosen.
6103 If BUFFER is already displayed in a visible or iconified frame,
6104 raise that frame. Otherwise, display BUFFER in a way as
6105 specified by optional argument ARGS.
6107 If ARGS is an alist, use it as a list of frame parameters. If
6108 these parameters contain \(same-window . t), display BUFFER in
6109 the selected window. If they contain \(same-frame . t), display
6110 BUFFER in a window on the selected frame.
6112 If ARGS is a list whose car is a symbol, use (car ARGS) as a
6113 function to do the work. Pass it BUFFER as first argument,
6114 and (cdr ARGS) as the rest of the arguments."
6119 ;; If we have a window already, make it visible.
6124 window))
6125 ;; Reuse the current window if the user requested it.
6129 ;; Stay on the same frame if requested.
6136 ;; If no window yet, make one in a new frame.
6141 special-display-frame-alist))))))
6145 ;; (make-obsolete
6146 ;; 'special-display-popup-frame
6147 ;; "use 2nd arg of `display-buffer' instead." "24.1")
6150 "Function to call for displaying special buffers.
6151 This function is called with two arguments - the buffer and,
6152 optionally, a list - and should return a window displaying that
6153 buffer. The default value usually makes a separate frame for the
6154 buffer using `special-display-frame-alist' to specify the frame
6155 parameters. See the definition of `special-display-popup-frame'
6156 for how to specify such a function.
6158 A buffer is special when its name is either listed in
6159 `special-display-buffer-names' or matches a regexp in
6160 `special-display-regexps'."
6164 ;; (make-obsolete-variable
6165 ;; 'special-display-function
6166 ;; "use 2nd arg of `display-buffer' instead." "24.1")
6169 "List of names of buffers that should be displayed specially.
6170 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
6171 its name is in this list, displays the buffer in a way specified
6172 by `special-display-function'. `special-display-popup-frame'
6173 \(the default for `special-display-function') usually displays
6174 the buffer in a separate frame made with the parameters specified
6175 by `special-display-frame-alist'. If `special-display-function'
6176 has been set to some other function, that function is called with
6177 the buffer as first, and nil as second argument.
6179 Alternatively, an element of this list can be specified as
6180 \(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
6181 name and FRAME-PARAMETERS an alist of \(PARAMETER . VALUE) pairs.
6182 `special-display-popup-frame' will interpret such pairs as frame
6183 parameters when it creates a special frame, overriding the
6184 corresponding values from `special-display-frame-alist'.
6186 As a special case, if FRAME-PARAMETERS contains (same-window . t)
6187 `special-display-popup-frame' displays that buffer in the
6188 selected window. If FRAME-PARAMETERS contains (same-frame . t),
6189 it displays that buffer in a window on the selected frame.
6191 If `special-display-function' specifies some other function than
6192 `special-display-popup-frame', that function is called with the
6193 buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
6194 argument.
6196 Finally, an element of this list can be also specified as
6197 \(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
6198 `special-display-popup-frame' will call FUNCTION with the buffer
6199 named BUFFER-NAME as first argument, and OTHER-ARGS as the
6200 second. If `special-display-function' specifies some other
6201 function, that function is called with the buffer named
6202 BUFFER-NAME as first, and the element's cdr as second argument.
6205 name to it but the corresponding buffer is displayed in the
6206 selected window, look at the values of `same-window-buffer-names'
6207 and `same-window-regexps'. Those variables take precedence over
6208 this one.
6210 See also `special-display-regexps'."
6231 ;; (make-obsolete-variable
6232 ;; 'special-display-buffer-names
6233 ;; "use 2nd arg of `display-buffer' instead." "24.1")
6235 ;;;###autoload
6239 "List of regexps saying which buffers should be displayed specially.
6240 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
6241 any regexp in this list matches its name, displays it specially
6242 using `special-display-function'. `special-display-popup-frame'
6243 \(the default for `special-display-function') usually displays
6244 the buffer in a separate frame made with the parameters specified
6245 by `special-display-frame-alist'. If `special-display-function'
6246 has been set to some other function, that function is called with
6247 the buffer as first, and nil as second argument.
6249 Alternatively, an element of this list can be specified as
6250 \(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
6251 FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
6252 `special-display-popup-frame' will then interpret these pairs as
6253 frame parameters when creating a special frame for a buffer whose
6254 name matches REGEXP, overriding the corresponding values from
6255 `special-display-frame-alist'.
6257 As a special case, if FRAME-PARAMETERS contains (same-window . t)
6258 `special-display-popup-frame' displays buffers matching REGEXP in
6259 the selected window. \(same-frame . t) in FRAME-PARAMETERS means
6260 to display such buffers in a window on the selected frame.
6262 If `special-display-function' specifies some other function than
6263 `special-display-popup-frame', that function is called with the
6264 buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
6265 as second argument.
6267 Finally, an element of this list can be also specified as
6268 \(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
6269 will then call FUNCTION with the buffer whose name matched
6270 REGEXP as first, and OTHER-ARGS as second argument. If
6271 `special-display-function' specifies some other function, that
6272 function is called with the buffer whose name matched REGEXP
6273 as first, and the element's cdr as second argument.
6276 name to it but the corresponding buffer is displayed in the
6277 selected window, look at the values of `same-window-buffer-names'
6278 and `same-window-regexps'. Those variables take precedence over
6279 this one.
6281 See also `special-display-buffer-names'."
6302 ;; (make-obsolete-variable
6303 ;; 'special-display-regexps
6304 ;; "use 2nd arg of `display-buffer' instead." "24.1")
6307 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
6308 More precisely, return t if `special-display-buffer-names' or
6309 `special-display-regexps' contain a string entry equaling or
6310 matching BUFFER-NAME. If `special-display-buffer-names' or
6311 `special-display-regexps' contain a list entry whose car equals
6312 or matches BUFFER-NAME, the return value is the cdr of that
6313 entry."
6316 tmp)
6320 t)
6332 ;; (make-obsolete
6333 ;; 'special-display-p
6334 ;; "pass argument to buffer display function instead." "24.1")
6337 "Alist of parameters for automatically generated new frames.
6338 You can set this in your init file; for example,
6340 (setq pop-up-frame-alist '((width . 80) (height . 20)))
6342 If non-nil, the value you specify here is used by the default
6343 `pop-up-frame-function' for the creation of new frames.
6345 Since `pop-up-frame-function' is used by `display-buffer' for
6346 making new frames, any value specified here by default affects
6347 the automatic generation of new frames via `display-buffer' and
6348 all functions based on it. The behavior of `make-frame' is not
6349 affected by this variable."
6354 ;; (make-obsolete-variable
6355 ;; 'pop-up-frame-alist
6356 ;; "use 2nd arg of `display-buffer' instead." "24.1")
6360 "Function used by `display-buffer' for creating a new frame.
6361 This function is called with no arguments and should return a new
6362 frame. The default value calls `make-frame' with the argument
6363 `pop-up-frame-alist'."
6366 ;; (make-obsolete-variable
6367 ;; 'pop-up-frame-function
6368 ;; "use 2nd arg of `display-buffer' instead." "24.1")
6371 "Whether `display-buffer' should make a separate frame.
6372 If nil, never make a separate frame.
6373 If the value is `graphic-only', make a separate frame
6374 on graphic displays only.
6375 Any other non-nil value means always make a separate frame."
6382 ;; (make-obsolete-variable
6383 ;; 'pop-up-frames
6384 ;; "use 2nd arg of `display-buffer' instead." "24.1")
6387 "Set and non-nil means `display-buffer' should reuse frames.
6388 If the buffer in question is already displayed in a frame, raise
6389 that frame."
6394 ;; (make-obsolete-variable
6395 ;; 'display-buffer-reuse-frames
6396 ;; "use 2nd arg of `display-buffer' instead." "24.1")
6399 "Non-nil means `display-buffer' should make a new window."
6402 ;; (make-obsolete-variable
6403 ;; 'pop-up-windows
6404 ;; "use 2nd arg of `display-buffer' instead." "24.1")
6407 "Function called by `display-buffer' to split a window.
6408 This function is called with a window as single argument and is
6409 supposed to split that window and return the new window. If the
6410 window can (or shall) not be split, it is supposed to return nil.
6412 The default is to call the function `split-window-sensibly' which
6413 tries to split the window in a way which seems most suitable.
6414 You can customize the options `split-height-threshold' and/or
6415 `split-width-threshold' in order to have `split-window-sensibly'
6416 prefer either vertical or horizontal splitting.
6418 If you set this to any other function, bear in mind that
6419 `display-buffer' may call that function repeatedly; the option
6420 `pop-up-windows' controls which windows may become the argument
6421 of this function.
6423 The window selected at the time `display-buffer' was invoked is
6424 still selected when this function is called. Hence you can
6425 compare the window argument with the value of `selected-window'
6426 if you intend to split the selected window instead or if you do
6427 not want to split the selected window."
6431 ;; (make-obsolete-variable
6432 ;; 'split-window-preferred-function
6433 ;; "use 2nd arg of `display-buffer' instead." "24.1")
6436 "Minimum height for splitting a window to display a buffer.
6437 If this is an integer, `display-buffer' can split a window
6438 vertically only if it has at least this many lines. If this is
6439 nil, `display-buffer' does not split windows vertically. If a
6440 window is the only window on its frame, `display-buffer' may
6441 split it vertically disregarding the value of this variable."
6445 ;; (make-obsolete-variable
6446 ;; 'split-height-threshold
6447 ;; "use 2nd arg of `display-buffer' instead." "24.1")
6450 "Minimum width for splitting a window to display a buffer.
6451 If this is an integer, `display-buffer' can split a window
6452 horizontally only if it has at least this many columns. If this
6453 is nil, `display-buffer' cannot split windows horizontally."
6457 ;; (make-obsolete-variable
6458 ;; 'split-width-threshold
6459 ;; "use 2nd arg of `display-buffer' instead." "24.1")
6462 "If non-nil `display-buffer' will try to even window heights.
6463 Otherwise `display-buffer' will leave the window configuration
6464 alone. Heights are evened only when `display-buffer' chooses a
6465 window that appears above or below the selected window."
6468 ;; (make-obsolete-variable
6469 ;; 'even-window-heights
6470 ;; "use 2nd arg of `display-buffer' instead." "24.1")
6473 "Non-nil means `display-buffer' marks the windows it creates as dedicated.
6474 The actual non-nil value of this variable will be copied to the
6476 ;; (make-obsolete-variable
6477 ;; 'display-buffer-mark-dedicated
6478 ;; "use 2nd arg of `display-buffer' instead." "24.1")
6481 "Return non-nil if `split-window-sensibly' may split WINDOW.
6482 Optional argument HORIZONTAL nil or omitted means check whether
6483 `split-window-sensibly' may split WINDOW vertically. HORIZONTAL
6484 non-nil means check whether WINDOW may be split horizontally.
6486 WINDOW may be split vertically when the following conditions
6487 hold:
6488 - `window-size-fixed' is either nil or equals `width' for the
6489 buffer of WINDOW.
6490 - `split-height-threshold' is an integer and WINDOW is at least as
6491 high as `split-height-threshold'.
6492 - When WINDOW is split evenly, the emanating windows are at least
6493 `window-min-height' lines tall and can accommodate at least one
6494 line plus - if WINDOW has one - a mode line.
6496 WINDOW may be split horizontally when the following conditions
6497 hold:
6498 - `window-size-fixed' is either nil or equals `height' for the
6499 buffer of WINDOW.
6500 - `split-width-threshold' is an integer and WINDOW is at least as
6501 wide as `split-width-threshold'.
6502 - When WINDOW is split evenly, the emanating windows are at least
6503 `window-min-width' or two (whichever is larger) columns wide."
6507 ;; A window can be split horizontally when its width is not
6508 ;; fixed, it is at least `split-width-threshold' columns wide
6509 ;; and at least twice as wide as `window-min-width' and 2 (the
6510 ;; latter value is hardcoded).
6512 ;; Testing `window-full-width-p' here hardly makes any
6513 ;; sense nowadays. This can be done more intuitively by
6514 ;; setting up `split-width-threshold' appropriately.
6519 ;; A window can be split vertically when its height is not
6520 ;; fixed, it is at least `split-height-threshold' lines high,
6521 ;; and it is at least twice as high as `window-min-height' and 2
6522 ;; if it has a modeline or 1.
6529 ;; (make-obsolete
6530 ;; 'window-splittable-p "use 2nd arg of `display-buffer' instead." "24.1")
6533 "Split WINDOW in a way suitable for `display-buffer'.
6534 If `split-height-threshold' specifies an integer, WINDOW is at
6535 least `split-height-threshold' lines tall and can be split
6536 vertically, split WINDOW into two windows one above the other and
6537 return the lower window. Otherwise, if `split-width-threshold'
6538 specifies an integer, WINDOW is at least `split-width-threshold'
6539 columns wide and can be split horizontally, split WINDOW into two
6540 windows side by side and return the window on the right. If this
6541 can't be done either and WINDOW is the only window on its frame,
6542 try to split WINDOW vertically disregarding any value specified
6543 by `split-height-threshold'. If that succeeds, return the lower
6544 window. Return nil otherwise.
6546 By default `display-buffer' routines call this function to split
6547 the largest or least recently used window. To change the default
6548 customize the option `split-window-preferred-function'.
6550 You can enforce this function to not split WINDOW horizontally,
6551 by setting \(or binding) the variable `split-width-threshold' to
6552 nil. If, in addition, you set `split-height-threshold' to zero,
6553 chances increase that this function does split WINDOW vertically.
6555 In order to not split WINDOW vertically, set \(or bind) the
6556 variable `split-height-threshold' to nil. Additionally, you can
6557 set `split-width-threshold' to zero to make a horizontal split
6558 more likely to occur.
6560 Have a look at the function `window-splittable-p' if you want to
6561 know how `split-window-sensibly' determines whether WINDOW can be
6562 split."
6564 ;; Split window vertically.
6568 ;; Split window horizontally.
6573 ;; If WINDOW is the only window on its frame and is not the
6574 ;; minibuffer window, try to split it vertically disregarding
6575 ;; the value of `split-height-threshold'.
6580 ;; (make-obsolete
6581 ;; 'split-window-sensibly "use 2nd arg of `display-buffer' instead." "24.1")
6583 ;; Functions for converting Emacs 23 buffer display options to buffer
6584 ;; display specifiers.
6586 "Helper function for `display-buffer-alist-set'."
6596 'display-buffer-alist
6600 "Set `display-buffer-alist' from Emacs 23 buffer display options.
6601 Optional argument NO-CUSTOM nil means use `customize-set-variable'
6602 to set the value of `display-buffer-alist'. NO-CUSTOM non-nil
6603 means to use `setq' instead.
6605 Optional argument ADD nil means to replace the actual value of
6606 `display-buffer-alist' with the value calculated here. ADD
6607 non-nil means prepend the value calculated here to the current
6608 value of `display-buffer-alist'."
6614 ;; Disable warnings, there are too many obsolete options here.
6616 ;; `pop-up-windows'
6618 nil
6621 ;; `split-window-sensibly' has been merged into the
6622 ;; `display-buffer-split-window' code as `nil'.
6623 split-window-preferred-function))
6627 ;; Undocumented hack.
6632 ;; Undocumented hack.
6635 'pop-up-window
6638 'pop-up-window
6643 no-custom)
6645 ;; `pop-up-frames'
6647 nil
6649 'pop-up-frame
6656 no-custom)
6658 ;; `special-display-regexps'
6662 ;; Plain string.
6666 'function
6668 special-display-frame-alist))
6669 no-custom))
6675 ;; A function.
6679 'function
6680 ;; Weary.
6682 no-custom))
6684 ;; A list of parameters.
6692 no-custom))
6700 'function
6702 special-display-frame-alist))
6703 no-custom)))))))))
6705 ;; `special-display-buffer-names'
6709 ;; Plain string.
6713 'function
6715 special-display-frame-alist))
6716 no-custom))
6722 ;; A function.
6726 'function
6727 ;; Weary.
6729 no-custom))
6731 ;; A list of parameters.
6739 no-custom))
6747 'function
6749 special-display-frame-alist))
6750 no-custom)))))))))
6752 ;; `same-window-regexps'
6759 no-custom))
6764 no-custom))))
6766 ;; `same-window-buffer-names'
6773 no-custom))
6778 no-custom))))
6780 ;; `reuse-window'
6782 nil
6784 'reuse-window
6787 ;; "0" (all visible and iconified frames) is hardcoded in
6788 ;; Emacs 23.
6792 no-custom)
6794 ;; `display-buffer-mark-dedicated'
6797 nil
6800 no-custom)))
6802 display-buffer-alist)
6803 \f
6805 "Set the height in lines of the text display area of WINDOW to HEIGHT.
6806 WINDOW must be a live window. HEIGHT doesn't include the mode
6807 line or header line, if any, or any partial-height lines in the
6808 text display area.
6810 Note that the current implementation of this function cannot
6811 always set the height exactly, but attempts to be conservative,
6812 by allocating more lines than are actually needed in the case
6813 where some error may be present."
6817 ;; Setting window-min-height to a value like 1 can lead to very
6818 ;; bizarre displays because it also allows Emacs to make *other*
6819 ;; windows 1-line tall, which means that there's no more space for
6820 ;; the modeline.
6825 "Make selected window DELTA columns wider.
6826 Interactively, if no argument is given, make selected window one
6827 column wider."
6832 "Make selected window DELTA columns narrower.
6833 Interactively, if no argument is given, make selected window one
6834 column narrower."
6839 "Return the number of screen lines in the region.
6840 The number of screen lines may be different from the number of actual lines,
6841 due to line breaking, display table, etc.
6843 Optional arguments BEG and END default to `point-min' and `point-max'
6844 respectively.
6846 If region ends with a newline, ignore it unless optional third argument
6847 COUNT-FINAL-NEWLINE is non-nil.
6849 The optional fourth argument WINDOW specifies the window used for obtaining
6850 parameters such as width, horizontal scrolling, and so on. The default is
6851 to use the selected window's parameters.
6853 Like `vertical-motion', `count-screen-lines' always uses the current buffer,
6854 regardless of which buffer is displayed in WINDOW. This makes possible to use
6855 `count-screen-lines' in any buffer, whether or not it is currently displayed
6856 in some window."
6862 0
6875 "Return the height (in screen lines) of the buffer that WINDOW is displaying."
6879 ;; If buffer ends with a newline, ignore it when
6880 ;; counting height unless point is after it.
6882 window))))
6884 ;;; Resizing buffers to fit their contents exactly.
6886 "Adjust height of WINDOW to display its buffer's contents exactly.
6887 WINDOW can be any live window and defaults to the selected one.
6889 Optional argument MAX-HEIGHT specifies the maximum height of
6890 WINDOW and defaults to the height of WINDOW's frame. Optional
6891 argument MIN-HEIGHT specifies the minimum height of WINDOW and
6892 defaults to `window-min-height'. Both, MAX-HEIGHT and MIN-HEIGHT
6893 are specified in lines and include the mode line and header line,
6894 if any.
6896 Optional argument OVERRIDE non-nil means override restrictions
6897 imposed by `window-min-height' and `window-min-width' on the size
6898 of WINDOW.
6900 Return the number of lines by which WINDOW was enlarged or
6901 shrunk. If an error occurs during resizing, return nil but don't
6902 signal an error.
6904 Note that even if this function makes WINDOW large enough to show
6905 _all_ lines of its buffer you might not see the first lines when
6906 WINDOW was scrolled."
6908 ;; Do all the work in WINDOW and its buffer and restore the selected
6909 ;; window and the current buffer when we're done.
6911 ;; Can't resize a full height or fixed-size window.
6914 ;; `with-selected-window' should orderly restore the current buffer.
6916 ;; We are in WINDOW's buffer now.
6922 window-safe-min-height)))
6925 ;; Adjust MAX-HEIGHT.
6928 max-window-height
6930 ;; Make `desired-height' the height necessary to show
6931 ;; all of WINDOW's buffer, constrained by MIN-HEIGHT
6932 ;; and MAX-HEIGHT.
6937 ;; For non-minibuffers count the mode line, if any.
6939 mode-line-format)
6940 1
6942 ;; Count the header line, if any.
6944 max-height)
6945 min-height))
6954 ;; This `condition-case' shouldn't be necessary, but who knows?
6957 ;; Return zero if DELTA became zero in the proces.
6958 0
6959 ;; Don't try to redisplay with the cursor at the end on its
6960 ;; own line--that would force a scroll and spoil things.
6962 ;; It's silly to put `point' at the end of the previous
6963 ;; line and so maybe force horizontal scrolling.
6965 ;; Call `window-resize' with OVERRIDE argument equal WINDOW.
6967 ;; Check if the last line is surely fully visible. If
6968 ;; not, enlarge the window.
6972 ;; Don't include final newline.
6975 ;; If line-wrapping is turned off, test the
6976 ;; beginning of the last line for
6977 ;; visibility instead of the end, as the
6978 ;; end of the line could be invisible by
6979 ;; virtue of extending past the edge of the
6980 ;; window.
6984 ;; This loop might in some rare pathological cases raise
6985 ;; an error - another reason for the `condition-case'.
6992 delta))))
6995 "Return t if WINDOW can be shrunk without shrinking other windows.
6996 WINDOW defaults to the selected window."
6999 ;; The following doesn't satisfy the doc-string's claim when
7000 ;; window and previous-/next-window are not part of the same
7001 ;; combination but still share a common edge. Using
7002 ;; `window-iso-combined-p' instead should handle that.
7005 ;; (make-obsolete
7006 ;; 'window-safely-shrinkable-p "use `window-iso-combined-p' instead." "24.1")
7009 "Shrink height of WINDOW if its buffer doesn't need so many lines.
7010 More precisely, shrink WINDOW vertically to be as small as
7011 possible, while still showing the full contents of its buffer.
7012 WINDOW defaults to the selected window.
7014 Do not shrink WINDOW to less than `window-min-height' lines. Do
7015 nothing if the buffer contains more lines than the present window
7016 height, or if some of the window's contents are scrolled out of
7017 view, or if shrinking this window would also shrink another
7018 window, or if the window is the only window of its frame.
7020 Return non-nil if the window was shrunk, nil otherwise."
7023 ;; Make sure that WINDOW is vertically combined and `point-min' is
7024 ;; visible (for whatever reason that's needed). The remaining issues
7025 ;; should be taken care of by `fit-window-to-buffer'.
7029 \f
7031 "Kill the current buffer and delete the selected window."
7040 ;; If `delete-window' failed before, we rerun it to regenerate
7041 ;; the error so it can be seen in the echo area.
7044 ;; If the buffer is not dead for some reason (probably because
7045 ;; of a `quit' signal), remove the hook again.
7051 "Quit WINDOW and bury its buffer.
7052 With a prefix argument, kill the buffer instead. WINDOW defaults
7053 to the selected window.
7055 If WINDOW is non-nil, dedicated, or a minibuffer window, delete
7056 it and, if it's alone on its frame, its frame too. Otherwise, or
7057 if deleting WINDOW fails in any of the preceding cases, display
7058 another buffer in WINDOW using `switch-to-buffer'.
7060 Optional argument KILL non-nil means kill WINDOW's buffer.
7061 Otherwise, bury WINDOW's buffer, see `bury-buffer'."
7067 ;; WINDOW is either non-nil, a minibuffer window, or dedicated;
7068 ;; try to delete it.
7072 ;; WINDOW is alone on its frame.
7074 ;; There are other windows on its frame, delete WINDOW.
7076 ;; Otherwise, switch to another buffer in the selected window.
7079 ;; Deal with the buffer.
7083 \f
7085 "Indicates the last recenter operation performed.
7089 "Cycling order for `recenter-top-bottom'.
7090 A list of elements with possible values `top', `middle', `bottom',
7091 integer or float numbers that define the cycling order for
7092 the command `recenter-top-bottom'.
7094 Top and bottom destinations are `scroll-margin' lines the from true
7095 window top and bottom. Middle redraws the frame and centers point
7096 vertically within the window. Integer number moves current line to
7097 the specified absolute window-line. Float number between 0.0 and 1.0
7098 means the percentage of the screen space from the top. The default
7099 cycling order is middle -> top -> bottom."
7110 "Move current buffer line to the specified window line.
7111 With no prefix argument, successive calls place point according
7112 to the cycling order defined by `recenter-positions'.
7114 A prefix argument is handled like `recenter':
7115 With numeric prefix ARG, move current line to window-line ARG.
7116 With plain `C-u', move current line to window center."
7124 recenter-positions))
7143 "Position point relative to window.
7145 With a prefix argument ARG, acts like `move-to-window-line'.
7147 With no argument, positions point at center of window.
7148 Successive calls position point at positions defined
7149 by `recenter-positions'."
7157 recenter-positions))
7174 \f
7175 ;;; Scrolling commands.
7177 ;;; Scrolling commands which does not signal errors at top/bottom
7178 ;;; of buffer at first key-press (instead moves to top/bottom
7179 ;;; of buffer).
7182 "Move point to top/bottom of buffer before signalling a scrolling error.
7183 A value of nil means just signal an error if no more scrolling possible.
7184 A value of t means point moves to the beginning or the end of the buffer
7185 \(depending on scrolling direction) when no more scrolling possible.
7186 When point is already on that position, then signal an error."
7192 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
7193 If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
7194 scroll window further, move cursor to the bottom line.
7195 When point is already on that position, then signal an error.
7196 A near full screen is `next-screen-context-lines' less than a full screen.
7197 Negative ARG means scroll downward.
7198 If ARG is the atom `-', scroll downward by nearly full screen."
7214 ;; When scrolling by ARG lines can't be done,
7215 ;; move by ARG lines instead.
7217 ;; When ARG is nil for full-screen scrolling,
7218 ;; move to the bottom of the buffer.
7224 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
7225 If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
7226 scroll window further, move cursor to the top line.
7227 When point is already on that position, then signal an error.
7228 A near full screen is `next-screen-context-lines' less than a full screen.
7229 Negative ARG means scroll upward.
7230 If ARG is the atom `-', scroll upward by nearly full screen."
7246 ;; When scrolling by ARG lines can't be done,
7247 ;; move by ARG lines instead.
7249 ;; When ARG is nil for full-screen scrolling,
7250 ;; move to the top of the buffer.
7255 ;;; Scrolling commands which scroll a line instead of full screen.
7258 "Scroll text of selected window upward ARG lines; or one line if no ARG.
7259 If ARG is omitted or nil, scroll upward by one line.
7260 This is different from `scroll-up-command' that scrolls a full screen."
7267 "Scroll text of selected window down ARG lines; or one line if no ARG.
7268 If ARG is omitted or nil, scroll down by one line.
7269 This is different from `scroll-down-command' that scrolls a full screen."
7275 \f
7278 For more details, see the documentation for `scroll-other-window'."
7281 ;; Just invert the argument's meaning.
7282 ;; We can do that without knowing which window it will be.
7288 "Move point to the beginning of the buffer in the other window.
7289 Leave mark at previous position.
7290 With arg N, put point N/10 of the way from the true beginning."
7294 ;; We use unwind-protect rather than save-window-excursion
7295 ;; because the latter would preserve the things we want to change.
7299 ;; Set point and mark in that window's buffer.
7302 ;; Set point accordingly.
7307 "Move point to the end of the buffer in the other window.
7308 Leave mark at previous position.
7309 With arg N, put point N/10 of the way from the true end."
7311 ;; See beginning-of-buffer-other-window for comments.
7321 \f
7332 "When non-nil, special state of delayed window autoselection.
7333 Possible values are `suspend' \(suspend autoselection after a menu or
7334 scrollbar interaction\) and `select' \(the next invocation of
7338 "Cancel delayed window autoselection.
7339 Optional argument FORCE means cancel unconditionally."
7341 ;; Don't cancel for select-window or select-frame events
7342 ;; or when the user drags a scroll bar.
7354 "Start delayed window autoselection.
7355 MOUSE-POSITION is the last position where the mouse was seen as returned
7356 by `mouse-position'. Optional argument WINDOW non-nil denotes the
7357 window where the mouse was seen. Optional argument SUSPEND non-nil
7358 means suspend autoselection."
7359 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
7363 ;; Install timer which runs `mouse-autoselect-window-select' after
7364 ;; `mouse-autoselect-window' seconds.
7370 "Select window with delayed window autoselection.
7371 If the mouse position has stabilized in a non-selected window, select
7372 that window. The minibuffer window is selected only if the minibuffer is
7373 active. This function is run by `mouse-autoselect-window-timer'."
7384 ;; A menu / popup dialog is active or the mouse is on the scroll-bar
7385 ;; of WINDOW, temporarily suspend delayed autoselection.
7388 ;; Delayed autoselection was temporarily suspended, reenable it.
7393 ;; If `mouse-autoselect-window' is positive, select
7394 ;; window if the window is the same as before.
7396 ;; Otherwise select window if the mouse is at the same
7397 ;; position as before. Observe that the first test after
7398 ;; starting autoselection usually fails since the value of
7399 ;; `mouse-autoselect-window-position' recorded there is the
7400 ;; position where the mouse has entered the new window and
7401 ;; not necessarily where the mouse has stopped moving.
7403 ;; The minibuffer is a candidate window if it's active.
7406 ;; Mouse position has stabilized in non-selected window: Cancel
7407 ;; delayed autoselection and try to select that window.
7409 ;; Select window where mouse appears unless the selected window is the
7410 ;; minibuffer. Use `unread-command-events' in order to execute pre-
7411 ;; and post-command hooks and trigger idle timers. To avoid delaying
7412 ;; autoselection again, set `mouse-autoselect-window-state'."
7417 unread-command-events))))
7421 ;; Mouse position has either stabilized in the selected window or at
7422 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
7425 ;; Mouse position has not stabilized yet, resume delayed
7426 ;; autoselection.
7430 "Handle select-window events."
7434 ;; Don't switch if we're currently in the minibuffer.
7435 ;; This tries to work around problems where the
7436 ;; minibuffer gets unselected unexpectedly, and where
7437 ;; you then have to move your mouse all the way down to
7438 ;; the minibuffer to select it.
7440 ;; Don't switch to minibuffer window unless it's active.
7443 ;; Don't switch when autoselection shall be delayed.
7448 ;; Cancel any delayed autoselection.
7450 ;; Start delayed autoselection from current mouse
7451 ;; position and window.
7453 ;; Executing a command cancels delayed autoselection.
7457 ;; Reset state of delayed autoselection.
7459 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
7464 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
7465 WINDOW defaults to the selected window.
7466 Return nil if WINDOW is not a partial-width window
7467 (regardless of the value of `truncate-lines').
7468 Otherwise, consult the value of `truncate-partial-width-windows'
7469 for the buffer shown in WINDOW."
7477 t-p-w-w))))
7478 \f
7491 ;;; window.el ends here