1 ;;; window.el --- GNU Emacs window commands aside from those written in C
3 ;; Copyright (C) 1985, 1989, 1992-1994, 2000-2016 Free Software
6 ;; Maintainer: emacs-devel@gnu.org
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/>.
27 ;; Window tree functions.
31 (defun internal--before-save-selected-window ()
32 (cons (selected-window)
33 ;; We save and restore all frames' selected windows, because
34 ;; `select-window' can change the frame-selected-window of
35 ;; whatever frame that window is in. Each text terminal's
36 ;; top-frame is preserved by putting it last in the list.
38 (mapcar (lambda (terminal)
39 (let ((frames (frames-on-display-list terminal
))
40 (top-frame (tty-top-frame terminal
))
45 (delq top-frame frames
))))
47 (push (cons f
(frame-selected-window f
))
52 (defun internal--after-save-selected-window (state)
53 (dolist (elt (cdr state
))
54 (and (frame-live-p (car elt
))
55 (window-live-p (cdr elt
))
56 (set-frame-selected-window (car elt
) (cdr elt
) 'norecord
)))
57 (when (window-live-p (car state
))
58 (select-window (car state
) 'norecord
)))
60 (defmacro save-selected-window
(&rest body
)
61 "Execute BODY, then select the previously selected window.
62 The value returned is the value of the last form in BODY.
64 This macro saves and restores the selected window, as well as the
65 selected window in each frame. If the previously selected window
66 is no longer live, then whatever window is selected at the end of
67 BODY remains selected. If the previously selected window of some
68 frame is no longer live at the end of BODY, that frame's selected
71 This macro saves and restores the current buffer, since otherwise
72 its normal operation could make a different buffer current. The
73 order of recently selected windows and the buffer list ordering
74 are not altered by this macro (unless they are altered in BODY)."
75 (declare (indent 0) (debug t
))
76 `(let ((save-selected-window--state (internal--before-save-selected-window)))
80 (internal--after-save-selected-window save-selected-window--state
)))))
82 (defvar temp-buffer-window-setup-hook nil
83 "Normal hook run by `with-temp-buffer-window' before buffer display.
84 This hook is run by `with-temp-buffer-window' with the buffer to be
87 (defvar temp-buffer-window-show-hook nil
88 "Normal hook run by `with-temp-buffer-window' after buffer display.
89 This hook is run by `with-temp-buffer-window' with the buffer
90 displayed and current and its window selected.")
92 (defun temp-buffer-window-setup (buffer-or-name)
93 "Set up temporary buffer specified by BUFFER-OR-NAME.
95 (let ((old-dir default-directory
)
96 (buffer (get-buffer-create buffer-or-name
)))
97 (with-current-buffer buffer
98 (kill-all-local-variables)
99 (setq default-directory old-dir
)
100 (delete-all-overlays)
101 (setq buffer-read-only nil
)
102 (setq buffer-file-name nil
)
103 (setq buffer-undo-list t
)
104 (let ((inhibit-read-only t
)
105 (inhibit-modification-hooks t
))
107 (run-hooks 'temp-buffer-window-setup-hook
))
108 ;; Return the buffer.
111 (defun temp-buffer-window-show (buffer &optional action
)
112 "Show temporary buffer BUFFER in a window.
113 Return the window showing BUFFER. Pass ACTION as action argument
114 to `display-buffer'."
116 (with-current-buffer buffer
117 (set-buffer-modified-p nil
)
118 (setq buffer-read-only t
)
119 (goto-char (point-min))
120 (when (let ((window-combination-limit
121 ;; When `window-combination-limit' equals
122 ;; `temp-buffer' or `temp-buffer-resize' and
123 ;; `temp-buffer-resize-mode' is enabled in this
124 ;; buffer bind it to t so resizing steals space
125 ;; preferably from the window that was split.
126 (if (or (eq window-combination-limit
'temp-buffer
)
127 (and (eq window-combination-limit
129 temp-buffer-resize-mode
))
131 window-combination-limit
)))
132 (setq window
(display-buffer buffer action
)))
133 (setq frame
(window-frame window
))
134 (unless (eq frame
(selected-frame))
136 (setq minibuffer-scroll-window window
)
137 (set-window-hscroll window
0)
138 (with-selected-window window
139 (run-hooks 'temp-buffer-window-show-hook
)
140 (when temp-buffer-resize-mode
141 (resize-temp-buffer-window window
)))
142 ;; Return the window.
145 (defmacro with-temp-buffer-window
(buffer-or-name action quit-function
&rest body
)
146 "Bind `standard-output' to BUFFER-OR-NAME, eval BODY, show the buffer.
147 BUFFER-OR-NAME must specify either a live buffer, or the name of
148 a buffer (if it does not exist, this macro creates it).
150 Make the buffer specified by BUFFER-OR-NAME empty before running
151 BODY and bind `standard-output' to that buffer, so that output
152 generated with `prin1' and similar functions in BODY goes into
153 that buffer. Do not make that buffer current for running the
154 forms in BODY. Use `with-current-buffer-window' instead if you
155 need to run BODY with that buffer current.
157 At the end of BODY, mark the specified buffer unmodified and
158 read-only, and display it in a window (but do not select it).
159 The display happens by calling `display-buffer' passing it the
160 ACTION argument. If `temp-buffer-resize-mode' is enabled, the
161 corresponding window may be resized automatically.
163 Return the value returned by BODY, unless QUIT-FUNCTION specifies
164 a function. In that case, run that function with two arguments -
165 the window showing the specified buffer and the value returned by
166 BODY - and return the value returned by that function.
168 If the buffer is displayed on a new frame, the window manager may
169 decide to select that frame. In that case, it's usually a good
170 strategy if QUIT-FUNCTION selects the window showing the buffer
171 before reading any value from the minibuffer; for example, when
172 asking a `yes-or-no-p' question.
174 This runs the hook `temp-buffer-window-setup-hook' before BODY,
175 with the specified buffer temporarily current. It runs the hook
176 `temp-buffer-window-show-hook' after displaying the buffer, with
177 that buffer temporarily current, and the window that was used to
178 display it temporarily selected.
180 This construct is similar to `with-output-to-temp-buffer' but,
181 neither runs `temp-buffer-setup-hook' which usually puts the
182 buffer in Help mode, nor `temp-buffer-show-function' (the ACTION
183 argument replaces this)."
185 (let ((buffer (make-symbol "buffer"))
186 (window (make-symbol "window"))
187 (value (make-symbol "value")))
188 (macroexp-let2* nil
((vbuffer-or-name buffer-or-name
)
190 (vquit-function quit-function
))
191 `(let* ((,buffer
(temp-buffer-window-setup ,vbuffer-or-name
))
192 (standard-output ,buffer
)
194 (setq ,value
(progn ,@body
))
195 (with-current-buffer ,buffer
196 (setq ,window
(temp-buffer-window-show ,buffer
,vaction
)))
198 (if (functionp ,vquit-function
)
199 (funcall ,vquit-function
,window
,value
)
202 (defmacro with-current-buffer-window
(buffer-or-name action quit-function
&rest body
)
203 "Evaluate BODY with a buffer BUFFER-OR-NAME current and show that buffer.
204 This construct is like `with-temp-buffer-window' but unlike that
205 makes the buffer specified by BUFFER-OR-NAME current for running
208 (let ((buffer (make-symbol "buffer"))
209 (window (make-symbol "window"))
210 (value (make-symbol "value")))
211 (macroexp-let2* nil
((vbuffer-or-name buffer-or-name
)
213 (vquit-function quit-function
))
214 `(let* ((,buffer
(temp-buffer-window-setup ,vbuffer-or-name
))
215 (standard-output ,buffer
)
217 (with-current-buffer ,buffer
218 (setq ,value
(progn ,@body
))
219 (setq ,window
(temp-buffer-window-show ,buffer
,vaction
)))
221 (if (functionp ,vquit-function
)
222 (funcall ,vquit-function
,window
,value
)
225 (defmacro with-displayed-buffer-window
(buffer-or-name action quit-function
&rest body
)
226 "Show a buffer BUFFER-OR-NAME and evaluate BODY in that buffer.
227 This construct is like `with-current-buffer-window' but unlike that
228 displays the buffer specified by BUFFER-OR-NAME before running BODY."
230 (let ((buffer (make-symbol "buffer"))
231 (window (make-symbol "window"))
232 (value (make-symbol "value")))
233 (macroexp-let2* nil
((vbuffer-or-name buffer-or-name
)
235 (vquit-function quit-function
))
236 `(let* ((,buffer
(temp-buffer-window-setup ,vbuffer-or-name
))
237 (standard-output ,buffer
)
239 (with-current-buffer ,buffer
240 (setq ,window
(temp-buffer-window-show
242 ;; Remove window-height when it's handled below.
243 (if (functionp (cdr (assq 'window-height
(cdr ,vaction
))))
244 (assq-delete-all 'window-height
(copy-sequence ,vaction
))
247 (let ((inhibit-read-only t
)
248 (inhibit-modification-hooks t
))
249 (setq ,value
(progn ,@body
)))
251 (set-window-point ,window
(point-min))
253 (when (functionp (cdr (assq 'window-height
(cdr ,vaction
))))
255 (funcall (cdr (assq 'window-height
(cdr ,vaction
))) ,window
)))
257 (when (consp (cdr (assq 'preserve-size
(cdr ,vaction
))))
258 (window-preserve-size
259 ,window t
(cadr (assq 'preserve-size
(cdr ,vaction
))))
260 (window-preserve-size
261 ,window nil
(cddr (assq 'preserve-size
(cdr ,vaction
)))))
263 (if (functionp ,vquit-function
)
264 (funcall ,vquit-function
,window
,value
)
267 ;; The following two functions are like `window-next-sibling' and
268 ;; `window-prev-sibling' but the WINDOW argument is _not_ optional (so
269 ;; they don't substitute the selected window for nil), and they return
270 ;; nil when WINDOW doesn't have a parent (like a frame's root window or
271 ;; a minibuffer window).
272 (defun window-right (window)
273 "Return WINDOW's right sibling.
274 Return nil if WINDOW is the root window of its frame. WINDOW can
276 (and window
(window-parent window
) (window-next-sibling window
)))
278 (defun window-left (window)
279 "Return WINDOW's left sibling.
280 Return nil if WINDOW is the root window of its frame. WINDOW can
282 (and window
(window-parent window
) (window-prev-sibling window
)))
284 (defun window-child (window)
285 "Return WINDOW's first child window.
286 WINDOW can be any window."
287 (or (window-top-child window
) (window-left-child window
)))
289 (defun window-child-count (window)
290 "Return number of WINDOW's child windows.
291 WINDOW can be any window."
293 (when (and (windowp window
) (setq window
(window-child window
)))
295 (setq count
(1+ count
))
296 (setq window
(window-next-sibling window
))))
299 (defun window-last-child (window)
300 "Return last child window of WINDOW.
301 WINDOW can be any window."
302 (when (and (windowp window
) (setq window
(window-child window
)))
303 (while (window-next-sibling window
)
304 (setq window
(window-next-sibling window
))))
307 (defun window-normalize-buffer (buffer-or-name)
308 "Return buffer specified by BUFFER-OR-NAME.
309 BUFFER-OR-NAME must be either a buffer or a string naming a live
310 buffer and defaults to the current buffer."
312 ((not buffer-or-name
)
314 ((bufferp buffer-or-name
)
315 (if (buffer-live-p buffer-or-name
)
317 (error "Buffer %s is not a live buffer" buffer-or-name
)))
318 ((get-buffer buffer-or-name
))
320 (error "No such buffer %s" buffer-or-name
))))
322 (defun window-normalize-frame (frame)
323 "Return frame specified by FRAME.
324 FRAME must be a live frame and defaults to the selected frame."
326 (if (frame-live-p frame
)
328 (error "%s is not a live frame" frame
))
331 (defun window-normalize-window (window &optional live-only
)
332 "Return the window specified by WINDOW.
333 If WINDOW is nil, return the selected window. Otherwise, if
334 WINDOW is a live or an internal window, return WINDOW; if
335 LIVE-ONLY is non-nil, return WINDOW for a live window only.
336 Otherwise, signal an error."
341 (if (window-live-p window
)
343 (error "%s is not a live window" window
)))
344 ((window-valid-p window
)
347 (error "%s is not a valid window" window
))))
349 ;; Maybe this should go to frame.el.
350 (defun frame-char-size (&optional window-or-frame horizontal
)
351 "Return the value of `frame-char-height' for WINDOW-OR-FRAME.
352 If WINDOW-OR-FRAME is a live frame, return the value of
353 `frame-char-height' for that frame. If WINDOW-OR-FRAME is a
354 valid window, return the value of `frame-char-height' for that
355 window's frame. In any other case, return the value of
356 `frame-char-height' for the selected frame.
358 Optional argument HORIZONTAL non-nil means to return the value of
359 `frame-char-width' for WINDOW-OR-FRAME."
362 ((window-valid-p window-or-frame
)
363 (window-frame window-or-frame
))
364 ((frame-live-p window-or-frame
)
366 (t (selected-frame)))))
368 (frame-char-width frame
)
369 (frame-char-height frame
))))
371 (defvar ignore-window-parameters nil
372 "If non-nil, standard functions ignore window parameters.
373 The functions currently affected by this are `split-window',
374 `delete-window', `delete-other-windows' and `other-window'.
376 An application may bind this to a non-nil value around calls to
377 these functions to inhibit processing of window parameters.")
379 ;; This must go to C, finally (or get removed).
380 (defconst window-safe-min-height
1
381 "The absolute minimum number of lines of any window.
382 Anything less might crash Emacs.")
384 (defun window-safe-min-pixel-height (&optional window
)
385 "Return the absolute minimum pixel height of WINDOW."
386 (* window-safe-min-height
387 (frame-char-size (window-normalize-window window
))))
389 (defcustom window-min-height
4
390 "The minimum total height, in lines, of any window.
391 The value has to accommodate one text line, a mode and header
392 line, a horizontal scroll bar and a bottom divider, if present.
393 A value less than `window-safe-min-height' is ignored. The value
394 of this variable is honored when windows are resized or split.
396 Applications should never rebind this variable. To resize a
397 window to a height less than the one specified here, an
398 application should instead call `window-resize' with a non-nil
399 IGNORE argument. In order to have `split-window' make a window
400 shorter, explicitly specify the SIZE argument of that function."
405 (defun window-min-pixel-height (&optional window
)
406 "Return the minimum pixel height of window WINDOW."
407 (* (max window-min-height window-safe-min-height
)
408 (frame-char-size window
)))
410 ;; This must go to C, finally (or get removed).
411 (defconst window-safe-min-width
2
412 "The absolute minimum number of columns of a window.
413 Anything less might crash Emacs.")
415 (defun window-safe-min-pixel-width (&optional window
)
416 "Return the absolute minimum pixel width of WINDOW."
417 (* window-safe-min-width
418 (frame-char-size (window-normalize-window window
) t
)))
420 (defcustom window-min-width
10
421 "The minimum total width, in columns, of any window.
422 The value has to accommodate two text columns as well as margins,
423 fringes, a scroll bar and a right divider, if present. A value
424 less than `window-safe-min-width' is ignored. The value of this
425 variable is honored when windows are resized or split.
427 Applications should never rebind this variable. To resize a
428 window to a width less than the one specified here, an
429 application should instead call `window-resize' with a non-nil
430 IGNORE argument. In order to have `split-window' make a window
431 narrower, explicitly specify the SIZE argument of that function."
436 (defun window-min-pixel-width (&optional window
)
437 "Return the minimum pixel width of window WINDOW."
438 (* (max window-min-width window-safe-min-width
)
439 (frame-char-size window t
)))
441 (defun window-safe-min-pixel-size (&optional window horizontal
)
442 "Return the absolute minimum pixel height of WINDOW.
443 Optional argument HORIZONTAL non-nil means return the absolute
444 minimum pixel width of WINDOW."
446 (window-safe-min-pixel-width window
)
447 (window-safe-min-pixel-height window
)))
449 (defun window-min-pixel-size (&optional window horizontal
)
450 "Return the minimum pixel height of WINDOW.
451 Optional argument HORIZONTAL non-nil means return the minimum
452 pixel width of WINDOW."
454 (window-min-pixel-width window
)
455 (window-min-pixel-height window
)))
457 (defun window-combined-p (&optional window horizontal
)
458 "Return non-nil if WINDOW has siblings in a given direction.
459 WINDOW must be a valid window and defaults to the selected one.
461 HORIZONTAL determines a direction for the window combination. If
462 HORIZONTAL is omitted or nil, return non-nil if WINDOW is part of
463 a vertical window combination. If HORIZONTAL is non-nil, return
464 non-nil if WINDOW is part of a horizontal window combination."
465 (setq window
(window-normalize-window window
))
466 (let ((parent (window-parent window
)))
469 (window-left-child parent
)
470 (window-top-child parent
)))))
472 (defun window-combination-p (&optional window horizontal
)
473 "Return WINDOW's first child if WINDOW is a vertical combination.
474 WINDOW can be any window and defaults to the selected one.
475 Optional argument HORIZONTAL non-nil means return WINDOW's first
476 child if WINDOW is a horizontal combination."
477 (setq window
(window-normalize-window window
))
479 (window-left-child window
)
480 (window-top-child window
)))
482 (defun window-combinations (window &optional horizontal
)
483 "Return largest number of windows vertically arranged within WINDOW.
484 WINDOW must be a valid window and defaults to the selected one.
485 If HORIZONTAL is non-nil, return the largest number of
486 windows horizontally arranged within WINDOW."
487 (setq window
(window-normalize-window window
))
489 ((window-live-p window
)
490 ;; If WINDOW is live, return 1.
493 (window-left-child window
)
494 (window-top-child window
))
495 ;; If WINDOW is iso-combined, return the sum of the values for all
496 ;; child windows of WINDOW.
497 (let ((child (window-child window
))
501 (+ (window-combinations child horizontal
)
503 (setq child
(window-right child
)))
506 ;; If WINDOW is not iso-combined, return the maximum value of any
507 ;; child window of WINDOW.
508 (let ((child (window-child window
))
512 (max (window-combinations child horizontal
)
514 (setq child
(window-right child
)))
517 (defun walk-window-tree-1 (fun walk-window-tree-window any
&optional sub-only
)
518 "Helper function for `walk-window-tree' and `walk-window-subtree'."
519 (let (walk-window-tree-buffer)
520 (while walk-window-tree-window
521 (setq walk-window-tree-buffer
522 (window-buffer walk-window-tree-window
))
523 (when (or walk-window-tree-buffer any
)
524 (funcall fun walk-window-tree-window
))
525 (unless walk-window-tree-buffer
527 fun
(window-left-child walk-window-tree-window
) any
)
529 fun
(window-top-child walk-window-tree-window
) any
))
531 (setq walk-window-tree-window nil
)
532 (setq walk-window-tree-window
533 (window-right walk-window-tree-window
))))))
535 (defun walk-window-tree (fun &optional frame any minibuf
)
536 "Run function FUN on each live window of FRAME.
537 FUN must be a function with one argument - a window. FRAME must
538 be a live frame and defaults to the selected one. ANY, if
539 non-nil, means to run FUN on all live and internal windows of
542 Optional argument MINIBUF t means run FUN on FRAME's minibuffer
543 window even if it isn't active. MINIBUF nil or omitted means run
544 FUN on FRAME's minibuffer window only if it's active. In both
545 cases the minibuffer window must be part of FRAME. MINIBUF
546 neither nil nor t means never run FUN on the minibuffer window.
548 This function performs a pre-order, depth-first traversal of the
549 window tree. If FUN changes the window tree, the result is
551 (setq frame
(window-normalize-frame frame
))
552 (walk-window-tree-1 fun
(frame-root-window frame
) any
)
553 (when (memq minibuf
'(nil t
))
554 ;; Run FUN on FRAME's minibuffer window if requested.
555 (let ((minibuffer-window (minibuffer-window frame
)))
556 (when (and (window-live-p minibuffer-window
)
557 (eq (window-frame minibuffer-window
) frame
)
559 (minibuffer-window-active-p minibuffer-window
)))
560 (funcall fun minibuffer-window
)))))
562 (defun walk-window-subtree (fun &optional window any
)
563 "Run function FUN on the subtree of windows rooted at WINDOW.
564 WINDOW defaults to the selected window. FUN must be a function
565 with one argument - a window. By default, run FUN only on live
566 windows of the subtree. If the optional argument ANY is non-nil,
567 run FUN on all live and internal windows of the subtree. If
568 WINDOW is live, run FUN on WINDOW only.
570 This function performs a pre-order, depth-first traversal of the
571 subtree rooted at WINDOW. If FUN changes that tree, the result
573 (setq window
(window-normalize-window window
))
574 (walk-window-tree-1 fun window any t
))
576 (defun window-with-parameter (parameter &optional value frame any minibuf
)
577 "Return first window on FRAME with PARAMETER non-nil.
578 FRAME defaults to the selected frame. Optional argument VALUE
579 non-nil means only return a window whose window-parameter value
580 for PARAMETER equals VALUE (comparison is done with `equal').
581 Optional argument ANY non-nil means consider internal windows
584 Optional argument MINIBUF t means consider FRAME's minibuffer
585 window even if it isn't active. MINIBUF nil or omitted means
586 consider FRAME's minibuffer window only if it's active. In both
587 cases the minibuffer window must be part of FRAME. MINIBUF
588 neither nil nor t means never consider the minibuffer window."
593 (when (and (setq this-value
(window-parameter window parameter
))
594 (or (not value
) (equal value this-value
)))
595 (throw 'found window
)))
596 frame any minibuf
))))
599 (defun window-atom-root (&optional window
)
600 "Return root of atomic window WINDOW is a part of.
601 WINDOW must be a valid window and defaults to the selected one.
602 Return nil if WINDOW is not part of an atomic window."
603 (setq window
(window-normalize-window window
))
605 (while (and window
(window-parameter window
'window-atom
))
607 (setq window
(window-parent window
)))
610 (defun window-make-atom (window)
611 "Make WINDOW an atomic window.
612 WINDOW must be an internal window. Return WINDOW."
613 (if (not (window-child window
))
614 (error "Window %s is not an internal window" window
)
617 (unless (window-parameter window
'window-atom
)
618 (set-window-parameter window
'window-atom t
)))
622 (defun display-buffer-in-atom-window (buffer alist
)
623 "Display BUFFER in an atomic window.
624 This function displays BUFFER in a new window that will be
625 combined with an existing window to form an atomic window. If
626 the existing window is already part of an atomic window, add the
627 new window to that atomic window. Operations like `split-window'
628 or `delete-window', when applied to a constituent of an atomic
629 window, are applied atomically to the root of that atomic window.
631 ALIST is an association list of symbols and values. The
632 following symbols can be used.
634 `window' specifies the existing window the new window shall be
635 combined with. Use `window-atom-root' to make the new window a
636 sibling of an atomic window's root. If an internal window is
637 specified here, all children of that window become part of the
638 atomic window too. If no window is specified, the new window
639 becomes a sibling of the selected window. By default, the
640 `window-atom' parameter of the existing window is set to `main'
641 provided it is live and was not set before.
643 `side' denotes the side of the existing window where the new
644 window shall be located. Valid values are `below', `right',
645 `above' and `left'. The default is `below'. By default, the
646 `window-atom' parameter of the new window is set to this value.
648 The return value is the new window, nil when creating that window
650 (let* ((ignore-window-parameters t
)
651 (window-combination-limit t
)
652 (window-combination-resize 'atom
)
653 (window (cdr (assq 'window alist
)))
654 (side (cdr (assq 'side alist
)))
655 (atom (when window
(window-parameter window
'window-atom
)))
657 (setq window
(window-normalize-window window
))
658 (setq root
(window-atom-root window
))
659 ;; Split off new window.
660 (when (setq new
(split-window window nil side
))
662 (if (and root
(not (eq root window
)))
663 ;; When WINDOW was part of an atomic window and we did not
664 ;; split its root, root atomic window at old root.
666 ;; Otherwise, root atomic window at WINDOW's new parent.
667 (window-parent window
)))
668 ;; Assign `window-atom' parameters, if needed.
669 (when (and (not atom
) (window-live-p window
))
670 (set-window-parameter window
'window-atom
'main
))
671 (set-window-parameter new
'window-atom side
)
672 ;; Display BUFFER in NEW and return NEW.
673 (window--display-buffer
674 buffer new
'window alist display-buffer-mark-dedicated
))))
676 (defun window--atom-check-1 (window)
677 "Subroutine of `window--atom-check'."
679 (if (window-parameter window
'window-atom
)
681 (when (or (catch 'reset
684 (if (window-parameter window
'window-atom
)
685 (setq count
(1+ count
))
688 ;; count >= 1 must hold here. If there's no other
689 ;; window around dissolve this atomic window.
691 ;; Dissolve atomic window.
694 (set-window-parameter window
'window-atom nil
))
697 (unless (window-buffer window
)
698 (window--atom-check-1 (window-left-child window
))
699 (window--atom-check-1 (window-top-child window
))))
700 ;; Check right sibling
701 (window--atom-check-1 (window-right window
))))
703 (defun window--atom-check (&optional frame
)
704 "Check atomicity of all windows on FRAME.
705 FRAME defaults to the selected frame. If an atomic window is
706 wrongly configured, reset the atomicity of all its windows on
707 FRAME to nil. An atomic window is wrongly configured if it has
708 no child windows or one of its child windows is not atomic."
709 (window--atom-check-1 (frame-root-window frame
)))
712 (defvar window-sides
'(left top right bottom
)
715 (defcustom window-sides-vertical nil
716 "If non-nil, left and right side windows are full height.
717 Otherwise, top and bottom side windows are full width."
722 (defcustom window-sides-slots
'(nil nil nil nil
)
723 "Maximum number of side window slots.
724 The value is a list of four elements specifying the number of
725 side window slots on (in this order) the left, top, right and
726 bottom side of each frame. If an element is a number, this means
727 to display at most that many side windows on the corresponding
728 side. If an element is nil, this means there's no bound on the
729 number of slots on that side."
734 :value
(nil nil nil nil
)
737 :help-echo
"Maximum slots of left side window."
739 :format
"%[Left%] %v\n"
740 (const :tag
"Unlimited" :format
"%t" nil
)
741 (integer :tag
"Number" :value
2 :size
5))
744 :help-echo
"Maximum slots of top side window."
746 :format
"%[Top%] %v\n"
747 (const :tag
"Unlimited" :format
"%t" nil
)
748 (integer :tag
"Number" :value
3 :size
5))
751 :help-echo
"Maximum slots of right side window."
753 :format
"%[Right%] %v\n"
754 (const :tag
"Unlimited" :format
"%t" nil
)
755 (integer :tag
"Number" :value
2 :size
5))
758 :help-echo
"Maximum slots of bottom side window."
760 :format
"%[Bottom%] %v\n"
761 (const :tag
"Unlimited" :format
"%t" nil
)
762 (integer :tag
"Number" :value
3 :size
5)))
765 (defun window--side-window-p (window)
766 "Return non-nil if WINDOW is a side window or the parent of one."
767 (or (window-parameter window
'window-side
)
768 (and (window-child window
)
769 (or (window-parameter
770 (window-child window
) 'window-side
)
772 (window-last-child window
) 'window-side
)))))
774 (defun window--major-non-side-window (&optional frame
)
775 "Return the major non-side window of frame FRAME.
776 The optional argument FRAME must be a live frame and defaults to
779 If FRAME has at least one side window, the major non-side window
780 is either an internal non-side window such that all other
781 non-side windows on FRAME descend from it, or the single live
782 non-side window of FRAME. If FRAME has no side windows, return
784 (let ((frame (window-normalize-frame frame
))
786 ;; Set major to the _last_ window found by `walk-window-tree' that
787 ;; is not a side window but has a side window as its sibling.
790 (and (not (window-parameter window
'window-side
))
791 (or (and (setq sibling
(window-prev-sibling window
))
792 (window-parameter sibling
'window-side
))
793 (and (setq sibling
(window-next-sibling window
))
794 (window-parameter sibling
'window-side
)))
795 (setq major window
)))
797 (or major
(frame-root-window frame
))))
799 (defun window--major-side-window (side)
800 "Return major side window on SIDE.
801 SIDE must be one of the symbols `left', `top', `right' or
802 `bottom'. Return nil if no such window exists."
803 (let ((root (frame-root-window))
805 ;; (1) If a window on the opposite side exists, return that window's
807 ;; (2) If the new window shall span the entire side, return the
808 ;; frame's root window.
809 ;; (3) If a window on an orthogonal side exists, return that
811 ;; (4) Otherwise return the frame's root window.
813 ((or (and (eq side
'left
)
814 (setq window
(window-with-parameter 'window-side
'right nil t
)))
816 (setq window
(window-with-parameter 'window-side
'bottom nil t
))))
817 (window-prev-sibling window
))
818 ((or (and (eq side
'right
)
819 (setq window
(window-with-parameter 'window-side
'left nil t
)))
820 (and (eq side
'bottom
)
821 (setq window
(window-with-parameter 'window-side
'top nil t
))))
822 (window-next-sibling window
))
823 ((memq side
'(left right
))
825 (window-sides-vertical
827 ((setq window
(window-with-parameter 'window-side
'top nil t
))
828 (window-next-sibling window
))
829 ((setq window
(window-with-parameter 'window-side
'bottom nil t
))
830 (window-prev-sibling window
))
832 ((memq side
'(top bottom
))
834 ((not window-sides-vertical
)
836 ((setq window
(window-with-parameter 'window-side
'left nil t
))
837 (window-next-sibling window
))
838 ((setq window
(window-with-parameter 'window-side
'right nil t
))
839 (window-prev-sibling window
))
842 (defun display-buffer-in-major-side-window (buffer side slot
&optional alist
)
843 "Display BUFFER in a new window on SIDE of the selected frame.
844 SIDE must be one of `left', `top', `right' or `bottom'. SLOT
845 specifies the slot to use. ALIST is an association list of
846 symbols and values as passed to `display-buffer-in-side-window'.
847 This function may be called only if no window on SIDE exists yet.
848 The new window automatically becomes the \"major\" side window on
849 SIDE. Return the new window, nil if its creation window failed."
850 (let* ((left-or-right (memq side
'(left right
)))
851 (major (window--major-side-window side
))
853 ((eq side
'top
) 'above
)
854 ((eq side
'bottom
) 'below
)
856 ;; The following two bindings will tell `split-window' to take
857 ;; the space for the new window from `major' and not make a new
858 ;; parent window unless needed.
859 (window-combination-resize 'side
)
860 (window-combination-limit nil
)
861 (new (split-window major nil on-side
)))
863 ;; Initialize `window-side' parameter of new window to SIDE.
864 (set-window-parameter new
'window-side side
)
865 ;; Install `window-slot' parameter of new window.
866 (set-window-parameter new
'window-slot slot
)
867 ;; Install `delete-window' parameter thus making sure that when
868 ;; the new window is deleted, a side window on the opposite side
869 ;; does not get resized.
870 (set-window-parameter new
'delete-window
'delete-side-window
)
871 ;; Auto-adjust height/width of new window unless a size has been
872 ;; explicitly requested.
873 (unless (if left-or-right
874 (cdr (assq 'window-width alist
))
875 (cdr (assq 'window-height alist
)))
879 (if left-or-right
'window-width
'window-height
)
880 (/ (window-total-size (frame-root-window) left-or-right
)
881 ;; By default use a fourth of the size of the frame's
885 ;; Install BUFFER in new window and return NEW.
886 (window--display-buffer buffer new
'window alist
'side
))))
888 (defun delete-side-window (window)
889 "Delete side window WINDOW."
890 (let ((window-combination-resize
891 (window-parameter (window-parent window
) 'window-side
))
892 (ignore-window-parameters t
))
893 (delete-window window
)))
895 (defun display-buffer-in-side-window (buffer alist
)
896 "Display BUFFER in a side window of the selected frame.
897 ALIST is an association list of symbols and values. The
898 following special symbols can be used in ALIST.
900 `side' denotes the side of the frame where the new window shall
901 be located. Valid values are `bottom', `right', `top' and
902 `left'. The default is `bottom'.
904 `slot' if non-nil, specifies the window slot where to display
905 BUFFER. A value of zero or nil means use the middle slot on
906 the specified side. A negative value means use a slot
907 preceding (that is, above or on the left of) the middle slot.
908 A positive value means use a slot following (that is, below or
909 on the right of) the middle slot. The default is zero."
910 (let ((side (or (cdr (assq 'side alist
)) 'bottom
))
911 (slot (or (cdr (assq 'slot alist
)) 0)))
913 ((not (memq side
'(top bottom left right
)))
914 (error "Invalid side %s specified" side
))
915 ((not (numberp slot
))
916 (error "Invalid slot %s specified" slot
)))
918 (let* ((major (window-with-parameter 'window-side side nil t
))
919 ;; `major' is the major window on SIDE, `windows' the list of
920 ;; life windows on SIDE.
926 (when (eq (window-parameter window
'window-side
) side
)
927 (setq windows
(cons window windows
))))
929 (nreverse windows
))))
930 (slots (when major
(max 1 (window-child-count major
))))
936 ((eq side
'bottom
) 3))
938 window this-window this-slot prev-window next-window
939 best-window best-slot abs-slot
)
942 ((and (numberp max-slots
) (<= max-slots
0))
943 ;; No side-slots available on this side. Don't create an error,
947 ;; No major window exists on this side, make one.
948 (display-buffer-in-major-side-window buffer side slot alist
))
950 ;; Scan windows on SIDE.
952 (dolist (window windows
)
953 (setq this-slot
(window-parameter window
'window-slot
))
955 ;; The following should not happen and probably be checked
956 ;; by window--side-check.
957 ((not (numberp this-slot
)))
959 ;; A window with a matching slot has been found.
960 (setq this-window window
)
963 ;; Check if this window has a better slot value wrt the
964 ;; slot of the window we want.
966 (if (or (and (> this-slot
0) (> slot
0))
967 (and (< this-slot
0) (< slot
0)))
968 (abs (- slot this-slot
))
969 (+ (abs slot
) (abs this-slot
))))
970 (unless (and best-slot
(<= best-slot abs-slot
))
971 (setq best-window window
)
972 (setq best-slot abs-slot
))
975 (setq prev-window window
))
977 (setq next-window window
)))))))
979 ;; `this-window' is the first window with the same SLOT.
980 ;; `prev-window' is the window with the largest slot < SLOT. A new
981 ;; window will be created after it.
982 ;; `next-window' is the window with the smallest slot > SLOT. A new
983 ;; window will be created before it.
984 ;; `best-window' is the window with the smallest absolute difference
985 ;; of its slot and SLOT.
987 ;; Note: We dedicate the window used softly to its buffer to
988 ;; avoid that "other" (non-side) buffer display functions steal
989 ;; it from us. This must eventually become customizable via
990 ;; ALIST (or, better, avoided in the "other" functions).
992 ;; Reuse `this-window'.
993 (window--display-buffer buffer this-window
'reuse alist
'side
))
994 (and (or (not max-slots
) (< slots max-slots
))
996 ;; Make new window before `next-window'.
998 (if (memq side
'(left right
)) 'above
'left
))
999 (window-combination-resize 'side
))
1000 (setq window
(split-window next-window nil next-side
))
1001 ;; When the new window is deleted, its space
1002 ;; is returned to other side windows.
1003 (set-window-parameter
1004 window
'delete-window
'delete-side-window
)
1007 ;; Make new window after `prev-window'.
1009 (if (memq side
'(left right
)) 'below
'right
))
1010 (window-combination-resize 'side
))
1011 (setq window
(split-window prev-window nil prev-side
))
1012 ;; When the new window is deleted, its space
1013 ;; is returned to other side windows.
1014 (set-window-parameter
1015 window
'delete-window
'delete-side-window
)
1017 (set-window-parameter window
'window-slot slot
)
1018 (window--display-buffer buffer window
'window alist
'side
))
1020 ;; Reuse `best-window'.
1022 ;; Give best-window the new slot value.
1023 (set-window-parameter best-window
'window-slot slot
)
1024 (window--display-buffer
1025 buffer best-window
'reuse alist
'side
)))))))))
1027 (defun window--side-check (&optional frame
)
1028 "Check the side window configuration of FRAME.
1029 FRAME defaults to the selected frame.
1031 A valid side window configuration preserves the following two
1034 - If there exists a window whose window-side parameter is
1035 non-nil, there must exist at least one live window whose
1036 window-side parameter is nil.
1038 - If a window W has a non-nil window-side parameter (i) it must
1039 have a parent window and that parent's window-side parameter
1040 must be either nil or the same as for W, and (ii) any child
1041 window of W must have the same window-side parameter as W.
1043 If the configuration is invalid, reset the window-side parameters
1044 of all windows on FRAME to nil."
1045 (let (left top right bottom none side parent parent-side
)
1046 (when (or (catch 'reset
1049 (setq side
(window-parameter window
'window-side
))
1050 (setq parent
(window-parent window
))
1052 (and parent
(window-parameter parent
'window-side
)))
1053 ;; The following `cond' seems a bit tedious, but I'd
1054 ;; rather stick to using just the stack.
1057 (when (not (eq parent-side side
))
1058 ;; A parent whose window-side is non-nil must
1059 ;; have a child with the same window-side.
1062 (when (window-buffer window
)
1063 ;; Record that we have at least one non-side,
1066 ((if (memq side
'(left top
))
1067 (window-prev-sibling window
)
1068 (window-next-sibling window
))
1069 ;; Left and top major side windows must not have a
1070 ;; previous sibling, right and bottom major side
1071 ;; windows must not have a next sibling.
1073 ;; Now check that there's no more than one major
1074 ;; window for any of left, top, right and bottom.
1076 (if left
(throw 'reset t
) (setq left t
)))
1078 (if top
(throw 'reset t
) (setq top t
)))
1080 (if right
(throw 'reset t
) (setq right t
)))
1082 (if bottom
(throw 'reset t
) (setq bottom t
)))
1086 ;; If there's a side window, there must be at least one
1088 (and (or left top right bottom
) (not none
)))
1091 (set-window-parameter window
'window-side nil
))
1094 (defun window--check (&optional frame
)
1095 "Check atomic and side windows on FRAME.
1096 FRAME defaults to the selected frame."
1097 (window--side-check frame
)
1098 (window--atom-check frame
))
1100 ;; Dumping frame/window contents.
1101 (defun window--dump-window (&optional window erase
)
1102 "Dump WINDOW to buffer *window-frame-dump*.
1103 WINDOW must be a valid window and defaults to the selected one.
1104 Optional argument ERASE non-nil means erase *window-frame-dump*
1105 before writing to it."
1106 (setq window
(window-normalize-window window
))
1107 (with-current-buffer (get-buffer-create "*window-frame-dump*")
1108 (when erase
(erase-buffer))
1110 (format "%s parent: %s\n" window
(window-parent window
))
1111 (format "pixel left: %s top: %s size: %s x %s new: %s\n"
1112 (window-pixel-left window
) (window-pixel-top window
)
1113 (window-size window t t
) (window-size window nil t
)
1114 (window-new-pixel window
))
1115 (format "char left: %s top: %s size: %s x %s new: %s\n"
1116 (window-left-column window
) (window-top-line window
)
1117 (window-total-size window t
) (window-total-size window
)
1118 (window-new-total window
))
1119 (format "normal: %s x %s new: %s\n"
1120 (window-normal-size window t
) (window-normal-size window
)
1121 (window-new-normal window
)))
1122 (when (window-live-p window
)
1123 (let ((fringes (window-fringes window
))
1124 (margins (window-margins window
)))
1126 (format "body pixel: %s x %s char: %s x %s\n"
1127 (window-body-width window t
) (window-body-height window t
)
1128 (window-body-width window
) (window-body-height window
))
1129 (format "width left fringe: %s left margin: %s right margin: %s\n"
1130 (car fringes
) (or (car margins
) 0) (or (cdr margins
) 0))
1131 (format "width right fringe: %s scroll-bar: %s divider: %s\n"
1133 (window-scroll-bar-width window
)
1134 (window-right-divider-width window
))
1135 (format "height header-line: %s mode-line: %s divider: %s\n"
1136 (window-header-line-height window
)
1137 (window-mode-line-height window
)
1138 (window-bottom-divider-width window
)))))
1141 (defun window--dump-frame (&optional window-or-frame
)
1142 "Dump WINDOW-OR-FRAME to buffer *window-frame-dump*.
1143 WINDOW-OR-FRAME can be a frame or a window and defaults to the
1144 selected frame. When WINDOW-OR-FRAME is a window, dump that
1145 window's frame. The buffer *window-frame-dump* is erased before
1149 ((or (not window-or-frame
)
1150 (frame-live-p window-or-frame
))
1151 (frame-root-window window-or-frame
))
1152 ((or (window-live-p window-or-frame
)
1153 (window-child window-or-frame
))
1156 (frame-root-window))))
1157 (frame (window-frame window
)))
1158 (with-current-buffer (get-buffer-create "*window-frame-dump*")
1161 (format "frame pixel: %s x %s cols/lines: %s x %s units: %s x %s\n"
1162 (frame-pixel-width frame
) (frame-pixel-height frame
)
1163 (frame-total-cols frame
) (frame-total-lines frame
)
1164 (frame-char-width frame
) (frame-char-height frame
))
1165 (format "frame text pixel: %s x %s cols/lines: %s x %s\n"
1166 (frame-text-width frame
) (frame-text-height frame
)
1167 (frame-text-cols frame
) (frame-text-lines frame
))
1168 (format "tool: %s scroll: %s/%s fringe: %s border: %s right: %s bottom: %s\n\n"
1169 (if (fboundp 'tool-bar-height
)
1170 (tool-bar-height frame t
)
1172 (frame-scroll-bar-width frame
)
1173 (frame-scroll-bar-height frame
)
1174 (frame-fringe-width frame
)
1175 (frame-border-width frame
)
1176 (frame-right-divider-width frame
)
1177 (frame-bottom-divider-width frame
)))
1178 (walk-window-tree 'window--dump-window frame t t
))))
1181 (defun window-total-size (&optional window horizontal round
)
1182 "Return the total height or width of WINDOW.
1183 WINDOW must be a valid window and defaults to the selected one.
1185 If HORIZONTAL is omitted or nil, return the total height of
1186 WINDOW, in lines. If WINDOW is live, its total height includes,
1187 in addition to the height of WINDOW's text, the heights of
1188 WINDOW's mode and header line and a bottom divider, if any.
1190 If HORIZONTAL is non-nil, return the total width of WINDOW, in
1191 columns. If WINDOW is live, its total width includes, in
1192 addition to the width of WINDOW's text, the widths of WINDOW's
1193 fringes, margins, scroll bars and its right divider, if any.
1195 If WINDOW is internal, return the respective size of the screen
1196 areas spanned by its children.
1198 Optional argument ROUND is handled as for `window-total-height'
1199 and `window-total-width'."
1201 (window-total-width window round
)
1202 (window-total-height window round
)))
1204 (defun window-size (&optional window horizontal pixelwise round
)
1205 "Return the height or width of WINDOW.
1206 WINDOW must be a valid window and defaults to the selected one.
1208 If HORIZONTAL is omitted or nil, return the total height of
1209 WINDOW, in lines, like `window-total-height'. Otherwise return
1210 the total width, in columns, like `window-total-width'.
1212 Optional argument PIXELWISE means return the pixel size of WINDOW
1213 like `window-pixel-height' and `window-pixel-width'.
1215 Optional argument ROUND is ignored if PIXELWISE is non-nil and
1216 handled as for `window-total-height' and `window-total-width'
1220 (window-pixel-width window
)
1221 (window-total-width window round
))
1223 (window-pixel-height window
)
1224 (window-total-height window round
))))
1226 (defvar window-size-fixed nil
1227 "Non-nil in a buffer means windows displaying the buffer are fixed-size.
1228 If the value is `height', then only the window's height is fixed.
1229 If the value is `width', then only the window's width is fixed.
1230 Any other non-nil value fixes both the width and the height.
1232 Emacs won't change the size of any window displaying that buffer,
1233 unless it has no other choice (like when deleting a neighboring
1235 (make-variable-buffer-local 'window-size-fixed
)
1237 (defun window--preservable-size (window &optional horizontal
)
1238 "Return height of WINDOW as `window-preserve-size' would preserve it.
1239 Optional argument HORIZONTAL non-nil means to return the width of
1240 WINDOW as `window-preserve-size' would preserve it."
1242 (window-body-width window t
)
1243 (+ (window-body-height window t
)
1244 (window-header-line-height window
)
1245 (window-mode-line-height window
))))
1247 (defun window-preserve-size (&optional window horizontal preserve
)
1248 "Preserve height of window WINDOW.
1249 WINDOW must be a live window and defaults to the selected one.
1250 Optional argument HORIZONTAL non-nil means preserve the width of
1253 PRESERVE t means to preserve the current height/width of WINDOW's
1254 body in frame and window resizing operations whenever possible.
1255 The height/width of WINDOW will change only if Emacs has no other
1256 choice. Resizing a window whose height/width is preserved never
1259 PRESERVE nil means to stop preserving the height/width of WINDOW,
1260 lifting the respective restraint induced by a previous call of
1261 `window-preserve-size' for WINDOW. Calling `enlarge-window',
1262 `shrink-window', `split-window' or `fit-window-to-buffer' with
1263 WINDOW as argument also removes the respective restraint.
1265 Other values of PRESERVE are reserved for future use."
1266 (setq window
(window-normalize-window window t
))
1267 (let* ((parameter (window-parameter window
'window-preserved-size
))
1268 (width (nth 1 parameter
))
1269 (height (nth 2 parameter
)))
1271 (set-window-parameter
1272 window
'window-preserved-size
1274 (window-buffer window
)
1275 (and preserve
(window--preservable-size window t
))
1277 (set-window-parameter
1278 window
'window-preserved-size
1280 (window-buffer window
)
1282 (and preserve
(window--preservable-size window
)))))))
1284 (defun window-preserved-size (&optional window horizontal
)
1285 "Return preserved height of window WINDOW.
1286 WINDOW must be a live window and defaults to the selected one.
1287 Optional argument HORIZONTAL non-nil means to return preserved
1289 (setq window
(window-normalize-window window t
))
1290 (let* ((parameter (window-parameter window
'window-preserved-size
))
1291 (buffer (nth 0 parameter
))
1292 (width (nth 1 parameter
))
1293 (height (nth 2 parameter
)))
1294 (when (eq buffer
(window-buffer window
))
1295 (if horizontal width height
))))
1297 (defun window--preserve-size (window horizontal
)
1298 "Return non-nil when the height of WINDOW shall be preserved.
1299 Optional argument HORIZONTAL non-nil means to return non-nil when
1300 the width of WINDOW shall be preserved."
1301 (let ((size (window-preserved-size window horizontal
)))
1303 (= size
(window--preservable-size window horizontal
)))))
1305 (defun window-safe-min-size (&optional window horizontal pixelwise
)
1306 "Return safe minimum size of WINDOW.
1307 WINDOW must be a valid window and defaults to the selected one.
1308 Optional argument HORIZONTAL non-nil means return the minimum
1309 number of columns of WINDOW; otherwise return the minimum number
1312 Optional argument PIXELWISE non-nil means return the minimum pixel-size
1314 (setq window
(window-normalize-window window
))
1317 (* window-safe-min-width
1318 (frame-char-width (window-frame window
)))
1319 (* window-safe-min-height
1320 (frame-char-height (window-frame window
))))
1321 (if horizontal window-safe-min-width window-safe-min-height
)))
1323 (defun window-min-size (&optional window horizontal ignore pixelwise
)
1324 "Return the minimum size of WINDOW.
1325 WINDOW must be a valid window and defaults to the selected one.
1326 Optional argument HORIZONTAL non-nil means return the minimum
1327 number of columns of WINDOW; otherwise return the minimum number
1330 The optional argument IGNORE has the same meaning as for
1331 `window-resizable'. Optional argument PIXELWISE non-nil means
1332 return the minimum pixel-size of WINDOW."
1334 (window-normalize-window window
) horizontal ignore pixelwise
))
1336 (defun window--min-size-ignore-p (window horizontal ignore
)
1337 "Return non-nil if IGNORE says to ignore height restrictions for WINDOW.
1338 HORIZONTAL non-nil means to return non-nil if IGNORE says to
1339 ignore width restrictions for WINDOW."
1340 (if (window-valid-p ignore
)
1342 (not (memq ignore
'(nil preserved
)))))
1344 (defun window--min-size-1 (window horizontal ignore pixelwise
)
1345 "Internal function of `window-min-size'."
1346 (let ((sub (window-child window
)))
1349 ;; WINDOW is an internal window.
1350 (if (window-combined-p sub horizontal
)
1351 ;; The minimum size of an iso-combination is the sum of
1352 ;; the minimum sizes of its child windows.
1354 (setq value
(+ value
1356 sub horizontal ignore pixelwise
)))
1357 (setq sub
(window-right sub
)))
1358 ;; The minimum size of an ortho-combination is the maximum
1359 ;; of the minimum sizes of its child windows.
1361 (setq value
(max value
1363 sub horizontal ignore pixelwise
)))
1364 (setq sub
(window-right sub
))))
1366 (with-current-buffer (window-buffer window
)
1368 ((window-minibuffer-p window
)
1369 (if pixelwise
(frame-char-height (window-frame window
)) 1))
1370 ((window-size-fixed-p window horizontal ignore
)
1371 ;; The minimum size of a fixed size window is its size.
1372 (window-size window horizontal pixelwise
))
1374 ;; If IGNORE equals `safe' return the safe value.
1375 (window-safe-min-size window horizontal pixelwise
))
1377 ;; For the minimum width of a window take fringes and
1378 ;; scroll-bars into account. This is questionable and should
1379 ;; be removed as soon as we are able to split (and resize)
1380 ;; windows such that the new (or resized) windows can get a
1381 ;; size less than the user-specified `window-min-height' and
1382 ;; `window-min-width'.
1383 (let* ((char-size (frame-char-size window t
))
1384 (fringes (window-fringes window
))
1385 (margins (window-margins window
))
1387 (+ (window-safe-min-size window t t
)
1388 (* (or (car margins
) 0) char-size
)
1389 (* (or (cdr margins
) 0) char-size
)
1390 (car fringes
) (cadr fringes
)
1391 (window-scroll-bar-width window
)
1392 (window-right-divider-width window
))))
1395 (if window-resize-pixelwise
1397 ;; Round up to next integral of columns.
1398 (* (ceiling pixel-width char-size
) char-size
))
1399 (if (window--min-size-ignore-p window horizontal ignore
)
1401 (window-min-pixel-width window
)))
1403 (ceiling pixel-width char-size
)
1404 (if (window--min-size-ignore-p window horizontal ignore
)
1406 window-min-width
)))))
1407 ((let ((char-size (frame-char-size window
))
1409 (+ (window-safe-min-size window nil t
)
1410 (window-header-line-height window
)
1411 (window-scroll-bar-height window
)
1412 (window-mode-line-height window
)
1413 (window-bottom-divider-width window
))))
1416 (if window-resize-pixelwise
1418 ;; Round up to next integral of lines.
1419 (* (ceiling pixel-height char-size
) char-size
))
1420 (if (window--min-size-ignore-p window horizontal ignore
)
1422 (window-min-pixel-height window
)))
1423 (max (ceiling pixel-height char-size
)
1424 (if (window--min-size-ignore-p window horizontal ignore
)
1426 window-min-height
))))))))))
1428 (defun window-sizable (window delta
&optional horizontal ignore pixelwise
)
1429 "Return DELTA if DELTA lines can be added to WINDOW.
1430 WINDOW must be a valid window and defaults to the selected one.
1431 Optional argument HORIZONTAL non-nil means return DELTA if DELTA
1432 columns can be added to WINDOW. A return value of zero means
1433 that no lines (or columns) can be added to WINDOW.
1435 This function looks only at WINDOW and, recursively, its child
1436 windows. The function `window-resizable' looks at other windows
1439 DELTA positive means WINDOW shall be enlarged by DELTA lines or
1440 columns. If WINDOW cannot be enlarged by DELTA lines or columns
1441 return the maximum value in the range 0..DELTA by which WINDOW
1444 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
1445 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
1446 return the minimum value in the range DELTA..0 by which WINDOW
1449 The optional argument IGNORE has the same meaning as for
1450 `window-resizable'. Optional argument PIXELWISE non-nil means
1451 interpret DELTA as pixels."
1452 (setq window
(window-normalize-window window
))
1455 (max (- (window-min-size window horizontal ignore pixelwise
)
1456 (window-size window horizontal pixelwise
))
1459 (if (window-size-fixed-p window horizontal ignore
)
1464 (defun window-sizable-p (window delta
&optional horizontal ignore pixelwise
)
1465 "Return t if WINDOW can be resized by DELTA lines.
1466 WINDOW must be a valid window and defaults to the selected one.
1467 For the meaning of the arguments of this function see the
1468 doc-string of `window-sizable'."
1469 (setq window
(window-normalize-window window
))
1471 (>= (window-sizable window delta horizontal ignore pixelwise
)
1473 (<= (window-sizable window delta horizontal ignore pixelwise
)
1476 (defun window--size-fixed-1 (window horizontal ignore
)
1477 "Internal function for `window-size-fixed-p'."
1478 (let ((sub (window-child window
)))
1481 ;; WINDOW is an internal window.
1482 (if (window-combined-p sub horizontal
)
1483 ;; An iso-combination is fixed size if all its child
1484 ;; windows are fixed-size.
1487 (unless (window--size-fixed-1 sub horizontal ignore
)
1488 ;; We found a non-fixed-size child window, so
1489 ;; WINDOW's size is not fixed.
1491 (setq sub
(window-right sub
)))
1492 ;; All child windows are fixed-size, so WINDOW's size is
1495 ;; An ortho-combination is fixed-size if at least one of its
1496 ;; child windows is fixed-size.
1498 (when (window--size-fixed-1 sub horizontal ignore
)
1499 ;; We found a fixed-size child window, so WINDOW's size
1502 (setq sub
(window-right sub
))))
1503 ;; WINDOW is a live window.
1504 (and (or (not (windowp ignore
)) (not (eq window ignore
)))
1505 (or (and (not (eq ignore
'preserved
))
1506 (window--preserve-size window horizontal
))
1507 (with-current-buffer (window-buffer window
)
1509 (memq window-size-fixed
'(width t
))
1510 (memq window-size-fixed
'(height t
))))))))))
1512 (defun window-size-fixed-p (&optional window horizontal ignore
)
1513 "Return non-nil if WINDOW's height is fixed.
1514 WINDOW must be a valid window and defaults to the selected one.
1515 Optional argument HORIZONTAL non-nil means return non-nil if
1516 WINDOW's width is fixed. The optional argument IGNORE has the
1517 same meaning as for `window-resizable'.
1519 If this function returns nil, this does not necessarily mean that
1520 WINDOW can be resized in the desired direction. The function
1521 `window-resizable' can tell that."
1522 (when (or (windowp ignore
) (memq ignore
'(nil preserved
)))
1523 (window--size-fixed-1
1524 (window-normalize-window window
) horizontal ignore
)))
1526 (defun window--min-delta-1 (window delta
&optional horizontal ignore trail noup pixelwise
)
1527 "Internal function for `window-min-delta'."
1528 (if (not (window-parent window
))
1529 ;; If we can't go up, return zero.
1531 ;; Else try to find a non-fixed-size sibling of WINDOW.
1532 (let* ((parent (window-parent window
))
1533 (sub (window-child parent
)))
1535 (if (window-combined-p sub horizontal
)
1536 ;; In an iso-combination throw DELTA if we find at least one
1537 ;; child window and that window is either not fixed-size or
1538 ;; we can ignore fixed-sizeness.
1539 (let ((skip (eq trail
'after
)))
1543 (setq skip
(eq trail
'before
)))
1545 ((window-size-fixed-p sub horizontal ignore
))
1547 ;; We found a non-fixed-size child window.
1548 (throw 'done delta
)))
1549 (setq sub
(window-right sub
))))
1550 ;; In an ortho-combination set DELTA to the minimum value by
1551 ;; which other child windows can shrink.
1553 (unless (eq sub window
)
1556 (max (- (window-size sub horizontal pixelwise
'ceiling
)
1558 sub horizontal ignore pixelwise
))
1560 (setq sub
(window-right sub
))))
1563 (window--min-delta-1
1564 parent delta horizontal ignore trail nil pixelwise
))))))
1566 (defun window-min-delta (&optional window horizontal ignore trail noup nodown pixelwise
)
1567 "Return number of lines by which WINDOW can be shrunk.
1568 WINDOW must be a valid window and defaults to the selected one.
1569 Return zero if WINDOW cannot be shrunk.
1571 Optional argument HORIZONTAL non-nil means return number of
1572 columns by which WINDOW can be shrunk.
1574 The optional argument IGNORE has the same meaning as for
1575 `window-resizable'. Optional argument TRAIL restricts the
1576 windows that can be enlarged. If its value is `before', only
1577 windows to the left of or above WINDOW can be enlarged. If it is
1578 `after', only windows to the right of or below WINDOW can be
1581 Optional argument NOUP non-nil means don't go up in the window
1582 tree, but try to enlarge windows within WINDOW's combination
1583 only. Optional argument NODOWN non-nil means don't check whether
1584 WINDOW itself (and its child windows) can be shrunk; check only
1585 whether at least one other window can be enlarged appropriately.
1587 Optional argument PIXELWISE non-nil means return number of pixels
1588 by which WINDOW can be shrunk."
1589 (setq window
(window-normalize-window window
))
1590 (let ((size (window-size window horizontal pixelwise
'floor
))
1591 (minimum (window-min-size window horizontal ignore pixelwise
)))
1594 ;; If NODOWN is t, try to recover the entire size of WINDOW.
1595 (window--min-delta-1
1596 window size horizontal ignore trail noup pixelwise
))
1598 ;; If NODOWN is nil and WINDOW's size is already at its minimum,
1599 ;; there's nothing to recover.
1602 ;; Otherwise, try to recover whatever WINDOW is larger than its
1604 (window--min-delta-1
1605 window
(- size minimum
) horizontal ignore trail noup pixelwise
)))))
1607 (defun frame-windows-min-size (&optional frame horizontal ignore pixelwise
)
1608 "Return minimum number of lines of FRAME's windows.
1609 HORIZONTAL non-nil means return number of columns of FRAME's
1610 windows. The optional argument IGNORE has the same meaning as
1611 for `window-resizable'. PIXELWISE non-nil means return sizes in
1613 (setq frame
(window-normalize-frame frame
))
1614 (let* ((root (frame-root-window frame
))
1615 (mini (window-next-sibling root
)))
1616 (+ (window-min-size root horizontal ignore pixelwise
)
1617 (if (and mini
(not horizontal
))
1618 (window-min-size mini horizontal nil pixelwise
)
1621 (defun window--max-delta-1 (window delta
&optional horizontal ignore trail noup pixelwise
)
1622 "Internal function of `window-max-delta'."
1623 (if (not (window-parent window
))
1624 ;; Can't go up. Return DELTA.
1626 (let* ((parent (window-parent window
))
1627 (sub (window-child parent
)))
1629 (if (window-combined-p sub horizontal
)
1630 ;; For an iso-combination calculate how much we can get from
1631 ;; other child windows.
1632 (let ((skip (eq trail
'after
)))
1636 (setq skip
(eq trail
'before
)))
1642 (- (window-size sub horizontal pixelwise
'floor
)
1644 sub horizontal ignore pixelwise
))
1646 (setq sub
(window-right sub
))))
1647 ;; For an ortho-combination throw DELTA when at least one
1648 ;; child window is fixed-size.
1650 (when (and (not (eq sub window
))
1651 (window-size-fixed-p sub horizontal ignore
))
1652 (throw 'fixed delta
))
1653 (setq sub
(window-right sub
))))
1655 ;; When NOUP is nil, DELTA is all we can get.
1657 ;; Else try with parent of WINDOW, passing the DELTA we
1658 ;; recovered so far.
1659 (window--max-delta-1
1660 parent delta horizontal ignore trail nil pixelwise
))))))
1662 (defun window-max-delta (&optional window horizontal ignore trail noup nodown pixelwise
)
1663 "Return maximum number of lines by which WINDOW can be enlarged.
1664 WINDOW must be a valid window and defaults to the selected one.
1665 The return value is zero if WINDOW cannot be enlarged.
1667 Optional argument HORIZONTAL non-nil means return maximum number
1668 of columns by which WINDOW can be enlarged.
1670 The optional argument IGNORE has the same meaning as for
1671 `window-resizable'. Optional argument TRAIL restricts the
1672 windows that can be enlarged. If its value is `before', only
1673 windows to the left of or above WINDOW can be enlarged. If it is
1674 `after', only windows to the right of or below WINDOW can be
1677 Optional argument NOUP non-nil means don't go up in the window
1678 tree but try to obtain the entire space from windows within
1679 WINDOW's combination. Optional argument NODOWN non-nil means do
1680 not check whether WINDOW itself (and its child windows) can be
1681 enlarged; check only whether other windows can be shrunk
1684 Optional argument PIXELWISE non-nil means return number of
1685 pixels by which WINDOW can be enlarged."
1686 (setq window
(window-normalize-window window
))
1687 (if (and (not nodown
) (window-size-fixed-p window horizontal ignore
))
1688 ;; With IGNORE and NOWDON nil return zero if WINDOW has fixed
1691 ;; WINDOW has no fixed size.
1692 (window--max-delta-1 window
0 horizontal ignore trail noup pixelwise
)))
1694 ;; Make NOUP also inhibit the min-size check.
1695 (defun window--resizable (window delta
&optional horizontal ignore trail noup nodown pixelwise
)
1696 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
1697 WINDOW must be a valid window and defaults to the selected one.
1698 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
1699 can be resized horizontally by DELTA columns. A return value of
1700 zero means that WINDOW is not resizable.
1702 DELTA positive means WINDOW shall be enlarged by DELTA lines or
1703 columns. If WINDOW cannot be enlarged by DELTA lines or columns,
1704 return the maximum value in the range 0..DELTA by which WINDOW
1707 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
1708 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
1709 return the minimum value in the range DELTA..0 that can be used
1710 for shrinking WINDOW.
1712 The optional argument IGNORE has the same meaning as for
1713 `window-resizable'. Optional argument TRAIL `before' means only
1714 windows to the left of or below WINDOW can be shrunk. Optional
1715 argument TRAIL `after' means only windows to the right of or
1716 above WINDOW can be shrunk.
1718 Optional argument NOUP non-nil means don't go up in the window
1719 tree but check only whether space can be obtained from (or given
1720 to) WINDOW's siblings. Optional argument NODOWN non-nil means
1721 don't go down in the window tree. This means do not check
1722 whether resizing would violate size restrictions of WINDOW or its
1725 Optional argument PIXELWISE non-nil means interpret DELTA as
1727 (setq window
(window-normalize-window window
))
1730 (max (- (window-min-delta
1731 window horizontal ignore trail noup nodown pixelwise
))
1734 (min (window-max-delta
1735 window horizontal ignore trail noup nodown pixelwise
)
1739 (defun window--resizable-p (window delta
&optional horizontal ignore trail noup nodown pixelwise
)
1740 "Return t if WINDOW can be resized vertically by DELTA lines.
1741 WINDOW must be a valid window and defaults to the selected one.
1742 For the meaning of the arguments of this function see the
1743 doc-string of `window--resizable'.
1745 Optional argument PIXELWISE non-nil means interpret DELTA as
1747 (setq window
(window-normalize-window window
))
1749 (>= (window--resizable
1750 window delta horizontal ignore trail noup nodown pixelwise
)
1752 (<= (window--resizable
1753 window delta horizontal ignore trail noup nodown pixelwise
)
1756 (defun window-resizable (window delta
&optional horizontal ignore pixelwise
)
1757 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
1758 WINDOW must be a valid window and defaults to the selected one.
1759 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
1760 can be resized horizontally by DELTA columns. A return value of
1761 zero means that WINDOW is not resizable.
1763 DELTA positive means WINDOW shall be enlarged by DELTA lines or
1764 columns. If WINDOW cannot be enlarged by DELTA lines or columns
1765 return the maximum value in the range 0..DELTA by which WINDOW
1768 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
1769 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
1770 return the minimum value in the range DELTA..0 that can be used
1771 for shrinking WINDOW.
1773 Optional argument IGNORE, if non-nil, means to ignore restraints
1774 induced by fixed size windows or the values of the variables
1775 `window-min-height' and `window-min-width'. The following values
1776 have special meanings: `safe' means that in addition live windows
1777 are allowed to get as small as `window-safe-min-height' lines and
1778 `window-safe-min-width' columns. `preserved' means to ignore
1779 only restrictions induced by `window-preserve-size'. If IGNORE
1780 is a window, then ignore restrictions for that window only.
1782 Optional argument PIXELWISE non-nil means interpret DELTA as
1784 (setq window
(window-normalize-window window
))
1785 (window--resizable window delta horizontal ignore nil nil nil pixelwise
))
1787 (defun window-resizable-p (window delta
&optional horizontal ignore pixelwise
)
1788 "Return t if WINDOW can be resized vertically by DELTA lines.
1789 WINDOW must be a valid window and defaults to the selected one.
1790 For the meaning of the arguments of this function see the
1791 doc-string of `window-resizable'."
1792 (setq window
(window-normalize-window window
))
1794 (>= (window--resizable
1795 window delta horizontal ignore nil nil nil pixelwise
)
1797 (<= (window--resizable
1798 window delta horizontal ignore nil nil nil pixelwise
)
1801 ;; Aliases of functions defined in window.c.
1802 (defalias 'window-height
'window-total-height
)
1803 (defalias 'window-width
'window-body-width
)
1805 (defun window-full-height-p (&optional window
)
1806 "Return t if WINDOW is as high as its containing frame.
1807 More precisely, return t if and only if the total height of
1808 WINDOW equals the total height of the root window of WINDOW's
1809 frame. WINDOW must be a valid window and defaults to the
1811 (setq window
(window-normalize-window window
))
1812 (if (window-minibuffer-p window
)
1813 (eq window
(frame-root-window (window-frame window
)))
1814 (= (window-pixel-height window
)
1815 (window-pixel-height (frame-root-window window
)))))
1817 (defun window-full-width-p (&optional window
)
1818 "Return t if WINDOW is as wide as its containing frame.
1819 More precisely, return t if and only if the total width of WINDOW
1820 equals the total width of the root window of WINDOW's frame.
1821 WINDOW must be a valid window and defaults to the selected one."
1822 (setq window
(window-normalize-window window
))
1823 (= (window-pixel-width window
)
1824 (window-pixel-width (frame-root-window window
))))
1826 (defun window-body-size (&optional window horizontal pixelwise
)
1827 "Return the height or width of WINDOW's text area.
1828 WINDOW must be a live window and defaults to the selected one.
1830 If HORIZONTAL is omitted or nil, return the height of the text
1831 area, like `window-body-height'. Otherwise, return the width of
1832 the text area, like `window-body-width'. In either case, the
1833 optional argument PIXELWISE is passed to the functions."
1835 (window-body-width window pixelwise
)
1836 (window-body-height window pixelwise
)))
1838 (declare-function font-info
"font.c" (name &optional frame
))
1840 (defun window-font-width (&optional window face
)
1841 "Return average character width for the font of FACE used in WINDOW.
1842 WINDOW must be a live window and defaults to the selected one.
1844 If FACE is nil or omitted, the default face is used. If FACE is
1845 remapped (see `face-remapping-alist'), the function returns the
1846 information for the remapped face."
1847 (with-selected-window (window-normalize-window window t
)
1848 (if (display-multi-font-p)
1849 (let* ((face (if face face
'default
))
1850 (info (font-info (face-font face
)))
1851 (width (aref info
11)))
1855 (frame-char-width))))
1857 (defun window-font-height (&optional window face
)
1858 "Return character height for the font of FACE used in WINDOW.
1859 WINDOW must be a live window and defaults to the selected one.
1861 If FACE is nil or omitted, the default face is used. If FACE is
1862 remapped (see `face-remapping-alist'), the function returns the
1863 information for the remapped face."
1864 (with-selected-window (window-normalize-window window t
)
1865 (if (display-multi-font-p)
1866 (let* ((face (if face face
'default
))
1867 (info (font-info (face-font face
))))
1869 (frame-char-height))))
1871 (defvar overflow-newline-into-fringe
)
1873 (defun window-max-chars-per-line (&optional window face
)
1874 "Return the number of characters that can be displayed on one line in WINDOW.
1875 WINDOW must be a live window and defaults to the selected one.
1877 The character width of FACE is used for the calculation. If FACE
1878 is nil or omitted, the default face is used. If FACE is
1879 remapped (see `face-remapping-alist'), the function uses the
1882 This function is different from `window-body-width' in two
1883 ways. First, it accounts for the portions of the line reserved
1884 for the continuation glyph. Second, it accounts for the size of
1886 (with-selected-window (window-normalize-window window t
)
1887 (let* ((window-width (window-body-width window t
))
1888 (font-width (window-font-width window face
))
1889 (ncols (/ window-width font-width
)))
1890 (if (and (display-graphic-p)
1891 overflow-newline-into-fringe
1892 (/= (frame-parameter nil
'left-fringe
) 0)
1893 (/= (frame-parameter nil
'right-fringe
) 0))
1897 (defun window-current-scroll-bars (&optional window
)
1898 "Return the current scroll bar types for WINDOW.
1899 WINDOW must be a live window and defaults to the selected one.
1901 The return value is a cons cell (VERTICAL . HORIZONTAL) where
1902 VERTICAL specifies the current location of the vertical scroll
1903 bar (`left', `right' or nil), and HORIZONTAL specifies the
1904 current location of the horizontal scroll bar (`bottom' or nil).
1906 Unlike `window-scroll-bars', this function reports the scroll bar
1907 type actually used, once frame defaults and `scroll-bar-mode' are
1908 taken into account."
1909 (setq window
(window-normalize-window window t
))
1910 (let ((vertical (nth 2 (window-scroll-bars window
)))
1911 (horizontal (nth 5 (window-scroll-bars window
)))
1912 (inherited (frame-current-scroll-bars (window-frame window
))))
1913 (when (eq vertical t
)
1914 (setq vertical
(car inherited
)))
1915 (when (eq horizontal t
)
1916 (setq horizontal
(cdr inherited
)))
1917 (cons vertical
(and horizontal
'bottom
))))
1919 (defun walk-windows (fun &optional minibuf all-frames
)
1920 "Cycle through all live windows, calling FUN for each one.
1921 FUN must specify a function with a window as its sole argument.
1922 The optional arguments MINIBUF and ALL-FRAMES specify the set of
1923 windows to include in the walk.
1925 MINIBUF t means include the minibuffer window even if the
1926 minibuffer is not active. MINIBUF nil or omitted means include
1927 the minibuffer window only if the minibuffer is active. Any
1928 other value means do not include the minibuffer window even if
1929 the minibuffer is active.
1931 ALL-FRAMES nil or omitted means consider all windows on the
1932 selected frame, plus the minibuffer window if specified by the
1933 MINIBUF argument. If the minibuffer counts, consider all windows
1934 on all frames that share that minibuffer too. The following
1935 non-nil values of ALL-FRAMES have special meanings:
1937 - t means consider all windows on all existing frames.
1939 - `visible' means consider all windows on all visible frames on
1940 the current terminal.
1942 - 0 (the number zero) means consider all windows on all visible
1943 and iconified frames on the current terminal.
1945 - A frame means consider all windows on that frame only.
1947 Anything else means consider all windows on the selected frame
1950 This function changes neither the order of recently selected
1951 windows nor the buffer list."
1952 ;; If we start from the minibuffer window, don't fail to come
1954 (when (window-minibuffer-p)
1956 ;; Make sure to not mess up the order of recently selected
1957 ;; windows. Use `save-selected-window' and `select-window'
1958 ;; with second argument non-nil for this purpose.
1959 (save-selected-window
1960 (when (framep all-frames
)
1961 (select-window (frame-first-window all-frames
) 'norecord
))
1962 (dolist (walk-windows-window (window-list-1 nil minibuf all-frames
))
1963 (funcall fun walk-windows-window
))))
1965 (defun window-at-side-p (&optional window side
)
1966 "Return t if WINDOW is at SIDE of its containing frame.
1967 WINDOW must be a valid window and defaults to the selected one.
1968 SIDE can be any of the symbols `left', `top', `right' or
1969 `bottom'. The default value nil is handled like `bottom'."
1970 (setq window
(window-normalize-window window
))
1975 ((eq side
'right
) 2)
1976 ((memq side
'(bottom nil
)) 3))))
1977 (= (nth edge
(window-pixel-edges window
))
1978 (nth edge
(window-pixel-edges (frame-root-window window
))))))
1980 (defun window-at-side-list (&optional frame side
)
1981 "Return list of all windows on SIDE of FRAME.
1982 FRAME must be a live frame and defaults to the selected frame.
1983 SIDE can be any of the symbols `left', `top', `right' or
1984 `bottom'. The default value nil is handled like `bottom'."
1985 (setq frame
(window-normalize-frame frame
))
1989 (when (window-at-side-p window side
)
1990 (setq windows
(cons window windows
))))
1992 (nreverse windows
)))
1994 (defun window--in-direction-2 (window posn
&optional horizontal
)
1995 "Support function for `window-in-direction'."
1997 (let ((top (window-pixel-top window
)))
2000 (- posn top
(window-pixel-height window
))))
2001 (let ((left (window-pixel-left window
)))
2004 (- posn left
(window-pixel-width window
))))))
2006 ;; Predecessors to the below have been devised by Julian Assange in
2007 ;; change-windows-intuitively.el and Hovav Shacham in windmove.el.
2008 ;; Neither of these allow one to selectively ignore specific windows
2009 ;; (windows whose `no-other-window' parameter is non-nil) as targets of
2011 (defun window-in-direction (direction &optional window ignore sign wrap mini
)
2012 "Return window in DIRECTION as seen from WINDOW.
2013 More precisely, return the nearest window in direction DIRECTION
2014 as seen from the position of `window-point' in window WINDOW.
2015 DIRECTION must be one of `above', `below', `left' or `right'.
2016 WINDOW must be a live window and defaults to the selected one.
2018 Do not return a window whose `no-other-window' parameter is
2019 non-nil. If the nearest window's `no-other-window' parameter is
2020 non-nil, try to find another window in the indicated direction.
2021 If, however, the optional argument IGNORE is non-nil, return that
2022 window even if its `no-other-window' parameter is non-nil.
2024 Optional argument SIGN a negative number means to use the right
2025 or bottom edge of WINDOW as reference position instead of
2026 `window-point'. SIGN a positive number means to use the left or
2027 top edge of WINDOW as reference position.
2029 Optional argument WRAP non-nil means to wrap DIRECTION around
2030 frame borders. This means to return for WINDOW at the top of the
2031 frame and DIRECTION `above' the minibuffer window if the frame
2032 has one, and a window at the bottom of the frame otherwise.
2034 Optional argument MINI nil means to return the minibuffer window
2035 if and only if it is currently active. MINI non-nil means to
2036 return the minibuffer window even when it's not active. However,
2037 if WRAP non-nil, always act as if MINI were nil.
2039 Return nil if no suitable window can be found."
2040 (setq window
(window-normalize-window window t
))
2041 (unless (memq direction
'(above below left right
))
2042 (error "Wrong direction %s" direction
))
2043 (let* ((frame (window-frame window
))
2044 (hor (memq direction
'(left right
)))
2046 (window-pixel-left window
)
2047 (window-pixel-top window
)))
2048 (last (+ first
(window-size window hor t
)))
2049 ;; The column / row value of `posn-at-point' can be nil for the
2050 ;; mini-window, guard against that.
2053 ((and (numberp sign
) (< sign
0))
2055 (1- (+ (window-pixel-top window
) (window-pixel-height window
)))
2056 (1- (+ (window-pixel-left window
) (window-pixel-width window
)))))
2057 ((and (numberp sign
) (> sign
0))
2059 (window-pixel-top window
)
2060 (window-pixel-left window
)))
2061 ((let ((posn-cons (nth 2 (posn-at-point (window-point window
) window
))))
2063 (+ (or (cdr posn-cons
) 1) (window-pixel-top window
))
2064 (+ (or (car posn-cons
) 1) (window-pixel-left window
)))))))
2067 ((eq direction
'below
) (frame-pixel-height frame
))
2068 ((eq direction
'right
) (frame-pixel-width frame
))
2070 (best-edge-2 best-edge
)
2071 (best-diff-2 (if hor
(frame-pixel-height frame
) (frame-pixel-width frame
)))
2072 best best-2 best-diff-2-new
)
2075 (let* ((w-top (window-pixel-top w
))
2076 (w-left (window-pixel-left w
)))
2079 ;; Ignore ourselves.
2080 (and (window-parameter w
'no-other-window
)
2081 ;; Ignore W unless IGNORE is non-nil.
2085 ((and (<= w-top posn
)
2086 (< posn
(+ w-top
(window-pixel-height w
))))
2087 ;; W is to the left or right of WINDOW and covers POSN.
2088 (when (or (and (eq direction
'left
)
2089 (or (and (<= w-left first
) (> w-left best-edge
))
2091 (window-at-side-p window
'left
)
2092 (window-at-side-p w
'right
))))
2093 (and (eq direction
'right
)
2094 (or (and (>= w-left last
) (< w-left best-edge
))
2096 (window-at-side-p window
'right
)
2097 (window-at-side-p w
'left
)))))
2098 (setq best-edge w-left
)
2100 ((and (or (and (eq direction
'left
)
2101 (<= (+ w-left
(window-pixel-width w
)) first
))
2102 (and (eq direction
'right
) (<= last w-left
)))
2103 ;; W is to the left or right of WINDOW but does not
2105 (setq best-diff-2-new
2106 (window--in-direction-2 w posn hor
))
2107 (or (< best-diff-2-new best-diff-2
)
2108 (and (= best-diff-2-new best-diff-2
)
2109 (if (eq direction
'left
)
2110 (> w-left best-edge-2
)
2111 (< w-left best-edge-2
)))))
2112 (setq best-edge-2 w-left
)
2113 (setq best-diff-2 best-diff-2-new
)
2115 ((and (<= w-left posn
)
2116 (< posn
(+ w-left
(window-pixel-width w
))))
2117 ;; W is above or below WINDOW and covers POSN.
2118 (when (or (and (eq direction
'above
)
2119 (or (and (<= w-top first
) (> w-top best-edge
))
2121 (window-at-side-p window
'top
)
2122 (if (active-minibuffer-window)
2123 (minibuffer-window-active-p w
)
2124 (window-at-side-p w
'bottom
)))))
2125 (and (eq direction
'below
)
2126 (or (and (>= w-top first
) (< w-top best-edge
))
2128 (if (active-minibuffer-window)
2129 (minibuffer-window-active-p window
)
2130 (window-at-side-p window
'bottom
))
2131 (window-at-side-p w
'top
)))))
2132 (setq best-edge w-top
)
2134 ((and (or (and (eq direction
'above
)
2135 (<= (+ w-top
(window-pixel-height w
)) first
))
2136 (and (eq direction
'below
) (<= last w-top
)))
2137 ;; W is above or below WINDOW but does not cover POSN.
2138 (setq best-diff-2-new
2139 (window--in-direction-2 w posn hor
))
2140 (or (< best-diff-2-new best-diff-2
)
2141 (and (= best-diff-2-new best-diff-2
)
2142 (if (eq direction
'above
)
2143 (> w-top best-edge-2
)
2144 (< w-top best-edge-2
)))))
2145 (setq best-edge-2 w-top
)
2146 (setq best-diff-2 best-diff-2-new
)
2148 frame nil
(and mini t
))
2151 (defun get-window-with-predicate (predicate &optional minibuf all-frames default
)
2152 "Return a live window satisfying PREDICATE.
2153 More precisely, cycle through all windows calling the function
2154 PREDICATE on each one of them with the window as its sole
2155 argument. Return the first window for which PREDICATE returns
2156 non-nil. Windows are scanned starting with the window following
2157 the selected window. If no window satisfies PREDICATE, return
2160 MINIBUF t means include the minibuffer window even if the
2161 minibuffer is not active. MINIBUF nil or omitted means include
2162 the minibuffer window only if the minibuffer is active. Any
2163 other value means do not include the minibuffer window even if
2164 the minibuffer is active.
2166 ALL-FRAMES nil or omitted means consider all windows on the selected
2167 frame, plus the minibuffer window if specified by the MINIBUF
2168 argument. If the minibuffer counts, consider all windows on all
2169 frames that share that minibuffer too. The following non-nil
2170 values of ALL-FRAMES have special meanings:
2172 - t means consider all windows on all existing frames.
2174 - `visible' means consider all windows on all visible frames on
2175 the current terminal.
2177 - 0 (the number zero) means consider all windows on all visible
2178 and iconified frames on the current terminal.
2180 - A frame means consider all windows on that frame only.
2182 Anything else means consider all windows on the selected frame
2185 (dolist (window (window-list-1
2186 (next-window nil minibuf all-frames
)
2187 minibuf all-frames
))
2188 (when (funcall predicate window
)
2189 (throw 'found window
)))
2192 (defalias 'some-window
'get-window-with-predicate
)
2194 (defun get-lru-window (&optional all-frames dedicated not-selected
)
2195 "Return the least recently used window on frames specified by ALL-FRAMES.
2196 Return a full-width window if possible. A minibuffer window is
2197 never a candidate. A dedicated window is never a candidate
2198 unless DEDICATED is non-nil, so if all windows are dedicated, the
2199 value is nil. Avoid returning the selected window if possible.
2200 Optional argument NOT-SELECTED non-nil means never return the
2203 The following non-nil values of the optional argument ALL-FRAMES
2204 have special meanings:
2206 - t means consider all windows on all existing frames.
2208 - `visible' means consider all windows on all visible frames on
2209 the current terminal.
2211 - 0 (the number zero) means consider all windows on all visible
2212 and iconified frames on the current terminal.
2214 - A frame means consider all windows on that frame only.
2216 Any other value of ALL-FRAMES means consider all windows on the
2217 selected frame and no others."
2218 (let (best-window best-time second-best-window second-best-time time
)
2219 (dolist (window (window-list-1 nil
'nomini all-frames
))
2220 (when (and (or dedicated
(not (window-dedicated-p window
)))
2221 (or (not not-selected
) (not (eq window
(selected-window)))))
2222 (setq time
(window-use-time window
))
2223 (if (or (eq window
(selected-window))
2224 (not (window-full-width-p window
)))
2225 (when (or (not second-best-time
) (< time second-best-time
))
2226 (setq second-best-time time
)
2227 (setq second-best-window window
))
2228 (when (or (not best-time
) (< time best-time
))
2229 (setq best-time time
)
2230 (setq best-window window
)))))
2231 (or best-window second-best-window
)))
2233 (defun get-mru-window (&optional all-frames dedicated not-selected
)
2234 "Return the most recently used window on frames specified by ALL-FRAMES.
2235 A minibuffer window is never a candidate. A dedicated window is
2236 never a candidate unless DEDICATED is non-nil, so if all windows
2237 are dedicated, the value is nil. Optional argument NOT-SELECTED
2238 non-nil means never return the selected window.
2240 The following non-nil values of the optional argument ALL-FRAMES
2241 have special meanings:
2243 - t means consider all windows on all existing frames.
2245 - `visible' means consider all windows on all visible frames on
2246 the current terminal.
2248 - 0 (the number zero) means consider all windows on all visible
2249 and iconified frames on the current terminal.
2251 - A frame means consider all windows on that frame only.
2253 Any other value of ALL-FRAMES means consider all windows on the
2254 selected frame and no others."
2255 (let (best-window best-time time
)
2256 (dolist (window (window-list-1 nil
'nomini all-frames
))
2257 (setq time
(window-use-time window
))
2258 (when (and (or dedicated
(not (window-dedicated-p window
)))
2259 (or (not not-selected
) (not (eq window
(selected-window))))
2260 (or (not best-time
) (> time best-time
)))
2261 (setq best-time time
)
2262 (setq best-window window
)))
2265 (defun get-largest-window (&optional all-frames dedicated not-selected
)
2266 "Return the largest window on frames specified by ALL-FRAMES.
2267 A minibuffer window is never a candidate. A dedicated window is
2268 never a candidate unless DEDICATED is non-nil, so if all windows
2269 are dedicated, the value is nil. Optional argument NOT-SELECTED
2270 non-nil means never return the selected window.
2272 The following non-nil values of the optional argument ALL-FRAMES
2273 have special meanings:
2275 - t means consider all windows on all existing frames.
2277 - `visible' means consider all windows on all visible frames on
2278 the current terminal.
2280 - 0 (the number zero) means consider all windows on all visible
2281 and iconified frames on the current terminal.
2283 - A frame means consider all windows on that frame only.
2285 Any other value of ALL-FRAMES means consider all windows on the
2286 selected frame and no others."
2289 (dolist (window (window-list-1 nil
'nomini all-frames
))
2290 (when (and (or dedicated
(not (window-dedicated-p window
)))
2291 (or (not not-selected
) (not (eq window
(selected-window)))))
2292 (setq size
(* (window-pixel-height window
)
2293 (window-pixel-width window
)))
2294 (when (> size best-size
)
2295 (setq best-size size
)
2296 (setq best-window window
))))
2299 (defun get-buffer-window-list (&optional buffer-or-name minibuf all-frames
)
2300 "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
2301 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2302 and defaults to the current buffer. If the selected window displays
2303 BUFFER-OR-NAME, it will be the first in the resulting list.
2305 MINIBUF t means include the minibuffer window even if the
2306 minibuffer is not active. MINIBUF nil or omitted means include
2307 the minibuffer window only if the minibuffer is active. Any
2308 other value means do not include the minibuffer window even if
2309 the minibuffer is active.
2311 ALL-FRAMES nil or omitted means consider all windows on the
2312 selected frame, plus the minibuffer window if specified by the
2313 MINIBUF argument. If the minibuffer counts, consider all windows
2314 on all frames that share that minibuffer too. The following
2315 non-nil values of ALL-FRAMES have special meanings:
2317 - t means consider all windows on all existing frames.
2319 - `visible' means consider all windows on all visible frames on
2320 the current terminal.
2322 - 0 (the number zero) means consider all windows on all visible
2323 and iconified frames on the current terminal.
2325 - A frame means consider all windows on that frame only.
2327 Anything else means consider all windows on the selected frame
2329 (let ((buffer (window-normalize-buffer buffer-or-name
))
2331 (dolist (window (window-list-1 (selected-window) minibuf all-frames
))
2332 (when (eq (window-buffer window
) buffer
)
2333 (setq windows
(cons window windows
))))
2334 (nreverse windows
)))
2336 (defun minibuffer-window-active-p (window)
2337 "Return t if WINDOW is the currently active minibuffer window."
2338 (eq window
(active-minibuffer-window)))
2340 (defun count-windows (&optional minibuf
)
2341 "Return the number of live windows on the selected frame.
2342 The optional argument MINIBUF specifies whether the minibuffer
2343 window shall be counted. See `walk-windows' for the precise
2344 meaning of this argument."
2345 (length (window-list-1 nil minibuf
)))
2347 ;;; Resizing windows.
2348 (defun window--size-to-pixel (window size
&optional horizontal pixelwise round-maybe
)
2349 "For WINDOW convert SIZE lines to pixels.
2350 SIZE is supposed to specify a height of WINDOW in terms of text
2351 lines. The return value is the number of pixels specifying that
2354 WINDOW must be a valid window. Optional argument HORIZONTAL
2355 non-nil means convert SIZE columns to pixels.
2357 Optional argument PIXELWISE non-nil means SIZE already specifies
2358 pixels but may have to be adjusted to a multiple of the character
2359 size of WINDOW's frame. Optional argument ROUND-MAYBE non-nil
2360 means round to the nearest multiple of the character size of
2361 WINDOW's frame if the option `window-resize-pixelwise' is nil."
2362 (setq window
(window-normalize-window window
))
2363 (let ((char-size (frame-char-size window horizontal
)))
2365 (if (and round-maybe
(not window-resize-pixelwise
))
2366 (* (round size char-size
) char-size
)
2368 (* size char-size
))))
2370 (defun window--pixel-to-total-1 (window horizontal char-size
)
2371 "Subroutine of `window--pixel-to-total'."
2372 (let ((child (window-child window
)))
2373 (if (window-combination-p window horizontal
)
2374 ;; In an iso-combination distribute sizes proportionally.
2375 (let ((remainder (window-new-total window
))
2376 size best-child rem best-rem
)
2377 ;; Initialize total sizes to each child's floor.
2379 (setq size
(max (/ (window-size child horizontal t
) char-size
) 1))
2380 (set-window-new-total child size
)
2381 (setq remainder
(- remainder size
))
2382 (setq child
(window-next-sibling child
)))
2383 ;; Distribute remainder.
2384 (while (> remainder
0)
2385 (setq child
(window-last-child window
))
2386 (setq best-child nil
)
2389 (when (and (<= (window-new-total child
)
2390 (/ (window-size child horizontal t
) char-size
))
2391 (> (setq rem
(%
(window-size child horizontal t
)
2394 (setq best-child child
)
2395 (setq best-rem rem
))
2396 (setq child
(window-prev-sibling child
)))
2397 ;; We MUST have a best-child here.
2398 (set-window-new-total best-child
1 t
)
2399 (setq remainder
(1- remainder
)))
2401 (setq child
(window-child window
))
2403 (window--pixel-to-total-1 child horizontal char-size
)
2404 (setq child
(window-next-sibling child
))))
2405 ;; In an ortho-combination assign new sizes directly.
2406 (let ((size (window-new-total window
)))
2408 (set-window-new-total child size
)
2409 (window--pixel-to-total-1 child horizontal char-size
)
2410 (setq child
(window-next-sibling child
)))))))
2412 (defun window--pixel-to-total (&optional frame horizontal
)
2413 "On FRAME assign new total window heights from pixel heights.
2414 FRAME must be a live frame and defaults to the selected frame.
2416 Optional argument HORIZONTAL non-nil means assign new total
2417 window widths from pixel widths."
2418 (setq frame
(window-normalize-frame frame
))
2419 (let* ((char-size (frame-char-size frame horizontal
))
2420 (root (frame-root-window frame
))
2421 (root-size (window-size root horizontal t
))
2422 ;; We have to care about the minibuffer window only if it
2423 ;; appears together with the root window on this frame.
2424 (mini (let ((mini (minibuffer-window frame
)))
2425 (and (eq (window-frame mini
) frame
)
2426 (not (eq mini root
)) mini
)))
2427 (mini-size (and mini
(window-size mini horizontal t
))))
2428 ;; We round the line/column sizes of windows here to the nearest
2429 ;; integer. In some cases this can make windows appear _larger_
2430 ;; than the containing frame (line/column-wise) because the latter's
2431 ;; sizes are not (yet) rounded. We might eventually fix that.
2432 (if (and mini
(not horizontal
))
2434 (set-window-new-total root
(max (/ root-size char-size
) 1))
2435 (set-window-new-total mini
(max (/ mini-size char-size
) 1))
2436 (setq lines
(- (round (+ root-size mini-size
) char-size
)
2437 (+ (window-new-total root
) (window-new-total mini
))))
2439 (if (>= (% root-size
(window-new-total root
))
2440 (% mini-size
(window-new-total mini
)))
2441 (set-window-new-total root
1 t
)
2442 (set-window-new-total mini
1 t
))
2443 (setq lines
(1- lines
))))
2444 (set-window-new-total root
(round root-size char-size
))
2446 ;; This is taken in the horizontal case only.
2447 (set-window-new-total mini
(round mini-size char-size
))))
2448 (unless (window-buffer root
)
2449 (window--pixel-to-total-1 root horizontal char-size
))
2450 ;; Apply the new sizes.
2451 (window-resize-apply-total frame horizontal
)))
2453 (defun window--resize-reset (&optional frame horizontal
)
2454 "Reset resize values for all windows on FRAME.
2455 FRAME defaults to the selected frame.
2457 This function stores the current value of `window-size' applied
2458 with argument HORIZONTAL in the new total size of all windows on
2459 FRAME. It also resets the new normal size of each of these
2461 (window--resize-reset-1
2462 (frame-root-window (window-normalize-frame frame
)) horizontal
))
2464 (defun window--resize-reset-1 (window horizontal
)
2465 "Internal function of `window--resize-reset'."
2466 ;; Register old size in the new total size.
2467 (set-window-new-pixel window
(window-size window horizontal t
))
2468 (set-window-new-total window
(window-size window horizontal
))
2469 ;; Reset new normal size.
2470 (set-window-new-normal window
)
2471 (when (window-child window
)
2472 (window--resize-reset-1 (window-child window
) horizontal
))
2473 (when (window-right window
)
2474 (window--resize-reset-1 (window-right window
) horizontal
)))
2476 ;; The following routine is used to manually resize the minibuffer
2477 ;; window and is currently used, for example, by ispell.el.
2478 (defun window--resize-mini-window (window delta
)
2479 "Resize minibuffer window WINDOW by DELTA pixels.
2480 If WINDOW cannot be resized by DELTA pixels make it as large (or
2481 as small) as possible, but don't signal an error."
2482 (when (window-minibuffer-p window
)
2483 (let* ((frame (window-frame window
))
2484 (root (frame-root-window frame
))
2485 (height (window-pixel-height window
))
2487 (- (window-pixel-height root
)
2488 (window-min-size root nil nil t
))))
2491 ((<= (+ height delta
) 0)
2492 (setq delta
(- (frame-char-height (window-frame window
)) height
)))
2493 ((> delta min-delta
)
2494 (setq delta min-delta
)))
2496 (unless (zerop delta
)
2498 (window--resize-reset frame
)
2499 ;; Ideally we should be able to resize just the last child of root
2500 ;; here. See the comment in `resize-root-window-vertically' for
2501 ;; why we do not do that.
2502 (window--resize-this-window root
(- delta
) nil nil t
)
2503 (set-window-new-pixel window
(+ height delta
))
2504 ;; The following routine catches the case where we want to resize
2505 ;; a minibuffer-only frame.
2506 (when (resize-mini-window-internal window
)
2507 (window--pixel-to-total frame
)
2508 (run-window-configuration-change-hook frame
))))))
2510 (defun window--resize-apply-p (frame &optional horizontal
)
2511 "Return t when a window on FRAME shall be resized vertically.
2512 Optional argument HORIZONTAL non-nil means return t when a window
2513 shall be resized horizontally."
2517 (unless (= (window-new-pixel window
)
2518 (window-size window horizontal t
))
2523 (defun window-resize (window delta
&optional horizontal ignore pixelwise
)
2524 "Resize WINDOW vertically by DELTA lines.
2525 WINDOW can be an arbitrary window and defaults to the selected
2526 one. An attempt to resize the root window of a frame will raise
2529 DELTA a positive number means WINDOW shall be enlarged by DELTA
2530 lines. DELTA negative means WINDOW shall be shrunk by -DELTA
2533 Optional argument HORIZONTAL non-nil means resize WINDOW
2534 horizontally by DELTA columns. In this case a positive DELTA
2535 means enlarge WINDOW by DELTA columns. DELTA negative means
2536 WINDOW shall be shrunk by -DELTA columns.
2538 Optional argument IGNORE, if non-nil, means to ignore restraints
2539 induced by fixed size windows or the values of the variables
2540 `window-min-height' and `window-min-width'. The following values
2541 have special meanings: `safe' means that in addition live windows
2542 are allowed to get as small as `window-safe-min-height' lines and
2543 `window-safe-min-width' columns. `preserved' means to ignore
2544 only restrictions induced by `window-preserve-size'. If IGNORE
2545 is a window, then ignore restrictions for that window only.
2547 Optional argument PIXELWISE non-nil means resize WINDOW by DELTA
2550 This function resizes other windows proportionally and never
2551 deletes any windows. If you want to move only the low (right)
2552 edge of WINDOW consider using `adjust-window-trailing-edge'
2554 (setq window
(window-normalize-window window
))
2555 (let* ((frame (window-frame window
))
2556 (minibuffer-window (minibuffer-window frame
))
2558 (setq delta
(window--size-to-pixel
2559 window delta horizontal pixelwise t
))
2561 ((eq window
(frame-root-window frame
))
2562 (error "Cannot resize the root window of a frame"))
2563 ((window-minibuffer-p window
)
2565 (error "Cannot resize minibuffer window horizontally")
2566 (window--resize-mini-window window delta
)))
2567 ((and (not horizontal
)
2568 (window-full-height-p window
)
2569 (eq (window-frame minibuffer-window
) frame
)
2570 (or (not resize-mini-windows
)
2571 (eq minibuffer-window
(active-minibuffer-window))))
2572 ;; If WINDOW is full height and either `resize-mini-windows' is
2573 ;; nil or the minibuffer window is active, resize the minibuffer
2575 (window--resize-mini-window minibuffer-window
(- delta
)))
2576 ((or (window--resizable-p
2577 window delta horizontal ignore nil nil nil t
)
2579 (setq ignore
'preserved
)
2580 (window--resizable-p
2581 window delta horizontal ignore nil nil nil t
)))
2582 (window--resize-reset frame horizontal
)
2583 (window--resize-this-window window delta horizontal ignore t
)
2584 (if (and (not window-combination-resize
)
2585 (window-combined-p window horizontal
)
2586 (setq sibling
(or (window-right window
) (window-left window
)))
2588 sibling
(- delta
) horizontal ignore t
))
2589 ;; If window-combination-resize is nil, WINDOW is part of an
2590 ;; iso-combination, and WINDOW's neighboring right or left
2591 ;; sibling can be resized as requested, resize that sibling.
2594 (window-size (window-parent window
) horizontal t
))))
2595 (window--resize-this-window sibling
(- delta
) horizontal nil t
)
2596 (set-window-new-normal
2597 window
(+ (window-normal-size window horizontal
)
2599 (set-window-new-normal
2600 sibling
(- (window-normal-size sibling horizontal
)
2602 ;; Otherwise, resize all other windows in the same combination.
2603 (window--resize-siblings window delta horizontal ignore
))
2604 (when (window--resize-apply-p frame horizontal
)
2605 (if (window-resize-apply frame horizontal
)
2607 (window--pixel-to-total frame horizontal
)
2608 (run-window-configuration-change-hook frame
))
2609 (error "Failed to apply resizing %s" window
))))
2611 (error "Cannot resize window %s" window
)))))
2613 (defun window-resize-no-error (window delta
&optional horizontal ignore pixelwise
)
2614 "Resize WINDOW vertically if it is resizable by DELTA lines.
2615 This function is like `window-resize' but does not signal an
2616 error when WINDOW cannot be resized. For the meaning of the
2617 optional arguments see the documentation of `window-resize'.
2619 Optional argument PIXELWISE non-nil means interpret DELTA as
2621 (when (window--resizable-p
2622 window delta horizontal ignore nil nil nil pixelwise
)
2623 (window-resize window delta horizontal ignore pixelwise
)))
2625 (defun window--resize-child-windows-skip-p (window)
2626 "Return non-nil if WINDOW shall be skipped by resizing routines."
2627 (memq (window-new-normal window
) '(ignore stuck skip
)))
2629 (defun window--resize-child-windows-normal (parent horizontal window this-delta
&optional trail other-delta
)
2630 "Recursively set new normal height of child windows of window PARENT.
2631 HORIZONTAL non-nil means set the new normal width of these
2632 windows. WINDOW specifies a child window of PARENT that has been
2633 resized by THIS-DELTA lines (columns).
2635 Optional argument TRAIL either `before' or `after' means set values
2636 only for windows before or after WINDOW. Optional argument
2637 OTHER-DELTA, a number, specifies that this many lines (columns)
2638 have been obtained from (or returned to) an ancestor window of
2639 PARENT in order to resize WINDOW."
2640 (let* ((delta-normal
2641 (if (and (= (- this-delta
)
2642 (window-size window horizontal t
))
2643 (zerop other-delta
))
2644 ;; When WINDOW gets deleted and we can return its entire
2645 ;; space to its siblings, use WINDOW's normal size as the
2647 (- (window-normal-size window horizontal
))
2648 ;; In any other case calculate the normal delta from the
2649 ;; relation of THIS-DELTA to the total size of PARENT.
2650 (/ (float this-delta
)
2651 (window-size parent horizontal t
))))
2652 (sub (window-child parent
))
2654 (skip (eq trail
'after
)))
2656 ;; Set parent-normal to the sum of the normal sizes of all child
2657 ;; windows of PARENT that shall be resized, excluding only WINDOW
2658 ;; and any windows specified by the optional TRAIL argument.
2662 (setq skip
(eq trail
'before
)))
2666 (+ parent-normal
(window-normal-size sub horizontal
)))))
2667 (setq sub
(window-right sub
)))
2669 ;; Set the new normal size of all child windows of PARENT from what
2670 ;; they should have contributed for recovering THIS-DELTA lines
2672 (setq sub
(window-child parent
))
2673 (setq skip
(eq trail
'after
))
2677 (setq skip
(eq trail
'before
)))
2680 (let ((old-normal (window-normal-size sub horizontal
)))
2681 (set-window-new-normal
2682 sub
(min 1.0 ; Don't get larger than 1.
2684 (* (/ old-normal parent-normal
)
2686 ;; Don't drop below 0.
2688 (setq sub
(window-right sub
)))
2690 (when (numberp other-delta
)
2691 ;; Set the new normal size of windows from what they should have
2692 ;; contributed for recovering OTHER-DELTA lines (columns).
2693 (setq delta-normal
(/ (float (window-size parent horizontal t
))
2694 (+ (window-size parent horizontal t
)
2696 (setq sub
(window-child parent
))
2697 (setq skip
(eq trail
'after
))
2701 (setq skip
(eq trail
'before
)))
2704 (set-window-new-normal
2705 sub
(min 1.0 ; Don't get larger than 1.
2706 (max (* (window-new-normal sub
) delta-normal
)
2707 ;; Don't drop below 0.
2709 (setq sub
(window-right sub
))))
2711 ;; Set the new normal size of WINDOW to what is left by the sum of
2712 ;; the normal sizes of its siblings.
2713 (set-window-new-normal
2716 (setq sub
(window-child parent
))
2720 ((not (numberp (window-new-normal sub
)))
2721 (setq sum
(+ sum
(window-normal-size sub horizontal
))))
2723 (setq sum
(+ sum
(window-new-normal sub
)))))
2724 (setq sub
(window-right sub
)))
2725 ;; Don't get larger than 1 or smaller than 0.
2726 (min 1.0 (max (- 1.0 sum
) 0.0))))))
2728 (defun window--resize-child-windows (parent delta
&optional horizontal window ignore trail edge char-size
)
2729 "Resize child windows of window PARENT vertically by DELTA pixels.
2730 PARENT must be a vertically combined internal window.
2732 Optional argument HORIZONTAL non-nil means resize child windows
2733 of PARENT horizontally by DELTA pixels. In this case PARENT must
2734 be a horizontally combined internal window.
2736 WINDOW, if specified, must denote a child window of PARENT that
2737 is resized by DELTA pixels.
2739 The optional argument IGNORE has the same meaning as for
2742 Optional arguments TRAIL and EDGE, when non-nil, restrict the set
2743 of windows that shall be resized. If TRAIL equals `before',
2744 resize only windows on the left or above EDGE. If TRAIL equals
2745 `after', resize only windows on the right or below EDGE. Also,
2746 preferably only resize windows adjacent to EDGE.
2748 If the optional argument CHAR-SIZE is a positive integer, it specifies
2749 the number of pixels by which windows are incrementally resized.
2750 If CHAR-SIZE is nil, this means to use the value of
2751 `frame-char-height' or `frame-char-width' of WINDOW's frame.
2753 Return the symbol `normalized' if new normal sizes have been
2754 already set by this routine."
2755 (let* ((first (window-child parent
))
2756 (last (window-last-child parent
))
2757 (parent-total (+ (window-size parent horizontal t
)
2759 (char-size (or char-size
2760 (and window-resize-pixelwise
1)
2761 (frame-char-size window horizontal
)))
2762 sub best-window best-value best-delta
)
2764 (if (and edge
(memq trail
'(before after
))
2767 (while (and (window-right sub
)
2768 (or (and (eq trail
'before
)
2769 (not (window--resize-child-windows-skip-p
2770 (window-right sub
))))
2771 (and (eq trail
'after
)
2772 (window--resize-child-windows-skip-p sub
))))
2773 (setq sub
(window-right sub
)))
2776 (if (eq trail
'before
)
2777 (= (+ (window-pixel-left sub
) (window-pixel-width sub
))
2779 (= (window-pixel-left sub
) edge
))
2780 (if (eq trail
'before
)
2781 (= (+ (window-pixel-top sub
) (window-pixel-height sub
))
2783 (= (window-pixel-top sub
) edge
)))
2784 (window-sizable-p sub delta horizontal ignore t
))
2785 ;; Resize only windows adjacent to EDGE.
2787 (window--resize-this-window
2788 sub delta horizontal ignore t trail edge
)
2789 (if (and window
(eq (window-parent sub
) parent
))
2791 ;; Assign new normal sizes.
2792 (set-window-new-normal
2793 sub
(/ (float (window-new-pixel sub
)) parent-total
))
2794 (set-window-new-normal
2795 window
(- (window-normal-size window horizontal
)
2796 (- (window-new-normal sub
)
2797 (window-normal-size sub horizontal
)))))
2798 (window--resize-child-windows-normal
2799 parent horizontal sub
0 trail delta
))
2800 ;; Return 'normalized to notify `window--resize-siblings' that
2801 ;; normal sizes have been already set.
2803 ;; Resize all windows proportionally.
2807 ((or (window--resize-child-windows-skip-p sub
)
2808 ;; Ignore windows to skip and fixed-size child windows -
2809 ;; in the latter case make it a window to skip.
2811 (window-size-fixed-p sub horizontal ignore
)
2812 (set-window-new-normal sub
'ignore
))))
2814 ;; When shrinking store the number of lines/cols we can get
2815 ;; from this window here together with the total/normal size
2817 (set-window-new-normal
2820 ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
2821 (window-min-delta sub horizontal ignore trail t nil t
)
2822 (- (/ (float (window-size sub horizontal t
))
2824 (window-normal-size sub horizontal
)))))
2826 ;; When enlarging store the total/normal size factor only
2827 (set-window-new-normal
2829 (- (/ (float (window-size sub horizontal t
))
2831 (window-normal-size sub horizontal
)))))
2833 (setq sub
(window-left sub
)))
2837 ;; Shrink windows by delta.
2838 (setq best-window t
)
2839 (while (and best-window
(not (zerop delta
)))
2841 (setq best-window nil
)
2842 (setq best-value most-negative-fixnum
)
2844 (when (and (consp (window-new-normal sub
))
2845 (not (<= (car (window-new-normal sub
)) 0))
2846 (> (cdr (window-new-normal sub
)) best-value
))
2847 (setq best-window sub
)
2848 (setq best-value
(cdr (window-new-normal sub
))))
2850 (setq sub
(window-left sub
)))
2853 (setq best-delta
(min (car (window-new-normal best-window
))
2854 char-size
(- delta
)))
2855 (setq delta
(+ delta best-delta
))
2856 (set-window-new-pixel best-window
(- best-delta
) t
)
2857 (set-window-new-normal
2859 (if (= (car (window-new-normal best-window
)) best-delta
)
2860 'skip
; We can't shrink best-window any further.
2861 (cons (- (car (window-new-normal best-window
)) best-delta
)
2862 (- (/ (float (window-new-pixel best-window
))
2864 (window-normal-size best-window horizontal
))))))))
2866 ;; Enlarge windows by delta.
2867 (setq best-window t
)
2868 (while (and best-window
(not (zerop delta
)))
2870 (setq best-window nil
)
2871 (setq best-value most-positive-fixnum
)
2873 (when (and (numberp (window-new-normal sub
))
2874 (< (window-new-normal sub
) best-value
))
2875 (setq best-window sub
)
2876 (setq best-value
(window-new-normal sub
)))
2878 (setq sub
(window-left sub
)))
2881 (setq best-delta
(min delta char-size
))
2882 (setq delta
(- delta best-delta
))
2883 (set-window-new-pixel best-window best-delta t
)
2884 (set-window-new-normal
2886 (- (/ (float (window-new-pixel best-window
))
2888 (window-normal-size best-window horizontal
)))))))
2893 (when (or (consp (window-new-normal sub
))
2894 (numberp (window-new-normal sub
)))
2895 ;; Reset new normal size fields so `window-resize-apply'
2896 ;; won't use them to apply new sizes.
2897 (set-window-new-normal sub
))
2899 (unless (eq (window-new-normal sub
) 'ignore
)
2900 ;; Resize this window's child windows (back-engineering
2901 ;; delta from sub's old and new total sizes).
2902 (let ((delta (- (window-new-pixel sub
)
2903 (window-size sub horizontal t
))))
2904 (unless (and (zerop delta
) (not trail
))
2905 ;; For the TRAIL non-nil case we have to resize SUB
2906 ;; recursively even if it's size does not change.
2907 (window--resize-this-window
2908 sub delta horizontal ignore nil trail edge
))))
2909 (setq sub
(window-left sub
)))))))
2911 (defun window--resize-siblings (window delta
&optional horizontal ignore trail edge char-size
)
2912 "Resize other windows when WINDOW is resized vertically by DELTA pixels.
2913 Optional argument HORIZONTAL non-nil means resize other windows
2914 when WINDOW is resized horizontally by DELTA pixels. WINDOW
2915 itself is not resized by this function.
2917 The optional argument IGNORE has the same meaning as for
2920 Optional arguments TRAIL and EDGE, when non-nil, refine the set
2921 of windows that shall be resized. If TRAIL equals `before',
2922 resize only windows on the left or above EDGE. If TRAIL equals
2923 `after', resize only windows on the right or below EDGE. Also,
2924 preferably only resize windows adjacent to EDGE."
2925 (when (window-parent window
)
2926 (let* ((parent (window-parent window
))
2927 (sub (window-child parent
)))
2928 (if (window-combined-p sub horizontal
)
2929 ;; In an iso-combination try to extract DELTA from WINDOW's
2931 (let ((skip (eq trail
'after
))
2932 this-delta other-delta
)
2933 ;; Decide which windows shall be left alone.
2937 ;; Make sure WINDOW is left alone when
2938 ;; resizing its siblings.
2939 (set-window-new-normal sub
'ignore
)
2940 (setq skip
(eq trail
'before
)))
2942 ;; Make sure this sibling is left alone when
2943 ;; resizing its siblings.
2944 (set-window-new-normal sub
'ignore
))
2945 ((not (window-size-fixed-p sub horizontal ignore
))
2946 ;; Set this-delta to t to signal that we found a sibling
2947 ;; of WINDOW whose size is not fixed.
2948 (setq this-delta t
)))
2950 (setq sub
(window-right sub
)))
2952 ;; Set this-delta to what we can get from WINDOW's siblings.
2953 (if (= (- delta
) (window-size window horizontal t
))
2954 ;; A deletion, presumably. We must handle this case
2955 ;; specially since `window--resizable' can't be used.
2957 ;; There's at least one resizable sibling we can
2958 ;; give WINDOW's size to.
2959 (setq this-delta delta
)
2960 ;; No resizable sibling exists.
2961 (setq this-delta
0))
2962 ;; Any other form of resizing.
2965 window delta horizontal ignore trail t nil t
)))
2967 ;; Set other-delta to what we still have to get from
2968 ;; ancestor windows of parent.
2969 (setq other-delta
(- delta this-delta
))
2970 (unless (zerop other-delta
)
2971 ;; Unless we got everything from WINDOW's siblings, PARENT
2972 ;; must be resized by other-delta lines or columns.
2973 (set-window-new-pixel parent other-delta
'add
))
2975 (if (zerop this-delta
)
2976 ;; We haven't got anything from WINDOW's siblings but we
2977 ;; must update the normal sizes to respect other-delta.
2978 (window--resize-child-windows-normal
2979 parent horizontal window this-delta trail other-delta
)
2980 ;; We did get something from WINDOW's siblings which means
2981 ;; we have to resize their child windows.
2982 (unless (eq (window--resize-child-windows
2983 parent
(- this-delta
) horizontal
2984 window ignore trail edge char-size
)
2985 ;; If `window--resize-child-windows' returns
2986 ;; 'normalized, this means it has set the
2987 ;; normal sizes already.
2989 ;; Set the normal sizes.
2990 (window--resize-child-windows-normal
2991 parent horizontal window this-delta trail other-delta
))
2992 ;; Set DELTA to what we still have to get from ancestor
2994 (setq delta other-delta
)))
2996 ;; In an ortho-combination all siblings of WINDOW must be
2997 ;; resized by DELTA.
2998 (set-window-new-pixel parent delta
'add
)
3000 (unless (eq sub window
)
3001 (window--resize-this-window
3002 sub delta horizontal ignore t
))
3003 (setq sub
(window-right sub
))))
3005 (unless (zerop delta
)
3007 (window--resize-siblings
3008 parent delta horizontal ignore trail edge char-size
)))))
3010 (defun window--resize-this-window (window delta
&optional horizontal ignore add trail edge char-size
)
3011 "Resize WINDOW vertically by DELTA pixels.
3012 Optional argument HORIZONTAL non-nil means resize WINDOW
3013 horizontally by DELTA pixels.
3015 The optional argument IGNORE has the same meaning as for
3016 `window-resizable'. Optional argument ADD non-nil means add
3017 DELTA to the new total size of WINDOW.
3019 Optional arguments TRAIL and EDGE, when non-nil, refine the set
3020 of windows that shall be resized. If TRAIL equals `before',
3021 resize only windows on the left or above EDGE. If TRAIL equals
3022 `after', resize only windows on the right or below EDGE. Also,
3023 preferably only resize windows adjacent to EDGE.
3025 If the optional argument CHAR-SIZE is a positive integer, it specifies
3026 the number of pixels by which windows are incrementally resized.
3027 If CHAR-SIZE is nil, this means to use the value of
3028 `frame-char-height' or `frame-char-width' of WINDOW's frame.
3030 This function recursively resizes WINDOW's child windows to fit the
3031 new size. Make sure that WINDOW is `window--resizable' before
3032 calling this function. Note that this function does not resize
3033 siblings of WINDOW or WINDOW's parent window. You have to
3034 eventually call `window-resize-apply' in order to make resizing
3035 actually take effect."
3037 ;; Add DELTA to the new total size of WINDOW.
3038 (set-window-new-pixel window delta t
))
3040 (let ((sub (window-child window
)))
3043 ((window-combined-p sub horizontal
)
3044 ;; In an iso-combination resize child windows according to their
3046 (window--resize-child-windows
3047 window delta horizontal nil ignore trail edge char-size
))
3048 ;; In an ortho-combination resize each child window by DELTA.
3051 (window--resize-this-window
3052 sub delta horizontal ignore t trail edge char-size
)
3053 (setq sub
(window-right sub
)))))))
3055 (defun window--resize-root-window (window delta horizontal ignore pixelwise
)
3056 "Resize root window WINDOW vertically by DELTA lines.
3057 HORIZONTAL non-nil means resize root window WINDOW horizontally
3060 IGNORE non-nil means ignore any restrictions imposed by fixed
3061 size windows, `window-min-height' or `window-min-width' settings.
3063 This function is only called by the frame resizing routines. It
3064 resizes windows proportionally and never deletes any windows."
3065 (when (and (windowp window
) (numberp delta
))
3069 (window--size-to-pixel window delta horizontal
))))
3070 (when (window-sizable-p window pixel-delta horizontal ignore t
)
3071 (window--resize-reset (window-frame window
) horizontal
)
3072 (window--resize-this-window
3073 window pixel-delta horizontal ignore t
)))))
3075 (defun window--resize-root-window-vertically (window delta pixelwise
)
3076 "Resize root window WINDOW vertically by DELTA lines.
3077 If DELTA is less than zero and we can't shrink WINDOW by DELTA
3078 lines, shrink it as much as possible. If DELTA is greater than
3079 zero, this function can resize fixed-size windows in order to
3080 recover the necessary lines. Return the number of lines that
3083 Third argument PIXELWISE non-nil means to interpret DELTA as
3084 pixels and return the number of pixels that were recovered.
3086 This function is called by the minibuffer window resizing
3088 (let* ((frame (window-frame window
))
3094 (* (frame-char-height frame
) delta
))
3098 ((zerop pixel-delta
))
3100 (setq pixel-delta
(window-sizable window pixel-delta nil nil pixelwise
))
3101 (window--resize-reset frame
)
3102 ;; When shrinking the root window, emulate an edge drag in order
3103 ;; to not resize other windows if we can avoid it (Bug#12419).
3104 (window--resize-this-window
3105 window pixel-delta nil ignore t
'before
3106 (+ (window-pixel-top window
) (window-pixel-height window
)))
3107 ;; Don't record new normal sizes to make sure that shrinking back
3108 ;; proportionally works as intended.
3110 (lambda (window) (set-window-new-normal window
'ignore
)) frame t
))
3112 (window--resize-reset frame
)
3113 (unless (window-sizable window pixel-delta nil nil pixelwise
)
3115 ;; When growing the root window, resize proportionally. This
3116 ;; should give windows back their original sizes (hopefully).
3117 (window--resize-this-window
3118 window pixel-delta nil ignore t
)))
3119 ;; Return the possibly adjusted DELTA.
3122 (/ pixel-delta
(frame-char-height frame
)))))
3124 (defun window--sanitize-window-sizes (frame horizontal
)
3125 "Assert that all windows on FRAME are large enough.
3126 If necessary and possible, make sure that every window on frame
3127 FRAME has its minimum height. Optional argument HORIZONTAL
3128 non-nil means to make sure that every window on frame FRAME has
3129 its minimum width. The minimum height/width of a window is the
3130 respective value returned by `window-min-size' for that window.
3132 Return t if all windows were resized appropriately. Return nil
3133 if at least one window could not be resized as requested, which
3134 may happen when the FRAME is not large enough to accommodate it."
3138 (let ((delta (- (window-min-size window horizontal nil t
)
3139 (window-size window horizontal t
))))
3141 (if (window-resizable-p window delta horizontal nil t
)
3142 (window-resize window delta horizontal nil t
)
3143 (setq value nil
))))))
3146 (defun adjust-window-trailing-edge (window delta
&optional horizontal pixelwise
)
3147 "Move WINDOW's bottom edge by DELTA lines.
3148 Optional argument HORIZONTAL non-nil means move WINDOW's right
3149 edge by DELTA columns. WINDOW must be a valid window and
3150 defaults to the selected one.
3152 Optional argument PIXELWISE non-nil means interpret DELTA as
3155 If DELTA is greater than zero, move the edge downwards or to the
3156 right. If DELTA is less than zero, move the edge upwards or to
3157 the left. If the edge can't be moved by DELTA lines or columns,
3158 move it as far as possible in the desired direction."
3159 (setq window
(window-normalize-window window
))
3160 (let* ((frame (window-frame window
))
3161 (minibuffer-window (minibuffer-window frame
))
3163 left first-left first-right this-delta min-delta max-delta ignore
)
3167 (setq delta
(* delta
(frame-char-size window horizontal
))))
3169 ;; Find the edge we want to move.
3170 (while (and (or (not (window-combined-p right horizontal
))
3171 (not (window-right right
)))
3172 (setq right
(window-parent right
))))
3174 ((and (not right
) (not horizontal
)
3175 ;; Resize the minibuffer window if it's on the same frame as
3176 ;; and immediately below WINDOW and it's either active or
3177 ;; `resize-mini-windows' is nil.
3178 (eq (window-frame minibuffer-window
) frame
)
3179 (= (nth 1 (window-pixel-edges minibuffer-window
))
3180 (nth 3 (window-pixel-edges window
)))
3181 (or (not resize-mini-windows
)
3182 (eq minibuffer-window
(active-minibuffer-window))))
3183 (window--resize-mini-window minibuffer-window
(- delta
)))
3184 ((or (not (setq left right
)) (not (setq right
(window-right right
))))
3186 (user-error "No window on the right of this one")
3187 (user-error "No window below this one")))
3189 ;; Set LEFT to the first resizable window on the left. This step is
3190 ;; needed to handle fixed-size windows.
3191 (setq first-left left
)
3193 (or (window-size-fixed-p left horizontal
)
3195 (<= (window-size left horizontal t
)
3196 (window-min-size left horizontal nil t
)))))
3198 (or (window-left left
)
3200 (while (and (setq left
(window-parent left
))
3201 (not (window-combined-p left horizontal
))))
3202 (window-left left
)))))
3204 ;; We have to resize a size-preserved window. Start again with
3205 ;; the window initially on the left.
3206 (setq ignore
'preserved
)
3207 (setq left first-left
)
3209 (or (window-size-fixed-p left horizontal
'preserved
)
3210 (<= (window-size left horizontal t
)
3211 (window-min-size left horizontal
'preserved t
))))
3213 (or (window-left left
)
3215 (while (and (setq left
(window-parent left
))
3216 (not (window-combined-p left horizontal
))))
3217 (window-left left
)))))
3221 (user-error "No resizable window on the left of this one")
3222 (user-error "No resizable window above this one"))))
3224 ;; Set RIGHT to the first resizable window on the right. This step
3225 ;; is needed to handle fixed-size windows.
3226 (setq first-right right
)
3228 (or (window-size-fixed-p right horizontal
)
3230 (<= (window-size right horizontal t
)
3231 (window-min-size right horizontal
'preserved t
)))))
3233 (or (window-right right
)
3235 (while (and (setq right
(window-parent right
))
3236 (not (window-combined-p right horizontal
))))
3237 (window-right right
)))))
3239 ;; We have to resize a size-preserved window. Start again with
3240 ;; the window initially on the right.
3241 (setq ignore
'preserved
)
3242 (setq right first-right
)
3244 (or (window-size-fixed-p right horizontal
'preserved
))
3245 (<= (window-size right horizontal t
)
3246 (window-min-size right horizontal
'preserved t
)))
3248 (or (window-right right
)
3250 (while (and (setq right
(window-parent right
))
3251 (not (window-combined-p right horizontal
))))
3252 (window-right right
)))))
3255 (user-error "No resizable window on the right of this one")
3256 (user-error "No resizable window below this one"))))
3258 ;; LEFT and RIGHT (which might be both internal windows) are now the
3259 ;; two windows we want to resize.
3263 (window--max-delta-1
3264 left
0 horizontal ignore
'after nil pixelwise
))
3266 (window--min-delta-1
3267 right
(- delta
) horizontal ignore
'before nil pixelwise
))
3268 (when (or (< max-delta delta
) (> min-delta
(- delta
)))
3269 ;; We can't get the whole DELTA - move as far as possible.
3270 (setq delta
(min max-delta
(- min-delta
))))
3271 (unless (zerop delta
)
3273 (window--resize-reset frame horizontal
)
3274 ;; Try to enlarge LEFT first.
3275 (setq this-delta
(window--resizable
3276 left delta horizontal ignore
'after nil nil pixelwise
))
3277 (unless (zerop this-delta
)
3278 (window--resize-this-window
3279 left this-delta horizontal ignore t
'before
3281 (+ (window-pixel-left left
) (window-pixel-width left
))
3282 (+ (window-pixel-top left
) (window-pixel-height left
)))))
3283 ;; Shrink windows on right of LEFT.
3284 (window--resize-siblings
3285 left delta horizontal ignore
'after
3287 (window-pixel-left right
)
3288 (window-pixel-top right
)))))
3291 (window--max-delta-1
3292 right
0 horizontal ignore
'before nil pixelwise
))
3294 (window--min-delta-1
3295 left delta horizontal ignore
'after nil pixelwise
))
3296 (when (or (< max-delta
(- delta
)) (> min-delta delta
))
3297 ;; We can't get the whole DELTA - move as far as possible.
3298 (setq delta
(max (- max-delta
) min-delta
)))
3299 (unless (zerop delta
)
3301 (window--resize-reset frame horizontal
)
3302 ;; Try to enlarge RIGHT.
3305 right
(- delta
) horizontal ignore
'before nil nil pixelwise
))
3306 (unless (zerop this-delta
)
3307 (window--resize-this-window
3308 right this-delta horizontal ignore t
'after
3310 (window-pixel-left right
)
3311 (window-pixel-top right
))))
3312 ;; Shrink windows on left of RIGHT.
3313 (window--resize-siblings
3314 right
(- delta
) horizontal ignore
'before
3316 (+ (window-pixel-left left
) (window-pixel-width left
))
3317 (+ (window-pixel-top left
) (window-pixel-height left
)))))))
3318 (unless (zerop delta
)
3319 ;; Don't report an error in the standard case.
3320 (when (window--resize-apply-p frame horizontal
)
3321 (if (window-resize-apply frame horizontal
)
3323 (window--pixel-to-total frame horizontal
)
3324 (run-window-configuration-change-hook frame
))
3325 ;; But do report an error if applying the changes fails.
3326 (error "Failed adjusting window %s" window
))))))))
3328 (defun enlarge-window (delta &optional horizontal
)
3329 "Make the selected window DELTA lines taller.
3330 Interactively, if no argument is given, make the selected window
3331 one line taller. If optional argument HORIZONTAL is non-nil,
3332 make selected window wider by DELTA columns. If DELTA is
3333 negative, shrink selected window by -DELTA lines or columns."
3335 (let ((minibuffer-window (minibuffer-window)))
3336 (when (window-preserved-size nil horizontal
)
3337 (window-preserve-size nil horizontal
))
3340 ((window-size-fixed-p nil horizontal
)
3341 (error "Selected window has fixed size"))
3342 ((window-minibuffer-p)
3344 (error "Cannot resize minibuffer window horizontally")
3345 (window--resize-mini-window (selected-window) delta
)))
3346 ((and (not horizontal
)
3347 (window-full-height-p)
3348 (eq (window-frame minibuffer-window
) (selected-frame))
3349 (not resize-mini-windows
))
3350 ;; If the selected window is full height and `resize-mini-windows'
3351 ;; is nil, resize the minibuffer window.
3352 (window--resize-mini-window minibuffer-window
(- delta
)))
3353 ((window--resizable-p nil delta horizontal
)
3354 (window-resize nil delta horizontal
))
3358 (window-max-delta nil horizontal
)
3359 (- (window-min-delta nil horizontal
)))
3362 (defun shrink-window (delta &optional horizontal
)
3363 "Make the selected window DELTA lines smaller.
3364 Interactively, if no argument is given, make the selected window
3365 one line smaller. If optional argument HORIZONTAL is non-nil,
3366 make selected window narrower by DELTA columns. If DELTA is
3367 negative, enlarge selected window by -DELTA lines or columns.
3368 Also see the `window-min-height' variable."
3370 (let ((minibuffer-window (minibuffer-window)))
3371 (when (window-preserved-size nil horizontal
)
3372 (window-preserve-size nil horizontal
))
3375 ((window-size-fixed-p nil horizontal
)
3376 (error "Selected window has fixed size"))
3377 ((window-minibuffer-p)
3379 (error "Cannot resize minibuffer window horizontally")
3380 (window--resize-mini-window (selected-window) (- delta
))))
3381 ((and (not horizontal
)
3382 (window-full-height-p)
3383 (eq (window-frame minibuffer-window
) (selected-frame))
3384 (not resize-mini-windows
))
3385 ;; If the selected window is full height and `resize-mini-windows'
3386 ;; is nil, resize the minibuffer window.
3387 (window--resize-mini-window minibuffer-window delta
))
3388 ((window--resizable-p nil
(- delta
) horizontal
)
3389 (window-resize nil
(- delta
) horizontal
))
3393 (- (window-min-delta nil horizontal
))
3394 (window-max-delta nil horizontal
))
3397 (defun maximize-window (&optional window
)
3399 Make WINDOW as large as possible without deleting any windows.
3400 WINDOW must be a valid window and defaults to the selected one.
3402 If the option `window-resize-pixelwise' is non-nil maximize
3405 (setq window
(window-normalize-window window
))
3407 window
(window-max-delta window nil nil nil nil nil window-resize-pixelwise
)
3408 nil nil window-resize-pixelwise
)
3410 window
(window-max-delta window t nil nil nil nil window-resize-pixelwise
)
3411 t nil window-resize-pixelwise
))
3413 (defun minimize-window (&optional window
)
3415 Make WINDOW as small as possible without deleting any windows.
3416 WINDOW must be a valid window and defaults to the selected one.
3418 If the option `window-resize-pixelwise' is non-nil minimize
3421 (setq window
(window-normalize-window window
))
3424 (- (window-min-delta window nil nil nil nil nil window-resize-pixelwise
))
3425 nil nil window-resize-pixelwise
)
3428 (- (window-min-delta window t nil nil nil nil window-resize-pixelwise
))
3429 t nil window-resize-pixelwise
))
3432 (defun window-edges (&optional window body absolute pixelwise
)
3433 "Return a list of the edge distances of WINDOW.
3434 WINDOW must be a valid window and defaults to the selected one.
3435 The list returned has the form (LEFT TOP RIGHT BOTTOM).
3437 If the optional argument BODY is nil, this means to return the
3438 edges corresponding to the total size of WINDOW. BODY non-nil
3439 means to return the edges of WINDOW's body (aka text area). If
3440 BODY is non-nil, WINDOW must specify a live window.
3442 Optional argument ABSOLUTE nil means to return edges relative to
3443 the position of WINDOW's native frame. ABSOLUTE non-nil means to
3444 return coordinates relative to the origin - the position (0, 0) -
3445 of FRAME's display. On non-graphical systems this argument has
3448 Optional argument PIXELWISE nil means to return the coordinates
3449 in terms of the canonical character width and height of WINDOW's
3450 frame, rounded if necessary. PIXELWISE non-nil means to return
3451 the coordinates in pixels where the values for RIGHT and BOTTOM
3452 are one more than the actual value of these edges. Note that if
3453 ABSOLUTE is non-nil, PIXELWISE is implicitly non-nil too."
3454 (let* ((window (window-normalize-window window body
))
3455 (frame (window-frame window
))
3456 (border-width (frame-border-width frame
))
3457 (char-width (frame-char-width frame
))
3458 (char-height (frame-char-height frame
))
3460 (+ (window-pixel-left window
) border-width
)
3461 (+ (window-left-column window
)
3462 (/ border-width char-width
))))
3465 (+ (window-pixel-left window
) border-width
3466 (if (eq (car (window-current-scroll-bars window
)) 'left
)
3467 (window-scroll-bar-width window
)
3469 (nth 0 (window-fringes window
))
3470 (* (or (nth 0 (window-margins window
)) 0) char-width
))))
3472 (+ (window-pixel-top window
) border-width
)
3473 (+ (window-top-line window
)
3474 (/ border-width char-height
))))
3477 (+ (window-pixel-top window
) border-width
3478 (window-header-line-height window
))))
3479 (right (+ left
(if pixelwise
3480 (window-pixel-width window
)
3481 (window-total-width window
))))
3482 (right-body (and body
(+ left-body
(window-body-width window t
))))
3483 (bottom (+ top
(if pixelwise
3484 (window-pixel-height window
)
3485 (window-total-height window
))))
3486 (bottom-body (and body
(+ top-body
(window-body-height window t
))))
3489 (let* ((native-edges (frame-edges frame
'native-edges
))
3490 (left-off (nth 0 native-edges
))
3491 (top-off (nth 1 native-edges
)))
3493 (list (+ left-body left-off
) (+ top-body top-off
)
3494 (+ right-body left-off
) (+ bottom-body top-off
))
3495 (list (+ left left-off
) (+ top top-off
)
3496 (+ right left-off
) (+ bottom top-off
))))
3499 (list left-body top-body right-body bottom-body
)
3500 (list (/ left-body char-width
) (/ top-body char-height
)
3502 (/ (+ right-body char-width -
1) char-width
)
3503 (/ (+ bottom-body char-height -
1) char-height
)))
3504 (list left top right bottom
)))))
3506 (defun window-body-edges (&optional window
)
3507 "Return a list of the edge coordinates of WINDOW's body.
3508 The return value is that of `window-edges' called with argument
3510 (window-edges window t
))
3511 (defalias 'window-inside-edges
'window-body-edges
)
3513 (defun window-pixel-edges (&optional window
)
3514 "Return a list of the edge pixel coordinates of WINDOW.
3515 The return value is that of `window-edges' called with argument
3517 (window-edges window nil nil t
))
3519 (defun window-body-pixel-edges (&optional window
)
3520 "Return a list of the edge pixel coordinates of WINDOW's body.
3521 The return value is that of `window-edges' called with arguments
3522 BODY and PIXELWISE non-nil."
3523 (window-edges window t nil t
))
3524 (defalias 'window-inside-pixel-edges
'window-body-pixel-edges
)
3526 (defun window-absolute-pixel-edges (&optional window
)
3527 "Return a list of the edge pixel coordinates of WINDOW.
3528 The return value is that of `window-edges' called with argument
3530 (window-edges window nil t t
))
3532 (defun window-absolute-body-pixel-edges (&optional window
)
3533 "Return a list of the edge pixel coordinates of WINDOW's text area.
3534 The return value is that of `window-edges' called with arguments
3535 BODY and ABSOLUTE non-nil."
3536 (window-edges window t t t
))
3537 (defalias 'window-inside-absolute-pixel-edges
'window-absolute-body-pixel-edges
)
3539 (defun window-absolute-pixel-position (&optional position window
)
3540 "Return display coordinates of POSITION in WINDOW.
3541 If the buffer position POSITION is visible in window WINDOW,
3542 return the display coordinates of the upper/left corner of the
3543 glyph at POSITION. The return value is a cons of the X- and
3544 Y-coordinates of that corner, relative to an origin at (0, 0) of
3545 WINDOW's display. Return nil if POSITION is not visible in
3548 WINDOW must be a live window and defaults to the selected window.
3549 POSITION defaults to the value of `window-point' of WINDOW."
3550 (let* ((window (window-normalize-window window t
))
3552 (pos-visible-in-window-p
3553 (or position
(window-point window
)) window t
)))
3555 (let ((edges (window-absolute-body-pixel-edges window
)))
3556 (cons (+ (nth 0 edges
) (nth 0 pos-in-window
))
3557 (+ (nth 1 edges
) (nth 1 pos-in-window
)))))))
3559 (defun frame-root-window-p (window)
3560 "Return non-nil if WINDOW is the root window of its frame."
3561 (eq window
(frame-root-window window
)))
3563 (defun window--subtree (window &optional next
)
3564 "Return window subtree rooted at WINDOW.
3565 Optional argument NEXT non-nil means include WINDOW's right
3566 siblings in the return value.
3568 See the documentation of `window-tree' for a description of the
3575 ((window-top-child window
)
3576 (cons t
(cons (window-edges window
)
3577 (window--subtree (window-top-child window
) t
))))
3578 ((window-left-child window
)
3579 (cons nil
(cons (window-edges window
)
3580 (window--subtree (window-left-child window
) t
))))
3583 (setq window
(when next
(window-next-sibling window
))))
3586 (defun window-tree (&optional frame
)
3587 "Return the window tree of frame FRAME.
3588 FRAME must be a live frame and defaults to the selected frame.
3589 The return value is a list of the form (ROOT MINI), where ROOT
3590 represents the window tree of the frame's root window, and MINI
3591 is the frame's minibuffer window.
3593 If the root window is not split, ROOT is the root window itself.
3594 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
3595 for a horizontal split, and t for a vertical split. EDGES gives
3596 the combined size and position of the child windows in the split,
3597 and the rest of the elements are the child windows in the split.
3598 Each of the child windows may again be a window or a list
3599 representing a window split, and so on. EDGES is a list (LEFT
3600 TOP RIGHT BOTTOM) as returned by `window-edges'."
3601 (setq frame
(window-normalize-frame frame
))
3602 (window--subtree (frame-root-window frame
) t
))
3604 (defun other-window (count &optional all-frames
)
3605 "Select another window in cyclic ordering of windows.
3606 COUNT specifies the number of windows to skip, starting with the
3607 selected window, before making the selection. If COUNT is
3608 positive, skip COUNT windows forwards. If COUNT is negative,
3609 skip -COUNT windows backwards. COUNT zero means do not skip any
3610 window, so select the selected window. In an interactive call,
3611 COUNT is the numeric prefix argument. Return nil.
3613 If the `other-window' parameter of the selected window is a
3614 function and `ignore-window-parameters' is nil, call that
3615 function with the arguments COUNT and ALL-FRAMES.
3617 This function does not select a window whose `no-other-window'
3618 window parameter is non-nil.
3620 This function uses `next-window' for finding the window to
3621 select. The argument ALL-FRAMES has the same meaning as in
3622 `next-window', but the MINIBUF argument of `next-window' is
3623 always effectively nil."
3625 (let* ((window (selected-window))
3626 (function (and (not ignore-window-parameters
)
3627 (window-parameter window
'other-window
)))
3628 old-window old-count
)
3629 (if (functionp function
)
3630 (funcall function count all-frames
)
3631 ;; `next-window' and `previous-window' may return a window we are
3632 ;; not allowed to select. Hence we need an exit strategy in case
3633 ;; all windows are non-selectable.
3636 (setq window
(next-window window nil all-frames
))
3638 ((eq window old-window
)
3639 (when (= count old-count
)
3640 ;; Keep out of infinite loops. When COUNT has not changed
3641 ;; since we last looked at `window' we're probably in one.
3643 ((window-parameter window
'no-other-window
)
3645 ;; The first non-selectable window `next-window' got us:
3646 ;; Remember it and the current value of COUNT.
3647 (setq old-window window
)
3648 (setq old-count count
)))
3650 (setq count
(1- count
)))))
3652 (setq window
(previous-window window nil all-frames
))
3654 ((eq window old-window
)
3655 (when (= count old-count
)
3656 ;; Keep out of infinite loops. When COUNT has not changed
3657 ;; since we last looked at `window' we're probably in one.
3659 ((window-parameter window
'no-other-window
)
3661 ;; The first non-selectable window `previous-window' got
3662 ;; us: Remember it and the current value of COUNT.
3663 (setq old-window window
)
3664 (setq old-count count
)))
3666 (setq count
(1+ count
)))))
3668 (select-window window
)
3669 ;; Always return nil.
3672 ;; This should probably return non-nil when the selected window is part
3673 ;; of an atomic window whose root is the frame's root window.
3674 (defun one-window-p (&optional nomini all-frames
)
3675 "Return non-nil if the selected window is the only window.
3676 Optional arg NOMINI non-nil means don't count the minibuffer
3677 even if it is active. Otherwise, the minibuffer is counted
3680 Optional argument ALL-FRAMES specifies the set of frames to
3681 consider, see also `next-window'. ALL-FRAMES nil or omitted
3682 means consider windows on the selected frame only, plus the
3683 minibuffer window if specified by the NOMINI argument. If the
3684 minibuffer counts, consider all windows on all frames that share
3685 that minibuffer too. The remaining non-nil values of ALL-FRAMES
3686 with a special meaning are:
3688 - t means consider all windows on all existing frames.
3690 - `visible' means consider all windows on all visible frames on
3691 the current terminal.
3693 - 0 (the number zero) means consider all windows on all visible
3694 and iconified frames on the current terminal.
3696 - A frame means consider all windows on that frame only.
3698 Anything else means consider all windows on the selected frame
3700 (let ((base-window (selected-window)))
3701 (if (and nomini
(eq base-window
(minibuffer-window)))
3702 (setq base-window
(next-window base-window
)))
3704 (next-window base-window
(if nomini
'arg
) all-frames
))))
3706 ;;; Deleting windows.
3707 (defun window-deletable-p (&optional window
)
3708 "Return t if WINDOW can be safely deleted from its frame.
3709 WINDOW must be a valid window and defaults to the selected one.
3710 Return `frame' if deleting WINDOW should also delete its frame."
3711 (setq window
(window-normalize-window window
))
3713 (unless (or ignore-window-parameters
3714 (eq (window-parameter window
'delete-window
) t
))
3715 ;; Handle atomicity.
3716 (when (window-parameter window
'window-atom
)
3717 (setq window
(window-atom-root window
))))
3719 (let ((frame (window-frame window
)))
3721 ((frame-root-window-p window
)
3722 ;; WINDOW's frame can be deleted only if there are other frames
3723 ;; on the same terminal, and it does not contain the active
3725 (unless (or (eq frame
(next-frame frame
0))
3726 ;; We can delete our frame only if no other frame
3727 ;; currently uses our minibuffer window.
3729 (dolist (other (frame-list))
3730 (when (and (not (eq other frame
))
3731 (eq (window-frame (minibuffer-window other
))
3734 (let ((minibuf (active-minibuffer-window)))
3735 (and minibuf
(eq frame
(window-frame minibuf
)))))
3737 ((or ignore-window-parameters
3738 (not (eq window
(window--major-non-side-window frame
))))
3739 ;; WINDOW can be deleted unless it is the major non-side window of
3743 (defun window--in-subtree-p (window root
)
3744 "Return t if WINDOW is either ROOT or a member of ROOT's subtree."
3745 (or (eq window root
)
3746 (let ((parent (window-parent window
)))
3749 (if (eq parent root
)
3751 (setq parent
(window-parent parent
))))))))
3753 (defun delete-window (&optional window
)
3755 WINDOW must be a valid window and defaults to the selected one.
3758 If the variable `ignore-window-parameters' is non-nil or the
3759 `delete-window' parameter of WINDOW equals t, do not process any
3760 parameters of WINDOW. Otherwise, if the `delete-window'
3761 parameter of WINDOW specifies a function, call that function with
3762 WINDOW as its sole argument and return the value returned by that
3765 Otherwise, if WINDOW is part of an atomic window, call
3766 `delete-window' with the root of the atomic window as its
3767 argument. Signal an error if WINDOW is either the only window on
3768 its frame, the last non-side window, or part of an atomic window
3769 that is its frame's root window."
3771 (setq window
(window-normalize-window window
))
3772 (let* ((frame (window-frame window
))
3773 (function (window-parameter window
'delete-window
))
3774 (parent (window-parent window
))
3776 (window--check frame
)
3778 ;; Handle window parameters.
3780 ;; Ignore window parameters if `ignore-window-parameters' tells
3781 ;; us so or `delete-window' equals t.
3782 ((or ignore-window-parameters
(eq function t
)))
3783 ((functionp function
)
3784 ;; The `delete-window' parameter specifies the function to call.
3785 ;; If that function is `ignore' nothing is done. It's up to the
3786 ;; function called here to avoid infinite recursion.
3787 (throw 'done
(funcall function window
)))
3788 ((and (window-parameter window
'window-atom
)
3789 (setq atom-root
(window-atom-root window
))
3790 (not (eq atom-root window
)))
3791 (if (eq atom-root
(frame-root-window frame
))
3792 (error "Root of atomic window is root window of its frame")
3793 (throw 'done
(delete-window atom-root
))))
3795 (error "Attempt to delete minibuffer or sole ordinary window"))
3796 ((eq window
(window--major-non-side-window frame
))
3797 (error "Attempt to delete last non-side window")))
3799 (let* ((horizontal (window-left-child parent
))
3800 (size (window-size window horizontal t
))
3802 (window--in-subtree-p (frame-selected-window frame
) window
))
3803 ;; Emacs 23 preferably gives WINDOW's space to its left
3805 (sibling (or (window-left window
) (window-right window
))))
3806 (window--resize-reset frame horizontal
)
3808 ((and (not window-combination-resize
)
3809 sibling
(window-sizable-p sibling size horizontal nil t
))
3810 ;; Resize WINDOW's sibling.
3811 (window--resize-this-window sibling size horizontal nil t
)
3812 (set-window-new-normal
3813 sibling
(+ (window-normal-size sibling horizontal
)
3814 (window-normal-size window horizontal
))))
3815 ((window--resizable-p window
(- size
) horizontal nil nil nil t t
)
3816 ;; Can do without resizing fixed-size windows.
3817 (window--resize-siblings window
(- size
) horizontal
))
3819 ;; Can't do without resizing fixed-size windows.
3820 (window--resize-siblings window
(- size
) horizontal t
)))
3821 ;; Actually delete WINDOW.
3822 (delete-window-internal window
)
3823 (window--pixel-to-total frame horizontal
)
3824 (when (and frame-selected
3826 (frame-selected-window frame
) 'no-other-window
))
3827 ;; `delete-window-internal' has selected a window that should
3828 ;; not be selected, fix this here.
3829 (other-window -
1 frame
))
3830 (run-window-configuration-change-hook frame
)
3831 (window--check frame
)
3832 ;; Always return nil.
3835 (defun delete-other-windows (&optional window
)
3836 "Make WINDOW fill its frame.
3837 WINDOW must be a valid window and defaults to the selected one.
3840 If the variable `ignore-window-parameters' is non-nil or the
3841 `delete-other-windows' parameter of WINDOW equals t, do not
3842 process any parameters of WINDOW. Otherwise, if the
3843 `delete-other-windows' parameter of WINDOW specifies a function,
3844 call that function with WINDOW as its sole argument and return
3845 the value returned by that function.
3847 Otherwise, if WINDOW is part of an atomic window, call this
3848 function with the root of the atomic window as its argument. If
3849 WINDOW is a non-side window, make WINDOW the only non-side window
3850 on the frame. Side windows are not deleted. If WINDOW is a side
3851 window signal an error."
3853 (setq window
(window-normalize-window window
))
3854 (let* ((frame (window-frame window
))
3855 (function (window-parameter window
'delete-other-windows
))
3856 (window-side (window-parameter window
'window-side
))
3857 atom-root side-main
)
3858 (window--check frame
)
3861 ;; Ignore window parameters if `ignore-window-parameters' is t or
3862 ;; `delete-other-windows' is t.
3863 ((or ignore-window-parameters
(eq function t
)))
3864 ((functionp function
)
3865 ;; The `delete-other-windows' parameter specifies the function
3866 ;; to call. If the function is `ignore' no windows are deleted.
3867 ;; It's up to the function called to avoid infinite recursion.
3868 (throw 'done
(funcall function window
)))
3869 ((and (window-parameter window
'window-atom
)
3870 (setq atom-root
(window-atom-root window
))
3871 (not (eq atom-root window
)))
3872 (if (eq atom-root
(frame-root-window frame
))
3873 (error "Root of atomic window is root window of its frame")
3874 (throw 'done
(delete-other-windows atom-root
))))
3875 ((memq window-side window-sides
)
3876 (error "Cannot make side window the only window"))
3877 ((and (window-minibuffer-p window
)
3878 (not (eq window
(frame-root-window window
))))
3879 (error "Can't expand minibuffer to full frame")))
3881 ;; If WINDOW is the major non-side window, do nothing.
3882 (if (window-with-parameter 'window-side
)
3883 (setq side-main
(window--major-non-side-window frame
))
3884 (setq side-main
(frame-root-window frame
)))
3885 (unless (eq window side-main
)
3886 (delete-other-windows-internal window side-main
)
3887 (run-window-configuration-change-hook frame
)
3888 (window--check frame
))
3889 ;; Always return nil.
3892 (defun delete-other-windows-vertically (&optional window
)
3893 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
3894 This may be a useful alternative binding for \\[delete-other-windows]
3895 if you often split windows horizontally."
3897 (let* ((window (or window
(selected-window)))
3898 (edges (window-edges window
))
3900 (while (not (eq (setq w
(next-window w
1)) window
))
3901 (let ((e (window-edges w
)))
3902 (when (and (= (car e
) (car edges
))
3903 (= (nth 2 e
) (nth 2 edges
)))
3905 (mapc 'delete-window delenda
)))
3907 ;;; Windows and buffers.
3909 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
3910 ;; for (1) determining which buffer to show in the window when its
3911 ;; buffer shall be buried or killed and (2) which buffer to show for
3912 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
3914 ;; `prev-buffers' consists of <buffer, window-start, window-point>
3915 ;; triples. The entries on this list are ordered by the time their
3916 ;; buffer has been removed from the window, the most recently removed
3917 ;; buffer's entry being first. The window-start and window-point
3918 ;; components are `window-start' and `window-point' at the time the
3919 ;; buffer was removed from the window which implies that the entry must
3920 ;; be added when `set-window-buffer' removes the buffer from the window.
3922 ;; `next-buffers' is the list of buffers that have been replaced
3923 ;; recently by `switch-to-prev-buffer'. These buffers are the least
3924 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
3925 ;; candidates of `switch-to-next-buffer' to switch to. This list is
3926 ;; reset to nil by any action changing the window's buffer with the
3927 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
3928 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
3929 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
3931 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
3932 ;; if such a buffer was killed while the window was hidden within a
3933 ;; window configuration. Such killed buffers get removed whenever
3934 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
3936 ;; The following function is called by `set-window-buffer' _before_ it
3937 ;; replaces the buffer of the argument window with the new buffer.
3938 (defun record-window-buffer (&optional window
)
3939 "Record WINDOW's buffer.
3940 WINDOW must be a live window and defaults to the selected one."
3941 (let* ((window (window-normalize-window window t
))
3942 (buffer (window-buffer window
))
3943 (entry (assq buffer
(window-prev-buffers window
))))
3944 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
3945 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
3946 (set-window-next-buffers window nil
)
3949 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
3950 (set-window-prev-buffers
3951 window
(assq-delete-all buffer
(window-prev-buffers window
))))
3953 ;; Don't record insignificant buffers.
3954 (unless (eq (aref (buffer-name buffer
) 0) ?\s
)
3955 ;; Add an entry for buffer to WINDOW's previous buffers.
3956 (with-current-buffer buffer
3957 (let ((start (window-start window
))
3958 (point (window-point window
)))
3962 ;; We have an entry, update marker positions.
3963 (list (set-marker (nth 1 entry
) start
)
3964 (set-marker (nth 2 entry
) point
))
3965 ;; Make new markers.
3966 (list (copy-marker start
)
3968 ;; Preserve window-point-insertion-type
3970 point window-point-insertion-type
)))))
3971 (set-window-prev-buffers
3972 window
(cons entry
(window-prev-buffers window
)))))
3974 (run-hooks 'buffer-list-update-hook
))))
3976 (defun unrecord-window-buffer (&optional window buffer
)
3977 "Unrecord BUFFER in WINDOW.
3978 WINDOW must be a live window and defaults to the selected one.
3979 BUFFER must be a live buffer and defaults to the buffer of
3981 (let* ((window (window-normalize-window window t
))
3982 (buffer (or buffer
(window-buffer window
))))
3983 (set-window-prev-buffers
3984 window
(assq-delete-all buffer
(window-prev-buffers window
)))
3985 (set-window-next-buffers
3986 window
(delq buffer
(window-next-buffers window
)))))
3988 (defun set-window-buffer-start-and-point (window buffer
&optional start point
)
3989 "Set WINDOW's buffer to BUFFER.
3990 WINDOW must be a live window and defaults to the selected one.
3991 Optional argument START non-nil means set WINDOW's start position
3992 to START. Optional argument POINT non-nil means set WINDOW's
3993 point to POINT. If WINDOW is selected this also sets BUFFER's
3994 `point' to POINT. If WINDOW is selected and the buffer it showed
3995 before was current this also makes BUFFER the current buffer."
3996 (setq window
(window-normalize-window window t
))
3997 (let ((selected (eq window
(selected-window)))
3998 (current (eq (window-buffer window
) (current-buffer))))
3999 (set-window-buffer window buffer
)
4000 (when (and selected current
)
4001 (set-buffer buffer
))
4003 ;; Don't force window-start here (even if POINT is nil).
4004 (set-window-start window start t
))
4006 (set-window-point window point
))))
4008 (defcustom switch-to-visible-buffer t
4009 "If non-nil, allow switching to an already visible buffer.
4010 If this variable is non-nil, `switch-to-prev-buffer' and
4011 `switch-to-next-buffer' may switch to an already visible buffer.
4012 If this variable is nil, `switch-to-prev-buffer' and
4013 `switch-to-next-buffer' always try to avoid switching to a buffer
4014 that is already visible in another window on the same frame."
4019 (defun switch-to-prev-buffer (&optional window bury-or-kill
)
4020 "In WINDOW switch to previous buffer.
4021 WINDOW must be a live window and defaults to the selected one.
4022 Return the buffer switched to, nil if no suitable buffer could be
4025 Optional argument BURY-OR-KILL non-nil means the buffer currently
4026 shown in WINDOW is about to be buried or killed and consequently
4027 shall not be switched to in future invocations of this command.
4029 As a special case, if BURY-OR-KILL equals `append', this means to
4030 move the buffer to the end of WINDOW's previous buffers list so a
4031 future invocation of `switch-to-prev-buffer' less likely switches
4034 (let* ((window (window-normalize-window window t
))
4035 (frame (window-frame window
))
4036 (old-buffer (window-buffer window
))
4037 ;; Save this since it's destroyed by `set-window-buffer'.
4038 (next-buffers (window-next-buffers window
))
4039 (pred (frame-parameter frame
'buffer-predicate
))
4040 entry new-buffer killed-buffers visible
)
4041 (when (window-minibuffer-p window
)
4042 ;; Don't switch in minibuffer window.
4043 (unless (setq window
(minibuffer-selected-window))
4044 (error "Window %s is a minibuffer window" window
)))
4046 (when (window-dedicated-p window
)
4047 ;; Don't switch in dedicated window.
4048 (error "Window %s is dedicated to buffer %s" window old-buffer
))
4051 ;; Scan WINDOW's previous buffers first, skipping entries of next
4053 (dolist (entry (window-prev-buffers window
))
4054 (when (and (setq new-buffer
(car entry
))
4055 (or (buffer-live-p new-buffer
)
4056 (not (setq killed-buffers
4057 (cons new-buffer killed-buffers
))))
4058 (not (eq new-buffer old-buffer
))
4059 (or (null pred
) (funcall pred new-buffer
))
4060 ;; When BURY-OR-KILL is nil, avoid switching to a
4061 ;; buffer in WINDOW's next buffers list.
4062 (or bury-or-kill
(not (memq new-buffer next-buffers
))))
4063 (if (and (not switch-to-visible-buffer
)
4064 (get-buffer-window new-buffer frame
))
4065 ;; Try to avoid showing a buffer visible in some other
4067 (setq visible new-buffer
)
4068 (set-window-buffer-start-and-point
4069 window new-buffer
(nth 1 entry
) (nth 2 entry
))
4071 ;; Scan reverted buffer list of WINDOW's frame next, skipping
4072 ;; entries of next buffers. Note that when we bury or kill a
4073 ;; buffer we don't reverse the global buffer list to avoid showing
4074 ;; a buried buffer instead. Otherwise, we must reverse the global
4075 ;; buffer list in order to make sure that switching to the
4076 ;; previous/next buffer traverse it in opposite directions.
4077 (dolist (buffer (if bury-or-kill
4079 (nreverse (buffer-list frame
))))
4080 (when (and (buffer-live-p buffer
)
4081 (not (eq buffer old-buffer
))
4082 (or (null pred
) (funcall pred buffer
))
4083 (not (eq (aref (buffer-name buffer
) 0) ?\s
))
4084 (or bury-or-kill
(not (memq buffer next-buffers
))))
4085 (if (and (not switch-to-visible-buffer
)
4086 (get-buffer-window buffer frame
))
4087 ;; Try to avoid showing a buffer visible in some other window.
4089 (setq visible buffer
))
4090 (setq new-buffer buffer
)
4091 (set-window-buffer-start-and-point window new-buffer
)
4093 (unless bury-or-kill
4094 ;; Scan reverted next buffers last (must not use nreverse
4096 (dolist (buffer (reverse next-buffers
))
4097 ;; Actually, buffer _must_ be live here since otherwise it
4098 ;; would have been caught in the scan of previous buffers.
4099 (when (and (or (buffer-live-p buffer
)
4100 (not (setq killed-buffers
4101 (cons buffer killed-buffers
))))
4102 (not (eq buffer old-buffer
))
4103 (or (null pred
) (funcall pred buffer
))
4104 (setq entry
(assq buffer
(window-prev-buffers window
))))
4105 (setq new-buffer buffer
)
4106 (set-window-buffer-start-and-point
4107 window new-buffer
(nth 1 entry
) (nth 2 entry
))
4110 ;; Show a buffer visible in another window.
4112 (setq new-buffer visible
)
4113 (set-window-buffer-start-and-point window new-buffer
)))
4116 (let ((entry (and (eq bury-or-kill
'append
)
4117 (assq old-buffer
(window-prev-buffers window
)))))
4118 ;; Remove `old-buffer' from WINDOW's previous and (restored list
4119 ;; of) next buffers.
4120 (set-window-prev-buffers
4121 window
(assq-delete-all old-buffer
(window-prev-buffers window
)))
4122 (set-window-next-buffers window
(delq old-buffer next-buffers
))
4124 ;; Append old-buffer's entry to list of WINDOW's previous
4125 ;; buffers so it's less likely to get switched to soon but
4126 ;; `display-buffer-in-previous-window' can nevertheless find
4128 (set-window-prev-buffers
4129 window
(append (window-prev-buffers window
) (list entry
)))))
4130 ;; Move `old-buffer' to head of WINDOW's restored list of next
4132 (set-window-next-buffers
4133 window
(cons old-buffer
(delq old-buffer next-buffers
))))
4135 ;; Remove killed buffers from WINDOW's previous and next buffers.
4136 (when killed-buffers
4137 (dolist (buffer killed-buffers
)
4138 (set-window-prev-buffers
4139 window
(assq-delete-all buffer
(window-prev-buffers window
)))
4140 (set-window-next-buffers
4141 window
(delq buffer
(window-next-buffers window
)))))
4143 ;; Return new-buffer.
4146 (defun switch-to-next-buffer (&optional window
)
4147 "In WINDOW switch to next buffer.
4148 WINDOW must be a live window and defaults to the selected one.
4149 Return the buffer switched to, nil if no suitable buffer could be
4152 (let* ((window (window-normalize-window window t
))
4153 (frame (window-frame window
))
4154 (old-buffer (window-buffer window
))
4155 (next-buffers (window-next-buffers window
))
4156 (pred (frame-parameter frame
'buffer-predicate
))
4157 new-buffer entry killed-buffers visible
)
4158 (when (window-minibuffer-p window
)
4159 ;; Don't switch in minibuffer window.
4160 (unless (setq window
(minibuffer-selected-window))
4161 (error "Window %s is a minibuffer window" window
)))
4163 (when (window-dedicated-p window
)
4164 ;; Don't switch in dedicated window.
4165 (error "Window %s is dedicated to buffer %s" window old-buffer
))
4168 ;; Scan WINDOW's next buffers first.
4169 (dolist (buffer next-buffers
)
4170 (when (and (or (buffer-live-p buffer
)
4171 (not (setq killed-buffers
4172 (cons buffer killed-buffers
))))
4173 (not (eq buffer old-buffer
))
4174 (or (null pred
) (funcall pred buffer
))
4175 (setq entry
(assq buffer
(window-prev-buffers window
))))
4176 (setq new-buffer buffer
)
4177 (set-window-buffer-start-and-point
4178 window new-buffer
(nth 1 entry
) (nth 2 entry
))
4180 ;; Scan the buffer list of WINDOW's frame next, skipping previous
4182 (dolist (buffer (buffer-list frame
))
4183 (when (and (buffer-live-p buffer
)
4184 (not (eq buffer old-buffer
))
4185 (or (null pred
) (funcall pred buffer
))
4186 (not (eq (aref (buffer-name buffer
) 0) ?\s
))
4187 (not (assq buffer
(window-prev-buffers window
))))
4188 (if (and (not switch-to-visible-buffer
)
4189 (get-buffer-window buffer frame
))
4190 ;; Try to avoid showing a buffer visible in some other window.
4191 (setq visible buffer
)
4192 (setq new-buffer buffer
)
4193 (set-window-buffer-start-and-point window new-buffer
)
4195 ;; Scan WINDOW's reverted previous buffers last (must not use
4197 (dolist (entry (reverse (window-prev-buffers window
)))
4198 (when (and (setq new-buffer
(car entry
))
4199 (or (buffer-live-p new-buffer
)
4200 (not (setq killed-buffers
4201 (cons new-buffer killed-buffers
))))
4202 (not (eq new-buffer old-buffer
))
4203 (or (null pred
) (funcall pred new-buffer
)))
4204 (if (and (not switch-to-visible-buffer
)
4205 (get-buffer-window new-buffer frame
))
4206 ;; Try to avoid showing a buffer visible in some other window.
4208 (setq visible new-buffer
))
4209 (set-window-buffer-start-and-point
4210 window new-buffer
(nth 1 entry
) (nth 2 entry
))
4213 ;; Show a buffer visible in another window.
4215 (setq new-buffer visible
)
4216 (set-window-buffer-start-and-point window new-buffer
)))
4218 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
4219 (set-window-next-buffers window
(delq new-buffer next-buffers
))
4221 ;; Remove killed buffers from WINDOW's previous and next buffers.
4222 (when killed-buffers
4223 (dolist (buffer killed-buffers
)
4224 (set-window-prev-buffers
4225 window
(assq-delete-all buffer
(window-prev-buffers window
)))
4226 (set-window-next-buffers
4227 window
(delq buffer
(window-next-buffers window
)))))
4229 ;; Return new-buffer.
4232 (defun get-next-valid-buffer (list &optional buffer visible-ok frame
)
4233 "Search LIST for a valid buffer to display in FRAME.
4234 Return nil when all buffers in LIST are undesirable for display,
4235 otherwise return the first suitable buffer in LIST.
4237 Buffers not visible in windows are preferred to visible buffers,
4238 unless VISIBLE-OK is non-nil.
4239 If the optional argument FRAME is nil, it defaults to the selected frame.
4240 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
4241 ;; This logic is more or less copied from other-buffer.
4242 (setq frame
(or frame
(selected-frame)))
4243 (let ((pred (frame-parameter frame
'buffer-predicate
))
4245 (while (and (not found
) list
)
4246 (setq buf
(car list
))
4247 (if (and (not (eq buffer buf
))
4249 (or (null pred
) (funcall pred buf
))
4250 (not (eq (aref (buffer-name buf
) 0) ?\s
))
4251 (or visible-ok
(null (get-buffer-window buf
'visible
))))
4253 (setq list
(cdr list
))))
4256 (defun last-buffer (&optional buffer visible-ok frame
)
4257 "Return the last buffer in FRAME's buffer list.
4258 If BUFFER is the last buffer, return the preceding buffer
4259 instead. Buffers not visible in windows are preferred to visible
4260 buffers, unless optional argument VISIBLE-OK is non-nil.
4261 Optional third argument FRAME nil or omitted means use the
4262 selected frame's buffer list. If no such buffer exists, return
4263 the buffer `*scratch*', creating it if necessary."
4264 (setq frame
(or frame
(selected-frame)))
4265 (or (get-next-valid-buffer (nreverse (buffer-list frame
))
4266 buffer visible-ok frame
)
4267 (get-buffer "*scratch*")
4268 (let ((scratch (get-buffer-create "*scratch*")))
4269 (set-buffer-major-mode scratch
)
4272 (defcustom frame-auto-hide-function
#'iconify-frame
4273 "Function called to automatically hide frames.
4274 The function is called with one argument - a frame.
4276 Functions affected by this option are those that bury a buffer
4277 shown in a separate frame like `quit-window' and `bury-buffer'."
4278 :type
'(choice (const :tag
"Iconify" iconify-frame
)
4279 (const :tag
"Delete" delete-frame
)
4280 (const :tag
"Do nothing" ignore
)
4286 (defun window--delete (&optional window dedicated-only kill
)
4287 "Delete WINDOW if possible.
4288 WINDOW must be a live window and defaults to the selected one.
4289 Optional argument DEDICATED-ONLY non-nil means to delete WINDOW
4290 only if it's dedicated to its buffer. Optional argument KILL
4291 means the buffer shown in window will be killed. Return non-nil
4292 if WINDOW gets deleted or its frame is auto-hidden."
4293 (setq window
(window-normalize-window window t
))
4294 (unless (and dedicated-only
(not (window-dedicated-p window
)))
4295 (let ((deletable (window-deletable-p window
)))
4297 ((eq deletable
'frame
)
4298 (let ((frame (window-frame window
)))
4301 (delete-frame frame
))
4302 ((functionp frame-auto-hide-function
)
4303 (funcall frame-auto-hide-function frame
))))
4306 (delete-window window
)
4309 (defun bury-buffer (&optional buffer-or-name
)
4310 "Put BUFFER-OR-NAME at the end of the list of all buffers.
4311 There it is the least likely candidate for `other-buffer' to
4312 return; thus, the least likely buffer for \\[switch-to-buffer] to
4315 You can specify a buffer name as BUFFER-OR-NAME, or an actual
4316 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
4317 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
4318 remove the current buffer from the selected window if it is
4321 (let* ((buffer (window-normalize-buffer buffer-or-name
)))
4322 ;; If `buffer-or-name' is not on the selected frame we unrecord it
4323 ;; although it's not "here" (call it a feature).
4324 (bury-buffer-internal buffer
)
4325 ;; Handle case where `buffer-or-name' is nil and the current buffer
4326 ;; is shown in the selected window.
4328 ((or buffer-or-name
(not (eq buffer
(window-buffer)))))
4329 ((window--delete nil t
))
4331 ;; Switch to another buffer in window.
4332 (set-window-dedicated-p nil nil
)
4333 (switch-to-prev-buffer nil
'bury
)))
4335 ;; Always return nil.
4338 (defun unbury-buffer ()
4339 "Switch to the last buffer in the buffer list."
4341 (switch-to-buffer (last-buffer)))
4343 (defun next-buffer ()
4344 "In selected window switch to next buffer."
4347 ((window-minibuffer-p)
4348 (error "Cannot switch buffers in minibuffer window"))
4349 ((eq (window-dedicated-p) t
)
4350 (error "Window is strongly dedicated to its buffer"))
4352 (switch-to-next-buffer))))
4354 (defun previous-buffer ()
4355 "In selected window switch to previous buffer."
4358 ((window-minibuffer-p)
4359 (error "Cannot switch buffers in minibuffer window"))
4360 ((eq (window-dedicated-p) t
)
4361 (error "Window is strongly dedicated to its buffer"))
4363 (switch-to-prev-buffer))))
4365 (defun delete-windows-on (&optional buffer-or-name frame
)
4366 "Delete all windows showing BUFFER-OR-NAME.
4367 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
4368 and defaults to the current buffer.
4370 The following non-nil values of the optional argument FRAME
4371 have special meanings:
4373 - t means consider all windows on the selected frame only.
4375 - `visible' means consider all windows on all visible frames on
4376 the current terminal.
4378 - 0 (the number zero) means consider all windows on all visible
4379 and iconified frames on the current terminal.
4381 - A frame means consider all windows on that frame only.
4383 Any other value of FRAME means consider all windows on all
4386 When a window showing BUFFER-OR-NAME is dedicated and the only
4387 window of its frame, that frame is deleted when there are other
4389 (interactive "BDelete windows on (buffer):\nP")
4390 (let ((buffer (window-normalize-buffer buffer-or-name
))
4391 ;; Handle the "inverted" meaning of the FRAME argument wrt other
4392 ;; `window-list-1' based function.
4393 (all-frames (cond ((not frame
) t
) ((eq frame t
) nil
) (t frame
))))
4394 (dolist (window (window-list-1 nil nil all-frames
))
4395 (if (eq (window-buffer window
) buffer
)
4396 (let ((deletable (window-deletable-p window
)))
4398 ((and (eq deletable
'frame
) (window-dedicated-p window
))
4399 ;; Delete frame if and only if window is dedicated.
4400 (delete-frame (window-frame window
)))
4403 (delete-window window
))
4405 ;; In window switch to previous buffer.
4406 (set-window-dedicated-p window nil
)
4407 (switch-to-prev-buffer window
'bury
))))
4408 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
4409 (unrecord-window-buffer window buffer
)))))
4411 (defun replace-buffer-in-windows (&optional buffer-or-name
)
4412 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
4413 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
4414 and defaults to the current buffer.
4416 When a window showing BUFFER-OR-NAME is dedicated, that window is
4417 deleted. If that window is the only window on its frame, the
4418 frame is deleted too when there are other frames left. If there
4419 are no other frames left, some other buffer is displayed in that
4422 This function removes the buffer denoted by BUFFER-OR-NAME from
4423 all window-local buffer lists."
4424 (interactive "bBuffer to replace: ")
4425 (let ((buffer (window-normalize-buffer buffer-or-name
)))
4426 (dolist (window (window-list-1 nil nil t
))
4427 (if (eq (window-buffer window
) buffer
)
4428 (unless (window--delete window t t
)
4429 ;; Switch to another buffer in window.
4430 (set-window-dedicated-p window nil
)
4431 (switch-to-prev-buffer window
'kill
))
4432 ;; Unrecord BUFFER in WINDOW.
4433 (unrecord-window-buffer window buffer
)))))
4435 (defun quit-restore-window (&optional window bury-or-kill
)
4436 "Quit WINDOW and deal with its buffer.
4437 WINDOW must be a live window and defaults to the selected one.
4439 According to information stored in WINDOW's `quit-restore' window
4440 parameter either (1) delete WINDOW and its frame, (2) delete
4441 WINDOW, (3) restore the buffer previously displayed in WINDOW,
4442 or (4) make WINDOW display some other buffer than the present
4443 one. If non-nil, reset `quit-restore' parameter to nil.
4445 Optional second argument BURY-OR-KILL tells how to proceed with
4446 the buffer of WINDOW. The following values are handled:
4448 nil means to not handle the buffer in a particular way. This
4449 means that if WINDOW is not deleted by this function, invoking
4450 `switch-to-prev-buffer' will usually show the buffer again.
4452 `append' means that if WINDOW is not deleted, move its buffer to
4453 the end of WINDOW's previous buffers so it's less likely that a
4454 future invocation of `switch-to-prev-buffer' will switch to it.
4455 Also, move the buffer to the end of the frame's buffer list.
4457 `bury' means that if WINDOW is not deleted, remove its buffer
4458 from WINDOW'S list of previous buffers. Also, move the buffer
4459 to the end of the frame's buffer list. This value provides the
4460 most reliable remedy to not have `switch-to-prev-buffer' switch
4461 to this buffer again without killing the buffer.
4463 `kill' means to kill WINDOW's buffer."
4464 (setq window
(window-normalize-window window t
))
4465 (let* ((buffer (window-buffer window
))
4466 (quit-restore (window-parameter window
'quit-restore
))
4468 (let* ((prev-buffers (window-prev-buffers window
))
4469 (prev-buffer (caar prev-buffers
)))
4470 (and (or (not (eq prev-buffer buffer
))
4471 (and (cdr prev-buffers
)
4472 (not (eq (setq prev-buffer
(cadr prev-buffers
))
4477 ((and (not prev-buffer
)
4478 (or (eq (nth 1 quit-restore
) 'frame
)
4479 (and (eq (nth 1 quit-restore
) 'window
)
4480 ;; If the window has been created on an existing
4481 ;; frame and ended up as the sole window on that
4482 ;; frame, do not delete it (Bug#12764).
4483 (not (eq window
(frame-root-window window
)))))
4484 (eq (nth 3 quit-restore
) buffer
)
4485 ;; Delete WINDOW if possible.
4486 (window--delete window nil
(eq bury-or-kill
'kill
)))
4487 ;; If the previously selected window is still alive, select it.
4488 (when (window-live-p (nth 2 quit-restore
))
4489 (select-window (nth 2 quit-restore
))))
4490 ((and (listp (setq quad
(nth 1 quit-restore
)))
4491 (buffer-live-p (car quad
))
4492 (eq (nth 3 quit-restore
) buffer
))
4493 ;; Show another buffer stored in quit-restore parameter.
4494 (when (and (integerp (nth 3 quad
))
4495 (if (window-combined-p window
)
4496 (/= (nth 3 quad
) (window-total-height window
))
4497 (/= (nth 3 quad
) (window-total-width window
))))
4498 ;; Try to resize WINDOW to its old height but don't signal an
4503 (- (nth 3 quad
) (if (window-combined-p window
)
4504 (window-total-height window
)
4505 (window-total-width window
)))
4506 (window-combined-p window t
))
4508 (set-window-dedicated-p window nil
)
4509 ;; Restore WINDOW's previous buffer, start and point position.
4510 (set-window-buffer-start-and-point
4511 window
(nth 0 quad
) (nth 1 quad
) (nth 2 quad
))
4512 ;; Deal with the buffer we just removed from WINDOW.
4513 (setq entry
(and (eq bury-or-kill
'append
)
4514 (assq buffer
(window-prev-buffers window
))))
4516 ;; Remove buffer from WINDOW's previous and next buffers.
4517 (set-window-prev-buffers
4518 window
(assq-delete-all buffer
(window-prev-buffers window
)))
4519 (set-window-next-buffers
4520 window
(delq buffer
(window-next-buffers window
))))
4522 ;; Append old buffer's entry to list of WINDOW's previous
4523 ;; buffers so it's less likely to get switched to soon but
4524 ;; `display-buffer-in-previous-window' can nevertheless find it.
4525 (set-window-prev-buffers
4526 window
(append (window-prev-buffers window
) (list entry
))))
4527 ;; Reset the quit-restore parameter.
4528 (set-window-parameter window
'quit-restore nil
)
4529 ;; Select old window.
4530 (when (window-live-p (nth 2 quit-restore
))
4531 (select-window (nth 2 quit-restore
))))
4533 ;; Show some other buffer in WINDOW and reset the quit-restore
4535 (set-window-parameter window
'quit-restore nil
)
4536 ;; Make sure that WINDOW is no more dedicated.
4537 (set-window-dedicated-p window nil
)
4538 (switch-to-prev-buffer window bury-or-kill
)))
4540 ;; Deal with the buffer.
4542 ((not (buffer-live-p buffer
)))
4543 ((eq bury-or-kill
'kill
)
4544 (kill-buffer buffer
))
4546 (bury-buffer-internal buffer
)))))
4548 (defun quit-window (&optional kill window
)
4549 "Quit WINDOW and bury its buffer.
4550 WINDOW must be a live window and defaults to the selected one.
4551 With prefix argument KILL non-nil, kill the buffer instead of
4554 According to information stored in WINDOW's `quit-restore' window
4555 parameter either (1) delete WINDOW and its frame, (2) delete
4556 WINDOW, (3) restore the buffer previously displayed in WINDOW,
4557 or (4) make WINDOW display some other buffer than the present
4558 one. If non-nil, reset `quit-restore' parameter to nil."
4560 (quit-restore-window window
(if kill
'kill
'bury
)))
4562 (defun quit-windows-on (&optional buffer-or-name kill frame
)
4563 "Quit all windows showing BUFFER-OR-NAME.
4564 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
4565 and defaults to the current buffer. Optional argument KILL
4566 non-nil means to kill BUFFER-OR-NAME. KILL nil means to bury
4567 BUFFER-OR-NAME. Optional argument FRAME is handled as by
4568 `delete-windows-on'.
4570 This function calls `quit-window' on all candidate windows
4571 showing BUFFER-OR-NAME."
4572 (interactive "BQuit windows on (buffer):\nP")
4573 (let ((buffer (window-normalize-buffer buffer-or-name
))
4574 ;; Handle the "inverted" meaning of the FRAME argument wrt other
4575 ;; `window-list-1' based function.
4576 (all-frames (cond ((not frame
) t
) ((eq frame t
) nil
) (t frame
))))
4577 (dolist (window (window-list-1 nil nil all-frames
))
4578 (if (eq (window-buffer window
) buffer
)
4579 (quit-window kill window
)
4580 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
4581 (unrecord-window-buffer window buffer
)))))
4583 (defun split-window (&optional window size side pixelwise
)
4584 "Make a new window adjacent to WINDOW.
4585 WINDOW must be a valid window and defaults to the selected one.
4586 Return the new window which is always a live window.
4588 Optional argument SIZE a positive number means make WINDOW SIZE
4589 lines or columns tall. If SIZE is negative, make the new window
4590 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
4591 absolute value can be less than `window-min-height' or
4592 `window-min-width'; so this command can make a new window as
4593 small as one line or two columns. SIZE defaults to half of
4596 Optional third argument SIDE nil (or `below') specifies that the
4597 new window shall be located below WINDOW. SIDE `above' means the
4598 new window shall be located above WINDOW. In both cases SIZE
4599 specifies the new number of lines for WINDOW (or the new window
4600 if SIZE is negative) including space reserved for the mode and/or
4603 SIDE t (or `right') specifies that the new window shall be
4604 located on the right side of WINDOW. SIDE `left' means the new
4605 window shall be located on the left of WINDOW. In both cases
4606 SIZE specifies the new number of columns for WINDOW (or the new
4607 window provided SIZE is negative) including space reserved for
4608 fringes and the scrollbar or a divider column. Any other non-nil
4609 value for SIDE is currently handled like t (or `right').
4611 PIXELWISE, if non-nil, means to interpret SIZE pixelwise.
4613 If the variable `ignore-window-parameters' is non-nil or the
4614 `split-window' parameter of WINDOW equals t, do not process any
4615 parameters of WINDOW. Otherwise, if the `split-window' parameter
4616 of WINDOW specifies a function, call that function with all three
4617 arguments and return the value returned by that function.
4619 Otherwise, if WINDOW is part of an atomic window, \"split\" the
4620 root of that atomic window. The new window does not become a
4621 member of that atomic window.
4623 If WINDOW is live, properties of the new window like margins and
4624 scrollbars are inherited from WINDOW. If WINDOW is an internal
4625 window, these properties as well as the buffer displayed in the
4626 new window are inherited from the window selected on WINDOW's
4627 frame. The selected window is not changed by this function."
4628 (setq window
(window-normalize-window window
))
4631 ((memq side
'(below above right left
)) side
)
4633 (horizontal (not (memq side
'(below above
))))
4634 (frame (window-frame window
))
4635 (parent (window-parent window
))
4636 (function (window-parameter window
'split-window
))
4637 (window-side (window-parameter window
'window-side
))
4638 ;; Rebind the following two variables since in some cases we
4639 ;; have to override their value.
4640 (window-combination-limit window-combination-limit
)
4641 (window-combination-resize window-combination-resize
)
4642 (char-size (frame-char-size window horizontal
))
4644 (when (numberp size
)
4645 (window--size-to-pixel window size horizontal pixelwise t
)))
4646 (divider-width (if horizontal
4647 (frame-right-divider-width frame
)
4648 (frame-bottom-divider-width frame
)))
4650 (window--check frame
)
4653 ;; Ignore window parameters if either `ignore-window-parameters'
4654 ;; is t or the `split-window' parameter equals t.
4655 ((or ignore-window-parameters
(eq function t
)))
4656 ((functionp function
)
4657 ;; The `split-window' parameter specifies the function to call.
4658 ;; If that function is `ignore', do nothing.
4659 (throw 'done
(funcall function window size side
)))
4660 ;; If WINDOW is part of an atomic window, split the root window
4661 ;; of that atomic window instead.
4662 ((and (window-parameter window
'window-atom
)
4663 (setq atom-root
(window-atom-root window
))
4664 (not (eq atom-root window
)))
4665 (throw 'done
(split-window atom-root size side pixelwise
)))
4666 ;; If WINDOW is a side window or its first or last child is a
4667 ;; side window, throw an error unless `window-combination-resize'
4669 ((and (not (eq window-combination-resize
'side
))
4670 (window--side-window-p window
))
4671 (error "Cannot split side window or parent of side window"))
4672 ;; If `window-combination-resize' is 'side and window has a side
4673 ;; window sibling, bind `window-combination-limit' to t.
4674 ((and (not (eq window-combination-resize
'side
))
4675 (or (and (window-prev-sibling window
)
4677 (window-prev-sibling window
) 'window-side
))
4678 (and (window-next-sibling window
)
4680 (window-next-sibling window
) 'window-side
))))
4681 (setq window-combination-limit t
)))
4683 ;; If `window-combination-resize' is t and SIZE is non-negative,
4684 ;; bind `window-combination-limit' to t.
4685 (when (and (eq window-combination-resize t
)
4686 pixel-size
(> pixel-size
0))
4687 (setq window-combination-limit t
))
4689 (let* ((parent-pixel-size
4690 ;; `parent-pixel-size' is the pixel size of WINDOW's
4691 ;; parent, provided it has one.
4692 (when parent
(window-size parent horizontal t
)))
4693 ;; `resize' non-nil means we are supposed to resize other
4694 ;; windows in WINDOW's combination.
4696 (and window-combination-resize
4697 (or (window-parameter window
'window-side
)
4698 (not (eq window-combination-resize
'side
)))
4699 (not (eq window-combination-limit t
))
4700 ;; Resize makes sense in iso-combinations only.
4701 (window-combined-p window horizontal
)))
4702 ;; `old-pixel-size' is the current pixel size of WINDOW.
4703 (old-pixel-size (window-size window horizontal t
))
4704 ;; `new-size' is the specified or calculated size of the
4706 new-pixel-size new-parent new-normal
)
4709 (setq new-pixel-size
4711 ;; When resizing try to give the new window the
4712 ;; average size of a window in its combination.
4713 (max (min (- parent-pixel-size
4714 (window-min-size parent horizontal nil t
))
4715 (/ parent-pixel-size
4716 (1+ (window-combinations parent horizontal
))))
4717 (window-min-pixel-size))
4718 ;; Else try to give the new window half the size
4719 ;; of WINDOW (plus an eventual odd pixel).
4720 (/ old-pixel-size
2)))
4721 (unless window-resize-pixelwise
4722 ;; Round to nearest char-size multiple.
4723 (setq new-pixel-size
4724 (* char-size
(round new-pixel-size char-size
)))))
4726 ;; SIZE non-negative specifies the new size of WINDOW.
4728 ;; Note: Specifying a non-negative SIZE is practically
4729 ;; always done as workaround for making the new window
4730 ;; appear above or on the left of the new window (the
4731 ;; ispell window is a typical example of that). In all
4732 ;; these cases the SIDE argument should be set to 'above
4733 ;; or 'left in order to support the 'resize option.
4734 ;; Here we have to nest the windows instead, see above.
4735 (setq new-pixel-size
(- old-pixel-size pixel-size
)))
4737 ;; SIZE negative specifies the size of the new window.
4738 (setq new-pixel-size
(- pixel-size
))))
4745 ;; SIZE unspecified, resizing.
4746 (unless (or (window-sizable-p
4747 parent
(- (+ new-pixel-size divider-width
)) horizontal
4750 parent
(- (+ new-pixel-size divider-width
)) horizontal
4751 (setq ignore
'preserved
) t
))
4752 (error "Window %s too small for splitting (1)" parent
)))
4753 ((and (> (+ new-pixel-size divider-width
4754 (window-min-size window horizontal nil t
))
4756 (> (+ new-pixel-size divider-width
4758 window horizontal
(setq ignore
'preserved
) t
))
4760 ;; SIZE unspecified, no resizing.
4761 (error "Window %s too small for splitting (2)" window
))))
4762 ((and (>= pixel-size
0)
4763 (or (>= pixel-size old-pixel-size
)
4765 (window-safe-min-pixel-size window horizontal
))))
4766 ;; SIZE specified as new size of old window. If the new size
4767 ;; is larger than the old size or the size of the new window
4768 ;; would be less than the safe minimum, signal an error.
4769 (error "Window %s too small for splitting (3)" window
))
4771 ;; SIZE specified, resizing.
4772 (unless (or (window-sizable-p
4773 parent
(- (+ new-pixel-size divider-width
)) horizontal
4776 parent
(- (+ new-pixel-size divider-width
)) horizontal
4777 (setq ignore
'preserved
) t
))
4778 ;; If we cannot resize the parent give up.
4779 (error "Window %s too small for splitting (4)" parent
)))
4780 ((or (< new-pixel-size
4781 (window-safe-min-pixel-size window horizontal
))
4782 (< (- old-pixel-size new-pixel-size
)
4783 (window-safe-min-pixel-size window horizontal
)))
4784 ;; SIZE specification violates minimum size restrictions.
4785 (error "Window %s too small for splitting (5)" window
)))
4787 (window--resize-reset frame horizontal
)
4790 ;; Make new-parent non-nil if we need a new parent window;
4791 ;; either because we want to nest or because WINDOW is not
4793 (or (eq window-combination-limit t
)
4794 (not (window-combined-p window horizontal
))))
4796 ;; Make new-normal the normal size of the new window.
4798 (pixel-size (/ (float new-pixel-size
)
4799 (if new-parent old-pixel-size parent-pixel-size
)))
4801 (resize (/ 1.0 (1+ (window-combinations parent horizontal
))))
4802 (t (/ (window-normal-size window horizontal
) 2.0))))
4805 ;; Try to get space from OLD's siblings. We could go "up" and
4806 ;; try getting additional space from surrounding windows but
4807 ;; we won't be able to return space to those windows when we
4808 ;; delete the one we create here. Hence we do not go up.
4810 (window--resize-child-windows
4811 parent
(- new-pixel-size
) horizontal nil ignore
)
4812 (let* ((normal (- 1.0 new-normal
))
4813 (sub (window-child parent
)))
4815 (set-window-new-normal
4816 sub
(* (window-normal-size sub horizontal
) normal
))
4817 (setq sub
(window-right sub
)))))
4818 ;; Get entire space from WINDOW.
4819 (set-window-new-pixel
4820 window
(- old-pixel-size new-pixel-size
))
4821 (window--resize-this-window
4822 window
(- new-pixel-size
) horizontal ignore
)
4823 (set-window-new-normal
4824 window
(- (if new-parent
1.0 (window-normal-size window horizontal
))
4827 (let* ((new (split-window-internal window new-pixel-size side new-normal
)))
4828 (window--pixel-to-total frame horizontal
)
4829 ;; Assign window-side parameters, if any.
4831 ((eq window-combination-resize
'side
)
4834 (window-side window-side
)
4835 ((eq side
'above
) 'top
)
4836 ((eq side
'below
) 'bottom
)
4838 ;; We made a new side window.
4839 (set-window-parameter new
'window-side window-side
)
4840 (when (and new-parent
(window-parameter window
'window-side
))
4841 ;; We've been splitting a side root window. Give the
4842 ;; new parent the same window-side parameter.
4843 (set-window-parameter
4844 (window-parent new
) 'window-side window-side
))))
4845 ((eq window-combination-resize
'atom
)
4846 ;; Make sure `window--check-frame' won't destroy an existing
4847 ;; atomic window in case the new window gets nested inside.
4848 (unless (window-parameter window
'window-atom
)
4849 (set-window-parameter window
'window-atom t
))
4851 (set-window-parameter (window-parent new
) 'window-atom t
))
4852 (set-window-parameter new
'window-atom t
)))
4854 ;; Sanitize sizes unless SIZE was specified.
4856 (window--sanitize-window-sizes frame horizontal
))
4858 (run-window-configuration-change-hook frame
)
4859 (run-window-scroll-functions new
)
4860 (window--check frame
)
4861 ;; Always return the new window.
4864 ;; I think this should be the default; I think people will prefer it--rms.
4865 (defcustom split-window-keep-point t
4866 "If non-nil, \\[split-window-below] preserves point in the new window.
4867 If nil, adjust point in the two windows to minimize redisplay.
4868 This option applies only to `split-window-below' and functions
4869 that call it. The low-level `split-window' function always keeps
4870 the original point in both windows."
4874 (defun split-window-below (&optional size
)
4875 "Split the selected window into two windows, one above the other.
4876 The selected window is above. The newly split-off window is
4877 below and displays the same buffer. Return the new window.
4879 If optional argument SIZE is omitted or nil, both windows get the
4880 same height, or close to it. If SIZE is positive, the upper
4881 \(selected) window gets SIZE lines. If SIZE is negative, the
4882 lower (new) window gets -SIZE lines.
4884 If the variable `split-window-keep-point' is non-nil, both
4885 windows get the same value of point as the selected window.
4886 Otherwise, the window starts are chosen so as to minimize the
4887 amount of redisplay; this is convenient on slow terminals."
4889 (let ((old-window (selected-window))
4890 (old-point (window-point))
4891 (size (and size
(prefix-numeric-value size
)))
4892 moved-by-window-height moved new-window bottom
)
4893 (when (and size
(< size
0) (< (- size
) window-min-height
))
4894 ;; `split-window' would not signal an error here.
4895 (error "Size of new window too small"))
4896 (setq new-window
(split-window nil size
))
4897 (unless split-window-keep-point
4898 (with-current-buffer (window-buffer)
4899 ;; Use `save-excursion' around vertical movements below
4900 ;; (Bug#10971). Note: When the selected window's buffer has a
4901 ;; header line, up to two lines of the buffer may not show up
4902 ;; in the resulting configuration.
4904 (goto-char (window-start))
4905 (setq moved
(vertical-motion (window-height)))
4906 (set-window-start new-window
(point))
4907 (when (> (point) (window-point new-window
))
4908 (set-window-point new-window
(point)))
4909 (when (= moved
(window-height))
4910 (setq moved-by-window-height t
)
4911 (vertical-motion -
1))
4912 (setq bottom
(point)))
4913 (and moved-by-window-height
4915 (set-window-point old-window
(1- bottom
)))
4916 (and moved-by-window-height
4917 (<= (window-start new-window
) old-point
)
4918 (set-window-point new-window old-point
)
4919 (select-window new-window
))))
4920 ;; Always copy quit-restore parameter in interactive use.
4921 (let ((quit-restore (window-parameter old-window
'quit-restore
)))
4923 (set-window-parameter new-window
'quit-restore quit-restore
)))
4926 (defalias 'split-window-vertically
'split-window-below
)
4928 (defun split-window-right (&optional size
)
4929 "Split the selected window into two side-by-side windows.
4930 The selected window is on the left. The newly split-off window
4931 is on the right and displays the same buffer. Return the new
4934 If optional argument SIZE is omitted or nil, both windows get the
4935 same width, or close to it. If SIZE is positive, the left-hand
4936 \(selected) window gets SIZE columns. If SIZE is negative, the
4937 right-hand (new) window gets -SIZE columns. Here, SIZE includes
4938 the width of the window's scroll bar; if there are no scroll
4939 bars, it includes the width of the divider column to the window's
4942 (let ((old-window (selected-window))
4943 (size (and size
(prefix-numeric-value size
)))
4945 (when (and size
(< size
0) (< (- size
) window-min-width
))
4946 ;; `split-window' would not signal an error here.
4947 (error "Size of new window too small"))
4948 (setq new-window
(split-window nil size t
))
4949 ;; Always copy quit-restore parameter in interactive use.
4950 (let ((quit-restore (window-parameter old-window
'quit-restore
)))
4952 (set-window-parameter new-window
'quit-restore quit-restore
)))
4955 (defalias 'split-window-horizontally
'split-window-right
)
4957 ;;; Balancing windows.
4959 ;; The following routine uses the recycled code from an old version of
4960 ;; `window--resize-child-windows'. It's not very pretty, but coding it the way the
4961 ;; new `window--resize-child-windows' code does would hardly make it any shorter or
4962 ;; more readable (FWIW we'd need three loops - one to calculate the
4963 ;; minimum sizes per window, one to enlarge or shrink windows until the
4964 ;; new parent-size matches, and one where we shrink the largest/enlarge
4965 ;; the smallest window).
4966 (defun balance-windows-2 (window horizontal
)
4967 "Subroutine of `balance-windows-1'.
4968 WINDOW must be a vertical combination (horizontal if HORIZONTAL
4970 (let* ((char-size (if window-resize-pixelwise
4972 (frame-char-size window horizontal
)))
4973 (first (window-child window
))
4975 (number-of-children 0)
4976 (parent-size (window-new-pixel window
))
4977 (total-sum parent-size
)
4978 failed size sub-total sub-delta sub-amount rest
)
4980 (setq number-of-children
(1+ number-of-children
))
4981 (when (window-size-fixed-p sub horizontal
)
4983 (- total-sum
(window-size sub horizontal t
)))
4984 (set-window-new-normal sub
'ignore
))
4985 (setq sub
(window-right sub
)))
4988 (while (and failed
(> number-of-children
0))
4989 (setq size
(/ total-sum number-of-children
))
4992 (while (and sub
(not failed
))
4993 ;; Ignore child windows that should be ignored or are stuck.
4994 (unless (window--resize-child-windows-skip-p sub
)
4995 (setq sub-total
(window-size sub horizontal t
))
4996 (setq sub-delta
(- size sub-total
))
4998 (window-sizable sub sub-delta horizontal nil t
))
4999 ;; Register the new total size for this child window.
5000 (set-window-new-pixel sub
(+ sub-total sub-amount
))
5001 (unless (= sub-amount sub-delta
)
5002 (setq total-sum
(- total-sum sub-total sub-amount
))
5003 (setq number-of-children
(1- number-of-children
))
5004 ;; We failed and need a new round.
5006 (set-window-new-normal sub
'skip
)))
5007 (setq sub
(window-right sub
))))
5009 ;; How can we be sure that `number-of-children' is NOT zero here ?
5010 (setq rest
(% total-sum number-of-children
))
5011 ;; Fix rounding by trying to enlarge non-stuck windows by one line
5012 ;; (column) until `rest' is zero.
5014 (while (and sub
(> rest
0))
5015 (unless (window--resize-child-windows-skip-p window
)
5016 (set-window-new-pixel sub
(min rest char-size
) t
)
5017 (setq rest
(- rest char-size
)))
5018 (setq sub
(window-right sub
)))
5020 ;; Fix rounding by trying to enlarge stuck windows by one line
5021 ;; (column) until `rest' equals zero.
5023 (while (and sub
(> rest
0))
5024 (unless (eq (window-new-normal sub
) 'ignore
)
5025 (set-window-new-pixel sub
(min rest char-size
) t
)
5026 (setq rest
(- rest char-size
)))
5027 (setq sub
(window-right sub
)))
5031 ;; Record new normal sizes.
5032 (set-window-new-normal
5033 sub
(/ (if (eq (window-new-normal sub
) 'ignore
)
5034 (window-size sub horizontal t
)
5035 (window-new-pixel sub
))
5036 (float parent-size
)))
5037 ;; Recursively balance each window's child windows.
5038 (balance-windows-1 sub horizontal
)
5039 (setq sub
(window-right sub
)))))
5041 (defun balance-windows-1 (window &optional horizontal
)
5042 "Subroutine of `balance-windows'."
5043 (if (window-child window
)
5044 (let ((sub (window-child window
)))
5045 (if (window-combined-p sub horizontal
)
5046 (balance-windows-2 window horizontal
)
5047 (let ((size (window-new-pixel window
)))
5049 (set-window-new-pixel sub size
)
5050 (balance-windows-1 sub horizontal
)
5051 (setq sub
(window-right sub
))))))))
5053 (defun balance-windows (&optional window-or-frame
)
5054 "Balance the sizes of windows of WINDOW-OR-FRAME.
5055 WINDOW-OR-FRAME is optional and defaults to the selected frame.
5056 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
5057 windows of that frame. If WINDOW-OR-FRAME denotes a window,
5058 recursively balance the sizes of all child windows of that
5063 ((or (not window-or-frame
)
5064 (frame-live-p window-or-frame
))
5065 (frame-root-window window-or-frame
))
5066 ((or (window-live-p window-or-frame
)
5067 (window-child window-or-frame
))
5070 (error "Not a window or frame %s" window-or-frame
))))
5071 (frame (window-frame window
)))
5072 ;; Balance vertically.
5073 (window--resize-reset (window-frame window
))
5074 (balance-windows-1 window
)
5075 (when (window--resize-apply-p frame
)
5076 (window-resize-apply frame
)
5077 (window--pixel-to-total frame
)
5078 (run-window-configuration-change-hook frame
))
5079 ;; Balance horizontally.
5080 (window--resize-reset (window-frame window
) t
)
5081 (balance-windows-1 window t
)
5082 (when (window--resize-apply-p frame t
)
5083 (window-resize-apply frame t
)
5084 (window--pixel-to-total frame t
)
5085 (run-window-configuration-change-hook frame
))))
5087 (defun window-fixed-size-p (&optional window direction
)
5088 "Return t if WINDOW cannot be resized in DIRECTION.
5089 WINDOW defaults to the selected window. DIRECTION can be
5090 nil (i.e. any), `height' or `width'."
5091 (with-current-buffer (window-buffer window
)
5092 (when (and (boundp 'window-size-fixed
) window-size-fixed
)
5094 (member (cons direction window-size-fixed
)
5095 '((height . width
) (width . height
))))))))
5097 ;;; A different solution to balance-windows.
5098 (defvar window-area-factor
1
5099 "Factor by which the window area should be over-estimated.
5100 This is used by `balance-windows-area'.
5101 Changing this globally has no effect.")
5102 (make-variable-buffer-local 'window-area-factor
)
5104 (defun balance-windows-area-adjust (window delta horizontal pixelwise
)
5105 "Wrapper around `window-resize' with error checking.
5106 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
5107 ;; `window-resize' may fail if delta is too large.
5108 (while (>= (abs delta
) 1)
5111 ;; It was wrong to use `window-resize' here. Somehow
5112 ;; `balance-windows-area' depends on resizing windows
5114 (adjust-window-trailing-edge window delta horizontal pixelwise
)
5117 ;;(message "adjust: %s" (error-message-string err))
5118 (setq delta
(/ delta
2))))))
5120 (defun balance-windows-area ()
5121 "Make all visible windows the same area (approximately).
5122 See also `window-area-factor' to change the relative size of
5125 (let* ((unchanged 0) (carry 0) (round 0)
5126 ;; Remove fixed-size windows.
5127 (wins (delq nil
(mapcar (lambda (win)
5128 (if (not (window-fixed-size-p win
)) win
))
5129 (window-list nil
'nomini
))))
5131 (pixelwise window-resize-pixelwise
)
5133 ;; Resizing a window changes the size of surrounding windows in complex
5134 ;; ways, so it's difficult to balance them all. The introduction of
5135 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
5136 ;; very difficult to do. `balance-window' above takes an off-line
5137 ;; approach: get the whole window tree, then balance it, then try to
5138 ;; adjust the windows so they fit the result.
5139 ;; Here, instead, we take a "local optimization" approach, where we just
5140 ;; go through all the windows several times until nothing needs to be
5141 ;; changed. The main problem with this approach is that it's difficult
5142 ;; to make sure it terminates, so we use some heuristic to try and break
5143 ;; off infinite loops.
5144 ;; After a round without any change, we allow a second, to give a chance
5145 ;; to the carry to propagate a minor imbalance from the end back to
5147 (while (< unchanged
2)
5148 ;; (message "New round")
5149 (setq unchanged
(1+ unchanged
) round
(1+ round
))
5152 (while (progn (setq next
(next-window next
))
5153 (window-fixed-size-p next
)))
5154 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
5156 (< (car (window-pixel-edges win
)) (car (window-pixel-edges next
))))
5157 (areadiff (/ (- (* (window-size next nil pixelwise
)
5158 (window-size next t pixelwise
)
5159 (buffer-local-value 'window-area-factor
5160 (window-buffer next
)))
5161 (* (window-size win nil pixelwise
)
5162 (window-size win t pixelwise
)
5163 (buffer-local-value 'window-area-factor
5164 (window-buffer win
))))
5165 (max (buffer-local-value 'window-area-factor
5166 (window-buffer win
))
5167 (buffer-local-value 'window-area-factor
5168 (window-buffer next
)))))
5170 (+ (window-size win nil pixelwise
)
5171 (window-size next nil pixelwise
))
5172 (+ (window-size win t pixelwise
)
5173 (window-size next t pixelwise
))))
5174 (diff (/ areadiff edgesize
)))
5176 ;; Maybe diff is actually closer to 1 than to 0.
5177 (setq diff
(/ (* 3 areadiff
) (* 2 edgesize
))))
5178 (when (and (zerop diff
) (not (zerop areadiff
)))
5179 (setq diff
(/ (+ areadiff carry
) edgesize
))
5180 ;; Change things smoothly.
5181 (if (or (> diff
1) (< diff -
1)) (setq diff
(/ diff
2))))
5183 ;; Make sure negligible differences don't accumulate to
5184 ;; become significant.
5185 (setq carry
(+ carry areadiff
))
5186 ;; This used `adjust-window-trailing-edge' before and uses
5187 ;; `window-resize' now. Error wrapping is still needed.
5188 (balance-windows-area-adjust win diff horiz pixelwise
)
5190 (let ((change (cons win
(window-pixel-edges win
))))
5191 ;; If the same change has been seen already for this window,
5192 ;; we're most likely in an endless loop, so don't count it as
5194 (unless (member change changelog
)
5195 (push change changelog
)
5196 (setq unchanged
0 carry
0)))))))
5197 ;; We've now basically balanced all the windows.
5198 ;; But there may be some minor off-by-one imbalance left over,
5199 ;; so let's do some fine tuning.
5200 ;; (bw-finetune wins)
5201 ;; (message "Done in %d rounds" round)
5204 ;;; Window states, how to get them and how to put them in a window.
5205 (defun window--state-get-1 (window &optional writable
)
5206 "Helper function for `window-state-get'."
5209 ((window-top-child window
) 'vc
)
5210 ((window-left-child window
) 'hc
)
5212 (buffer (window-buffer window
))
5213 (selected (eq window
(selected-window)))
5216 ,@(unless (window-next-sibling window
) `((last . t
)))
5217 (pixel-width .
,(window-pixel-width window
))
5218 (pixel-height .
,(window-pixel-height window
))
5219 (total-width .
,(window-total-width window
))
5220 (total-height .
,(window-total-height window
))
5221 (normal-height .
,(window-normal-size window
))
5222 (normal-width .
,(window-normal-size window t
))
5223 ,@(unless (window-live-p window
)
5224 `((combination-limit .
,(window-combination-limit window
))))
5225 ,@(let ((parameters (window-parameters window
))
5227 ;; Make copies of those window parameters whose
5228 ;; persistence property is `writable' if WRITABLE is
5229 ;; non-nil and non-nil if WRITABLE is nil.
5230 (dolist (par parameters
)
5231 (let ((pers (cdr (assq (car par
)
5232 window-persistent-parameters
))))
5233 (when (and pers
(or (not writable
) (eq pers
'writable
)))
5234 (setq list
(cons (cons (car par
) (cdr par
)) list
)))))
5235 ;; Add `clone-of' parameter if necessary.
5236 (let ((pers (cdr (assq 'clone-of
5237 window-persistent-parameters
))))
5238 (when (and pers
(or (not writable
) (eq pers
'writable
))
5239 (not (assq 'clone-of list
)))
5240 (setq list
(cons (cons 'clone-of window
) list
))))
5242 `((parameters .
,list
))))
5244 ;; All buffer related things go in here.
5245 (let ((point (window-point window
))
5246 (start (window-start window
)))
5248 ,(buffer-name buffer
)
5249 (selected .
,selected
)
5250 (hscroll .
,(window-hscroll window
))
5251 (fringes .
,(window-fringes window
))
5252 (margins .
,(window-margins window
))
5253 (scroll-bars .
,(window-scroll-bars window
))
5254 (vscroll .
,(window-vscroll window
))
5255 (dedicated .
,(window-dedicated-p window
))
5256 (point .
,(if writable point
5259 'window-point-insertion-type
5261 (start .
,(if writable start
(copy-marker start
)))))))))
5263 (when (memq type
'(vc hc
))
5265 (setq window
(window-child window
))
5267 (setq list
(cons (window--state-get-1 window writable
) list
))
5268 (setq window
(window-right window
)))
5270 (append head tail
)))
5272 (defun window-state-get (&optional window writable
)
5273 "Return state of WINDOW as a Lisp object.
5274 WINDOW can be any window and defaults to the root window of the
5277 Optional argument WRITABLE non-nil means do not use markers for
5278 sampling `window-point' and `window-start'. Together, WRITABLE
5279 and the variable `window-persistent-parameters' specify which
5280 window parameters are saved by this function. WRITABLE should be
5281 non-nil when the return value shall be written to a file and read
5282 back in another session. Otherwise, an application may run into
5283 an `invalid-read-syntax' error while attempting to read back the
5286 The return value can be used as argument for `window-state-put'
5287 to put the state recorded here into an arbitrary window. The
5288 value can be also stored on disk and read back in a new session."
5291 (if (window-valid-p window
)
5293 (error "%s is not a live or internal window" window
))
5294 (frame-root-window)))
5295 ;; The return value is a cons whose car specifies some constraints on
5296 ;; the size of WINDOW. The cdr lists the states of the child windows
5299 ;; Frame related things would go into a function, say `frame-state',
5300 ;; calling `window-state-get' to insert the frame's root window.
5301 `((min-height .
,(window-min-size window
))
5302 (min-width .
,(window-min-size window t
))
5303 (min-height-ignore .
,(window-min-size window nil t
))
5304 (min-width-ignore .
,(window-min-size window t t
))
5305 (min-height-safe .
,(window-min-size window nil
'safe
))
5306 (min-width-safe .
,(window-min-size window t
'safe
))
5307 (min-pixel-height .
,(window-min-size window nil nil t
))
5308 (min-pixel-width .
,(window-min-size window t nil t
))
5309 (min-pixel-height-ignore .
,(window-min-size window nil t t
))
5310 (min-pixel-width-ignore .
,(window-min-size window t t t
))
5311 (min-pixel-height-safe .
,(window-min-size window nil
'safe t
))
5312 (min-pixel-width-safe .
,(window-min-size window t
'safe t
)))
5313 (window--state-get-1 window writable
)))
5315 (defvar window-state-put-list nil
5316 "Helper variable for `window-state-put'.")
5318 (defvar window-state-put-stale-windows nil
5319 "Helper variable for `window-state-put'.")
5321 (defun window--state-put-1 (state &optional window ignore totals pixelwise
)
5322 "Helper function for `window-state-put'."
5323 (let ((type (car state
)))
5324 (setq state
(cdr state
))
5327 ;; For a leaf window just add unprocessed entries to
5328 ;; `window-state-put-list'.
5329 (push (cons window state
) window-state-put-list
))
5330 ((memq type
'(vc hc
))
5331 (let* ((horizontal (eq type
'hc
))
5332 (total (window-size window horizontal pixelwise
))
5335 (dolist (item state
)
5336 ;; Find the next child window. WINDOW always points to the
5337 ;; real window that we want to fill with what we find here.
5338 (when (memq (car item
) '(leaf vc hc
))
5339 (if (assq 'last item
)
5340 ;; The last child window. Below `window--state-put-1'
5341 ;; will put into it whatever ITEM has in store.
5343 ;; Not the last child window, prepare for splitting
5344 ;; WINDOW. SIZE is the new (and final) size of the old
5350 (cdr (assq (if horizontal
5354 (cdr (assq (if horizontal
5358 ;; Use normalized size and round.
5361 (cdr (assq (if horizontal
'normal-width
'normal-height
)
5364 ;; Use safe sizes, we try to resize later.
5365 (setq size
(max size
5367 (* window-safe-min-width
5369 (frame-char-width (window-frame window
))
5371 (* window-safe-min-height
5373 (frame-char-height (window-frame window
))
5375 (if (window-sizable-p window
(- size
) horizontal
'safe pixelwise
)
5376 (let* ((window-combination-limit
5377 (assq 'combination-limit item
)))
5378 ;; We must inherit the combination limit, otherwise
5379 ;; we might mess up handling of atomic and side
5381 (setq new
(split-window window size horizontal pixelwise
)))
5382 ;; Give up if we can't resize window down to safe sizes.
5383 (error "Cannot resize window %s" window
))
5387 ;; When creating the first child window add for parent
5388 ;; unprocessed entries to `window-state-put-list'.
5389 (setq window-state-put-list
5390 (cons (cons (window-parent window
) state
)
5391 window-state-put-list
))))
5393 ;; Now process the current window (either the one we've just
5394 ;; split or the last child of its parent).
5395 (window--state-put-1 item window ignore totals
)
5396 ;; Continue with the last window split off.
5397 (setq window new
))))))))
5399 (defun window--state-put-2 (ignore pixelwise
)
5400 "Helper function for `window-state-put'."
5401 (dolist (item window-state-put-list
)
5402 (let ((window (car item
))
5403 (combination-limit (cdr (assq 'combination-limit item
)))
5404 (parameters (cdr (assq 'parameters item
)))
5405 (state (cdr (assq 'buffer item
))))
5406 (when combination-limit
5407 (set-window-combination-limit window combination-limit
))
5408 ;; Reset window's parameters and assign saved ones (we might want
5409 ;; a `remove-window-parameters' function here).
5410 (dolist (parameter (window-parameters window
))
5411 (set-window-parameter window
(car parameter
) nil
))
5413 (dolist (parameter parameters
)
5414 (set-window-parameter window
(car parameter
) (cdr parameter
))))
5415 ;; Process buffer related state.
5417 (let ((buffer (get-buffer (car state
))))
5419 (with-current-buffer buffer
5420 (set-window-buffer window buffer
)
5421 (set-window-hscroll window
(cdr (assq 'hscroll state
)))
5422 (apply 'set-window-fringes
5423 (cons window
(cdr (assq 'fringes state
))))
5424 (let ((margins (cdr (assq 'margins state
))))
5425 (set-window-margins window
(car margins
) (cdr margins
)))
5426 (let ((scroll-bars (cdr (assq 'scroll-bars state
))))
5427 (set-window-scroll-bars
5428 window
(car scroll-bars
) (nth 2 scroll-bars
)
5429 (nth 3 scroll-bars
) (nth 5 scroll-bars
)))
5430 (set-window-vscroll window
(cdr (assq 'vscroll state
)))
5431 ;; Adjust vertically.
5432 (if (memq window-size-fixed
'(t height
))
5433 ;; A fixed height window, try to restore the
5437 (if pixelwise
'pixel-height
'total-height
)
5439 (window-size window nil pixelwise
)))
5441 (when (window--resizable-p
5442 window delta nil nil nil nil nil pixelwise
)
5443 (window-resize window delta nil nil pixelwise
)))
5444 ;; Else check whether the window is not high enough.
5446 (window-min-size window nil ignore pixelwise
))
5448 (- min-size
(window-size window nil pixelwise
))))
5449 (when (and (> delta
0)
5450 (window--resizable-p
5451 window delta nil ignore nil nil nil pixelwise
))
5452 (window-resize window delta nil ignore pixelwise
))))
5453 ;; Adjust horizontally.
5454 (if (memq window-size-fixed
'(t width
))
5455 ;; A fixed width window, try to restore the original
5459 (if pixelwise
'pixel-width
'total-width
)
5461 (window-size window t pixelwise
)))
5463 (when (window--resizable-p
5464 window delta nil nil nil nil nil pixelwise
)
5465 (window-resize window delta nil nil pixelwise
)))
5466 ;; Else check whether the window is not wide enough.
5467 (let* ((min-size (window-min-size window t ignore pixelwise
))
5468 (delta (- min-size
(window-size window t pixelwise
))))
5469 (when (and (> delta
0)
5470 (window--resizable-p
5471 window delta t ignore nil nil nil pixelwise
))
5472 (window-resize window delta t ignore pixelwise
))))
5473 ;; Set dedicated status.
5474 (set-window-dedicated-p window
(cdr (assq 'dedicated state
)))
5475 ;; Install positions (maybe we should do this after all
5476 ;; windows have been created and sized).
5478 (set-window-start window
(cdr (assq 'start state
)))
5479 (set-window-point window
(cdr (assq 'point state
))))
5480 ;; Select window if it's the selected one.
5481 (when (cdr (assq 'selected state
))
5482 (select-window window
)))
5483 ;; We don't want to raise an error in case the buffer does
5484 ;; not exist anymore, so we switch to a previous one and
5485 ;; save the window with the intention of deleting it later
5487 (switch-to-prev-buffer window
)
5488 (push window window-state-put-stale-windows
)))))))
5490 (defun window-state-put (state &optional window ignore
)
5491 "Put window state STATE into WINDOW.
5492 STATE should be the state of a window returned by an earlier
5493 invocation of `window-state-get'. Optional argument WINDOW must
5494 specify a valid window and defaults to the selected one. If
5495 WINDOW is not live, replace WINDOW by a live one before putting
5498 Optional argument IGNORE non-nil means ignore minimum window
5499 sizes and fixed size restrictions. IGNORE equal `safe' means
5500 windows can get as small as `window-safe-min-height' and
5501 `window-safe-min-width'."
5502 (setq window-state-put-stale-windows nil
)
5503 (setq window
(window-normalize-window window
))
5505 ;; When WINDOW is internal, reduce it to a live one to put STATE into,
5507 (unless (window-live-p window
)
5508 (let ((root (frame-root-window window
)))
5509 (if (eq window root
)
5510 (setq window
(frame-first-window root
))
5512 (setq window
(catch 'live
5513 (walk-window-subtree
5515 (when (window-live-p window
)
5516 (throw 'live window
)))
5518 (delete-other-windows-internal window root
)))
5520 (set-window-dedicated-p window nil
)
5522 (let* ((frame (window-frame window
))
5524 ;; We check here (1) whether the total sizes of root window of
5525 ;; STATE and that of WINDOW are equal so we can avoid
5526 ;; calculating new sizes, and (2) if we do have to resize
5527 ;; whether we can do so without violating size restrictions.
5528 (pixelwise (and (cdr (assq 'pixel-width state
))
5529 (cdr (assq 'pixel-height state
))))
5530 (totals (or (and pixelwise
5531 (= (window-pixel-width window
)
5532 (cdr (assq 'pixel-width state
)))
5533 (= (window-pixel-height window
)
5534 (cdr (assq 'pixel-height state
))))
5535 (and (= (window-total-width window
)
5536 (cdr (assq 'total-width state
)))
5537 (= (window-total-height window
)
5538 (cdr (assq 'total-height state
))))))
5539 (min-height (cdr (assq
5540 (if pixelwise
'min-pixel-height
'min-height
)
5542 (min-width (cdr (assq
5543 (if pixelwise
'min-pixel-width
'min-weight
)
5545 (if (and (not totals
)
5546 (or (> min-height
(window-size window nil pixelwise
))
5547 (> min-width
(window-size window t pixelwise
)))
5549 (and (setq min-height
5552 'min-pixel-height-ignore
5558 'min-pixel-width-ignore
5562 (window-size window nil pixelwise
))
5564 (window-size window t pixelwise
)))
5565 (or (not (eq ignore
'safe
))
5566 (and (setq min-height
5569 'min-pixel-height-safe
5575 'min-pixel-width-safe
5579 (window-size window nil pixelwise
))
5581 (window-size window t pixelwise
))))))))
5582 ;; The check above might not catch all errors due to rounding
5583 ;; issues - so IGNORE equal 'safe might not always produce the
5584 ;; minimum possible state. But such configurations hardly make
5586 (error "Window %s too small to accommodate state" window
)
5587 (setq state
(cdr state
))
5588 (setq window-state-put-list nil
)
5589 ;; Work on the windows of a temporary buffer to make sure that
5590 ;; splitting proceeds regardless of any buffer local values of
5591 ;; `window-size-fixed'. Release that buffer after the buffers of
5592 ;; all live windows have been set by `window--state-put-2'.
5594 (set-window-buffer window
(current-buffer))
5595 (window--state-put-1 state window nil totals pixelwise
)
5596 (window--state-put-2 ignore pixelwise
))
5597 (while window-state-put-stale-windows
5598 (let ((window (pop window-state-put-stale-windows
)))
5599 (when (eq (window-deletable-p window
) t
)
5600 (delete-window window
))))
5601 (window--check frame
))))
5603 (defun display-buffer-record-window (type window buffer
)
5604 "Record information for window used by `display-buffer'.
5605 TYPE specifies the type of the calling operation and must be one
5606 of the symbols `reuse' (when WINDOW existed already and was
5607 reused for displaying BUFFER), `window' (when WINDOW was created
5608 on an already existing frame), or `frame' (when WINDOW was
5609 created on a new frame). WINDOW is the window used for or created
5610 by the `display-buffer' routines. BUFFER is the buffer that
5613 This function installs or updates the quit-restore parameter of
5614 WINDOW. The quit-restore parameter is a list of four elements:
5615 The first element is one of the symbols `window', `frame', `same' or
5616 `other'. The second element is either one of the symbols `window'
5617 or `frame' or a list whose elements are the buffer previously
5618 shown in the window, that buffer's window start and window point,
5619 and the window's height. The third element is the window
5620 selected at the time the parameter was created. The fourth
5624 (if (eq (window-buffer window
) buffer
)
5625 ;; WINDOW shows BUFFER already. Update WINDOW's quit-restore
5626 ;; parameter, if any.
5627 (let ((quit-restore (window-parameter window
'quit-restore
)))
5628 (when (consp quit-restore
)
5629 (setcar quit-restore
'same
)
5630 ;; The selected-window might have changed in
5631 ;; between (Bug#20353).
5632 (unless (or (eq window
(selected-window))
5633 (eq window
(nth 2 quit-restore
)))
5634 (setcar (cddr quit-restore
) (selected-window)))))
5635 ;; WINDOW shows another buffer.
5636 (with-current-buffer (window-buffer window
)
5637 (set-window-parameter
5638 window
'quit-restore
5640 ;; A quadruple of WINDOW's buffer, start, point and height.
5641 (list (current-buffer) (window-start window
)
5642 ;; Preserve window-point-insertion-type (Bug#12588).
5644 (window-point window
) window-point-insertion-type
)
5645 (if (window-combined-p window
)
5646 (window-total-height window
)
5647 (window-total-width window
)))
5648 (selected-window) buffer
)))))
5650 ;; WINDOW has been created on an existing frame.
5651 (set-window-parameter
5652 window
'quit-restore
5653 (list 'window
'window
(selected-window) buffer
)))
5655 ;; WINDOW has been created on a new frame.
5656 (set-window-parameter
5657 window
'quit-restore
5658 (list 'frame
'frame
(selected-window) buffer
)))))
5660 (defcustom display-buffer-function nil
5661 "If non-nil, function to call to handle `display-buffer'.
5662 It will receive two args, the buffer and a flag which if non-nil
5663 means that the currently selected window is not acceptable. It
5664 should choose or create a window, display the specified buffer in
5665 it, and return the window.
5667 The specified function should call `display-buffer-record-window'
5668 with corresponding arguments to set up the quit-restore parameter
5669 of the window used."
5672 (function :tag
"function"))
5675 (make-obsolete-variable 'display-buffer-function
5676 'display-buffer-alist
"24.3")
5678 ;; Eventually, we want to turn this into a defvar; instead of
5679 ;; customizing this, the user should use a `pop-up-frame-parameters'
5680 ;; alist entry in `display-buffer-base-action'.
5681 (defcustom pop-up-frame-alist nil
5682 "Alist of parameters for automatically generated new frames.
5683 If non-nil, the value you specify here is used by the default
5684 `pop-up-frame-function' for the creation of new frames.
5686 Since `pop-up-frame-function' is used by `display-buffer' for
5687 making new frames, any value specified here by default affects
5688 the automatic generation of new frames via `display-buffer' and
5689 all functions based on it. The behavior of `make-frame' is not
5690 affected by this variable."
5691 :type
'(repeat (cons :format
"%v"
5692 (symbol :tag
"Parameter")
5693 (sexp :tag
"Value")))
5696 (defcustom pop-up-frame-function
5697 (lambda () (make-frame pop-up-frame-alist
))
5698 "Function used by `display-buffer' for creating a new frame.
5699 This function is called with no arguments and should return a new
5700 frame. The default value calls `make-frame' with the argument
5701 `pop-up-frame-alist'."
5705 (defcustom special-display-buffer-names nil
5706 "List of names of buffers that should be displayed specially.
5707 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
5708 its name is in this list, displays the buffer in a way specified
5709 by `special-display-function'. `special-display-popup-frame'
5710 \(the default for `special-display-function') usually displays
5711 the buffer in a separate frame made with the parameters specified
5712 by `special-display-frame-alist'. If `special-display-function'
5713 has been set to some other function, that function is called with
5714 the buffer as first, and nil as second argument.
5716 Alternatively, an element of this list can be specified as
5717 \(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
5718 name and FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
5719 `special-display-popup-frame' will interpret such pairs as frame
5720 parameters when it creates a special frame, overriding the
5721 corresponding values from `special-display-frame-alist'.
5723 As a special case, if FRAME-PARAMETERS contains (same-window . t)
5724 `special-display-popup-frame' displays that buffer in the
5725 selected window. If FRAME-PARAMETERS contains (same-frame . t),
5726 it displays that buffer in a window on the selected frame.
5728 If `special-display-function' specifies some other function than
5729 `special-display-popup-frame', that function is called with the
5730 buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
5733 Finally, an element of this list can be also specified as
5734 \(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
5735 `special-display-popup-frame' will call FUNCTION with the buffer
5736 named BUFFER-NAME as first argument, and OTHER-ARGS as the
5739 Any alternative function specified here is responsible for
5740 setting up the quit-restore parameter of the window used.
5742 If this variable appears \"not to work\", because you added a
5743 name to it but the corresponding buffer is displayed in the
5744 selected window, look at the values of `same-window-buffer-names'
5745 and `same-window-regexps'. Those variables take precedence over
5748 See also `special-display-regexps'."
5750 (choice :tag
"Buffer"
5752 (string :format
"%v")
5753 (cons :tag
"With parameters"
5756 (string :format
"%v")
5757 (repeat :tag
"Parameters"
5759 (symbol :tag
"Parameter")
5760 (sexp :tag
"Value"))))
5761 (list :tag
"With function"
5764 (string :format
"%v")
5765 (function :tag
"Function")
5766 (repeat :tag
"Arguments" (sexp)))))
5769 (make-obsolete-variable 'special-display-buffer-names
'display-buffer-alist
"24.3")
5770 (put 'special-display-buffer-names
'risky-local-variable t
)
5772 (defcustom special-display-regexps nil
5773 "List of regexps saying which buffers should be displayed specially.
5774 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
5775 any regexp in this list matches its name, displays it specially
5776 using `special-display-function'. `special-display-popup-frame'
5777 \(the default for `special-display-function') usually displays
5778 the buffer in a separate frame made with the parameters specified
5779 by `special-display-frame-alist'. If `special-display-function'
5780 has been set to some other function, that function is called with
5781 the buffer as first, and nil as second argument.
5783 Alternatively, an element of this list can be specified as
5784 \(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
5785 FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
5786 `special-display-popup-frame' will then interpret these pairs as
5787 frame parameters when creating a special frame for a buffer whose
5788 name matches REGEXP, overriding the corresponding values from
5789 `special-display-frame-alist'.
5791 As a special case, if FRAME-PARAMETERS contains (same-window . t)
5792 `special-display-popup-frame' displays buffers matching REGEXP in
5793 the selected window. (same-frame . t) in FRAME-PARAMETERS means
5794 to display such buffers in a window on the selected frame.
5796 If `special-display-function' specifies some other function than
5797 `special-display-popup-frame', that function is called with the
5798 buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
5801 Finally, an element of this list can be also specified as
5802 \(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
5803 will then call FUNCTION with the buffer whose name matched
5804 REGEXP as first, and OTHER-ARGS as second argument.
5806 Any alternative function specified here is responsible for
5807 setting up the quit-restore parameter of the window used.
5809 If this variable appears \"not to work\", because you added a
5810 name to it but the corresponding buffer is displayed in the
5811 selected window, look at the values of `same-window-buffer-names'
5812 and `same-window-regexps'. Those variables take precedence over
5815 See also `special-display-buffer-names'."
5817 (choice :tag
"Buffer"
5819 (regexp :format
"%v")
5820 (cons :tag
"With parameters"
5823 (regexp :format
"%v")
5824 (repeat :tag
"Parameters"
5826 (symbol :tag
"Parameter")
5827 (sexp :tag
"Value"))))
5828 (list :tag
"With function"
5831 (regexp :format
"%v")
5832 (function :tag
"Function")
5833 (repeat :tag
"Arguments" (sexp)))))
5836 (make-obsolete-variable 'special-display-regexps
'display-buffer-alist
"24.3")
5837 (put 'special-display-regexps
'risky-local-variable t
)
5839 (defun special-display-p (buffer-name)
5840 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
5841 More precisely, return t if `special-display-buffer-names' or
5842 `special-display-regexps' contain a string entry equaling or
5843 matching BUFFER-NAME. If `special-display-buffer-names' or
5844 `special-display-regexps' contain a list entry whose car equals
5845 or matches BUFFER-NAME, the return value is the cdr of that
5849 ((member buffer-name special-display-buffer-names
)
5851 ((setq tmp
(assoc buffer-name special-display-buffer-names
))
5854 (dolist (regexp special-display-regexps
)
5857 (when (string-match-p regexp buffer-name
)
5859 ((and (consp regexp
) (stringp (car regexp
))
5860 (string-match-p (car regexp
) buffer-name
))
5861 (throw 'found
(cdr regexp
))))))))))
5863 (defcustom special-display-frame-alist
5864 '((height .
14) (width .
80) (unsplittable . t
))
5865 "Alist of parameters for special frames.
5866 Special frames are used for buffers whose names are listed in
5867 `special-display-buffer-names' and for buffers whose names match
5868 one of the regular expressions in `special-display-regexps'.
5870 This variable can be set in your init file, like this:
5872 (setq special-display-frame-alist \\='((width . 80) (height . 20)))
5874 These supersede the values given in `default-frame-alist'."
5875 :type
'(repeat (cons :format
"%v"
5876 (symbol :tag
"Parameter")
5877 (sexp :tag
"Value")))
5879 (make-obsolete-variable 'special-display-frame-alist
'display-buffer-alist
"24.3")
5881 (defun special-display-popup-frame (buffer &optional args
)
5882 "Pop up a frame displaying BUFFER and return its window.
5883 If BUFFER is already displayed in a visible or iconified frame,
5884 raise that frame. Otherwise, display BUFFER in a new frame.
5886 Optional argument ARGS is a list specifying additional
5889 If ARGS is an alist, use it as a list of frame parameters. If
5890 these parameters contain (same-window . t), display BUFFER in
5891 the selected window. If they contain (same-frame . t), display
5892 BUFFER in a window of the selected frame.
5894 If ARGS is a list whose car is a symbol, use (car ARGS) as a
5895 function to do the work. Pass it BUFFER as first argument, and
5896 pass the elements of (cdr ARGS) as the remaining arguments."
5897 (if (and args
(symbolp (car args
)))
5898 (apply (car args
) buffer
(cdr args
))
5899 (let ((window (get-buffer-window buffer
0)))
5901 ;; If we have a window already, make it visible.
5903 (let ((frame (window-frame window
)))
5904 (make-frame-visible frame
)
5906 (display-buffer-record-window 'reuse window buffer
)
5908 ;; Reuse the current window if the user requested it.
5909 (when (cdr (assq 'same-window args
))
5911 (progn (switch-to-buffer buffer nil t
) (selected-window))
5913 ;; Stay on the same frame if requested.
5914 (when (or (cdr (assq 'same-frame args
)) (cdr (assq 'same-window args
)))
5915 (let* ((pop-up-windows t
)
5917 special-display-buffer-names special-display-regexps
)
5918 (display-buffer buffer
)))
5919 ;; If no window yet, make one in a new frame.
5921 (with-current-buffer buffer
5922 (make-frame (append args special-display-frame-alist
))))
5923 (window (frame-selected-window frame
)))
5924 (display-buffer-record-window 'frame window buffer
)
5925 (unless (eq buffer
(window-buffer window
))
5926 (set-window-buffer window buffer
)
5927 (set-window-prev-buffers window nil
))
5928 (set-window-dedicated-p window t
)
5931 (defcustom special-display-function
'special-display-popup-frame
5932 "Function to call for displaying special buffers.
5933 This function is called with two arguments - the buffer and,
5934 optionally, a list - and should return a window displaying that
5935 buffer. The default value usually makes a separate frame for the
5936 buffer using `special-display-frame-alist' to specify the frame
5937 parameters. See the definition of `special-display-popup-frame'
5938 for how to specify such a function.
5940 A buffer is special when its name is either listed in
5941 `special-display-buffer-names' or matches a regexp in
5942 `special-display-regexps'.
5944 The specified function should call `display-buffer-record-window'
5945 with corresponding arguments to set up the quit-restore parameter
5946 of the window used."
5949 (make-obsolete-variable 'special-display-function
'display-buffer-alist
"24.3")
5951 (defcustom same-window-buffer-names nil
5952 "List of names of buffers that should appear in the \"same\" window.
5953 `display-buffer' and `pop-to-buffer' show a buffer whose name is
5954 on this list in the selected rather than some other window.
5956 An element of this list can be a cons cell instead of just a
5957 string. In that case, the cell's car must be a string specifying
5958 the buffer name. This is for compatibility with
5959 `special-display-buffer-names'; the cdr of the cons cell is
5962 See also `same-window-regexps'."
5963 :type
'(repeat (string :format
"%v"))
5966 (defcustom same-window-regexps nil
5967 "List of regexps saying which buffers should appear in the \"same\" window.
5968 `display-buffer' and `pop-to-buffer' show a buffer whose name
5969 matches a regexp on this list in the selected rather than some
5972 An element of this list can be a cons cell instead of just a
5973 string. In that case, the cell's car must be a regexp matching
5974 the buffer name. This is for compatibility with
5975 `special-display-regexps'; the cdr of the cons cell is ignored.
5977 See also `same-window-buffer-names'."
5978 :type
'(repeat (regexp :format
"%v"))
5981 (defun same-window-p (buffer-name)
5982 "Return non-nil if a buffer named BUFFER-NAME would be shown in the \"same\" window.
5983 This function returns non-nil if `display-buffer' or
5984 `pop-to-buffer' would show a buffer named BUFFER-NAME in the
5985 selected rather than (as usual) some other window. See
5986 `same-window-buffer-names' and `same-window-regexps'."
5988 ((not (stringp buffer-name
)))
5989 ;; The elements of `same-window-buffer-names' can be buffer
5990 ;; names or cons cells whose cars are buffer names.
5991 ((member buffer-name same-window-buffer-names
))
5992 ((assoc buffer-name same-window-buffer-names
))
5994 (dolist (regexp same-window-regexps
)
5995 ;; The elements of `same-window-regexps' can be regexps
5996 ;; or cons cells whose cars are regexps.
5997 (when (or (and (stringp regexp
)
5998 (string-match-p regexp buffer-name
))
5999 (and (consp regexp
) (stringp (car regexp
))
6000 (string-match-p (car regexp
) buffer-name
)))
6001 (throw 'found t
)))))))
6003 (defcustom pop-up-frames nil
6004 "Whether `display-buffer' should make a separate frame.
6005 If nil, never make a separate frame.
6006 If the value is `graphic-only', make a separate frame
6007 on graphic displays only.
6008 Any other non-nil value means always make a separate frame."
6010 (const :tag
"Never" nil
)
6011 (const :tag
"On graphic displays only" graphic-only
)
6012 (const :tag
"Always" t
))
6015 (defcustom display-buffer-reuse-frames nil
6016 "Non-nil means `display-buffer' should reuse frames.
6017 If the buffer in question is already displayed in a frame, raise
6023 (make-obsolete-variable
6024 'display-buffer-reuse-frames
6025 "use a `reusable-frames' alist entry in `display-buffer-alist'."
6028 (defcustom pop-up-windows t
6029 "Non-nil means `display-buffer' should make a new window."
6033 (defcustom split-window-preferred-function
'split-window-sensibly
6034 "Function called by `display-buffer' routines to split a window.
6035 This function is called with a window as single argument and is
6036 supposed to split that window and return the new window. If the
6037 window can (or shall) not be split, it is supposed to return nil.
6038 The default is to call the function `split-window-sensibly' which
6039 tries to split the window in a way which seems most suitable.
6040 You can customize the options `split-height-threshold' and/or
6041 `split-width-threshold' in order to have `split-window-sensibly'
6042 prefer either vertical or horizontal splitting.
6044 If you set this to any other function, bear in mind that the
6045 `display-buffer' routines may call this function two times. The
6046 argument of the first call is the largest window on its frame.
6047 If that call fails to return a live window, the function is
6048 called again with the least recently used window as argument. If
6049 that call fails too, `display-buffer' will use an existing window
6050 to display its buffer.
6052 The window selected at the time `display-buffer' was invoked is
6053 still selected when this function is called. Hence you can
6054 compare the window argument with the value of `selected-window'
6055 if you intend to split the selected window instead or if you do
6056 not want to split the selected window."
6061 (defcustom split-height-threshold
80
6062 "Minimum height for splitting windows sensibly.
6063 If this is an integer, `split-window-sensibly' may split a window
6064 vertically only if it has at least this many lines. If this is
6065 nil, `split-window-sensibly' is not allowed to split a window
6066 vertically. If, however, a window is the only window on its
6067 frame, `split-window-sensibly' may split it vertically
6068 disregarding the value of this variable."
6069 :type
'(choice (const nil
) (integer :tag
"lines"))
6073 (defcustom split-width-threshold
160
6074 "Minimum width for splitting windows sensibly.
6075 If this is an integer, `split-window-sensibly' may split a window
6076 horizontally only if it has at least this many columns. If this
6077 is nil, `split-window-sensibly' is not allowed to split a window
6079 :type
'(choice (const nil
) (integer :tag
"columns"))
6083 (defun window-splittable-p (window &optional horizontal
)
6084 "Return non-nil if `split-window-sensibly' may split WINDOW.
6085 Optional argument HORIZONTAL nil or omitted means check whether
6086 `split-window-sensibly' may split WINDOW vertically. HORIZONTAL
6087 non-nil means check whether WINDOW may be split horizontally.
6089 WINDOW may be split vertically when the following conditions
6091 - `window-size-fixed' is either nil or equals `width' for the
6093 - `split-height-threshold' is an integer and WINDOW is at least as
6094 high as `split-height-threshold'.
6095 - When WINDOW is split evenly, the emanating windows are at least
6096 `window-min-height' lines tall and can accommodate at least one
6097 line plus - if WINDOW has one - a mode line.
6099 WINDOW may be split horizontally when the following conditions
6101 - `window-size-fixed' is either nil or equals `height' for the
6103 - `split-width-threshold' is an integer and WINDOW is at least as
6104 wide as `split-width-threshold'.
6105 - When WINDOW is split evenly, the emanating windows are at least
6106 `window-min-width' or two (whichever is larger) columns wide."
6107 (when (and (window-live-p window
) (not (window--side-window-p window
)))
6108 (with-current-buffer (window-buffer window
)
6110 ;; A window can be split horizontally when its width is not
6111 ;; fixed, it is at least `split-width-threshold' columns wide
6112 ;; and at least twice as wide as `window-min-width' and 2 (the
6113 ;; latter value is hardcoded).
6114 (and (memq window-size-fixed
'(nil height
))
6115 ;; Testing `window-full-width-p' here hardly makes any
6116 ;; sense nowadays. This can be done more intuitively by
6117 ;; setting up `split-width-threshold' appropriately.
6118 (numberp split-width-threshold
)
6119 (>= (window-width window
)
6120 (max split-width-threshold
6121 (* 2 (max window-min-width
2)))))
6122 ;; A window can be split vertically when its height is not
6123 ;; fixed, it is at least `split-height-threshold' lines high,
6124 ;; and it is at least twice as high as `window-min-height' and 2
6125 ;; if it has a mode line or 1.
6126 (and (memq window-size-fixed
'(nil width
))
6127 (numberp split-height-threshold
)
6128 (>= (window-height window
)
6129 (max split-height-threshold
6130 (* 2 (max window-min-height
6131 (if mode-line-format
2 1))))))))))
6133 (defun split-window-sensibly (&optional window
)
6134 "Split WINDOW in a way suitable for `display-buffer'.
6135 WINDOW defaults to the currently selected window.
6136 If `split-height-threshold' specifies an integer, WINDOW is at
6137 least `split-height-threshold' lines tall and can be split
6138 vertically, split WINDOW into two windows one above the other and
6139 return the lower window. Otherwise, if `split-width-threshold'
6140 specifies an integer, WINDOW is at least `split-width-threshold'
6141 columns wide and can be split horizontally, split WINDOW into two
6142 windows side by side and return the window on the right. If this
6143 can't be done either and WINDOW is the only window on its frame,
6144 try to split WINDOW vertically disregarding any value specified
6145 by `split-height-threshold'. If that succeeds, return the lower
6146 window. Return nil otherwise.
6148 By default `display-buffer' routines call this function to split
6149 the largest or least recently used window. To change the default
6150 customize the option `split-window-preferred-function'.
6152 You can enforce this function to not split WINDOW horizontally,
6153 by setting (or binding) the variable `split-width-threshold' to
6154 nil. If, in addition, you set `split-height-threshold' to zero,
6155 chances increase that this function does split WINDOW vertically.
6157 In order to not split WINDOW vertically, set (or bind) the
6158 variable `split-height-threshold' to nil. Additionally, you can
6159 set `split-width-threshold' to zero to make a horizontal split
6160 more likely to occur.
6162 Have a look at the function `window-splittable-p' if you want to
6163 know how `split-window-sensibly' determines whether WINDOW can be
6165 (let ((window (or window
(selected-window))))
6166 (or (and (window-splittable-p window
)
6167 ;; Split window vertically.
6168 (with-selected-window window
6169 (split-window-below)))
6170 (and (window-splittable-p window t
)
6171 ;; Split window horizontally.
6172 (with-selected-window window
6173 (split-window-right)))
6174 (and (eq window
(frame-root-window (window-frame window
)))
6175 (not (window-minibuffer-p window
))
6176 ;; If WINDOW is the only window on its frame and is not the
6177 ;; minibuffer window, try to split it vertically disregarding
6178 ;; the value of `split-height-threshold'.
6179 (let ((split-height-threshold 0))
6180 (when (window-splittable-p window
)
6181 (with-selected-window window
6182 (split-window-below))))))))
6184 (defun window--try-to-split-window (window &optional alist
)
6185 "Try to split WINDOW.
6186 Return value returned by `split-window-preferred-function' if it
6187 represents a live window, nil otherwise."
6188 (and (window-live-p window
)
6189 (not (frame-parameter (window-frame window
) 'unsplittable
))
6190 (let* ((window-combination-limit
6191 ;; When `window-combination-limit' equals
6192 ;; `display-buffer' or equals `resize-window' and a
6193 ;; `window-height' or `window-width' alist entry are
6194 ;; present, bind it to t so resizing steals space
6195 ;; preferably from the window that was split.
6196 (if (or (eq window-combination-limit
'display-buffer
)
6197 (and (eq window-combination-limit
'window-size
)
6198 (or (cdr (assq 'window-height alist
))
6199 (cdr (assq 'window-width alist
)))))
6201 window-combination-limit
))
6203 ;; Since `split-window-preferred-function' might
6204 ;; throw an error use `condition-case'.
6206 (funcall split-window-preferred-function window
)
6208 (and (window-live-p new-window
) new-window
))))
6210 (defun window--frame-usable-p (frame)
6211 "Return FRAME if it can be used to display a buffer."
6212 (when (frame-live-p frame
)
6213 (let ((window (frame-root-window frame
)))
6214 ;; `frame-root-window' may be an internal window which is considered
6215 ;; "dead" by `window-live-p'. Hence if `window' is not live we
6216 ;; implicitly know that `frame' has a visible window we can use.
6217 (unless (and (window-live-p window
)
6218 (or (window-minibuffer-p window
)
6219 ;; If the window is soft-dedicated, the frame is usable.
6220 ;; Actually, even if the window is really dedicated,
6221 ;; the frame is still usable by splitting it.
6222 ;; At least Emacs-22 allowed it, and it is desirable
6223 ;; when displaying same-frame windows.
6224 nil
; (eq t (window-dedicated-p window))
6228 (defcustom even-window-sizes t
6229 "If non-nil `display-buffer' will try to even window sizes.
6230 Otherwise `display-buffer' will leave the window configuration
6231 alone. Special values are `height-only' to even heights only and
6232 `width-only' to even widths only. Any other value means to even
6235 (const :tag
"Never" nil
)
6236 (const :tag
"Side-by-side windows only" width-only
)
6237 (const :tag
"Windows above or below only" height-only
)
6238 (const :tag
"Always" t
))
6241 (defvaralias 'even-window-heights
'even-window-sizes
)
6243 (defun window--even-window-sizes (window)
6244 "Even sizes of WINDOW and selected window.
6245 Even only if these windows are the only children of their parent,
6246 `even-window-sizes' has the appropriate value and the selected
6247 window is larger than WINDOW."
6248 (when (and (= (window-child-count (window-parent window
)) 2)
6249 (eq (window-parent) (window-parent window
)))
6251 ((and (not (memq even-window-sizes
'(nil height-only
)))
6252 (window-combined-p window t
)
6253 (> (window-total-width) (window-total-width window
)))
6256 (/ (- (window-total-width window
) (window-total-width)) 2) t
)
6258 ((and (not (memq even-window-sizes
'(nil width-only
)))
6259 (window-combined-p window
)
6260 (> (window-total-height) (window-total-height window
)))
6263 (/ (- (window-total-height window
) (window-total-height)) 2))
6266 (defun window--display-buffer (buffer window type
&optional alist dedicated
)
6267 "Display BUFFER in WINDOW.
6268 TYPE must be one of the symbols `reuse', `window' or `frame' and
6269 is passed unaltered to `display-buffer-record-window'. ALIST is
6270 the alist argument of `display-buffer'. Set `window-dedicated-p'
6271 to DEDICATED if non-nil. Return WINDOW if BUFFER and WINDOW are
6273 (when (and (buffer-live-p buffer
) (window-live-p window
))
6274 (display-buffer-record-window type window buffer
)
6275 (unless (eq buffer
(window-buffer window
))
6276 (set-window-dedicated-p window nil
)
6277 (set-window-buffer window buffer
)
6279 (set-window-dedicated-p window dedicated
))
6280 (when (memq type
'(window frame
))
6281 (set-window-prev-buffers window nil
)))
6282 (let ((parameter (window-parameter window
'quit-restore
))
6283 (height (cdr (assq 'window-height alist
)))
6284 (width (cdr (assq 'window-width alist
)))
6285 (size (cdr (assq 'window-size alist
)))
6286 (preserve-size (cdr (assq 'preserve-size alist
))))
6288 ((or (eq type
'frame
)
6289 (and (eq (car parameter
) 'same
)
6290 (eq (nth 1 parameter
) 'frame
)))
6291 ;; Adjust size of frame if asked for.
6295 (let ((width (car size
))
6297 (frame (window-frame window
)))
6298 (when (and (numberp width
) (numberp height
))
6300 frame
(+ (frame-height frame
)
6301 (- height
(window-total-height window
))))
6303 frame
(+ (frame-width frame
)
6304 (- width
(window-total-width window
)))))))
6306 (ignore-errors (funcall size window
)))))
6307 ((or (eq type
'window
)
6308 (and (eq (car parameter
) 'same
)
6309 (eq (nth 1 parameter
) 'window
)))
6310 ;; Adjust height of window if asked for.
6315 (if (integerp height
)
6318 (* (window-total-height (frame-root-window window
))
6320 (delta (- new-height
(window-total-height window
))))
6321 (when (and (window--resizable-p window delta nil
'safe
)
6322 (window-combined-p window
))
6323 (window-resize window delta nil
'safe
))))
6325 (ignore-errors (funcall height window
))))
6326 ;; Adjust width of window if asked for.
6331 (if (integerp width
)
6334 (* (window-total-width (frame-root-window window
))
6336 (delta (- new-width
(window-total-width window
))))
6337 (when (and (window--resizable-p window delta t
'safe
)
6338 (window-combined-p window t
))
6339 (window-resize window delta t
'safe
))))
6341 (ignore-errors (funcall width window
))))
6342 ;; Preserve window size if asked for.
6343 (when (consp preserve-size
)
6344 (window-preserve-size window t
(car preserve-size
))
6345 (window-preserve-size window nil
(cdr preserve-size
))))))
6349 (defun window--maybe-raise-frame (frame)
6350 (let ((visible (frame-visible-p frame
)))
6351 (unless (or (not visible
)
6352 ;; Assume the selected frame is already visible enough.
6353 (eq frame
(selected-frame))
6354 ;; Assume the frame from which we invoked the
6355 ;; minibuffer is visible.
6356 (and (minibuffer-window-active-p (selected-window))
6357 (eq frame
(window-frame (minibuffer-selected-window)))))
6358 (raise-frame frame
))))
6360 ;; FIXME: Not implemented.
6361 ;; FIXME: By the way, there could be more levels of dedication:
6362 ;; - `barely' dedicated doesn't prevent reuse of the window, only records that
6363 ;; the window hasn't been used for something else yet.
6364 ;; - `soft' (`softly') dedicated only allows reuse when asked explicitly.
6365 ;; - `strongly' never allows reuse.
6366 (defvar display-buffer-mark-dedicated nil
6367 "If non-nil, `display-buffer' marks the windows it creates as dedicated.
6368 The actual non-nil value of this variable will be copied to the
6369 `window-dedicated-p' flag.")
6371 (defconst display-buffer--action-function-custom-type
6372 '(choice :tag
"Function"
6373 (const :tag
"--" ignore
) ; default for insertion
6374 (const display-buffer-reuse-window
)
6375 (const display-buffer-pop-up-window
)
6376 (const display-buffer-same-window
)
6377 (const display-buffer-pop-up-frame
)
6378 (const display-buffer-below-selected
)
6379 (const display-buffer-at-bottom
)
6380 (const display-buffer-in-previous-window
)
6381 (const display-buffer-use-some-window
)
6382 (const display-buffer-use-some-frame
)
6383 (function :tag
"Other function"))
6384 "Custom type for `display-buffer' action functions.")
6386 (defconst display-buffer--action-custom-type
6387 `(cons :tag
"Action"
6388 (choice :tag
"Action functions"
6389 ,display-buffer--action-function-custom-type
6391 :tag
"List of functions"
6392 ,display-buffer--action-function-custom-type
))
6393 (alist :tag
"Action arguments"
6395 :value-type
(sexp :tag
"Value")))
6396 "Custom type for `display-buffer' actions.")
6398 (defvar display-buffer-overriding-action
'(nil . nil
)
6399 "Overriding action to perform to display a buffer.
6400 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
6401 function or a list of functions. Each function should accept two
6402 arguments: a buffer to display and an alist similar to ALIST.
6403 See `display-buffer' for details.")
6404 (put 'display-buffer-overriding-action
'risky-local-variable t
)
6406 (defcustom display-buffer-alist nil
6407 "Alist of conditional actions for `display-buffer'.
6408 This is a list of elements (CONDITION . ACTION), where:
6410 CONDITION is either a regexp matching buffer names, or a
6411 function that takes two arguments - a buffer name and the
6412 ACTION argument of `display-buffer' - and returns a boolean.
6414 ACTION is a cons cell (FUNCTION . ALIST), where FUNCTION is a
6415 function or a list of functions. Each such function should
6416 accept two arguments: a buffer to display and an alist of the
6417 same form as ALIST. See `display-buffer' for details.
6419 `display-buffer' scans this alist until it either finds a
6420 matching regular expression or the function specified by a
6421 condition returns non-nil. In any of these cases, it adds the
6422 associated action to the list of actions it will try."
6423 :type
`(alist :key-type
6424 (choice :tag
"Condition"
6426 (function :tag
"Matcher function"))
6427 :value-type
,display-buffer--action-custom-type
)
6432 (defcustom display-buffer-base-action
'(nil . nil
)
6433 "User-specified default action for `display-buffer'.
6434 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
6435 function or a list of functions. Each function should accept two
6436 arguments: a buffer to display and an alist similar to ALIST.
6437 See `display-buffer' for details."
6438 :type display-buffer--action-custom-type
6443 (defconst display-buffer-fallback-action
6444 '((display-buffer--maybe-same-window ;FIXME: why isn't this redundant?
6445 display-buffer-reuse-window
6446 display-buffer--maybe-pop-up-frame-or-window
6447 display-buffer-in-previous-window
6448 display-buffer-use-some-window
6449 ;; If all else fails, pop up a new frame.
6450 display-buffer-pop-up-frame
))
6451 "Default fallback action for `display-buffer'.
6452 This is the action used by `display-buffer' if no other actions
6453 specified, e.g. by the user options `display-buffer-alist' or
6454 `display-buffer-base-action'. See `display-buffer'.")
6455 (put 'display-buffer-fallback-action
'risky-local-variable t
)
6457 (defun display-buffer-assq-regexp (buffer-name alist action
)
6458 "Retrieve ALIST entry corresponding to BUFFER-NAME.
6459 ACTION is the action argument passed to `display-buffer'."
6461 (dolist (entry alist
)
6462 (let ((key (car entry
)))
6463 (when (or (and (stringp key
)
6464 (string-match-p key buffer-name
))
6465 (and (functionp key
)
6466 (funcall key buffer-name action
)))
6467 (throw 'match
(cdr entry
)))))))
6469 (defvar display-buffer--same-window-action
6470 '(display-buffer-same-window
6471 (inhibit-same-window . nil
))
6472 "A `display-buffer' action for displaying in the same window.")
6473 (put 'display-buffer--same-window-action
'risky-local-variable t
)
6475 (defvar display-buffer--other-frame-action
6476 '((display-buffer-reuse-window
6477 display-buffer-pop-up-frame
)
6478 (reusable-frames .
0)
6479 (inhibit-same-window . t
))
6480 "A `display-buffer' action for displaying in another frame.")
6481 (put 'display-buffer--other-frame-action
'risky-local-variable t
)
6483 (defun display-buffer (buffer-or-name &optional action frame
)
6484 "Display BUFFER-OR-NAME in some window, without selecting it.
6485 BUFFER-OR-NAME must be a buffer or the name of an existing
6486 buffer. Return the window chosen for displaying BUFFER-OR-NAME,
6487 or nil if no such window is found.
6489 Optional argument ACTION, if non-nil, should specify a display
6490 action. Its form is described below.
6492 Optional argument FRAME, if non-nil, acts like an additional
6493 ALIST entry (reusable-frames . FRAME) to the action list of ACTION,
6494 specifying the frame(s) to search for a window that is already
6495 displaying the buffer. See `display-buffer-reuse-window'.
6497 If ACTION is non-nil, it should have the form (FUNCTION . ALIST),
6498 where FUNCTION is either a function or a list of functions, and
6499 ALIST is an arbitrary association list (alist).
6501 Each such FUNCTION should accept two arguments: the buffer to
6502 display and an alist. Based on those arguments, it should
6503 display the buffer and return the window. If the caller is
6504 prepared to handle the case of not displaying the buffer
6505 and returning nil from `display-buffer' it should pass
6506 \(allow-no-window . t) as an element of the ALIST.
6508 The `display-buffer' function builds a function list and an alist
6509 by combining the functions and alists specified in
6510 `display-buffer-overriding-action', `display-buffer-alist', the
6511 ACTION argument, `display-buffer-base-action', and
6512 `display-buffer-fallback-action' (in order). Then it calls each
6513 function in the combined function list in turn, passing the
6514 buffer as the first argument and the combined alist as the second
6515 argument, until one of the functions returns non-nil.
6517 If ACTION is nil, the function list and the alist are built using
6518 only the other variables mentioned above.
6520 Available action functions include:
6521 `display-buffer-same-window'
6522 `display-buffer-reuse-window'
6523 `display-buffer-pop-up-frame'
6524 `display-buffer-pop-up-window'
6525 `display-buffer-in-previous-window'
6526 `display-buffer-use-some-window'
6527 `display-buffer-use-some-frame'
6529 Recognized alist entries include:
6531 `inhibit-same-window' -- A non-nil value prevents the same
6532 window from being used for display.
6534 `inhibit-switch-frame' -- A non-nil value prevents any other
6535 frame from being raised or selected,
6536 even if the window is displayed there.
6538 `reusable-frames' -- Value specifies frame(s) to search for a
6539 window that already displays the buffer.
6540 See `display-buffer-reuse-window'.
6542 `pop-up-frame-parameters' -- Value specifies an alist of frame
6543 parameters to give a new frame, if
6546 `window-height' -- Value specifies either an integer (the number
6547 of lines of a new window), a floating point number (the
6548 fraction of a new window with respect to the height of the
6549 frame's root window) or a function to be called with one
6550 argument - a new window. The function is supposed to adjust
6551 the height of the window; its return value is ignored.
6552 Suitable functions are `shrink-window-if-larger-than-buffer'
6553 and `fit-window-to-buffer'.
6555 `window-width' -- Value specifies either an integer (the number
6556 of columns of a new window), a floating point number (the
6557 fraction of a new window with respect to the width of the
6558 frame's root window) or a function to be called with one
6559 argument - a new window. The function is supposed to adjust
6560 the width of the window; its return value is ignored.
6562 `allow-no-window' -- A non-nil value indicates readiness for the case
6563 of not displaying the buffer and FUNCTION can safely return
6564 a non-window value to suppress displaying.
6566 `preserve-size' -- Value should be either (t . nil) to
6567 preserve the width of the window, (nil . t) to preserve its
6568 height or (t . t) to preserve both.
6570 The ACTION argument to `display-buffer' can also have a non-nil
6571 and non-list value. This means to display the buffer in a window
6572 other than the selected one, even if it is already displayed in
6573 the selected window. If called interactively with a prefix
6574 argument, ACTION is t."
6575 (interactive (list (read-buffer "Display buffer: " (other-buffer))
6576 (if current-prefix-arg t
)))
6577 (let ((buffer (if (bufferp buffer-or-name
)
6579 (get-buffer buffer-or-name
)))
6580 ;; Make sure that when we split windows the old window keeps
6581 ;; point, bug#14829.
6582 (split-window-keep-point t
)
6583 ;; Handle the old form of the first argument.
6584 (inhibit-same-window (and action
(not (listp action
)))))
6585 (unless (listp action
) (setq action nil
))
6586 (if display-buffer-function
6587 ;; If `display-buffer-function' is defined, let it do the job.
6588 (funcall display-buffer-function buffer inhibit-same-window
)
6589 ;; Otherwise, use the defined actions.
6591 (display-buffer-assq-regexp
6592 (buffer-name buffer
) display-buffer-alist action
))
6593 (special-action (display-buffer--special-action buffer
))
6594 ;; Extra actions from the arguments to this function:
6596 (cons nil
(append (if inhibit-same-window
6597 '((inhibit-same-window . t
)))
6599 `((reusable-frames .
,frame
))))))
6600 ;; Construct action function list and action alist.
6601 (actions (list display-buffer-overriding-action
6602 user-action special-action action extra-action
6603 display-buffer-base-action
6604 display-buffer-fallback-action
))
6605 (functions (apply 'append
6608 (if (functionp x
) (list x
) x
))
6610 (alist (apply 'append
(mapcar 'cdr actions
)))
6612 (unless (buffer-live-p buffer
)
6613 (error "Invalid buffer"))
6614 (while (and functions
(not window
))
6615 (setq window
(funcall (car functions
) buffer alist
)
6616 functions
(cdr functions
)))
6617 (and (windowp window
) window
)))))
6619 (defun display-buffer-other-frame (buffer)
6620 "Display buffer BUFFER preferably in another frame.
6621 This uses the function `display-buffer' as a subroutine; see
6622 its documentation for additional customization information."
6623 (interactive "BDisplay buffer in other frame: ")
6624 (display-buffer buffer display-buffer--other-frame-action t
))
6626 ;;; `display-buffer' action functions:
6628 (defun display-buffer-use-some-frame (buffer alist
)
6629 "Display BUFFER in an existing frame that meets a predicate
6630 \(by default any frame other than the current frame). If
6631 successful, return the window used; otherwise return nil.
6633 If ALIST has a non-nil `inhibit-switch-frame' entry, avoid
6636 If ALIST has a non-nil `frame-predicate' entry, its value is a
6637 function taking one argument (a frame), returning non-nil if the
6638 frame is a candidate; this function replaces the default
6641 If ALIST has a non-nil `inhibit-same-window' entry, avoid using
6642 the currently selected window (only useful with a frame-predicate
6643 that allows the selected frame)."
6644 (let* ((predicate (or (cdr (assq 'frame-predicate alist
))
6647 (not (eq frame
(selected-frame)))
6648 (not (window-dedicated-p
6650 (get-lru-window frame
)
6651 (frame-first-window frame
)))))
6653 (frame (car (filtered-frame-list predicate
)))
6654 (window (and frame
(get-lru-window frame nil
(cdr (assq 'inhibit-same-window alist
))))))
6657 (window--display-buffer
6658 buffer window
'frame alist display-buffer-mark-dedicated
)
6659 (unless (cdr (assq 'inhibit-switch-frame alist
))
6660 (window--maybe-raise-frame frame
))))
6663 (defun display-buffer-same-window (buffer alist
)
6664 "Display BUFFER in the selected window.
6665 This fails if ALIST has a non-nil `inhibit-same-window' entry, or
6666 if the selected window is a minibuffer window or is dedicated to
6667 another buffer; in that case, return nil. Otherwise, return the
6669 (unless (or (cdr (assq 'inhibit-same-window alist
))
6670 (window-minibuffer-p)
6671 (window-dedicated-p))
6672 (window--display-buffer buffer
(selected-window) 'reuse alist
)))
6674 (defun display-buffer--maybe-same-window (buffer alist
)
6675 "Conditionally display BUFFER in the selected window.
6676 If `same-window-p' returns non-nil for BUFFER's name, call
6677 `display-buffer-same-window' and return its value. Otherwise,
6679 (and (same-window-p (buffer-name buffer
))
6680 (display-buffer-same-window buffer alist
)))
6682 (defun display-buffer-reuse-window (buffer alist
)
6683 "Return a window that is already displaying BUFFER.
6684 Return nil if no usable window is found.
6686 If ALIST has a non-nil `inhibit-same-window' entry, the selected
6687 window is not eligible for reuse.
6689 If ALIST contains a `reusable-frames' entry, its value determines
6690 which frames to search for a reusable window:
6691 nil -- the selected frame (actually the last non-minibuffer frame)
6692 A frame -- just that frame
6693 `visible' -- all visible frames
6694 0 -- all frames on the current terminal
6697 If ALIST contains no `reusable-frames' entry, search just the
6698 selected frame if `display-buffer-reuse-frames' and
6699 `pop-up-frames' are both nil; search all frames on the current
6700 terminal if either of those variables is non-nil.
6702 If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
6703 event that a window on another frame is chosen, avoid raising
6705 (let* ((alist-entry (assq 'reusable-frames alist
))
6706 (frames (cond (alist-entry (cdr alist-entry
))
6707 ((if (eq pop-up-frames
'graphic-only
)
6711 (display-buffer-reuse-frames 0)
6712 (t (last-nonminibuffer-frame))))
6713 (window (if (and (eq buffer
(window-buffer))
6714 (not (cdr (assq 'inhibit-same-window alist
))))
6716 (car (delq (selected-window)
6717 (get-buffer-window-list buffer
'nomini
6719 (when (window-live-p window
)
6720 (prog1 (window--display-buffer buffer window
'reuse alist
)
6721 (unless (cdr (assq 'inhibit-switch-frame alist
))
6722 (window--maybe-raise-frame (window-frame window
)))))))
6724 (defun display-buffer--special-action (buffer)
6725 "Return special display action for BUFFER, if any.
6726 If `special-display-p' returns non-nil for BUFFER, return an
6727 appropriate display action involving `special-display-function'.
6728 See `display-buffer' for the format of display actions."
6729 (and special-display-function
6730 ;; `special-display-p' returns either t or a list of frame
6731 ;; parameters to pass to `special-display-function'.
6732 (let ((pars (special-display-p (buffer-name buffer
))))
6734 (list (list #'display-buffer-reuse-window
6735 `(lambda (buffer _alist
)
6736 (funcall special-display-function
6737 buffer
',(if (listp pars
) pars
)))))))))
6739 (defun display-buffer-pop-up-frame (buffer alist
)
6740 "Display BUFFER in a new frame.
6741 This works by calling `pop-up-frame-function'. If successful,
6742 return the window used; otherwise return nil.
6744 If ALIST has a non-nil `inhibit-switch-frame' entry, avoid
6745 raising the new frame.
6747 If ALIST has a non-nil `pop-up-frame-parameters' entry, the
6748 corresponding value is an alist of frame parameters to give the
6750 (let* ((params (cdr (assq 'pop-up-frame-parameters alist
)))
6751 (pop-up-frame-alist (append params pop-up-frame-alist
))
6752 (fun pop-up-frame-function
)
6755 ;; Make BUFFER current so `make-frame' will use it as the
6756 ;; new frame's buffer (Bug#15133).
6757 (with-current-buffer buffer
6758 (setq frame
(funcall fun
)))
6759 (setq window
(frame-selected-window frame
)))
6760 (prog1 (window--display-buffer
6761 buffer window
'frame alist display-buffer-mark-dedicated
)
6762 (unless (cdr (assq 'inhibit-switch-frame alist
))
6763 (window--maybe-raise-frame frame
))))))
6765 (defun display-buffer-pop-up-window (buffer alist
)
6766 "Display BUFFER by popping up a new window.
6767 The new window is created on the selected frame, or in
6768 `last-nonminibuffer-frame' if no windows can be created there.
6769 If successful, return the new window; otherwise return nil.
6771 If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
6772 event that the new window is created on another frame, avoid
6774 (let ((frame (or (window--frame-usable-p (selected-frame))
6775 (window--frame-usable-p (last-nonminibuffer-frame))))
6777 (when (and (or (not (frame-parameter frame
'unsplittable
))
6778 ;; If the selected frame cannot be split, look at
6779 ;; `last-nonminibuffer-frame'.
6780 (and (eq frame
(selected-frame))
6781 (setq frame
(last-nonminibuffer-frame))
6782 (window--frame-usable-p frame
)
6783 (not (frame-parameter frame
'unsplittable
))))
6784 ;; Attempt to split largest or least recently used window.
6785 (setq window
(or (window--try-to-split-window
6786 (get-largest-window frame t
) alist
)
6787 (window--try-to-split-window
6788 (get-lru-window frame t
) alist
))))
6789 (prog1 (window--display-buffer
6790 buffer window
'window alist display-buffer-mark-dedicated
)
6791 (unless (cdr (assq 'inhibit-switch-frame alist
))
6792 (window--maybe-raise-frame (window-frame window
)))))))
6794 (defun display-buffer--maybe-pop-up-frame-or-window (buffer alist
)
6795 "Try displaying BUFFER based on `pop-up-frames' or `pop-up-windows'.
6797 If `pop-up-frames' is non-nil (and not `graphic-only' on a
6798 text-only terminal), try with `display-buffer-pop-up-frame'.
6800 If that cannot be done, and `pop-up-windows' is non-nil, try
6801 again with `display-buffer-pop-up-window'."
6802 (or (and (if (eq pop-up-frames
'graphic-only
)
6805 (display-buffer-pop-up-frame buffer alist
))
6807 (display-buffer-pop-up-window buffer alist
))))
6809 (defun display-buffer-below-selected (buffer alist
)
6810 "Try displaying BUFFER in a window below the selected window.
6811 This either splits the selected window or reuses the window below
6814 (or (and (setq window
(window-in-direction 'below
))
6815 (eq buffer
(window-buffer window
))
6816 (window--display-buffer buffer window
'reuse alist
))
6817 (and (not (frame-parameter nil
'unsplittable
))
6818 (let ((split-height-threshold 0)
6819 split-width-threshold
)
6820 (setq window
(window--try-to-split-window (selected-window) alist
)))
6821 (window--display-buffer
6822 buffer window
'window alist display-buffer-mark-dedicated
))
6823 (and (setq window
(window-in-direction 'below
))
6824 (not (window-dedicated-p window
))
6825 (window--display-buffer
6826 buffer window
'reuse alist display-buffer-mark-dedicated
)))))
6828 (defun display-buffer-at-bottom (buffer alist
)
6829 "Try displaying BUFFER in a window at the bottom of the selected frame.
6830 This either reuses such a window provided it shows BUFFER
6831 already, splits a window at the bottom of the frame or the
6832 frame's root window, or reuses some window at the bottom of the
6834 (let (bottom-window bottom-window-shows-buffer window
)
6838 ((window-in-direction 'below window
))
6839 ((and (not bottom-window-shows-buffer
)
6840 (eq buffer
(window-buffer window
)))
6841 (setq bottom-window-shows-buffer t
)
6842 (setq bottom-window window
))
6843 ((not bottom-window
)
6844 (setq bottom-window window
)))
6846 (or (and bottom-window-shows-buffer
6847 (window--display-buffer
6848 buffer bottom-window
'reuse alist display-buffer-mark-dedicated
))
6849 (and (not (frame-parameter nil
'unsplittable
))
6850 (let (split-width-threshold)
6851 (setq window
(window--try-to-split-window bottom-window alist
)))
6852 (window--display-buffer
6853 buffer window
'window alist display-buffer-mark-dedicated
))
6854 (and (not (frame-parameter nil
'unsplittable
))
6857 (split-window (window--major-non-side-window))
6859 (window--display-buffer
6860 buffer window
'window alist display-buffer-mark-dedicated
))
6861 (and (setq window bottom-window
)
6862 (not (window-dedicated-p window
))
6863 (window--display-buffer
6864 buffer window
'reuse alist display-buffer-mark-dedicated
)))))
6866 (defun display-buffer-in-previous-window (buffer alist
)
6867 "Display BUFFER in a window previously showing it.
6868 If ALIST has a non-nil `inhibit-same-window' entry, the selected
6869 window is not eligible for reuse.
6871 If ALIST contains a `reusable-frames' entry, its value determines
6872 which frames to search for a reusable window:
6873 nil -- the selected frame (actually the last non-minibuffer frame)
6874 A frame -- just that frame
6875 `visible' -- all visible frames
6876 0 -- all frames on the current terminal
6879 If ALIST contains no `reusable-frames' entry, search just the
6880 selected frame if `display-buffer-reuse-frames' and
6881 `pop-up-frames' are both nil; search all frames on the current
6882 terminal if either of those variables is non-nil.
6884 If ALIST has a `previous-window' entry, the window specified by
6885 that entry will override any other window found by the methods
6886 above, even if that window never showed BUFFER before."
6887 (let* ((alist-entry (assq 'reusable-frames alist
))
6888 (inhibit-same-window
6889 (cdr (assq 'inhibit-same-window alist
)))
6891 (alist-entry (cdr alist-entry
))
6892 ((if (eq pop-up-frames
'graphic-only
)
6896 (display-buffer-reuse-frames 0)
6897 (t (last-nonminibuffer-frame))))
6898 best-window second-best-window window
)
6899 ;; Scan windows whether they have shown the buffer recently.
6901 (dolist (window (window-list-1 (frame-first-window) 'nomini frames
))
6902 (when (and (assq buffer
(window-prev-buffers window
))
6903 (not (window-dedicated-p window
)))
6904 (if (eq window
(selected-window))
6905 (unless inhibit-same-window
6906 (setq second-best-window window
))
6907 (setq best-window window
)
6909 ;; When ALIST has a `previous-window' entry, that entry may override
6910 ;; anything we found so far.
6911 (when (and (setq window
(cdr (assq 'previous-window alist
)))
6912 (window-live-p window
)
6913 (not (window-dedicated-p window
)))
6914 (if (eq window
(selected-window))
6915 (unless inhibit-same-window
6916 (setq second-best-window window
))
6917 (setq best-window window
)))
6918 ;; Return best or second best window found.
6919 (when (setq window
(or best-window second-best-window
))
6920 (window--display-buffer buffer window
'reuse alist
))))
6922 (defun display-buffer-use-some-window (buffer alist
)
6923 "Display BUFFER in an existing window.
6924 Search for a usable window, set that window to the buffer, and
6925 return the window. If no suitable window is found, return nil.
6927 If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
6928 event that a window in another frame is chosen, avoid raising
6930 (let* ((not-this-window (cdr (assq 'inhibit-same-window alist
)))
6931 (frame (or (window--frame-usable-p (selected-frame))
6932 (window--frame-usable-p (last-nonminibuffer-frame))))
6934 ;; Reuse an existing window.
6935 (or (get-lru-window frame nil not-this-window
)
6936 (let ((window (get-buffer-window buffer
'visible
)))
6937 (unless (and not-this-window
6938 (eq window
(selected-window)))
6940 (get-largest-window 'visible nil not-this-window
)
6941 (let ((window (get-buffer-window buffer
0)))
6942 (unless (and not-this-window
6943 (eq window
(selected-window)))
6945 (get-largest-window 0 nil not-this-window
)))
6946 (quit-restore (and (window-live-p window
)
6947 (window-parameter window
'quit-restore
)))
6948 (quad (nth 1 quit-restore
)))
6949 (when (window-live-p window
)
6950 ;; If the window was used by `display-buffer' before, try to
6951 ;; resize it to its old height but don't signal an error.
6952 (when (and (listp quad
)
6953 (integerp (nth 3 quad
))
6954 (> (nth 3 quad
) (window-total-height window
)))
6956 (window-resize window
(- (nth 3 quad
) (window-total-height window
)))
6960 (window--display-buffer buffer window
'reuse alist
)
6961 (window--even-window-sizes window
)
6962 (unless (cdr (assq 'inhibit-switch-frame alist
))
6963 (window--maybe-raise-frame (window-frame window
)))))))
6965 (defun display-buffer-no-window (_buffer alist
)
6966 "Display BUFFER in no window.
6967 If ALIST has a non-nil `allow-no-window' entry, then don't display
6968 a window at all. This makes possible to override the default action
6969 and avoid displaying the buffer. It is assumed that when the caller
6970 specifies a non-nil `allow-no-window' then it can handle a nil value
6971 returned from `display-buffer' in this case."
6972 (when (cdr (assq 'allow-no-window alist
))
6975 ;;; Display + selection commands:
6976 (defun pop-to-buffer (buffer &optional action norecord
)
6977 "Select buffer BUFFER in some window, preferably a different one.
6978 BUFFER may be a buffer, a string (a buffer name), or nil. If it
6979 is a string not naming an existent buffer, create a buffer with
6980 that name. If BUFFER is nil, choose some other buffer. Return
6983 This uses `display-buffer' as a subroutine. The optional ACTION
6984 argument is passed to `display-buffer' as its ACTION argument.
6985 See `display-buffer' for more information. ACTION is t if called
6986 interactively with a prefix argument, which means to pop to a
6987 window other than the selected one even if the buffer is already
6988 displayed in the selected window.
6990 If the window to show BUFFER is not on the selected
6991 frame, raise that window's frame and give it input focus.
6993 Optional third arg NORECORD non-nil means do not put this buffer
6994 at the front of the list of recently selected ones."
6995 (interactive (list (read-buffer "Pop to buffer: " (other-buffer))
6996 (if current-prefix-arg t
)))
6997 (setq buffer
(window-normalize-buffer-to-switch-to buffer
))
6998 ;; This should be done by `select-window' below.
6999 ;; (set-buffer buffer)
7000 (let* ((old-frame (selected-frame))
7001 (window (display-buffer buffer action
))
7002 (frame (window-frame window
)))
7003 ;; If we chose another frame, make sure it gets input focus.
7004 (unless (eq frame old-frame
)
7005 (select-frame-set-input-focus frame norecord
))
7006 ;; Make sure new window is selected (Bug#8615), (Bug#6954).
7007 (select-window window norecord
)
7010 (defun pop-to-buffer-same-window (buffer &optional norecord
)
7011 "Select buffer BUFFER in some window, preferably the same one.
7012 BUFFER may be a buffer, a string (a buffer name), or nil. If it
7013 is a string not naming an existent buffer, create a buffer with
7014 that name. If BUFFER is nil, choose some other buffer. Return
7017 Optional argument NORECORD, if non-nil means do not put this
7018 buffer at the front of the list of recently selected ones.
7020 Unlike `pop-to-buffer', this function prefers using the selected
7021 window over popping up a new window or frame."
7022 (pop-to-buffer buffer display-buffer--same-window-action norecord
))
7024 (defun read-buffer-to-switch (prompt)
7025 "Read the name of a buffer to switch to, prompting with PROMPT.
7026 Return the name of the buffer as a string.
7028 This function is intended for the `switch-to-buffer' family of
7029 commands since these need to omit the name of the current buffer
7030 from the list of completions and default values."
7031 (let ((rbts-completion-table (internal-complete-buffer-except)))
7032 (minibuffer-with-setup-hook
7034 (setq minibuffer-completion-table rbts-completion-table
)
7035 ;; Since rbts-completion-table is built dynamically, we
7036 ;; can't just add it to the default value of
7037 ;; icomplete-with-completion-tables, so we add it
7039 (if (and (boundp 'icomplete-with-completion-tables
)
7040 (listp icomplete-with-completion-tables
))
7041 (set (make-local-variable 'icomplete-with-completion-tables
)
7042 (cons rbts-completion-table
7043 icomplete-with-completion-tables
))))
7044 (read-buffer prompt
(other-buffer (current-buffer))
7045 (confirm-nonexistent-file-or-buffer)))))
7047 (defun window-normalize-buffer-to-switch-to (buffer-or-name)
7048 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
7049 If BUFFER-OR-NAME is nil, return the buffer returned by
7050 `other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
7051 exists, return that buffer. If no such buffer exists, create a
7052 buffer with the name BUFFER-OR-NAME and return that buffer."
7054 (or (get-buffer buffer-or-name
)
7055 (let ((buffer (get-buffer-create buffer-or-name
)))
7056 (set-buffer-major-mode buffer
)
7060 (defcustom switch-to-buffer-preserve-window-point nil
7061 "If non-nil, `switch-to-buffer' tries to preserve `window-point'.
7062 If this is nil, `switch-to-buffer' displays the buffer at that
7063 buffer's `point'. If this is `already-displayed', it tries to
7064 display the buffer at its previous position in the selected
7065 window, provided the buffer is currently displayed in some other
7066 window on any visible or iconified frame. If this is t, it
7067 unconditionally tries to display the buffer at its previous
7068 position in the selected window.
7070 This variable is ignored if the buffer is already displayed in
7071 the selected window or never appeared in it before, or if
7072 `switch-to-buffer' calls `pop-to-buffer' to display the buffer."
7074 (const :tag
"Never" nil
)
7075 (const :tag
"If already displayed elsewhere" already-displayed
)
7076 (const :tag
"Always" t
))
7080 (defcustom switch-to-buffer-in-dedicated-window nil
7081 "Allow switching to buffer in strongly dedicated windows.
7082 If non-nil, allow `switch-to-buffer' to proceed when called
7083 interactively and the selected window is strongly dedicated to
7086 The following values are recognized:
7088 nil - disallow switching; signal an error
7090 prompt - prompt user whether to allow switching
7092 pop - perform `pop-to-buffer' instead
7094 t - undedicate selected window and switch
7096 When called non-interactively, `switch-to-buffer' always signals
7097 an error when the selected window is dedicated to its buffer and
7098 FORCE-SAME-WINDOW is non-nil."
7100 (const :tag
"Disallow" nil
)
7101 (const :tag
"Prompt" prompt
)
7102 (const :tag
"Pop" pop
)
7103 (const :tag
"Allow" t
))
7107 (defun switch-to-buffer (buffer-or-name &optional norecord force-same-window
)
7108 "Display buffer BUFFER-OR-NAME in the selected window.
7110 WARNING: This is NOT the way to work on another buffer temporarily
7111 within a Lisp program! Use `set-buffer' instead. That avoids
7112 messing with the window-buffer correspondences.
7114 If the selected window cannot display the specified buffer
7115 because it is a minibuffer window or strongly dedicated to
7116 another buffer, call `pop-to-buffer' to select the buffer in
7117 another window. In interactive use, if the selected window is
7118 strongly dedicated to its buffer, the value of the option
7119 `switch-to-buffer-in-dedicated-window' specifies how to proceed.
7121 If called interactively, read the buffer name using the
7122 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
7123 determines whether to request confirmation before creating a new
7126 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or nil.
7127 If BUFFER-OR-NAME is a string that does not identify an existing
7128 buffer, create a buffer with that name. If BUFFER-OR-NAME is
7129 nil, switch to the buffer returned by `other-buffer'.
7131 If optional argument NORECORD is non-nil, do not put the buffer
7132 at the front of the buffer list, and do not make the window
7133 displaying it the most recently selected one.
7135 If optional argument FORCE-SAME-WINDOW is non-nil, the buffer
7136 must be displayed in the selected window when called
7137 non-interactively; if that is impossible, signal an error rather
7138 than calling `pop-to-buffer'.
7140 The option `switch-to-buffer-preserve-window-point' can be used
7141 to make the buffer appear at its last position in the selected
7144 Return the buffer switched to."
7146 (let ((force-same-window
7148 ((window-minibuffer-p) nil
)
7149 ((not (eq (window-dedicated-p) t
)) 'force-same-window
)
7150 ((pcase switch-to-buffer-in-dedicated-window
7152 "Cannot switch buffers in a dedicated window"))
7155 (format "Window is dedicated to %s; undedicate it"
7158 (set-window-dedicated-p nil nil
)
7161 "Cannot switch buffers in a dedicated window")))
7163 (_ (set-window-dedicated-p nil nil
) 'force-same-window
))))))
7164 (list (read-buffer-to-switch "Switch to buffer: ") nil force-same-window
)))
7165 (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name
)))
7167 ;; Don't call set-window-buffer if it's not needed since it
7168 ;; might signal an error (e.g. if the window is dedicated).
7169 ((eq buffer
(window-buffer)))
7170 ((window-minibuffer-p)
7171 (if force-same-window
7172 (user-error "Cannot switch buffers in minibuffer window")
7173 (pop-to-buffer buffer norecord
)))
7174 ((eq (window-dedicated-p) t
)
7175 (if force-same-window
7176 (user-error "Cannot switch buffers in a dedicated window")
7177 (pop-to-buffer buffer norecord
)))
7179 (let* ((entry (assq buffer
(window-prev-buffers)))
7180 (displayed (and (eq switch-to-buffer-preserve-window-point
7182 (get-buffer-window buffer
0))))
7183 (set-window-buffer nil buffer
)
7185 (or (eq switch-to-buffer-preserve-window-point t
)
7187 ;; Try to restore start and point of buffer in the selected
7188 ;; window (Bug#4041).
7189 (set-window-start (selected-window) (nth 1 entry
) t
)
7190 (set-window-point nil
(nth 2 entry
))))))
7193 (select-window (selected-window)))
7194 (set-buffer buffer
)))
7196 (defun switch-to-buffer-other-window (buffer-or-name &optional norecord
)
7197 "Select the buffer specified by BUFFER-OR-NAME in another window.
7198 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
7199 nil. Return the buffer switched to.
7201 If called interactively, prompt for the buffer name using the
7202 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
7203 determines whether to request confirmation before creating a new
7206 If BUFFER-OR-NAME is a string and does not identify an existing
7207 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
7208 nil, switch to the buffer returned by `other-buffer'.
7210 Optional second argument NORECORD non-nil means do not put this
7211 buffer at the front of the list of recently selected ones.
7213 This uses the function `display-buffer' as a subroutine; see its
7214 documentation for additional customization information."
7216 (list (read-buffer-to-switch "Switch to buffer in other window: ")))
7217 (let ((pop-up-windows t
))
7218 (pop-to-buffer buffer-or-name t norecord
)))
7220 (defun switch-to-buffer-other-frame (buffer-or-name &optional norecord
)
7221 "Switch to buffer BUFFER-OR-NAME in another frame.
7222 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
7223 nil. Return the buffer switched to.
7225 If called interactively, prompt for the buffer name using the
7226 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
7227 determines whether to request confirmation before creating a new
7230 If BUFFER-OR-NAME is a string and does not identify an existing
7231 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
7232 nil, switch to the buffer returned by `other-buffer'.
7234 Optional second arg NORECORD non-nil means do not put this
7235 buffer at the front of the list of recently selected ones.
7237 This uses the function `display-buffer' as a subroutine; see its
7238 documentation for additional customization information."
7240 (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
7241 (pop-to-buffer buffer-or-name display-buffer--other-frame-action norecord
))
7243 (defun set-window-text-height (window height
)
7244 "Set the height in lines of the text display area of WINDOW to HEIGHT.
7245 WINDOW must be a live window and defaults to the selected one.
7246 HEIGHT doesn't include the mode line or header line, if any, or
7247 any partial-height lines in the text display area.
7249 Note that the current implementation of this function cannot
7250 always set the height exactly, but attempts to be conservative,
7251 by allocating more lines than are actually needed in the case
7252 where some error may be present."
7253 (setq window
(window-normalize-window window t
))
7254 (let ((delta (- height
(window-text-height window
))))
7255 (unless (zerop delta
)
7256 ;; Setting window-min-height to a value like 1 can lead to very
7257 ;; bizarre displays because it also allows Emacs to make *other*
7258 ;; windows one line tall, which means that there's no more space
7259 ;; for the mode line.
7260 (let ((window-min-height (min 2 height
)))
7261 (window-resize window delta
)))))
7263 (defun enlarge-window-horizontally (delta)
7264 "Make selected window DELTA columns wider.
7265 Interactively, if no argument is given, make selected window one
7268 (enlarge-window delta t
))
7270 (defun shrink-window-horizontally (delta)
7271 "Make selected window DELTA columns narrower.
7272 Interactively, if no argument is given, make selected window one
7275 (shrink-window delta t
))
7277 (defun count-screen-lines (&optional beg end count-final-newline window
)
7278 "Return the number of screen lines in the region.
7279 The number of screen lines may be different from the number of actual lines,
7280 due to line breaking, display table, etc.
7282 Optional arguments BEG and END default to `point-min' and `point-max'
7285 If region ends with a newline, ignore it unless optional third argument
7286 COUNT-FINAL-NEWLINE is non-nil.
7288 The optional fourth argument WINDOW specifies the window used for obtaining
7289 parameters such as width, horizontal scrolling, and so on. The default is
7290 to use the selected window's parameters.
7292 Like `vertical-motion', `count-screen-lines' always uses the current buffer,
7293 regardless of which buffer is displayed in WINDOW. This makes possible to use
7294 `count-screen-lines' in any buffer, whether or not it is currently displayed
7297 (setq beg
(point-min)))
7299 (setq end
(point-max)))
7305 (narrow-to-region (min beg end
)
7306 (if (and (not count-final-newline
)
7307 (= ?
\n (char-before (max beg end
))))
7310 (goto-char (point-min))
7311 (1+ (vertical-motion (buffer-size) window
))))))
7313 (defun window-buffer-height (window)
7314 "Return the height (in screen lines) of the buffer that WINDOW is displaying.
7315 WINDOW must be a live window and defaults to the selected one."
7316 (setq window
(window-normalize-window window t
))
7317 (with-current-buffer (window-buffer window
)
7319 (count-screen-lines (point-min) (point-max)
7320 ;; If buffer ends with a newline, ignore it when
7321 ;; counting height unless point is after it.
7325 ;;; Resizing windows and frames to fit their contents exactly.
7326 (defcustom fit-window-to-buffer-horizontally nil
7327 "Non-nil means `fit-window-to-buffer' can resize windows horizontally.
7328 If this is nil, `fit-window-to-buffer' never resizes windows
7329 horizontally. If this is `only', it can resize windows
7330 horizontally only. Any other value means `fit-window-to-buffer'
7331 can resize windows in both dimensions."
7336 ;; `fit-frame-to-buffer' eventually wants to know the real frame sizes
7337 ;; counting title bar and outer borders.
7338 (defcustom fit-frame-to-buffer nil
7339 "Non-nil means `fit-window-to-buffer' can fit a frame to its buffer.
7340 A frame is fit if and only if its root window is a live window
7341 and this option is non-nil. If this is `horizontally', frames
7342 are resized horizontally only. If this is `vertically', frames
7343 are resized vertically only. Any other non-nil value means
7344 frames can be resized in both dimensions."
7349 (defcustom fit-frame-to-buffer-margins
'(nil nil nil nil
)
7350 "Margins around frame for `fit-frame-to-buffer'.
7351 This specifies the numbers of pixels to be left free on the left,
7352 above, on the right, and below a frame fitted to its buffer. Set
7353 this to avoid obscuring other desktop objects like the taskbar.
7354 The default is nil for each side, which means to not add margins.
7356 The value specified here can be overridden for a specific frame
7357 by that frame's `fit-frame-to-buffer-margins' parameter, if
7358 present. See also `fit-frame-to-buffer-sizes'."
7364 :format
"%[LeftMargin%] %v "
7365 (const :tag
"None" :format
"%t" nil
)
7366 (integer :tag
"Pixels" :size
5))
7370 :format
"%[TopMargin%] %v "
7371 (const :tag
"None" :format
"%t" nil
)
7372 (integer :tag
"Pixels" :size
5))
7376 :format
"%[RightMargin%] %v "
7377 (const :tag
"None" :format
"%t" nil
)
7378 (integer :tag
"Pixels" :size
5))
7382 :format
"%[BottomMargin%] %v "
7383 (const :tag
"None" :format
"%t" nil
)
7384 (integer :tag
"Pixels" :size
5)))
7387 (defcustom fit-frame-to-buffer-sizes
'(nil nil nil nil
)
7388 "Size boundaries of frame for `fit-frame-to-buffer'.
7389 This list specifies the total maximum and minimum lines and
7390 maximum and minimum columns of the root window of any frame that
7391 shall be fit to its buffer. If any of these values is non-nil,
7392 it overrides the corresponding argument of `fit-frame-to-buffer'.
7394 On window systems where the menubar can wrap, fitting a frame to
7395 its buffer may swallow the last line(s). Specifying an
7396 appropriate minimum width value here can avoid such wrapping.
7398 See also `fit-frame-to-buffer-margins'."
7402 :tag
"Maximum Height"
7404 :format
"%[MaxHeight%] %v "
7405 (const :tag
"None" :format
"%t" nil
)
7406 (integer :tag
"Lines" :size
5))
7408 :tag
"Minimum Height"
7410 :format
"%[MinHeight%] %v "
7411 (const :tag
"None" :format
"%t" nil
)
7412 (integer :tag
"Lines" :size
5))
7414 :tag
"Maximum Width"
7416 :format
"%[MaxWidth%] %v "
7417 (const :tag
"None" :format
"%t" nil
)
7418 (integer :tag
"Columns" :size
5))
7420 :tag
"Minimum Width"
7422 :format
"%[MinWidth%] %v\n"
7423 (const :tag
"None" :format
"%t" nil
)
7424 (integer :tag
"Columns" :size
5)))
7427 (declare-function x-display-pixel-height
"xfns.c" (&optional terminal
))
7429 (defun window--sanitize-margin (margin left right
)
7430 "Return MARGIN if it's a number between LEFT and RIGHT."
7431 (when (and (numberp margin
)
7432 (<= left
(- right margin
)) (<= margin right
))
7435 (declare-function tool-bar-height
"xdisp.c" (&optional frame pixelwise
))
7437 (defun fit-frame-to-buffer (&optional frame max-height min-height max-width min-width only
)
7438 "Adjust size of FRAME to display the contents of its buffer exactly.
7439 FRAME can be any live frame and defaults to the selected one.
7440 Fit only if FRAME's root window is live. MAX-HEIGHT, MIN-HEIGHT,
7441 MAX-WIDTH and MIN-WIDTH specify bounds on the new total size of
7442 FRAME's root window. MIN-HEIGHT and MIN-WIDTH default to the values of
7443 `window-min-height' and `window-min-width' respectively.
7445 If the optional argument ONLY is `vertically', resize the frame
7446 vertically only. If ONLY is `horizontally', resize the frame
7449 The new position and size of FRAME can be additionally determined
7450 by customizing the options `fit-frame-to-buffer-sizes' and
7451 `fit-frame-to-buffer-margins' or the corresponding parameters of
7454 (unless (and (fboundp 'x-display-pixel-height
)
7455 ;; We need the respective sizes now.
7456 (fboundp 'display-monitor-attributes-list
))
7457 (user-error "Cannot resize frame in non-graphic Emacs"))
7458 (setq frame
(window-normalize-frame frame
))
7459 (when (window-live-p (frame-root-window frame
))
7460 (with-selected-window (frame-root-window frame
)
7461 (let* ((window (frame-root-window frame
))
7462 (char-width (frame-char-width))
7463 (char-height (frame-char-height))
7464 (monitor-attributes (car (display-monitor-attributes-list
7465 (frame-parameter frame
'display
))))
7466 (geometry (cdr (assq 'geometry monitor-attributes
)))
7467 (display-width (- (nth 2 geometry
) (nth 0 geometry
)))
7468 (display-height (- (nth 3 geometry
) (nth 1 geometry
)))
7469 (workarea (cdr (assq 'workarea monitor-attributes
)))
7471 (margins (or (frame-parameter frame
'fit-frame-to-buffer-margins
)
7472 fit-frame-to-buffer-margins
))
7473 (left-margin (if (nth 0 margins
)
7474 (or (window--sanitize-margin
7475 (nth 0 margins
) 0 display-width
)
7478 (top-margin (if (nth 1 margins
)
7479 (or (window--sanitize-margin
7480 (nth 1 margins
) 0 display-height
)
7483 (workarea-width (nth 2 workarea
))
7484 (right-margin (if (nth 2 margins
)
7486 (or (window--sanitize-margin
7487 (nth 2 margins
) left-margin display-width
)
7490 (workarea-height (nth 3 workarea
))
7491 (bottom-margin (if (nth 3 margins
)
7493 (or (window--sanitize-margin
7494 (nth 3 margins
) top-margin display-height
)
7497 ;; The pixel width of FRAME (which does not include the
7498 ;; window manager's decorations).
7499 (frame-width (frame-pixel-width))
7500 ;; The pixel width of the body of FRAME's root window.
7501 (window-body-width (window-body-width nil t
))
7502 ;; The difference in pixels between total and body width of
7504 (window-extra-width (- (window-pixel-width) window-body-width
))
7505 ;; The difference in pixels between the frame's pixel width
7506 ;; and the window's body width. This is the space we can't
7508 (extra-width (- frame-width window-body-width
))
7509 ;; The maximum width we can use for fitting.
7510 (fit-width (- workarea-width extra-width
))
7511 ;; The pixel position of FRAME's left border. We usually
7512 ;; try to leave this alone.
7514 (let ((left (frame-parameter nil
'left
)))
7516 (funcall (car left
) (cadr left
))
7518 ;; The pixel height of FRAME (which does not include title
7519 ;; line, decorations, and sometimes neither the menu nor
7521 (frame-height (frame-pixel-height))
7522 ;; The pixel height of FRAME's root window (we don't care
7523 ;; about the window's body height since the return value of
7524 ;; `window-text-pixel-size' includes header and mode line).
7525 (window-height (window-pixel-height))
7526 ;; The difference in pixels between the frame's pixel
7527 ;; height and the window's height.
7528 (extra-height (- frame-height window-height
))
7529 ;; When tool-bar-mode is enabled and we just created a new
7530 ;; frame, reserve lines for toolbar resizing. Needed
7531 ;; because for reasons unknown to me Emacs (1) reserves one
7532 ;; line for the toolbar when making the initial frame and
7533 ;; toolbars are enabled, and (2) later adds the remaining
7534 ;; lines needed. Our code runs IN BETWEEN (1) and (2).
7535 ;; YMMV when you're on a system that behaves differently.
7536 (toolbar-extra-height
7537 (let ((quit-restore (window-parameter window
'quit-restore
))
7538 ;; This may have to change when we allow arbitrary
7539 ;; pixel height toolbars.
7540 (lines (tool-bar-height)))
7542 (if (and quit-restore
(eq (car quit-restore
) 'frame
)
7543 (not (zerop lines
)))
7546 ;; The pixel position of FRAME's top border.
7548 (let ((top (frame-parameter nil
'top
)))
7550 (funcall (car top
) (cadr top
))
7552 ;; Sanitize minimum and maximum sizes.
7553 (sizes (or (frame-parameter frame
'fit-frame-to-buffer-sizes
)
7554 fit-frame-to-buffer-sizes
))
7557 ((numberp (nth 0 sizes
)) (* (nth 0 sizes
) char-height
))
7558 ((numberp max-height
) (* max-height char-height
))
7559 (t display-height
)))
7562 ((numberp (nth 1 sizes
)) (* (nth 1 sizes
) char-height
))
7563 ((numberp min-height
) (* min-height char-height
))
7564 (t (* window-min-height char-height
))))
7567 ((numberp (nth 2 sizes
))
7568 (- (* (nth 2 sizes
) char-width
) window-extra-width
))
7569 ((numberp max-width
)
7570 (- (* max-width char-width
) window-extra-width
))
7574 ((numberp (nth 3 sizes
))
7575 (- (* (nth 3 sizes
) char-width
) window-extra-width
))
7576 ((numberp min-width
)
7577 (- (* min-width char-width
) window-extra-width
))
7578 (t (* window-min-width char-width
))))
7579 ;; Note: Currently, for a new frame the sizes of the header
7580 ;; and mode line may be estimated incorrectly
7581 (value (window-text-pixel-size
7582 nil t t workarea-width workarea-height t
))
7583 (width (+ (car value
) (window-right-divider-width)))
7586 (window-bottom-divider-width)
7587 (window-scroll-bar-height))))
7588 ;; Don't change height or width when the window's size is fixed
7589 ;; in either direction or ONLY forbids it.
7591 ((or (eq window-size-fixed
'width
) (eq only
'vertically
))
7593 ((or (eq window-size-fixed
'height
) (eq only
'horizontally
))
7595 ;; Fit width to constraints.
7597 (unless frame-resize-pixelwise
7598 ;; Round to character sizes.
7599 (setq width
(* (/ (+ width char-width -
1) char-width
)
7601 ;; Fit to maximum and minimum widths.
7602 (setq width
(max (min width max-width
) min-width
))
7604 (setq width
(+ width extra-width
))
7605 ;; Preserve margins.
7606 (let ((right (+ left width
)))
7608 ((> right right-margin
)
7609 ;; Move frame to left (we don't know its real width).
7610 (setq left
(max left-margin
(- left
(- right right-margin
)))))
7611 ((< left left-margin
)
7612 ;; Move frame to right.
7613 (setq left left-margin
)))))
7614 ;; Fit height to constraints.
7616 (unless frame-resize-pixelwise
7617 (setq height
(* (/ (+ height char-height -
1) char-height
)
7619 ;; Fit to maximum and minimum heights.
7620 (setq height
(max (min height max-height
) min-height
))
7621 ;; Add extra height.
7622 (setq height
(+ height extra-height
))
7623 ;; Preserve margins.
7624 (let ((bottom (+ top height
)))
7626 ((> bottom bottom-margin
)
7627 ;; Move frame up (we don't know its real height).
7628 (setq top
(max top-margin
(- top
(- bottom bottom-margin
)))))
7631 (setq top top-margin
)))))
7633 (set-frame-position frame left top
)
7634 ;; Clumsily try to translate our calculations to what
7635 ;; `set-frame-size' wants.
7637 (setq width
(- (+ (frame-text-width) width
)
7638 extra-width window-body-width
)))
7640 (setq height
(- (+ (frame-text-height) height
)
7641 extra-height window-height
)))
7645 (if frame-resize-pixelwise
7647 (/ width char-width
))
7650 (if frame-resize-pixelwise
7652 (/ height char-height
))
7653 (frame-text-height))
7654 frame-resize-pixelwise
)))))
7656 (defun fit-window-to-buffer (&optional window max-height min-height max-width min-width preserve-size
)
7657 "Adjust size of WINDOW to display its buffer's contents exactly.
7658 WINDOW must be a live window and defaults to the selected one.
7660 If WINDOW is part of a vertical combination, adjust WINDOW's
7661 height. The new height is calculated from the actual height of
7662 the accessible portion of its buffer. The optional argument
7663 MAX-HEIGHT specifies a maximum height and defaults to the height
7664 of WINDOW's frame. The optional argument MIN-HEIGHT specifies a
7665 minimum height and defaults to `window-min-height'. Both
7666 MAX-HEIGHT and MIN-HEIGHT are specified in lines and include mode
7667 and header line and a bottom divider, if any.
7669 If WINDOW is part of a horizontal combination and the value of
7670 the option `fit-window-to-buffer-horizontally' is non-nil, adjust
7671 WINDOW's width. The new width of WINDOW is calculated from the
7672 maximum length of its buffer's lines that follow the current
7673 start position of WINDOW. The optional argument MAX-WIDTH
7674 specifies a maximum width and defaults to the width of WINDOW's
7675 frame. The optional argument MIN-WIDTH specifies a minimum width
7676 and defaults to `window-min-width'. Both MAX-WIDTH and MIN-WIDTH
7677 are specified in columns and include fringes, margins, a
7678 scrollbar and a vertical divider, if any.
7680 If the optional argument `preserve-size' is non-nil, preserve the
7681 size of WINDOW (see `window-preserve-size').
7683 Fit pixelwise if the option `window-resize-pixelwise' is non-nil.
7684 If WINDOW is its frame's root window and the option
7685 `fit-frame-to-buffer' is non-nil, call `fit-frame-to-buffer' to
7686 adjust the frame's size.
7688 Note that even if this function makes WINDOW large enough to show
7689 _all_ parts of its buffer you might not see the first part when
7690 WINDOW was scrolled. If WINDOW is resized horizontally, you will
7691 not see the top of its buffer unless WINDOW starts at its minimum
7692 accessible position."
7694 (setq window
(window-normalize-window window t
))
7695 (if (eq window
(frame-root-window window
))
7696 (when fit-frame-to-buffer
7697 ;; Fit WINDOW's frame to buffer.
7698 (fit-frame-to-buffer
7699 (window-frame window
)
7700 max-height min-height max-width min-width
7701 (and (memq fit-frame-to-buffer
'(vertically horizontally
))
7702 fit-frame-to-buffer
)))
7703 (with-selected-window window
7704 (let* ((pixelwise window-resize-pixelwise
)
7705 (char-height (frame-char-height))
7706 (char-width (frame-char-width))
7707 (total-height (window-size window nil pixelwise
))
7708 (body-height (window-body-height window pixelwise
))
7709 (body-width (window-body-width window pixelwise
))
7711 ;; Sanitize MIN-HEIGHT.
7712 (if (numberp min-height
)
7713 ;; Can't get smaller than `window-safe-min-height'.
7715 (* char-height min-height
)
7718 (window-safe-min-pixel-height window
)
7719 window-safe-min-height
))
7720 ;; Preserve header and mode line if present.
7722 (* char-height window-min-height
)
7724 (window-min-size window nil window pixelwise
))))
7726 ;; Sanitize MAX-HEIGHT.
7727 (if (numberp max-height
)
7731 window nil window nil nil nil pixelwise
))
7733 (* char-height max-height
)
7735 (+ total-height
(window-max-delta
7736 window nil window nil nil nil pixelwise
))))
7739 ;; If WINDOW is vertically combined, try to resize it
7741 ((and (not (eq fit-window-to-buffer-horizontally
'only
))
7742 (not (window-size-fixed-p window
'preserved
))
7743 (window-combined-p))
7744 ;; Vertically we always want to fit the entire buffer.
7745 ;; WINDOW'S height can't get larger than its frame's pixel
7746 ;; height. Its width remains fixed.
7747 (setq height
(+ (cdr (window-text-pixel-size
7748 nil nil t nil
(frame-pixel-height) t
))
7749 (window-scroll-bar-height window
)
7750 (window-bottom-divider-width)))
7753 (setq height
(/ (+ height char-height -
1) char-height
)))
7754 (unless (= height total-height
)
7755 (window-preserve-size window
)
7756 (window-resize-no-error
7758 (- (max min-height
(min max-height height
)) total-height
)
7759 nil window pixelwise
)
7761 (window-preserve-size window nil t
))))
7762 ;; If WINDOW is horizontally combined, try to resize it
7764 ((and fit-window-to-buffer-horizontally
7765 (not (window-size-fixed-p window t
'preserved
))
7766 (window-combined-p nil t
))
7767 (let* ((total-width (window-size window t pixelwise
))
7769 ;; Sanitize MIN-WIDTH.
7770 (if (numberp min-width
)
7771 ;; Can't get smaller than `window-safe-min-width'.
7773 (* char-width min-width
)
7776 (window-safe-min-pixel-width)
7777 window-safe-min-width
))
7778 ;; Preserve fringes, margins, scrollbars if present.
7780 (* char-width window-min-width
)
7782 (window-min-size nil nil window pixelwise
))))
7784 ;; Sanitize MAX-WIDTH.
7785 (if (numberp max-width
)
7788 window t window nil nil nil pixelwise
))
7790 (* char-width max-width
)
7792 (+ total-width
(window-max-delta
7793 window t window nil nil nil pixelwise
))))
7794 ;; When fitting horizontally, assume that WINDOW's
7795 ;; start position remains unaltered. WINDOW can't get
7796 ;; wider than its frame's pixel width, its height
7797 ;; remains unaltered.
7798 (width (+ (car (window-text-pixel-size
7799 nil
(window-start) (point-max)
7801 ;; Add one char-height to assure that
7802 ;; we're on the safe side. This
7803 ;; overshoots when the first line below
7804 ;; the bottom is wider than the window.
7806 (if pixelwise
1 char-height
))))
7807 (window-right-divider-width))))
7809 (setq width
(/ (+ width char-width -
1) char-width
)))
7810 (unless (= width body-width
)
7811 (window-preserve-size window t
)
7812 (window-resize-no-error
7816 (+ total-width
(- width body-width
))))
7820 (window-preserve-size window t t
))))))))))
7822 (defun window-safely-shrinkable-p (&optional window
)
7823 "Return t if WINDOW can be shrunk without shrinking other windows.
7824 WINDOW defaults to the selected window."
7825 (with-selected-window (or window
(selected-window))
7826 (let ((edges (window-edges)))
7827 (or (= (nth 2 edges
) (nth 2 (window-edges (previous-window))))
7828 (= (nth 0 edges
) (nth 0 (window-edges (next-window))))))))
7830 (defun shrink-window-if-larger-than-buffer (&optional window
)
7831 "Shrink height of WINDOW if its buffer doesn't need so many lines.
7832 More precisely, shrink WINDOW vertically to be as small as
7833 possible, while still showing the full contents of its buffer.
7834 WINDOW must be a live window and defaults to the selected one.
7836 Do not shrink WINDOW to less than `window-min-height' lines. Do
7837 nothing if the buffer contains more lines than the present window
7838 height, or if some of the window's contents are scrolled out of
7839 view, or if shrinking this window would also shrink another
7840 window, or if the window is the only window of its frame.
7842 Return non-nil if the window was shrunk, nil otherwise."
7844 (setq window
(window-normalize-window window t
))
7845 ;; Make sure that WINDOW is vertically combined and `point-min' is
7846 ;; visible (for whatever reason that's needed). The remaining issues
7847 ;; should be taken care of by `fit-window-to-buffer'.
7848 (when (and (window-combined-p window
)
7849 (pos-visible-in-window-p (point-min) window
))
7850 (fit-window-to-buffer window
(window-total-height window
))))
7852 (defun kill-buffer-and-window ()
7853 "Kill the current buffer and delete the selected window."
7855 (let ((window-to-delete (selected-window))
7856 (buffer-to-kill (current-buffer))
7857 (delete-window-hook (lambda () (ignore-errors (delete-window)))))
7860 (add-hook 'kill-buffer-hook delete-window-hook t t
)
7861 (if (kill-buffer (current-buffer))
7862 ;; If `delete-window' failed before, we rerun it to regenerate
7863 ;; the error so it can be seen in the echo area.
7864 (when (eq (selected-window) window-to-delete
)
7866 ;; If the buffer is not dead for some reason (probably because
7867 ;; of a `quit' signal), remove the hook again.
7869 (with-current-buffer buffer-to-kill
7870 (remove-hook 'kill-buffer-hook delete-window-hook t
))))))
7874 ;; Groups of windows (Follow Mode).
7876 ;; This section of functions extends the functionality of some window
7877 ;; manipulating commands to groups of windows cooperatively
7878 ;; displaying a buffer, typically with Follow Mode.
7880 ;; The xxx-function variables are permanent locals so that their local
7881 ;; status is undone only when explicitly programmed, not when a buffer
7882 ;; is reverted or a mode function is called.
7884 (defvar window-group-start-function nil
)
7885 (make-variable-buffer-local 'window-group-start-function
)
7886 (put 'window-group-start-function
'permanent-local t
)
7887 (defun window-group-start (&optional window
)
7888 "Return position at which display currently starts in the group of
7889 windows containing WINDOW. When a grouping mode (such as Follow Mode)
7890 is not active, this function is identical to `window-start'.
7892 WINDOW must be a live window and defaults to the selected one.
7893 This is updated by redisplay or by calling `set-window*-start'."
7894 (if (functionp window-group-start-function
)
7895 (funcall window-group-start-function window
)
7896 (window-start window
)))
7898 (defvar window-group-end-function nil
)
7899 (make-variable-buffer-local 'window-group-end-function
)
7900 (put 'window-group-end-function
'permanent-local t
)
7901 (defun window-group-end (&optional window update
)
7902 "Return position at which display currently ends in the group of
7903 windows containing WINDOW. When a grouping mode (such as Follow Mode)
7904 is not active, this function is identical to `window-end'.
7906 WINDOW must be a live window and defaults to the selected one.
7907 This is updated by redisplay, when it runs to completion.
7908 Simply changing the buffer text or setting `window-group-start'
7909 does not update this value.
7910 Return nil if there is no recorded value. (This can happen if the
7911 last redisplay of WINDOW was preempted, and did not finish.)
7912 If UPDATE is non-nil, compute the up-to-date position
7913 if it isn't already recorded."
7914 (if (functionp window-group-end-function
)
7915 (funcall window-group-end-function window update
)
7916 (window-end window update
)))
7918 (defvar set-window-group-start-function nil
)
7919 (make-variable-buffer-local 'set-window-group-start-function
)
7920 (put 'set-window-group-start-function
'permanent-local t
)
7921 (defun set-window-group-start (window pos
&optional noforce
)
7922 "Make display in the group of windows containing WINDOW start at
7923 position POS in WINDOW's buffer. When a grouping mode (such as Follow
7924 Mode) is not active, this function is identical to `set-window-start'.
7926 WINDOW must be a live window and defaults to the selected one. Return
7927 POS. Optional third arg NOFORCE non-nil inhibits next redisplay from
7928 overriding motion of point in order to display at this exact start."
7929 (if (functionp set-window-group-start-function
)
7930 (funcall set-window-group-start-function window pos noforce
)
7931 (set-window-start window pos noforce
)))
7933 (defvar recenter-window-group-function nil
)
7934 (make-variable-buffer-local 'recenter-window-group-function
)
7935 (put 'recenter-window-group-function
'permanent-local t
)
7936 (defun recenter-window-group (&optional arg
)
7937 "Center point in the group of windows containing the selected window
7938 and maybe redisplay frame. When a grouping mode (such as Follow Mode)
7939 is not active, this function is identical to `recenter'.
7941 With a numeric prefix argument ARG, recenter putting point on screen line ARG
7942 relative to the first window in the selected window group. If ARG is
7943 negative, it counts up from the bottom of the last window in the
7944 group. (ARG should be less than the total height of the window group.)
7946 If ARG is omitted or nil, then recenter with point on the middle line of
7947 the selected window group; if the variable `recenter-redisplay' is
7948 non-nil, also erase the entire frame and redraw it (when
7949 `auto-resize-tool-bars' is set to `grow-only', this resets the
7950 tool-bar's height to the minimum height needed); if
7951 `recenter-redisplay' has the special value `tty', then only tty frames
7954 Just C-u as prefix means put point in the center of the window
7955 and redisplay normally--don't erase and redraw the frame."
7956 (if (functionp recenter-window-group-function
)
7957 (funcall recenter-window-group-function arg
)
7960 (defvar pos-visible-in-window-group-p-function nil
)
7961 (make-variable-buffer-local 'pos-visible-in-window-group-p-function
)
7962 (put 'pos-visible-in-window-group-p-function
'permanent-local t
)
7963 (defun pos-visible-in-window-group-p (&optional pos window partially
)
7964 "Return non-nil if position POS is currently on the frame in the
7965 window group containing WINDOW. When a grouping mode (such as Follow
7966 Mode) is not active, this function is identical to
7967 `pos-visible-in-window-p'.
7969 WINDOW must be a live window and defaults to the selected one.
7971 Return nil if that position is scrolled vertically out of view. If a
7972 character is only partially visible, nil is returned, unless the
7973 optional argument PARTIALLY is non-nil. If POS is only out of view
7974 because of horizontal scrolling, return non-nil. If POS is t, it
7975 specifies the position of the last visible glyph in the window group.
7976 POS defaults to point in WINDOW; WINDOW defaults to the selected
7979 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
7980 the return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
7981 where X and Y are the pixel coordinates relative to the top left corner
7982 of the window. The remaining elements are omitted if the character after
7983 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
7984 off-window at the top and bottom of the screen line (\"row\") containing
7985 POS, ROWH is the visible height of that row, and VPOS is the row number
7987 (if (functionp pos-visible-in-window-group-p-function
)
7988 (funcall pos-visible-in-window-group-p-function pos window partially
)
7989 (pos-visible-in-window-p pos window partially
)))
7991 (defvar selected-window-group-function nil
)
7992 (make-variable-buffer-local 'selected-window-group-function
)
7993 (put 'selected-window-group-function
'permanent-local t
)
7994 (defun selected-window-group ()
7995 "Return the list of windows in the group containing the selected window.
7996 When a grouping mode (such as Follow Mode) is not active, the
7997 result is a list containing only the selected window."
7998 (if (functionp selected-window-group-function
)
7999 (funcall selected-window-group-function
)
8000 (list (selected-window))))
8002 (defvar move-to-window-group-line-function nil
)
8003 (make-variable-buffer-local 'move-to-window-group-line-function
)
8004 (put 'move-to-window-group-line-function
'permanent-local t
)
8005 (defun move-to-window-group-line (arg)
8006 "Position point relative to the the current group of windows.
8007 When a grouping mode (such as Follow Mode) is not active, this
8008 function is identical to `move-to-window-line'.
8010 ARG nil means position point at center of the window group.
8011 Else, ARG specifies the vertical position within the window
8012 group; zero means top of first window in the group, negative
8013 means relative to the bottom of the last window in the group."
8014 (if (functionp move-to-window-group-line-function
)
8015 (funcall move-to-window-group-line-function arg
)
8016 (move-to-window-line arg
)))
8019 (defvar recenter-last-op nil
8020 "Indicates the last recenter operation performed.
8021 Possible values: `top', `middle', `bottom', integer or float numbers.
8022 It can also be nil, which means the first value in `recenter-positions'.")
8024 (defcustom recenter-positions
'(middle top bottom
)
8025 "Cycling order for `recenter-top-bottom'.
8026 A list of elements with possible values `top', `middle', `bottom',
8027 integer or float numbers that define the cycling order for
8028 the command `recenter-top-bottom'.
8030 Top and bottom destinations are `scroll-margin' lines from the true
8031 window top and bottom. Middle redraws the frame and centers point
8032 vertically within the window. Integer number moves current line to
8033 the specified absolute window-line. Float number between 0.0 and 1.0
8034 means the percentage of the screen space from the top. The default
8035 cycling order is middle -> top -> bottom."
8036 :type
'(repeat (choice
8037 (const :tag
"Top" top
)
8038 (const :tag
"Middle" middle
)
8039 (const :tag
"Bottom" bottom
)
8040 (integer :tag
"Line number")
8041 (float :tag
"Percentage")))
8045 (defun recenter-top-bottom (&optional arg
)
8046 "Move current buffer line to the specified window line.
8047 With no prefix argument, successive calls place point according
8048 to the cycling order defined by `recenter-positions'.
8050 A prefix argument is handled like `recenter':
8051 With numeric prefix ARG, move current line to window-line ARG.
8052 With plain `C-u', move current line to window center."
8055 (arg (recenter arg
)) ; Always respect ARG.
8057 (setq recenter-last-op
8058 (if (eq this-command last-command
)
8059 (car (or (cdr (member recenter-last-op recenter-positions
))
8060 recenter-positions
))
8061 (car recenter-positions
)))
8062 (let ((this-scroll-margin
8063 (min (max 0 scroll-margin
)
8064 (truncate (/ (window-body-height) 4.0)))))
8065 (cond ((eq recenter-last-op
'middle
)
8067 ((eq recenter-last-op
'top
)
8068 (recenter this-scroll-margin
))
8069 ((eq recenter-last-op
'bottom
)
8070 (recenter (- -
1 this-scroll-margin
)))
8071 ((integerp recenter-last-op
)
8072 (recenter recenter-last-op
))
8073 ((floatp recenter-last-op
)
8074 (recenter (round (* recenter-last-op
(window-height))))))))))
8076 (define-key global-map
[?\C-l
] 'recenter-top-bottom
)
8078 (defun move-to-window-line-top-bottom (&optional arg
)
8079 "Position point relative to window.
8081 With a prefix argument ARG, acts like `move-to-window-line'.
8083 With no argument, positions point at center of window.
8084 Successive calls position point at positions defined
8085 by `recenter-positions'."
8088 (arg (move-to-window-line arg
)) ; Always respect ARG.
8090 (setq recenter-last-op
8091 (if (eq this-command last-command
)
8092 (car (or (cdr (member recenter-last-op recenter-positions
))
8093 recenter-positions
))
8094 (car recenter-positions
)))
8095 (let ((this-scroll-margin
8096 (min (max 0 scroll-margin
)
8097 (truncate (/ (window-body-height) 4.0)))))
8098 (cond ((eq recenter-last-op
'middle
)
8099 (call-interactively 'move-to-window-line
))
8100 ((eq recenter-last-op
'top
)
8101 (move-to-window-line this-scroll-margin
))
8102 ((eq recenter-last-op
'bottom
)
8103 (move-to-window-line (- -
1 this-scroll-margin
)))
8104 ((integerp recenter-last-op
)
8105 (move-to-window-line recenter-last-op
))
8106 ((floatp recenter-last-op
)
8107 (move-to-window-line (round (* recenter-last-op
(window-height))))))))))
8109 (define-key global-map
[?\M-r
] 'move-to-window-line-top-bottom
)
8111 ;;; Scrolling commands.
8113 ;;; Scrolling commands which do not signal errors at top/bottom
8114 ;;; of buffer at first key-press (instead move to top/bottom
8117 (defcustom scroll-error-top-bottom nil
8118 "Move point to top/bottom of buffer before signaling a scrolling error.
8119 A value of nil means just signal an error if no more scrolling possible.
8120 A value of t means point moves to the beginning or the end of the buffer
8121 \(depending on scrolling direction) when no more scrolling possible.
8122 When point is already on that position, then signal an error."
8127 (defun scroll-up-command (&optional arg
)
8128 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
8129 If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
8130 scroll window further, move cursor to the bottom line.
8131 When point is already on that position, then signal an error.
8132 A near full screen is `next-screen-context-lines' less than a full screen.
8133 Negative ARG means scroll downward.
8134 If ARG is the atom `-', scroll downward by nearly full screen."
8137 ((null scroll-error-top-bottom
)
8140 (scroll-down-command nil
))
8141 ((< (prefix-numeric-value arg
) 0)
8142 (scroll-down-command (- (prefix-numeric-value arg
))))
8144 (scroll-up arg
)) ; signal error
8150 ;; When scrolling by ARG lines can't be done,
8151 ;; move by ARG lines instead.
8153 ;; When ARG is nil for full-screen scrolling,
8154 ;; move to the bottom of the buffer.
8155 (goto-char (point-max))))))))
8157 (put 'scroll-up-command
'scroll-command t
)
8159 (defun scroll-down-command (&optional arg
)
8160 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
8161 If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
8162 scroll window further, move cursor to the top line.
8163 When point is already on that position, then signal an error.
8164 A near full screen is `next-screen-context-lines' less than a full screen.
8165 Negative ARG means scroll upward.
8166 If ARG is the atom `-', scroll upward by nearly full screen."
8169 ((null scroll-error-top-bottom
)
8172 (scroll-up-command nil
))
8173 ((< (prefix-numeric-value arg
) 0)
8174 (scroll-up-command (- (prefix-numeric-value arg
))))
8176 (scroll-down arg
)) ; signal error
8180 (beginning-of-buffer
8182 ;; When scrolling by ARG lines can't be done,
8183 ;; move by ARG lines instead.
8184 (forward-line (- arg
))
8185 ;; When ARG is nil for full-screen scrolling,
8186 ;; move to the top of the buffer.
8187 (goto-char (point-min))))))))
8189 (put 'scroll-down-command
'scroll-command t
)
8191 ;;; Scrolling commands which scroll a line instead of full screen.
8193 (defun scroll-up-line (&optional arg
)
8194 "Scroll text of selected window upward ARG lines; or one line if no ARG.
8195 If ARG is omitted or nil, scroll upward by one line.
8196 This is different from `scroll-up-command' that scrolls a full screen."
8198 (scroll-up (or arg
1)))
8200 (put 'scroll-up-line
'scroll-command t
)
8202 (defun scroll-down-line (&optional arg
)
8203 "Scroll text of selected window down ARG lines; or one line if no ARG.
8204 If ARG is omitted or nil, scroll down by one line.
8205 This is different from `scroll-down-command' that scrolls a full screen."
8207 (scroll-down (or arg
1)))
8209 (put 'scroll-down-line
'scroll-command t
)
8212 (defun scroll-other-window-down (&optional lines
)
8213 "Scroll the \"other window\" down.
8214 For more details, see the documentation for `scroll-other-window'."
8216 (scroll-other-window
8217 ;; Just invert the argument's meaning.
8218 ;; We can do that without knowing which window it will be.
8219 (if (eq lines
'-
) nil
8221 (- (prefix-numeric-value lines
))))))
8223 (defun beginning-of-buffer-other-window (arg)
8224 "Move point to the beginning of the buffer in the other window.
8225 Leave mark at previous position.
8226 With arg N, put point N/10 of the way from the true beginning."
8228 (let ((orig-window (selected-window))
8229 (window (other-window-for-scrolling)))
8230 ;; We use unwind-protect rather than save-window-excursion
8231 ;; because the latter would preserve the things we want to change.
8234 (select-window window
)
8235 ;; Set point and mark in that window's buffer.
8237 (beginning-of-buffer arg
))
8238 ;; Set point accordingly.
8240 (select-window orig-window
))))
8242 (defun end-of-buffer-other-window (arg)
8243 "Move point to the end of the buffer in the other window.
8244 Leave mark at previous position.
8245 With arg N, put point N/10 of the way from the true end."
8247 ;; See beginning-of-buffer-other-window for comments.
8248 (let ((orig-window (selected-window))
8249 (window (other-window-for-scrolling)))
8252 (select-window window
)
8254 (end-of-buffer arg
))
8256 (select-window orig-window
))))
8258 (defvar mouse-autoselect-window-timer nil
8259 "Timer used by delayed window autoselection.")
8261 (defvar mouse-autoselect-window-position-1 nil
8262 "First mouse position recorded by delayed window autoselection.")
8264 (defvar mouse-autoselect-window-position nil
8265 "Last mouse position recorded by delayed window autoselection.")
8267 (defvar mouse-autoselect-window-window nil
8268 "Last window recorded by delayed window autoselection.")
8270 (defvar mouse-autoselect-window-state nil
8271 "When non-nil, special state of delayed window autoselection.
8272 Possible values are `suspend' (suspend autoselection after a menu or
8273 scrollbar interaction) and `select' (the next invocation of
8274 `handle-select-window' shall select the window immediately).")
8276 (defun mouse-autoselect-window-cancel (&optional force
)
8277 "Cancel delayed window autoselection.
8278 Optional argument FORCE means cancel unconditionally."
8279 (unless (and (not force
)
8280 ;; Don't cancel for select-window or select-frame events
8281 ;; or when the user drags a scroll bar.
8282 (or (memq this-command
8283 '(handle-select-window handle-switch-frame
))
8284 (and (eq this-command
'scroll-bar-toolkit-scroll
)
8285 (memq (nth 4 (event-end last-input-event
))
8286 '(handle end-scroll
)))))
8287 (setq mouse-autoselect-window-state nil
)
8288 (setq mouse-autoselect-window-position-1 nil
)
8289 (when (timerp mouse-autoselect-window-timer
)
8290 (cancel-timer mouse-autoselect-window-timer
))
8291 (remove-hook 'pre-command-hook
'mouse-autoselect-window-cancel
)))
8293 (defun mouse-autoselect-window-start (mouse-position &optional window suspend
)
8294 "Start delayed window autoselection.
8295 MOUSE-POSITION is the last position where the mouse was seen as returned
8296 by `mouse-position'. Optional argument WINDOW non-nil denotes the
8297 window where the mouse was seen. Optional argument SUSPEND non-nil
8298 means suspend autoselection."
8299 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
8300 (setq mouse-autoselect-window-position mouse-position
)
8301 (when window
(setq mouse-autoselect-window-window window
))
8302 (setq mouse-autoselect-window-state
(when suspend
'suspend
))
8303 ;; Install timer which runs `mouse-autoselect-window-select' after
8304 ;; `mouse-autoselect-window' seconds.
8305 (setq mouse-autoselect-window-timer
8307 (abs mouse-autoselect-window
) nil
'mouse-autoselect-window-select
)))
8309 (defun mouse-autoselect-window-select ()
8310 "Select window with delayed window autoselection.
8311 If the mouse position has stabilized in a non-selected window, select
8312 that window. The minibuffer window is selected only if the minibuffer
8313 is active. This function is run by `mouse-autoselect-window-timer'."
8315 (let* ((mouse-position (mouse-position))
8318 (window-at (cadr mouse-position
) (cddr mouse-position
)
8319 (car mouse-position
)))))
8321 ((or (and (fboundp 'menu-or-popup-active-p
) (menu-or-popup-active-p))
8323 (let ((coords (coordinates-in-window-p
8324 (cdr mouse-position
) window
)))
8325 (and (not (consp coords
))
8326 (not (memq coords
'(left-margin right-margin
)))))))
8327 ;; A menu / popup dialog is active or the mouse is not on the
8328 ;; text region of WINDOW: Suspend autoselection temporarily.
8329 (mouse-autoselect-window-start mouse-position nil t
))
8330 ((or (eq mouse-autoselect-window-state
'suspend
)
8331 ;; When the mouse is at its first recorded position, restart
8332 ;; delayed autoselection. This works around a scenario with
8333 ;; two two-window frames with identical dimensions: select the
8334 ;; first window of the first frame, switch to the second
8335 ;; frame, move the mouse to its second window, minimize the
8336 ;; second frame. Now the second window of the first frame
8337 ;; gets selected although the mouse never really "moved" into
8339 (and (numberp mouse-autoselect-window
)
8340 (equal (mouse-position) mouse-autoselect-window-position-1
)))
8341 ;; Delayed autoselection was temporarily suspended, reenable it.
8342 (mouse-autoselect-window-start mouse-position
))
8343 ((and window
(not (eq window
(selected-window)))
8344 (or (not (numberp mouse-autoselect-window
))
8345 (and (>= mouse-autoselect-window
0)
8346 ;; If `mouse-autoselect-window' is non-negative,
8347 ;; select window if it's the same as before.
8348 (eq window mouse-autoselect-window-window
))
8349 ;; Otherwise select window iff the mouse is at the same
8350 ;; position as before. Observe that the first test
8351 ;; after starting autoselection usually fails since the
8352 ;; value of `mouse-autoselect-window-position' recorded
8353 ;; there is the position where the mouse has entered the
8354 ;; new window and not necessarily where the mouse has
8356 (equal mouse-position mouse-autoselect-window-position
))
8357 ;; The minibuffer is a candidate window if it's active.
8358 (or (not (window-minibuffer-p window
))
8359 (eq window
(active-minibuffer-window))))
8360 ;; Mouse position has stabilized in non-selected window: Cancel
8361 ;; delayed autoselection and try to select that window.
8362 (mouse-autoselect-window-cancel t
)
8363 ;; Select window where mouse appears unless the selected window is the
8364 ;; minibuffer. Use `unread-command-events' in order to execute pre-
8365 ;; and post-command hooks and trigger idle timers. To avoid delaying
8366 ;; autoselection again, set `mouse-autoselect-window-state'."
8367 (unless (window-minibuffer-p)
8368 (setq mouse-autoselect-window-state
'select
)
8369 (setq unread-command-events
8370 (cons (list 'select-window
(list window
))
8371 unread-command-events
))))
8372 ((or (and window
(eq window
(selected-window)))
8373 (not (numberp mouse-autoselect-window
))
8374 (equal mouse-position mouse-autoselect-window-position
))
8375 ;; Mouse position has either stabilized in the selected window or at
8376 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
8377 (mouse-autoselect-window-cancel t
))
8379 ;; Mouse position has not stabilized yet, resume delayed
8381 (mouse-autoselect-window-start mouse-position window
))))))
8383 (defun handle-select-window (event)
8384 "Handle select-window events."
8386 (let ((window (posn-window (event-start event
))))
8387 (unless (or (not (window-live-p window
))
8388 ;; Don't switch if we're currently in the minibuffer.
8389 ;; This tries to work around problems where the
8390 ;; minibuffer gets unselected unexpectedly, and where
8391 ;; you then have to move your mouse all the way down to
8392 ;; the minibuffer to select it.
8393 (window-minibuffer-p)
8394 ;; Don't switch to minibuffer window unless it's active.
8395 (and (window-minibuffer-p window
)
8396 (not (minibuffer-window-active-p window
)))
8397 ;; Don't switch when autoselection shall be delayed.
8398 (and (numberp mouse-autoselect-window
)
8399 (not (eq mouse-autoselect-window-state
'select
))
8400 (let ((position (mouse-position)))
8401 ;; Cancel any delayed autoselection.
8402 (mouse-autoselect-window-cancel t
)
8403 ;; Start delayed autoselection from current mouse
8404 ;; position and window.
8405 (setq mouse-autoselect-window-position-1 position
)
8406 (mouse-autoselect-window-start position window
)
8407 ;; Executing a command cancels delayed autoselection.
8409 'pre-command-hook
'mouse-autoselect-window-cancel
))))
8410 (when mouse-autoselect-window
8411 ;; Reset state of delayed autoselection.
8412 (setq mouse-autoselect-window-state nil
)
8413 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
8414 (run-hooks 'mouse-leave-buffer-hook
))
8417 (select-window window
))))
8419 (defun truncated-partial-width-window-p (&optional window
)
8420 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
8421 WINDOW must be a live window and defaults to the selected one.
8422 Return nil if WINDOW is not a partial-width window
8423 (regardless of the value of `truncate-lines').
8424 Otherwise, consult the value of `truncate-partial-width-windows'
8425 for the buffer shown in WINDOW."
8426 (setq window
(window-normalize-window window t
))
8427 (unless (window-full-width-p window
)
8428 (let ((t-p-w-w (buffer-local-value 'truncate-partial-width-windows
8429 (window-buffer window
))))
8430 (if (integerp t-p-w-w
)
8431 (< (window-width window
) t-p-w-w
)
8435 ;; Automatically inform subprocesses of changes to window size.
8437 (defcustom window-adjust-process-window-size-function
8438 'window-adjust-process-window-size-smallest
8439 "Control how Emacs chooses inferior process window sizes.
8440 Emacs uses this function to tell processes the space they have
8441 available for displaying their output. After each window
8442 configuration change, Emacs calls the value of
8443 `window-adjust-process-window-size-function' for each process
8444 with a buffer being displayed in at least one window.
8445 This function is responsible for combining the sizes of the
8446 displayed windows and returning a cons (WIDTH . HEIGHT)
8447 describing the width and height with which Emacs will call
8448 `set-process-window-size' for that process. If the function
8449 returns nil, Emacs does not call `set-process-window-size'.
8451 This function is called with the process buffer as the current
8452 buffer and with two arguments: the process and a list of windows
8453 displaying process. Modes can make this variable buffer-local;
8454 additionally, the `adjust-window-size-function' process property
8455 overrides the global or buffer-local value of
8456 `window-adjust-process-window-size-function'."
8458 (const :tag
"Minimum area of any window"
8459 window-adjust-process-window-size-smallest
)
8460 (const :tag
"Maximum area of any window"
8461 window-adjust-process-window-size-largest
)
8462 (const :tag
"Do not adjust process window sizes" ignore
)
8467 (defun window-adjust-process-window-size (reducer process windows
)
8468 "Adjust the process window size of PROCESS.
8469 WINDOWS is a list of windows associated with PROCESS. REDUCER is
8470 a two-argument function used to combine the widths and heights of
8473 (let ((width (window-body-width (car windows
)))
8474 (height (window-body-height (car windows
))))
8475 (dolist (window (cdr windows
))
8476 (setf width
(funcall reducer width
(window-body-width window
)))
8477 (setf height
(funcall reducer height
(window-body-height window
))))
8478 (cons width height
))))
8480 (defun window-adjust-process-window-size-smallest (process windows
)
8481 "Adjust the process window size of PROCESS.
8482 WINDOWS is a list of windows associated with PROCESS. Choose the
8483 smallest area available for displaying PROCESS's output."
8484 (window-adjust-process-window-size #'min process windows
))
8486 (defun window-adjust-process-window-size-largest (process windows
)
8487 "Adjust the process window size of PROCESS.
8488 WINDOWS is a list of windows associated with PROCESS. Choose the
8489 largest area available for displaying PROCESS's output."
8490 (window-adjust-process-window-size #'max process windows
))
8492 (defun window--process-window-list ()
8493 "Return an alist mapping processes to associated windows.
8494 A window is associated with a process if that window is
8495 displaying that processes's buffer."
8496 (let ((processes (process-list))
8497 (process-windows nil
))
8500 (let ((buffer (window-buffer window
))
8502 (while (let ((process (car iter
)))
8503 (if (and (process-live-p process
)
8504 (eq buffer
(process-buffer process
)))
8505 (let ((procwin (assq process process-windows
)))
8506 ;; Add this window to the list of windows
8507 ;; displaying process.
8509 (push window
(cdr procwin
))
8510 (push (list process window
) process-windows
))
8511 ;; We found our process for this window, so
8512 ;; stop iterating over the process list.
8514 (setf iter
(cdr iter
)))))))
8518 (defun window--adjust-process-windows ()
8519 "Update process window sizes to match the current window configuration."
8520 (dolist (procwin (window--process-window-list))
8521 (let ((process (car procwin
)))
8522 (with-demoted-errors "Error adjusting window size: %S"
8523 (with-current-buffer (process-buffer process
)
8524 (let ((size (funcall
8525 (or (process-get process
'adjust-window-size-function
)
8526 window-adjust-process-window-size-function
)
8527 process
(cdr procwin
))))
8529 (set-process-window-size process
(cdr size
) (car size
)))))))))
8531 (add-hook 'window-configuration-change-hook
'window--adjust-process-windows
)
8534 ;; Some of these are in tutorial--default-keys, so update that if you
8536 (define-key ctl-x-map
"0" 'delete-window
)
8537 (define-key ctl-x-map
"1" 'delete-other-windows
)
8538 (define-key ctl-x-map
"2" 'split-window-below
)
8539 (define-key ctl-x-map
"3" 'split-window-right
)
8540 (define-key ctl-x-map
"o" 'other-window
)
8541 (define-key ctl-x-map
"^" 'enlarge-window
)
8542 (define-key ctl-x-map
"}" 'enlarge-window-horizontally
)
8543 (define-key ctl-x-map
"{" 'shrink-window-horizontally
)
8544 (define-key ctl-x-map
"-" 'shrink-window-if-larger-than-buffer
)
8545 (define-key ctl-x-map
"+" 'balance-windows
)
8546 (define-key ctl-x-4-map
"0" 'kill-buffer-and-window
)
8548 ;;; window.el ends here