* test/automated/ert-tests.el (ert-test-deftest):
[emacs.git] / lisp / window.el
bloba4ed9ea721648d12a980992410c9bde909154a6d
1 ;;; window.el --- GNU Emacs window commands aside from those written in C
3 ;; Copyright (C) 1985, 1989, 1992-1994, 2000-2015 Free Software
4 ;; Foundation, Inc.
6 ;; Maintainer: emacs-devel@gnu.org
7 ;; Keywords: internal
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; Window tree functions.
29 ;;; Code:
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.
37 (apply #'append
38 (mapcar (lambda (terminal)
39 (let ((frames (frames-on-display-list terminal))
40 (top-frame (tty-top-frame terminal))
41 alist)
42 (if top-frame
43 (setq frames
44 (cons top-frame
45 (delq top-frame frames))))
46 (dolist (f frames)
47 (push (cons f (frame-selected-window f))
48 alist))
49 alist))
50 (terminal-list)))))
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
69 window is left alone.
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)))
77 (save-current-buffer
78 (unwind-protect
79 (progn ,@body)
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
85 displayed current.")
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.
94 Return the buffer."
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))
106 (erase-buffer)
107 (run-hooks 'temp-buffer-window-setup-hook))
108 ;; Return the buffer.
109 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'."
115 (let (window frame)
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
128 'temp-buffer-resize)
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))
135 (raise-frame 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.
143 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)."
184 (declare (debug t))
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)
189 (vaction action)
190 (vquit-function quit-function))
191 `(let* ((,buffer (temp-buffer-window-setup ,vbuffer-or-name))
192 (standard-output ,buffer)
193 ,window ,value)
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)
200 ,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
206 BODY."
207 (declare (debug t))
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)
212 (vaction action)
213 (vquit-function quit-function))
214 `(let* ((,buffer (temp-buffer-window-setup ,vbuffer-or-name))
215 (standard-output ,buffer)
216 ,window ,value)
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)
223 ,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."
229 (declare (debug t))
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)
234 (vaction action)
235 (vquit-function quit-function))
236 `(let* ((,buffer (temp-buffer-window-setup ,vbuffer-or-name))
237 (standard-output ,buffer)
238 ,window ,value)
239 (with-current-buffer ,buffer
240 (setq ,window (temp-buffer-window-show
241 ,buffer
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))
245 ,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))))
254 (ignore-errors
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)
265 ,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
275 be any window."
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
281 be any window."
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."
292 (let ((count 0))
293 (when (and (windowp window) (setq window (window-child window)))
294 (while window
295 (setq count (1+ count))
296 (setq window (window-next-sibling window))))
297 count))
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))))
305 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."
311 (cond
312 ((not buffer-or-name)
313 (current-buffer))
314 ((bufferp buffer-or-name)
315 (if (buffer-live-p buffer-or-name)
316 buffer-or-name
317 (error "Buffer %s is not a live buffer" buffer-or-name)))
318 ((get-buffer buffer-or-name))
319 (t
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."
325 (if frame
326 (if (frame-live-p frame)
327 frame
328 (error "%s is not a live frame" frame))
329 (selected-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."
337 (cond
338 ((null window)
339 (selected-window))
340 (live-only
341 (if (window-live-p window)
342 window
343 (error "%s is not a live window" window)))
344 ((window-valid-p window)
345 window)
346 (t
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."
360 (let ((frame
361 (cond
362 ((window-valid-p window-or-frame)
363 (window-frame window-or-frame))
364 ((frame-live-p window-or-frame)
365 window-or-frame)
366 (t (selected-frame)))))
367 (if horizontal
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."
401 :type 'integer
402 :version "24.1"
403 :group 'windows)
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."
432 :type 'integer
433 :version "24.1"
434 :group 'windows)
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."
445 (if horizontal
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."
453 (if horizontal
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)))
467 (and parent
468 (if horizontal
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))
478 (if horizontal
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))
488 (cond
489 ((window-live-p window)
490 ;; If WINDOW is live, return 1.
491 1)
492 ((if horizontal
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))
498 (count 0))
499 (while child
500 (setq count
501 (+ (window-combinations child horizontal)
502 count))
503 (setq child (window-right child)))
504 count))
505 (t
506 ;; If WINDOW is not iso-combined, return the maximum value of any
507 ;; child window of WINDOW.
508 (let ((child (window-child window))
509 (count 1))
510 (while child
511 (setq count
512 (max (window-combinations child horizontal)
513 count))
514 (setq child (window-right child)))
515 count))))
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
526 (walk-window-tree-1
527 fun (window-left-child walk-window-tree-window) any)
528 (walk-window-tree-1
529 fun (window-top-child walk-window-tree-window) any))
530 (if sub-only
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
540 FRAME.
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
550 unpredictable."
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)
558 (or (eq minibuf t)
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
572 is unpredictable."
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
582 too.
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."
589 (let (this-value)
590 (catch 'found
591 (walk-window-tree
592 (lambda (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))))
598 ;;; Atomic windows.
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))
604 (let (root)
605 (while (and window (window-parameter window 'window-atom))
606 (setq root window)
607 (setq window (window-parent window)))
608 root))
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)
615 (walk-window-subtree
616 (lambda (window)
617 (unless (window-parameter window 'window-atom)
618 (set-window-parameter window 'window-atom t)))
619 window t)
620 window))
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
649 failed."
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)))
656 root new)
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))
661 (window-make-atom
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.
665 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'."
678 (when window
679 (if (window-parameter window 'window-atom)
680 (let ((count 0))
681 (when (or (catch 'reset
682 (walk-window-subtree
683 (lambda (window)
684 (if (window-parameter window 'window-atom)
685 (setq count (1+ count))
686 (throw 'reset t)))
687 window t))
688 ;; count >= 1 must hold here. If there's no other
689 ;; window around dissolve this atomic window.
690 (= count 1))
691 ;; Dissolve atomic window.
692 (walk-window-subtree
693 (lambda (window)
694 (set-window-parameter window 'window-atom nil))
695 window t)))
696 ;; Check children.
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)))
711 ;; Side windows.
712 (defvar window-sides '(left top right bottom)
713 "Window sides.")
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."
718 :type 'boolean
719 :group 'windows
720 :version "24.1")
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."
730 :version "24.1"
731 :risky t
732 :type
733 '(list
734 :value (nil nil nil nil)
735 (choice
736 :tag "Left"
737 :help-echo "Maximum slots of left side window."
738 :value nil
739 :format "%[Left%] %v\n"
740 (const :tag "Unlimited" :format "%t" nil)
741 (integer :tag "Number" :value 2 :size 5))
742 (choice
743 :tag "Top"
744 :help-echo "Maximum slots of top side window."
745 :value nil
746 :format "%[Top%] %v\n"
747 (const :tag "Unlimited" :format "%t" nil)
748 (integer :tag "Number" :value 3 :size 5))
749 (choice
750 :tag "Right"
751 :help-echo "Maximum slots of right side window."
752 :value nil
753 :format "%[Right%] %v\n"
754 (const :tag "Unlimited" :format "%t" nil)
755 (integer :tag "Number" :value 2 :size 5))
756 (choice
757 :tag "Bottom"
758 :help-echo "Maximum slots of bottom side window."
759 :value nil
760 :format "%[Bottom%] %v\n"
761 (const :tag "Unlimited" :format "%t" nil)
762 (integer :tag "Number" :value 3 :size 5)))
763 :group 'windows)
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)
771 (window-parameter
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
777 the selected one.
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
783 its root window."
784 (let ((frame (window-normalize-frame frame))
785 major sibling)
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.
788 (walk-window-tree
789 (lambda (window)
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)))
796 frame t 'nomini)
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))
804 window)
805 ;; (1) If a window on the opposite side exists, return that window's
806 ;; sibling.
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
810 ;; window's sibling.
811 ;; (4) Otherwise return the frame's root window.
812 (cond
813 ((or (and (eq side 'left)
814 (setq window (window-with-parameter 'window-side 'right nil t)))
815 (and (eq side 'top)
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))
824 (cond
825 (window-sides-vertical
826 root)
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))
831 (t root)))
832 ((memq side '(top bottom))
833 (cond
834 ((not window-sides-vertical)
835 root)
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))
840 (t root))))))
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))
852 (on-side (cond
853 ((eq side 'top) 'above)
854 ((eq side 'bottom) 'below)
855 (t side)))
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)))
862 (when new
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)))
876 (setq alist
877 (cons
878 (cons
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
882 ;; root window.
883 4))
884 alist)))
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)))
912 (cond
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.
921 (windows
922 (when major
923 (let (windows)
924 (walk-window-tree
925 (lambda (window)
926 (when (eq (window-parameter window 'window-side) side)
927 (setq windows (cons window windows))))
928 nil nil 'nomini)
929 (nreverse windows))))
930 (slots (when major (max 1 (window-child-count major))))
931 (max-slots
932 (nth (cond
933 ((eq side 'left) 0)
934 ((eq side 'top) 1)
935 ((eq side 'right) 2)
936 ((eq side 'bottom) 3))
937 window-sides-slots))
938 window this-window this-slot prev-window next-window
939 best-window best-slot abs-slot)
941 (cond
942 ((and (numberp max-slots) (<= max-slots 0))
943 ;; No side-slots available on this side. Don't create an error,
944 ;; just return nil.
945 nil)
946 ((not windows)
947 ;; No major window exists on this side, make one.
948 (display-buffer-in-major-side-window buffer side slot alist))
949 (t
950 ;; Scan windows on SIDE.
951 (catch 'found
952 (dolist (window windows)
953 (setq this-slot (window-parameter window 'window-slot))
954 (cond
955 ;; The following should not happen and probably be checked
956 ;; by window--side-check.
957 ((not (numberp this-slot)))
958 ((= this-slot slot)
959 ;; A window with a matching slot has been found.
960 (setq this-window window)
961 (throw 'found t))
962 (t
963 ;; Check if this window has a better slot value wrt the
964 ;; slot of the window we want.
965 (setq abs-slot
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))
973 (cond
974 ((<= this-slot slot)
975 (setq prev-window window))
976 ((not next-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).
991 (or (and this-window
992 ;; Reuse `this-window'.
993 (window--display-buffer buffer this-window 'reuse alist 'side))
994 (and (or (not max-slots) (< slots max-slots))
995 (or (and next-window
996 ;; Make new window before `next-window'.
997 (let ((next-side
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)
1005 window))
1006 (and prev-window
1007 ;; Make new window after `prev-window'.
1008 (let ((prev-side
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)
1016 window)))
1017 (set-window-parameter window 'window-slot slot)
1018 (window--display-buffer buffer window 'window alist 'side))
1019 (and best-window
1020 ;; Reuse `best-window'.
1021 (progn
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
1032 invariants:
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
1047 (walk-window-tree
1048 (lambda (window)
1049 (setq side (window-parameter window 'window-side))
1050 (setq parent (window-parent window))
1051 (setq parent-side
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.
1055 (cond
1056 (parent-side
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.
1060 (throw 'reset t)))
1061 ((not side)
1062 (when (window-buffer window)
1063 ;; Record that we have at least one non-side,
1064 ;; live window.
1065 (setq none t)))
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.
1072 (throw 'reset t))
1073 ;; Now check that there's no more than one major
1074 ;; window for any of left, top, right and bottom.
1075 ((eq side 'left)
1076 (if left (throw 'reset t) (setq left t)))
1077 ((eq side 'top)
1078 (if top (throw 'reset t) (setq top t)))
1079 ((eq side 'right)
1080 (if right (throw 'reset t) (setq right t)))
1081 ((eq side 'bottom)
1082 (if bottom (throw 'reset t) (setq bottom t)))
1083 (t
1084 (throw 'reset t))))
1085 frame t 'nomini))
1086 ;; If there's a side window, there must be at least one
1087 ;; non-side window.
1088 (and (or left top right bottom) (not none)))
1089 (walk-window-tree
1090 (lambda (window)
1091 (set-window-parameter window 'window-side nil))
1092 frame t 'nomini))))
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))
1109 (insert
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)))
1125 (insert
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"
1132 (cadr fringes)
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)))))
1139 (insert "\n")))
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
1146 dumping to it."
1147 (let* ((window
1148 (cond
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))
1154 window-or-frame)
1155 (t
1156 (frame-root-window))))
1157 (frame (window-frame window)))
1158 (with-current-buffer (get-buffer-create "*window-frame-dump*")
1159 (erase-buffer)
1160 (insert
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)
1171 "0")
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))))
1180 ;;; Window sizes.
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'."
1200 (if horizontal
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'
1217 otherwise."
1218 (if horizontal
1219 (if pixelwise
1220 (window-pixel-width window)
1221 (window-total-width window round))
1222 (if pixelwise
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
1234 window).")
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."
1241 (if horizontal
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
1251 WINDOW.
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
1257 throws an error.
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)))
1270 (if horizontal
1271 (set-window-parameter
1272 window 'window-preserved-size
1273 (list
1274 (window-buffer window)
1275 (and preserve (window--preservable-size window t))
1276 height))
1277 (set-window-parameter
1278 window 'window-preserved-size
1279 (list
1280 (window-buffer window)
1281 width
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
1288 width of WINDOW."
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)))
1302 (and (numberp size)
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
1310 of WINDOW's lines.
1312 Optional argument PIXELWISE non-nil means return the minimum pixel-size
1313 of WINDOW."
1314 (setq window (window-normalize-window window))
1315 (if pixelwise
1316 (if horizontal
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
1328 of WINDOW's lines.
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."
1333 (window--min-size-1
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)
1341 (eq window 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)))
1347 (if sub
1348 (let ((value 0))
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.
1353 (while sub
1354 (setq value (+ value
1355 (window--min-size-1
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.
1360 (while sub
1361 (setq value (max value
1362 (window--min-size-1
1363 sub horizontal ignore pixelwise)))
1364 (setq sub (window-right sub))))
1365 value)
1366 (with-current-buffer (window-buffer window)
1367 (cond
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))
1373 ((eq ignore 'safe)
1374 ;; If IGNORE equals `safe' return the safe value.
1375 (window-safe-min-size window horizontal pixelwise))
1376 (horizontal
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))
1386 (pixel-width
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))))
1393 (if pixelwise
1394 (max
1395 (if window-resize-pixelwise
1396 pixel-width
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)))
1402 (max
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))
1408 (pixel-height
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))))
1414 (if pixelwise
1415 (max
1416 (if window-resize-pixelwise
1417 pixel-height
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
1437 as well.
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
1442 can be enlarged.
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
1447 can be shrunk.
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))
1453 (cond
1454 ((< delta 0)
1455 (max (- (window-min-size window horizontal ignore pixelwise)
1456 (window-size window horizontal pixelwise))
1457 delta))
1458 ((> delta 0)
1459 (if (window-size-fixed-p window horizontal ignore)
1461 delta))
1462 (t 0)))
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))
1470 (if (> delta 0)
1471 (>= (window-sizable window delta horizontal ignore pixelwise)
1472 delta)
1473 (<= (window-sizable window delta horizontal ignore pixelwise)
1474 delta)))
1476 (defun window--size-fixed-1 (window horizontal ignore)
1477 "Internal function for `window-size-fixed-p'."
1478 (let ((sub (window-child window)))
1479 (catch 'fixed
1480 (if sub
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.
1485 (progn
1486 (while sub
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.
1490 (throw 'fixed nil))
1491 (setq sub (window-right sub)))
1492 ;; All child windows are fixed-size, so WINDOW's size is
1493 ;; fixed.
1494 (throw 'fixed t))
1495 ;; An ortho-combination is fixed-size if at least one of its
1496 ;; child windows is fixed-size.
1497 (while sub
1498 (when (window--size-fixed-1 sub horizontal ignore)
1499 ;; We found a fixed-size child window, so WINDOW's size
1500 ;; is fixed.
1501 (throw 'fixed t))
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)
1508 (if horizontal
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)))
1534 (catch 'done
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)))
1540 (while sub
1541 (cond
1542 ((eq sub window)
1543 (setq skip (eq trail 'before)))
1544 (skip)
1545 ((window-size-fixed-p sub horizontal ignore))
1546 (t
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.
1552 (while sub
1553 (unless (eq sub window)
1554 (setq delta
1555 (min delta
1556 (max (- (window-size sub horizontal pixelwise 'ceiling)
1557 (window-min-size
1558 sub horizontal ignore pixelwise))
1559 0))))
1560 (setq sub (window-right sub))))
1561 (if noup
1562 delta
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
1579 enlarged.
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)))
1592 (cond
1593 (nodown
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))
1597 ((<= size minimum)
1598 ;; If NODOWN is nil and WINDOW's size is already at its minimum,
1599 ;; there's nothing to recover.
1600 0)
1601 (t
1602 ;; Otherwise, try to recover whatever WINDOW is larger than its
1603 ;; minimum size.
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
1612 pixels."
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)
1619 0))))
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.
1625 delta
1626 (let* ((parent (window-parent window))
1627 (sub (window-child parent)))
1628 (catch 'fixed
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)))
1633 (while sub
1634 (cond
1635 ((eq sub window)
1636 (setq skip (eq trail 'before)))
1637 (skip)
1638 (t
1639 (setq delta
1640 (+ delta
1641 (max
1642 (- (window-size sub horizontal pixelwise 'floor)
1643 (window-min-size
1644 sub horizontal ignore pixelwise))
1645 0)))))
1646 (setq sub (window-right sub))))
1647 ;; For an ortho-combination throw DELTA when at least one
1648 ;; child window is fixed-size.
1649 (while sub
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))))
1654 (if noup
1655 ;; When NOUP is nil, DELTA is all we can get.
1656 delta
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
1675 enlarged.
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
1682 appropriately.
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
1689 ;; size.
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
1705 can be enlarged.
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
1723 child windows.
1725 Optional argument PIXELWISE non-nil means interpret DELTA as
1726 number of pixels."
1727 (setq window (window-normalize-window window))
1728 (cond
1729 ((< delta 0)
1730 (max (- (window-min-delta
1731 window horizontal ignore trail noup nodown pixelwise))
1732 delta))
1733 ((> delta 0)
1734 (min (window-max-delta
1735 window horizontal ignore trail noup nodown pixelwise)
1736 delta))
1737 (t 0)))
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
1746 pixels."
1747 (setq window (window-normalize-window window))
1748 (if (> delta 0)
1749 (>= (window--resizable
1750 window delta horizontal ignore trail noup nodown pixelwise)
1751 delta)
1752 (<= (window--resizable
1753 window delta horizontal ignore trail noup nodown pixelwise)
1754 delta)))
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
1766 can be enlarged.
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
1783 pixels."
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))
1793 (if (> delta 0)
1794 (>= (window--resizable
1795 window delta horizontal ignore nil nil nil pixelwise)
1796 delta)
1797 (<= (window--resizable
1798 window delta horizontal ignore nil nil nil pixelwise)
1799 delta)))
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
1810 selected one."
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."
1834 (if horizontal
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)))
1852 (if (> width 0)
1853 width
1854 (aref info 10)))
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))))
1868 (aref info 3))
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
1880 remapped face.
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
1885 the font."
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))
1894 ncols
1895 (1- ncols)))))
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
1948 and no others.
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
1953 ;; back to it.
1954 (when (window-minibuffer-p)
1955 (setq minibuf t))
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))
1971 (let ((edge
1972 (cond
1973 ((eq side 'left) 0)
1974 ((eq side 'top) 1)
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))
1986 (let (windows)
1987 (walk-window-tree
1988 (lambda (window)
1989 (when (window-at-side-p window side)
1990 (setq windows (cons window windows))))
1991 frame nil 'nomini)
1992 (nreverse windows)))
1994 (defun window--in-direction-2 (window posn &optional horizontal)
1995 "Support function for `window-in-direction'."
1996 (if horizontal
1997 (let ((top (window-pixel-top window)))
1998 (if (> top posn)
1999 (- top posn)
2000 (- posn top (window-pixel-height window))))
2001 (let ((left (window-pixel-left window)))
2002 (if (> left posn)
2003 (- left posn)
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 to selectively ignore specific windows
2009 ;; (windows whose `no-other-window' parameter is non-nil) as targets of
2010 ;; the movement.
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)))
2045 (first (if hor
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.
2051 (posn
2052 (cond
2053 ((and (numberp sign) (< sign 0))
2054 (if hor
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))
2058 (if hor
2059 (window-pixel-top window)
2060 (window-pixel-left window)))
2061 ((let ((posn-cons (nth 2 (posn-at-point (window-point window) window))))
2062 (if hor
2063 (+ (or (cdr posn-cons) 1) (window-pixel-top window))
2064 (+ (or (car posn-cons) 1) (window-pixel-left window)))))))
2065 (best-edge
2066 (cond
2067 ((eq direction 'below) (frame-pixel-height frame))
2068 ((eq direction 'right) (frame-pixel-width frame))
2069 (t -1)))
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)
2073 (walk-window-tree
2074 (lambda (w)
2075 (let* ((w-top (window-pixel-top w))
2076 (w-left (window-pixel-left w)))
2077 (cond
2078 ((or (eq window w)
2079 ;; Ignore ourselves.
2080 (and (window-parameter w 'no-other-window)
2081 ;; Ignore W unless IGNORE is non-nil.
2082 (not ignore))))
2083 (hor
2084 (cond
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))
2090 (and wrap
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))
2095 (and wrap
2096 (window-at-side-p window 'right)
2097 (window-at-side-p w 'left)))))
2098 (setq best-edge w-left)
2099 (setq best w)))
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
2104 ;; cover POSN.
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)
2114 (setq best-2 w))))
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))
2120 (and wrap
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))
2127 (and wrap
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)
2133 (setq best w)))
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)
2147 (setq best-2 w)))))
2148 frame nil (and mini t))
2149 (or best best-2)))
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
2158 DEFAULT.
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
2183 and no others."
2184 (catch 'found
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)))
2190 default))
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
2201 selected window.
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)))
2263 best-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."
2287 (let ((best-size 0)
2288 best-window size)
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))))
2297 best-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. Windows are scanned starting
2303 with the selected window.
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
2328 and no others."
2329 (let ((buffer (window-normalize-buffer buffer-or-name))
2330 windows)
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)))
2346 \f
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
2352 height.
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)))
2364 (if pixelwise
2365 (if (and round-maybe (not window-resize-pixelwise))
2366 (* (round size char-size) char-size)
2367 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.
2378 (while child
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)
2387 (setq best-rem 0)
2388 (while child
2389 (when (and (<= (window-new-total child)
2390 (/ (window-size child horizontal t) char-size))
2391 (> (setq rem (% (window-size child horizontal t)
2392 char-size))
2393 best-rem))
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)))
2400 ;; Recurse.
2401 (setq child (window-child window))
2402 (while child
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)))
2407 (while child
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))
2433 (let (lines)
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))))
2438 (while (> lines 0)
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))
2445 (when mini
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
2460 windows."
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))
2486 (min-delta
2487 (- (window-pixel-height root)
2488 (window-min-size root nil nil t))))
2489 ;; Sanitize DELTA.
2490 (cond
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)
2497 ;; Resize now.
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."
2514 (catch 'apply
2515 (walk-window-tree
2516 (lambda (window)
2517 (unless (= (window-new-pixel window)
2518 (window-size window horizontal t))
2519 (throw 'apply t)))
2520 frame t)
2521 nil))
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
2527 an error though.
2529 DELTA a positive number means WINDOW shall be enlarged by DELTA
2530 lines. DELTA negative means WINDOW shall be shrunk by -DELTA
2531 lines.
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
2548 pixels.
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'
2553 instead."
2554 (setq window (window-normalize-window window))
2555 (let* ((frame (window-frame window))
2556 (minibuffer-window (minibuffer-window frame))
2557 sibling)
2558 (setq delta (window--size-to-pixel
2559 window delta horizontal pixelwise t))
2560 (cond
2561 ((eq window (frame-root-window frame))
2562 (error "Cannot resize the root window of a frame"))
2563 ((window-minibuffer-p window)
2564 (if horizontal
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
2574 ;; window.
2575 (window--resize-mini-window minibuffer-window (- delta)))
2576 ((or (window--resizable-p
2577 window delta horizontal ignore nil nil nil t)
2578 (and (not ignore)
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)))
2587 (window-sizable-p
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.
2592 (let ((normal-delta
2593 (/ (float delta)
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)
2598 normal-delta))
2599 (set-window-new-normal
2600 sibling (- (window-normal-size sibling horizontal)
2601 normal-delta)))
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)
2606 (progn
2607 (window--pixel-to-total frame horizontal)
2608 (run-window-configuration-change-hook frame))
2609 (error "Failed to apply resizing %s" window))))
2610 (t
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
2620 pixels."
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
2646 ;; normal delta.
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))
2653 (parent-normal 0.0)
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.
2659 (while sub
2660 (cond
2661 ((eq sub window)
2662 (setq skip (eq trail 'before)))
2663 (skip)
2664 (t
2665 (setq parent-normal
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
2671 ;; (columns).
2672 (setq sub (window-child parent))
2673 (setq skip (eq trail 'after))
2674 (while sub
2675 (cond
2676 ((eq sub window)
2677 (setq skip (eq trail 'before)))
2678 (skip)
2679 (t
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.
2683 (max (- old-normal
2684 (* (/ old-normal parent-normal)
2685 delta-normal))
2686 ;; Don't drop below 0.
2687 0.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)
2695 other-delta)))
2696 (setq sub (window-child parent))
2697 (setq skip (eq trail 'after))
2698 (while sub
2699 (cond
2700 ((eq sub window)
2701 (setq skip (eq trail 'before)))
2702 (skip)
2703 (t
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.
2708 0.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
2714 window
2715 (let ((sum 0))
2716 (setq sub (window-child parent))
2717 (while sub
2718 (cond
2719 ((eq sub window))
2720 ((not (numberp (window-new-normal sub)))
2721 (setq sum (+ sum (window-normal-size sub horizontal))))
2722 (t
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
2740 `window-resizable'.
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)
2758 delta))
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))
2765 (progn
2766 (setq sub first)
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)))
2774 sub)
2775 (if horizontal
2776 (if (eq trail 'before)
2777 (= (+ (window-pixel-left sub) (window-pixel-width sub))
2778 edge)
2779 (= (window-pixel-left sub) edge))
2780 (if (eq trail 'before)
2781 (= (+ (window-pixel-top sub) (window-pixel-height sub))
2782 edge)
2783 (= (window-pixel-top sub) edge)))
2784 (window-sizable-p sub delta horizontal ignore t))
2785 ;; Resize only windows adjacent to EDGE.
2786 (progn
2787 (window--resize-this-window
2788 sub delta horizontal ignore t trail edge)
2789 (if (and window (eq (window-parent sub) parent))
2790 (progn
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.
2802 'normalized)
2803 ;; Resize all windows proportionally.
2804 (setq sub last)
2805 (while sub
2806 (cond
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.
2810 (and (not ignore)
2811 (window-size-fixed-p sub horizontal ignore)
2812 (set-window-new-normal sub 'ignore))))
2813 ((< delta 0)
2814 ;; When shrinking store the number of lines/cols we can get
2815 ;; from this window here together with the total/normal size
2816 ;; factor.
2817 (set-window-new-normal
2818 sub
2819 (cons
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))
2823 parent-total)
2824 (window-normal-size sub horizontal)))))
2825 ((> delta 0)
2826 ;; When enlarging store the total/normal size factor only
2827 (set-window-new-normal
2828 sub
2829 (- (/ (float (window-size sub horizontal t))
2830 parent-total)
2831 (window-normal-size sub horizontal)))))
2833 (setq sub (window-left sub)))
2835 (cond
2836 ((< delta 0)
2837 ;; Shrink windows by delta.
2838 (setq best-window t)
2839 (while (and best-window (not (zerop delta)))
2840 (setq sub last)
2841 (setq best-window nil)
2842 (setq best-value most-negative-fixnum)
2843 (while sub
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)))
2852 (when best-window
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
2858 best-window
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))
2863 parent-total)
2864 (window-normal-size best-window horizontal))))))))
2865 ((> delta 0)
2866 ;; Enlarge windows by delta.
2867 (setq best-window t)
2868 (while (and best-window (not (zerop delta)))
2869 (setq sub last)
2870 (setq best-window nil)
2871 (setq best-value most-positive-fixnum)
2872 (while sub
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)))
2880 (when best-window
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
2885 best-window
2886 (- (/ (float (window-new-pixel best-window))
2887 parent-total)
2888 (window-normal-size best-window horizontal)))))))
2890 (when best-window
2891 (setq sub last)
2892 (while sub
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
2918 `window-resizable'.
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
2930 ;; siblings.
2931 (let ((skip (eq trail 'after))
2932 this-delta other-delta)
2933 ;; Decide which windows shall be left alone.
2934 (while sub
2935 (cond
2936 ((eq sub window)
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)))
2941 (skip
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.
2956 (if this-delta
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.
2963 (setq this-delta
2964 (window--resizable
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.
2988 'normalized)
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
2993 ;; windows.
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)
2999 (while sub
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)
3006 ;; "Go up."
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."
3036 (when add
3037 ;; Add DELTA to the new total size of WINDOW.
3038 (set-window-new-pixel window delta t))
3040 (let ((sub (window-child window)))
3041 (cond
3042 ((not sub))
3043 ((window-combined-p sub horizontal)
3044 ;; In an iso-combination resize child windows according to their
3045 ;; normal sizes.
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.
3049 (t
3050 (while sub
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
3058 by DELTA columns.
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))
3066 (let ((pixel-delta
3067 (if pixelwise
3068 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
3081 were recovered.
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
3087 routines."
3088 (let* ((frame (window-frame window))
3089 (pixel-delta
3090 (cond
3091 (pixelwise
3092 delta)
3093 ((numberp delta)
3094 (* (frame-char-height frame) delta))
3095 (t 0)))
3096 ignore)
3097 (cond
3098 ((zerop pixel-delta))
3099 ((< pixel-delta 0)
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.
3109 (walk-window-tree
3110 (lambda (window) (set-window-new-normal window 'ignore)) frame t))
3111 ((> pixel-delta 0)
3112 (window--resize-reset frame)
3113 (unless (window-sizable window pixel-delta nil nil pixelwise)
3114 (setq ignore t))
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.
3120 (if pixelwise
3121 pixel-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."
3135 (let ((value t))
3136 (walk-window-tree
3137 (lambda (window)
3138 (let ((delta (- (window-min-size window horizontal nil t)
3139 (window-size window horizontal t))))
3140 (when (> delta 0)
3141 (if (window-resizable-p window delta horizontal nil t)
3142 (window-resize window delta horizontal nil t)
3143 (setq value nil))))))
3144 value))
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
3153 number of pixels.
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))
3162 (right window)
3163 left this-delta min-delta max-delta ignore)
3165 (unless pixelwise
3166 (setq pixelwise t)
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))))
3173 (cond
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))))
3185 (if horizontal
3186 (user-error "No window on the right of this one")
3187 (user-error "No window below this one")))
3188 (t
3189 ;; Set LEFT to the first resizable window on the left. This step is
3190 ;; needed to handle fixed-size windows.
3191 (while (and left
3192 (or (window-size-fixed-p left horizontal)
3193 (and (< delta 0)
3194 (<= (window-size left horizontal t)
3195 (window-min-size left horizontal nil t)))))
3196 (setq left
3197 (or (window-left left)
3198 (progn
3199 (while (and (setq left (window-parent left))
3200 (not (window-combined-p left horizontal))))
3201 (window-left left)))))
3202 (unless left
3203 (setq ignore 'preserved)
3204 (setq left window)
3205 (while (and left
3206 (or (window-size-fixed-p left horizontal 'preserved)
3207 (<= (window-size left horizontal t)
3208 (window-min-size left horizontal 'preserved t))))
3209 (setq left
3210 (or (window-left left)
3211 (progn
3212 (while (and (setq left (window-parent left))
3213 (not (window-combined-p left horizontal))))
3214 (window-left left)))))
3216 (unless left
3217 (if horizontal
3218 (user-error "No resizable window on the left of this one")
3219 (user-error "No resizable window above this one"))))
3221 ;; Set RIGHT to the first resizable window on the right. This step
3222 ;; is needed to handle fixed-size windows.
3223 (while (and right
3224 (or (window-size-fixed-p right horizontal)
3225 (and (> delta 0)
3226 (<= (window-size right horizontal t)
3227 (window-min-size right horizontal 'preserved t)))))
3228 (setq right
3229 (or (window-right right)
3230 (progn
3231 (while (and (setq right (window-parent right))
3232 (not (window-combined-p right horizontal))))
3233 (window-right right)))))
3234 (unless right
3235 (setq ignore 'preserved)
3236 (setq right (window-right window))
3237 (while (and right
3238 (or (window-size-fixed-p right horizontal 'preserved))
3239 (<= (window-size right horizontal t)
3240 (window-min-size right horizontal nil t)))
3241 (setq right
3242 (or (window-right right)
3243 (progn
3244 (while (and (setq right (window-parent right))
3245 (not (window-combined-p right horizontal))))
3246 (window-right right)))))
3247 (unless right
3248 (if horizontal
3249 (user-error "No resizable window on the right of this one")
3250 (user-error "No resizable window below this one"))))
3252 ;; LEFT and RIGHT (which might be both internal windows) are now the
3253 ;; two windows we want to resize.
3254 (cond
3255 ((> delta 0)
3256 (setq max-delta
3257 (window--max-delta-1
3258 left 0 horizontal ignore 'after nil pixelwise))
3259 (setq min-delta
3260 (window--min-delta-1
3261 right (- delta) horizontal ignore 'before nil pixelwise))
3262 (when (or (< max-delta delta) (> min-delta (- delta)))
3263 ;; We can't get the whole DELTA - move as far as possible.
3264 (setq delta (min max-delta (- min-delta))))
3265 (unless (zerop delta)
3266 ;; Start resizing.
3267 (window--resize-reset frame horizontal)
3268 ;; Try to enlarge LEFT first.
3269 (setq this-delta (window--resizable
3270 left delta horizontal ignore 'after nil nil pixelwise))
3271 (unless (zerop this-delta)
3272 (window--resize-this-window
3273 left this-delta horizontal ignore t 'before
3274 (if horizontal
3275 (+ (window-pixel-left left) (window-pixel-width left))
3276 (+ (window-pixel-top left) (window-pixel-height left)))))
3277 ;; Shrink windows on right of LEFT.
3278 (window--resize-siblings
3279 left delta horizontal ignore 'after
3280 (if horizontal
3281 (window-pixel-left right)
3282 (window-pixel-top right)))))
3283 ((< delta 0)
3284 (setq max-delta
3285 (window--max-delta-1
3286 right 0 horizontal ignore 'before nil pixelwise))
3287 (setq min-delta
3288 (window--min-delta-1
3289 left delta horizontal ignore 'after nil pixelwise))
3290 (when (or (< max-delta (- delta)) (> min-delta delta))
3291 ;; We can't get the whole DELTA - move as far as possible.
3292 (setq delta (max (- max-delta) min-delta)))
3293 (unless (zerop delta)
3294 ;; Start resizing.
3295 (window--resize-reset frame horizontal)
3296 ;; Try to enlarge RIGHT.
3297 (setq this-delta
3298 (window--resizable
3299 right (- delta) horizontal ignore 'before nil nil pixelwise))
3300 (unless (zerop this-delta)
3301 (window--resize-this-window
3302 right this-delta horizontal ignore t 'after
3303 (if horizontal
3304 (window-pixel-left right)
3305 (window-pixel-top right))))
3306 ;; Shrink windows on left of RIGHT.
3307 (window--resize-siblings
3308 right (- delta) horizontal ignore 'before
3309 (if horizontal
3310 (+ (window-pixel-left left) (window-pixel-width left))
3311 (+ (window-pixel-top left) (window-pixel-height left)))))))
3312 (unless (zerop delta)
3313 ;; Don't report an error in the standard case.
3314 (when (window--resize-apply-p frame horizontal)
3315 (if (window-resize-apply frame horizontal)
3316 (progn
3317 (window--pixel-to-total frame horizontal)
3318 (run-window-configuration-change-hook frame))
3319 ;; But do report an error if applying the changes fails.
3320 (error "Failed adjusting window %s" window))))))))
3322 (defun enlarge-window (delta &optional horizontal)
3323 "Make the selected window DELTA lines taller.
3324 Interactively, if no argument is given, make the selected window
3325 one line taller. If optional argument HORIZONTAL is non-nil,
3326 make selected window wider by DELTA columns. If DELTA is
3327 negative, shrink selected window by -DELTA lines or columns."
3328 (interactive "p")
3329 (let ((minibuffer-window (minibuffer-window)))
3330 (when (window-preserved-size nil horizontal)
3331 (window-preserve-size nil horizontal))
3332 (cond
3333 ((zerop delta))
3334 ((window-size-fixed-p nil horizontal)
3335 (error "Selected window has fixed size"))
3336 ((window-minibuffer-p)
3337 (if horizontal
3338 (error "Cannot resize minibuffer window horizontally")
3339 (window--resize-mini-window (selected-window) delta)))
3340 ((and (not horizontal)
3341 (window-full-height-p)
3342 (eq (window-frame minibuffer-window) (selected-frame))
3343 (not resize-mini-windows))
3344 ;; If the selected window is full height and `resize-mini-windows'
3345 ;; is nil, resize the minibuffer window.
3346 (window--resize-mini-window minibuffer-window (- delta)))
3347 ((window--resizable-p nil delta horizontal)
3348 (window-resize nil delta horizontal))
3349 (t
3350 (window-resize
3351 nil (if (> delta 0)
3352 (window-max-delta nil horizontal)
3353 (- (window-min-delta nil horizontal)))
3354 horizontal)))))
3356 (defun shrink-window (delta &optional horizontal)
3357 "Make the selected window DELTA lines smaller.
3358 Interactively, if no argument is given, make the selected window
3359 one line smaller. If optional argument HORIZONTAL is non-nil,
3360 make selected window narrower by DELTA columns. If DELTA is
3361 negative, enlarge selected window by -DELTA lines or columns.
3362 Also see the `window-min-height' variable."
3363 (interactive "p")
3364 (let ((minibuffer-window (minibuffer-window)))
3365 (when (window-preserved-size nil horizontal)
3366 (window-preserve-size nil horizontal))
3367 (cond
3368 ((zerop delta))
3369 ((window-size-fixed-p nil horizontal)
3370 (error "Selected window has fixed size"))
3371 ((window-minibuffer-p)
3372 (if horizontal
3373 (error "Cannot resize minibuffer window horizontally")
3374 (window--resize-mini-window (selected-window) (- delta))))
3375 ((and (not horizontal)
3376 (window-full-height-p)
3377 (eq (window-frame minibuffer-window) (selected-frame))
3378 (not resize-mini-windows))
3379 ;; If the selected window is full height and `resize-mini-windows'
3380 ;; is nil, resize the minibuffer window.
3381 (window--resize-mini-window minibuffer-window delta))
3382 ((window--resizable-p nil (- delta) horizontal)
3383 (window-resize nil (- delta) horizontal))
3384 (t
3385 (window-resize
3386 nil (if (> delta 0)
3387 (- (window-min-delta nil horizontal))
3388 (window-max-delta nil horizontal))
3389 horizontal)))))
3391 (defun maximize-window (&optional window)
3392 "Maximize WINDOW.
3393 Make WINDOW as large as possible without deleting any windows.
3394 WINDOW must be a valid window and defaults to the selected one.
3396 If the option `window-resize-pixelwise' is non-nil maximize
3397 WINDOW pixelwise."
3398 (interactive)
3399 (setq window (window-normalize-window window))
3400 (window-resize
3401 window (window-max-delta window nil nil nil nil nil window-resize-pixelwise)
3402 nil nil window-resize-pixelwise)
3403 (window-resize
3404 window (window-max-delta window t nil nil nil nil window-resize-pixelwise)
3405 t nil window-resize-pixelwise))
3407 (defun minimize-window (&optional window)
3408 "Minimize WINDOW.
3409 Make WINDOW as small as possible without deleting any windows.
3410 WINDOW must be a valid window and defaults to the selected one.
3412 If the option `window-resize-pixelwise' is non-nil minimize
3413 WINDOW pixelwise."
3414 (interactive)
3415 (setq window (window-normalize-window window))
3416 (window-resize
3417 window
3418 (- (window-min-delta window nil nil nil nil nil window-resize-pixelwise))
3419 nil nil window-resize-pixelwise)
3420 (window-resize
3421 window
3422 (- (window-min-delta window t nil nil nil nil window-resize-pixelwise))
3423 t nil window-resize-pixelwise))
3424 \f
3425 (defun frame-root-window-p (window)
3426 "Return non-nil if WINDOW is the root window of its frame."
3427 (eq window (frame-root-window window)))
3429 (defun window--subtree (window &optional next)
3430 "Return window subtree rooted at WINDOW.
3431 Optional argument NEXT non-nil means include WINDOW's right
3432 siblings in the return value.
3434 See the documentation of `window-tree' for a description of the
3435 return value."
3436 (let (list)
3437 (while window
3438 (setq list
3439 (cons
3440 (cond
3441 ((window-top-child window)
3442 (cons t (cons (window-edges window)
3443 (window--subtree (window-top-child window) t))))
3444 ((window-left-child window)
3445 (cons nil (cons (window-edges window)
3446 (window--subtree (window-left-child window) t))))
3447 (t window))
3448 list))
3449 (setq window (when next (window-next-sibling window))))
3450 (nreverse list)))
3452 (defun window-tree (&optional frame)
3453 "Return the window tree of frame FRAME.
3454 FRAME must be a live frame and defaults to the selected frame.
3455 The return value is a list of the form (ROOT MINI), where ROOT
3456 represents the window tree of the frame's root window, and MINI
3457 is the frame's minibuffer window.
3459 If the root window is not split, ROOT is the root window itself.
3460 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
3461 for a horizontal split, and t for a vertical split. EDGES gives
3462 the combined size and position of the child windows in the split,
3463 and the rest of the elements are the child windows in the split.
3464 Each of the child windows may again be a window or a list
3465 representing a window split, and so on. EDGES is a list (LEFT
3466 TOP RIGHT BOTTOM) as returned by `window-edges'."
3467 (setq frame (window-normalize-frame frame))
3468 (window--subtree (frame-root-window frame) t))
3469 \f
3470 (defun other-window (count &optional all-frames)
3471 "Select another window in cyclic ordering of windows.
3472 COUNT specifies the number of windows to skip, starting with the
3473 selected window, before making the selection. If COUNT is
3474 positive, skip COUNT windows forwards. If COUNT is negative,
3475 skip -COUNT windows backwards. COUNT zero means do not skip any
3476 window, so select the selected window. In an interactive call,
3477 COUNT is the numeric prefix argument. Return nil.
3479 If the `other-window' parameter of the selected window is a
3480 function and `ignore-window-parameters' is nil, call that
3481 function with the arguments COUNT and ALL-FRAMES.
3483 This function does not select a window whose `no-other-window'
3484 window parameter is non-nil.
3486 This function uses `next-window' for finding the window to
3487 select. The argument ALL-FRAMES has the same meaning as in
3488 `next-window', but the MINIBUF argument of `next-window' is
3489 always effectively nil."
3490 (interactive "p")
3491 (let* ((window (selected-window))
3492 (function (and (not ignore-window-parameters)
3493 (window-parameter window 'other-window)))
3494 old-window old-count)
3495 (if (functionp function)
3496 (funcall function count all-frames)
3497 ;; `next-window' and `previous-window' may return a window we are
3498 ;; not allowed to select. Hence we need an exit strategy in case
3499 ;; all windows are non-selectable.
3500 (catch 'exit
3501 (while (> count 0)
3502 (setq window (next-window window nil all-frames))
3503 (cond
3504 ((eq window old-window)
3505 (when (= count old-count)
3506 ;; Keep out of infinite loops. When COUNT has not changed
3507 ;; since we last looked at `window' we're probably in one.
3508 (throw 'exit nil)))
3509 ((window-parameter window 'no-other-window)
3510 (unless old-window
3511 ;; The first non-selectable window `next-window' got us:
3512 ;; Remember it and the current value of COUNT.
3513 (setq old-window window)
3514 (setq old-count count)))
3515 (t
3516 (setq count (1- count)))))
3517 (while (< count 0)
3518 (setq window (previous-window window nil all-frames))
3519 (cond
3520 ((eq window old-window)
3521 (when (= count old-count)
3522 ;; Keep out of infinite loops. When COUNT has not changed
3523 ;; since we last looked at `window' we're probably in one.
3524 (throw 'exit nil)))
3525 ((window-parameter window 'no-other-window)
3526 (unless old-window
3527 ;; The first non-selectable window `previous-window' got
3528 ;; us: Remember it and the current value of COUNT.
3529 (setq old-window window)
3530 (setq old-count count)))
3531 (t
3532 (setq count (1+ count)))))
3534 (select-window window)
3535 ;; Always return nil.
3536 nil))))
3538 ;; This should probably return non-nil when the selected window is part
3539 ;; of an atomic window whose root is the frame's root window.
3540 (defun one-window-p (&optional nomini all-frames)
3541 "Return non-nil if the selected window is the only window.
3542 Optional arg NOMINI non-nil means don't count the minibuffer
3543 even if it is active. Otherwise, the minibuffer is counted
3544 when it is active.
3546 Optional argument ALL-FRAMES specifies the set of frames to
3547 consider, see also `next-window'. ALL-FRAMES nil or omitted
3548 means consider windows on the selected frame only, plus the
3549 minibuffer window if specified by the NOMINI argument. If the
3550 minibuffer counts, consider all windows on all frames that share
3551 that minibuffer too. The remaining non-nil values of ALL-FRAMES
3552 with a special meaning are:
3554 - t means consider all windows on all existing frames.
3556 - `visible' means consider all windows on all visible frames on
3557 the current terminal.
3559 - 0 (the number zero) means consider all windows on all visible
3560 and iconified frames on the current terminal.
3562 - A frame means consider all windows on that frame only.
3564 Anything else means consider all windows on the selected frame
3565 and no others."
3566 (let ((base-window (selected-window)))
3567 (if (and nomini (eq base-window (minibuffer-window)))
3568 (setq base-window (next-window base-window)))
3569 (eq base-window
3570 (next-window base-window (if nomini 'arg) all-frames))))
3571 \f
3572 ;;; Deleting windows.
3573 (defun window-deletable-p (&optional window)
3574 "Return t if WINDOW can be safely deleted from its frame.
3575 WINDOW must be a valid window and defaults to the selected one.
3576 Return 'frame if deleting WINDOW should also delete its frame."
3577 (setq window (window-normalize-window window))
3579 (unless (or ignore-window-parameters
3580 (eq (window-parameter window 'delete-window) t))
3581 ;; Handle atomicity.
3582 (when (window-parameter window 'window-atom)
3583 (setq window (window-atom-root window))))
3585 (let ((frame (window-frame window)))
3586 (cond
3587 ((frame-root-window-p window)
3588 ;; WINDOW's frame can be deleted only if there are other frames
3589 ;; on the same terminal, and it does not contain the active
3590 ;; minibuffer.
3591 (unless (or (eq frame (next-frame frame 0))
3592 ;; We can delete our frame only if no other frame
3593 ;; currently uses our minibuffer window.
3594 (catch 'other
3595 (dolist (other (frame-list))
3596 (when (and (not (eq other frame))
3597 (eq (window-frame (minibuffer-window other))
3598 frame))
3599 (throw 'other t))))
3600 (let ((minibuf (active-minibuffer-window)))
3601 (and minibuf (eq frame (window-frame minibuf)))))
3602 'frame))
3603 ((or ignore-window-parameters
3604 (not (eq window (window--major-non-side-window frame))))
3605 ;; WINDOW can be deleted unless it is the major non-side window of
3606 ;; its frame.
3607 t))))
3609 (defun window--in-subtree-p (window root)
3610 "Return t if WINDOW is either ROOT or a member of ROOT's subtree."
3611 (or (eq window root)
3612 (let ((parent (window-parent window)))
3613 (catch 'done
3614 (while parent
3615 (if (eq parent root)
3616 (throw 'done t)
3617 (setq parent (window-parent parent))))))))
3619 (defun delete-window (&optional window)
3620 "Delete WINDOW.
3621 WINDOW must be a valid window and defaults to the selected one.
3622 Return nil.
3624 If the variable `ignore-window-parameters' is non-nil or the
3625 `delete-window' parameter of WINDOW equals t, do not process any
3626 parameters of WINDOW. Otherwise, if the `delete-window'
3627 parameter of WINDOW specifies a function, call that function with
3628 WINDOW as its sole argument and return the value returned by that
3629 function.
3631 Otherwise, if WINDOW is part of an atomic window, call
3632 `delete-window' with the root of the atomic window as its
3633 argument. Signal an error if WINDOW is either the only window on
3634 its frame, the last non-side window, or part of an atomic window
3635 that is its frame's root window."
3636 (interactive)
3637 (setq window (window-normalize-window window))
3638 (let* ((frame (window-frame window))
3639 (function (window-parameter window 'delete-window))
3640 (parent (window-parent window))
3641 atom-root)
3642 (window--check frame)
3643 (catch 'done
3644 ;; Handle window parameters.
3645 (cond
3646 ;; Ignore window parameters if `ignore-window-parameters' tells
3647 ;; us so or `delete-window' equals t.
3648 ((or ignore-window-parameters (eq function t)))
3649 ((functionp function)
3650 ;; The `delete-window' parameter specifies the function to call.
3651 ;; If that function is `ignore' nothing is done. It's up to the
3652 ;; function called here to avoid infinite recursion.
3653 (throw 'done (funcall function window)))
3654 ((and (window-parameter window 'window-atom)
3655 (setq atom-root (window-atom-root window))
3656 (not (eq atom-root window)))
3657 (if (eq atom-root (frame-root-window frame))
3658 (error "Root of atomic window is root window of its frame")
3659 (throw 'done (delete-window atom-root))))
3660 ((not parent)
3661 (error "Attempt to delete minibuffer or sole ordinary window"))
3662 ((eq window (window--major-non-side-window frame))
3663 (error "Attempt to delete last non-side window")))
3665 (let* ((horizontal (window-left-child parent))
3666 (size (window-size window horizontal t))
3667 (frame-selected
3668 (window--in-subtree-p (frame-selected-window frame) window))
3669 ;; Emacs 23 preferably gives WINDOW's space to its left
3670 ;; sibling.
3671 (sibling (or (window-left window) (window-right window))))
3672 (window--resize-reset frame horizontal)
3673 (cond
3674 ((and (not window-combination-resize)
3675 sibling (window-sizable-p sibling size horizontal nil t))
3676 ;; Resize WINDOW's sibling.
3677 (window--resize-this-window sibling size horizontal nil t)
3678 (set-window-new-normal
3679 sibling (+ (window-normal-size sibling horizontal)
3680 (window-normal-size window horizontal))))
3681 ((window--resizable-p window (- size) horizontal nil nil nil t t)
3682 ;; Can do without resizing fixed-size windows.
3683 (window--resize-siblings window (- size) horizontal))
3684 (t
3685 ;; Can't do without resizing fixed-size windows.
3686 (window--resize-siblings window (- size) horizontal t)))
3687 ;; Actually delete WINDOW.
3688 (delete-window-internal window)
3689 (window--pixel-to-total frame horizontal)
3690 (when (and frame-selected
3691 (window-parameter
3692 (frame-selected-window frame) 'no-other-window))
3693 ;; `delete-window-internal' has selected a window that should
3694 ;; not be selected, fix this here.
3695 (other-window -1 frame))
3696 (run-window-configuration-change-hook frame)
3697 (window--check frame)
3698 ;; Always return nil.
3699 nil))))
3701 (defun delete-other-windows (&optional window)
3702 "Make WINDOW fill its frame.
3703 WINDOW must be a valid window and defaults to the selected one.
3704 Return nil.
3706 If the variable `ignore-window-parameters' is non-nil or the
3707 `delete-other-windows' parameter of WINDOW equals t, do not
3708 process any parameters of WINDOW. Otherwise, if the
3709 `delete-other-windows' parameter of WINDOW specifies a function,
3710 call that function with WINDOW as its sole argument and return
3711 the value returned by that function.
3713 Otherwise, if WINDOW is part of an atomic window, call this
3714 function with the root of the atomic window as its argument. If
3715 WINDOW is a non-side window, make WINDOW the only non-side window
3716 on the frame. Side windows are not deleted. If WINDOW is a side
3717 window signal an error."
3718 (interactive)
3719 (setq window (window-normalize-window window))
3720 (let* ((frame (window-frame window))
3721 (function (window-parameter window 'delete-other-windows))
3722 (window-side (window-parameter window 'window-side))
3723 atom-root side-main)
3724 (window--check frame)
3725 (catch 'done
3726 (cond
3727 ;; Ignore window parameters if `ignore-window-parameters' is t or
3728 ;; `delete-other-windows' is t.
3729 ((or ignore-window-parameters (eq function t)))
3730 ((functionp function)
3731 ;; The `delete-other-windows' parameter specifies the function
3732 ;; to call. If the function is `ignore' no windows are deleted.
3733 ;; It's up to the function called to avoid infinite recursion.
3734 (throw 'done (funcall function window)))
3735 ((and (window-parameter window 'window-atom)
3736 (setq atom-root (window-atom-root window))
3737 (not (eq atom-root window)))
3738 (if (eq atom-root (frame-root-window frame))
3739 (error "Root of atomic window is root window of its frame")
3740 (throw 'done (delete-other-windows atom-root))))
3741 ((memq window-side window-sides)
3742 (error "Cannot make side window the only window"))
3743 ((and (window-minibuffer-p window)
3744 (not (eq window (frame-root-window window))))
3745 (error "Can't expand minibuffer to full frame")))
3747 ;; If WINDOW is the major non-side window, do nothing.
3748 (if (window-with-parameter 'window-side)
3749 (setq side-main (window--major-non-side-window frame))
3750 (setq side-main (frame-root-window frame)))
3751 (unless (eq window side-main)
3752 (delete-other-windows-internal window side-main)
3753 (run-window-configuration-change-hook frame)
3754 (window--check frame))
3755 ;; Always return nil.
3756 nil)))
3758 (defun delete-other-windows-vertically (&optional window)
3759 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
3760 This may be a useful alternative binding for \\[delete-other-windows]
3761 if you often split windows horizontally."
3762 (interactive)
3763 (let* ((window (or window (selected-window)))
3764 (edges (window-edges window))
3765 (w window) delenda)
3766 (while (not (eq (setq w (next-window w 1)) window))
3767 (let ((e (window-edges w)))
3768 (when (and (= (car e) (car edges))
3769 (= (nth 2 e) (nth 2 edges)))
3770 (push w delenda))))
3771 (mapc 'delete-window delenda)))
3773 ;;; Windows and buffers.
3775 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
3776 ;; for (1) determining which buffer to show in the window when its
3777 ;; buffer shall be buried or killed and (2) which buffer to show for
3778 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
3780 ;; `prev-buffers' consists of <buffer, window-start, window-point>
3781 ;; triples. The entries on this list are ordered by the time their
3782 ;; buffer has been removed from the window, the most recently removed
3783 ;; buffer's entry being first. The window-start and window-point
3784 ;; components are `window-start' and `window-point' at the time the
3785 ;; buffer was removed from the window which implies that the entry must
3786 ;; be added when `set-window-buffer' removes the buffer from the window.
3788 ;; `next-buffers' is the list of buffers that have been replaced
3789 ;; recently by `switch-to-prev-buffer'. These buffers are the least
3790 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
3791 ;; candidates of `switch-to-next-buffer' to switch to. This list is
3792 ;; reset to nil by any action changing the window's buffer with the
3793 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
3794 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
3795 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
3797 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
3798 ;; if such a buffer was killed while the window was hidden within a
3799 ;; window configuration. Such killed buffers get removed whenever
3800 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
3802 ;; The following function is called by `set-window-buffer' _before_ it
3803 ;; replaces the buffer of the argument window with the new buffer.
3804 (defun record-window-buffer (&optional window)
3805 "Record WINDOW's buffer.
3806 WINDOW must be a live window and defaults to the selected one."
3807 (let* ((window (window-normalize-window window t))
3808 (buffer (window-buffer window))
3809 (entry (assq buffer (window-prev-buffers window))))
3810 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
3811 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
3812 (set-window-next-buffers window nil)
3814 (when entry
3815 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
3816 (set-window-prev-buffers
3817 window (assq-delete-all buffer (window-prev-buffers window))))
3819 ;; Don't record insignificant buffers.
3820 (unless (eq (aref (buffer-name buffer) 0) ?\s)
3821 ;; Add an entry for buffer to WINDOW's previous buffers.
3822 (with-current-buffer buffer
3823 (let ((start (window-start window))
3824 (point (window-point window)))
3825 (setq entry
3826 (cons buffer
3827 (if entry
3828 ;; We have an entry, update marker positions.
3829 (list (set-marker (nth 1 entry) start)
3830 (set-marker (nth 2 entry) point))
3831 ;; Make new markers.
3832 (list (copy-marker start)
3833 (copy-marker
3834 ;; Preserve window-point-insertion-type
3835 ;; (Bug#12588).
3836 point window-point-insertion-type)))))
3837 (set-window-prev-buffers
3838 window (cons entry (window-prev-buffers window)))))
3840 (run-hooks 'buffer-list-update-hook))))
3842 (defun unrecord-window-buffer (&optional window buffer)
3843 "Unrecord BUFFER in WINDOW.
3844 WINDOW must be a live window and defaults to the selected one.
3845 BUFFER must be a live buffer and defaults to the buffer of
3846 WINDOW."
3847 (let* ((window (window-normalize-window window t))
3848 (buffer (or buffer (window-buffer window))))
3849 (set-window-prev-buffers
3850 window (assq-delete-all buffer (window-prev-buffers window)))
3851 (set-window-next-buffers
3852 window (delq buffer (window-next-buffers window)))))
3854 (defun set-window-buffer-start-and-point (window buffer &optional start point)
3855 "Set WINDOW's buffer to BUFFER.
3856 WINDOW must be a live window and defaults to the selected one.
3857 Optional argument START non-nil means set WINDOW's start position
3858 to START. Optional argument POINT non-nil means set WINDOW's
3859 point to POINT. If WINDOW is selected this also sets BUFFER's
3860 `point' to POINT. If WINDOW is selected and the buffer it showed
3861 before was current this also makes BUFFER the current buffer."
3862 (setq window (window-normalize-window window t))
3863 (let ((selected (eq window (selected-window)))
3864 (current (eq (window-buffer window) (current-buffer))))
3865 (set-window-buffer window buffer)
3866 (when (and selected current)
3867 (set-buffer buffer))
3868 (when start
3869 ;; Don't force window-start here (even if POINT is nil).
3870 (set-window-start window start t))
3871 (when point
3872 (set-window-point window point))))
3874 (defcustom switch-to-visible-buffer t
3875 "If non-nil, allow switching to an already visible buffer.
3876 If this variable is non-nil, `switch-to-prev-buffer' and
3877 `switch-to-next-buffer' may switch to an already visible buffer.
3878 If this variable is nil, `switch-to-prev-buffer' and
3879 `switch-to-next-buffer' always try to avoid switching to a buffer
3880 that is already visible in another window on the same frame."
3881 :type 'boolean
3882 :version "24.1"
3883 :group 'windows)
3885 (defun switch-to-prev-buffer (&optional window bury-or-kill)
3886 "In WINDOW switch to previous buffer.
3887 WINDOW must be a live window and defaults to the selected one.
3888 Return the buffer switched to, nil if no suitable buffer could be
3889 found.
3891 Optional argument BURY-OR-KILL non-nil means the buffer currently
3892 shown in WINDOW is about to be buried or killed and consequently
3893 shall not be switched to in future invocations of this command.
3895 As a special case, if BURY-OR-KILL equals `append', this means to
3896 move the buffer to the end of WINDOW's previous buffers list so a
3897 future invocation of `switch-to-prev-buffer' less likely switches
3898 to it."
3899 (interactive)
3900 (let* ((window (window-normalize-window window t))
3901 (frame (window-frame window))
3902 (old-buffer (window-buffer window))
3903 ;; Save this since it's destroyed by `set-window-buffer'.
3904 (next-buffers (window-next-buffers window))
3905 (pred (frame-parameter frame 'buffer-predicate))
3906 entry new-buffer killed-buffers visible)
3907 (when (window-minibuffer-p window)
3908 ;; Don't switch in minibuffer window.
3909 (unless (setq window (minibuffer-selected-window))
3910 (error "Window %s is a minibuffer window" window)))
3912 (when (window-dedicated-p window)
3913 ;; Don't switch in dedicated window.
3914 (error "Window %s is dedicated to buffer %s" window old-buffer))
3916 (catch 'found
3917 ;; Scan WINDOW's previous buffers first, skipping entries of next
3918 ;; buffers.
3919 (dolist (entry (window-prev-buffers window))
3920 (when (and (setq new-buffer (car entry))
3921 (or (buffer-live-p new-buffer)
3922 (not (setq killed-buffers
3923 (cons new-buffer killed-buffers))))
3924 (not (eq new-buffer old-buffer))
3925 (or (null pred) (funcall pred new-buffer))
3926 ;; When BURY-OR-KILL is nil, avoid switching to a
3927 ;; buffer in WINDOW's next buffers list.
3928 (or bury-or-kill (not (memq new-buffer next-buffers))))
3929 (if (and (not switch-to-visible-buffer)
3930 (get-buffer-window new-buffer frame))
3931 ;; Try to avoid showing a buffer visible in some other
3932 ;; window.
3933 (setq visible new-buffer)
3934 (set-window-buffer-start-and-point
3935 window new-buffer (nth 1 entry) (nth 2 entry))
3936 (throw 'found t))))
3937 ;; Scan reverted buffer list of WINDOW's frame next, skipping
3938 ;; entries of next buffers. Note that when we bury or kill a
3939 ;; buffer we don't reverse the global buffer list to avoid showing
3940 ;; a buried buffer instead. Otherwise, we must reverse the global
3941 ;; buffer list in order to make sure that switching to the
3942 ;; previous/next buffer traverse it in opposite directions.
3943 (dolist (buffer (if bury-or-kill
3944 (buffer-list frame)
3945 (nreverse (buffer-list frame))))
3946 (when (and (buffer-live-p buffer)
3947 (not (eq buffer old-buffer))
3948 (or (null pred) (funcall pred buffer))
3949 (not (eq (aref (buffer-name buffer) 0) ?\s))
3950 (or bury-or-kill (not (memq buffer next-buffers))))
3951 (if (and (not switch-to-visible-buffer)
3952 (get-buffer-window buffer frame))
3953 ;; Try to avoid showing a buffer visible in some other window.
3954 (unless visible
3955 (setq visible buffer))
3956 (setq new-buffer buffer)
3957 (set-window-buffer-start-and-point window new-buffer)
3958 (throw 'found t))))
3959 (unless bury-or-kill
3960 ;; Scan reverted next buffers last (must not use nreverse
3961 ;; here!).
3962 (dolist (buffer (reverse next-buffers))
3963 ;; Actually, buffer _must_ be live here since otherwise it
3964 ;; would have been caught in the scan of previous buffers.
3965 (when (and (or (buffer-live-p buffer)
3966 (not (setq killed-buffers
3967 (cons buffer killed-buffers))))
3968 (not (eq buffer old-buffer))
3969 (or (null pred) (funcall pred buffer))
3970 (setq entry (assq buffer (window-prev-buffers window))))
3971 (setq new-buffer buffer)
3972 (set-window-buffer-start-and-point
3973 window new-buffer (nth 1 entry) (nth 2 entry))
3974 (throw 'found t))))
3976 ;; Show a buffer visible in another window.
3977 (when visible
3978 (setq new-buffer visible)
3979 (set-window-buffer-start-and-point window new-buffer)))
3981 (if bury-or-kill
3982 (let ((entry (and (eq bury-or-kill 'append)
3983 (assq old-buffer (window-prev-buffers window)))))
3984 ;; Remove `old-buffer' from WINDOW's previous and (restored list
3985 ;; of) next buffers.
3986 (set-window-prev-buffers
3987 window (assq-delete-all old-buffer (window-prev-buffers window)))
3988 (set-window-next-buffers window (delq old-buffer next-buffers))
3989 (when entry
3990 ;; Append old-buffer's entry to list of WINDOW's previous
3991 ;; buffers so it's less likely to get switched to soon but
3992 ;; `display-buffer-in-previous-window' can nevertheless find
3993 ;; it.
3994 (set-window-prev-buffers
3995 window (append (window-prev-buffers window) (list entry)))))
3996 ;; Move `old-buffer' to head of WINDOW's restored list of next
3997 ;; buffers.
3998 (set-window-next-buffers
3999 window (cons old-buffer (delq old-buffer next-buffers))))
4001 ;; Remove killed buffers from WINDOW's previous and next buffers.
4002 (when killed-buffers
4003 (dolist (buffer killed-buffers)
4004 (set-window-prev-buffers
4005 window (assq-delete-all buffer (window-prev-buffers window)))
4006 (set-window-next-buffers
4007 window (delq buffer (window-next-buffers window)))))
4009 ;; Return new-buffer.
4010 new-buffer))
4012 (defun switch-to-next-buffer (&optional window)
4013 "In WINDOW switch to next buffer.
4014 WINDOW must be a live window and defaults to the selected one.
4015 Return the buffer switched to, nil if no suitable buffer could be
4016 found."
4017 (interactive)
4018 (let* ((window (window-normalize-window window t))
4019 (frame (window-frame window))
4020 (old-buffer (window-buffer window))
4021 (next-buffers (window-next-buffers window))
4022 (pred (frame-parameter frame 'buffer-predicate))
4023 new-buffer entry killed-buffers visible)
4024 (when (window-minibuffer-p window)
4025 ;; Don't switch in minibuffer window.
4026 (unless (setq window (minibuffer-selected-window))
4027 (error "Window %s is a minibuffer window" window)))
4029 (when (window-dedicated-p window)
4030 ;; Don't switch in dedicated window.
4031 (error "Window %s is dedicated to buffer %s" window old-buffer))
4033 (catch 'found
4034 ;; Scan WINDOW's next buffers first.
4035 (dolist (buffer next-buffers)
4036 (when (and (or (buffer-live-p buffer)
4037 (not (setq killed-buffers
4038 (cons buffer killed-buffers))))
4039 (not (eq buffer old-buffer))
4040 (or (null pred) (funcall pred buffer))
4041 (setq entry (assq buffer (window-prev-buffers window))))
4042 (setq new-buffer buffer)
4043 (set-window-buffer-start-and-point
4044 window new-buffer (nth 1 entry) (nth 2 entry))
4045 (throw 'found t)))
4046 ;; Scan the buffer list of WINDOW's frame next, skipping previous
4047 ;; buffers entries.
4048 (dolist (buffer (buffer-list frame))
4049 (when (and (buffer-live-p buffer)
4050 (not (eq buffer old-buffer))
4051 (or (null pred) (funcall pred buffer))
4052 (not (eq (aref (buffer-name buffer) 0) ?\s))
4053 (not (assq buffer (window-prev-buffers window))))
4054 (if (and (not switch-to-visible-buffer)
4055 (get-buffer-window buffer frame))
4056 ;; Try to avoid showing a buffer visible in some other window.
4057 (setq visible buffer)
4058 (setq new-buffer buffer)
4059 (set-window-buffer-start-and-point window new-buffer)
4060 (throw 'found t))))
4061 ;; Scan WINDOW's reverted previous buffers last (must not use
4062 ;; nreverse here!)
4063 (dolist (entry (reverse (window-prev-buffers window)))
4064 (when (and (setq new-buffer (car entry))
4065 (or (buffer-live-p new-buffer)
4066 (not (setq killed-buffers
4067 (cons new-buffer killed-buffers))))
4068 (not (eq new-buffer old-buffer))
4069 (or (null pred) (funcall pred new-buffer)))
4070 (if (and (not switch-to-visible-buffer)
4071 (get-buffer-window new-buffer frame))
4072 ;; Try to avoid showing a buffer visible in some other window.
4073 (unless visible
4074 (setq visible new-buffer))
4075 (set-window-buffer-start-and-point
4076 window new-buffer (nth 1 entry) (nth 2 entry))
4077 (throw 'found t))))
4079 ;; Show a buffer visible in another window.
4080 (when visible
4081 (setq new-buffer visible)
4082 (set-window-buffer-start-and-point window new-buffer)))
4084 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
4085 (set-window-next-buffers window (delq new-buffer next-buffers))
4087 ;; Remove killed buffers from WINDOW's previous and next buffers.
4088 (when killed-buffers
4089 (dolist (buffer killed-buffers)
4090 (set-window-prev-buffers
4091 window (assq-delete-all buffer (window-prev-buffers window)))
4092 (set-window-next-buffers
4093 window (delq buffer (window-next-buffers window)))))
4095 ;; Return new-buffer.
4096 new-buffer))
4098 (defun get-next-valid-buffer (list &optional buffer visible-ok frame)
4099 "Search LIST for a valid buffer to display in FRAME.
4100 Return nil when all buffers in LIST are undesirable for display,
4101 otherwise return the first suitable buffer in LIST.
4103 Buffers not visible in windows are preferred to visible buffers,
4104 unless VISIBLE-OK is non-nil.
4105 If the optional argument FRAME is nil, it defaults to the selected frame.
4106 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
4107 ;; This logic is more or less copied from other-buffer.
4108 (setq frame (or frame (selected-frame)))
4109 (let ((pred (frame-parameter frame 'buffer-predicate))
4110 found buf)
4111 (while (and (not found) list)
4112 (setq buf (car list))
4113 (if (and (not (eq buffer buf))
4114 (buffer-live-p buf)
4115 (or (null pred) (funcall pred buf))
4116 (not (eq (aref (buffer-name buf) 0) ?\s))
4117 (or visible-ok (null (get-buffer-window buf 'visible))))
4118 (setq found buf)
4119 (setq list (cdr list))))
4120 (car list)))
4122 (defun last-buffer (&optional buffer visible-ok frame)
4123 "Return the last buffer in FRAME's buffer list.
4124 If BUFFER is the last buffer, return the preceding buffer
4125 instead. Buffers not visible in windows are preferred to visible
4126 buffers, unless optional argument VISIBLE-OK is non-nil.
4127 Optional third argument FRAME nil or omitted means use the
4128 selected frame's buffer list. If no such buffer exists, return
4129 the buffer `*scratch*', creating it if necessary."
4130 (setq frame (or frame (selected-frame)))
4131 (or (get-next-valid-buffer (nreverse (buffer-list frame))
4132 buffer visible-ok frame)
4133 (get-buffer "*scratch*")
4134 (let ((scratch (get-buffer-create "*scratch*")))
4135 (set-buffer-major-mode scratch)
4136 scratch)))
4138 (defcustom frame-auto-hide-function #'iconify-frame
4139 "Function called to automatically hide frames.
4140 The function is called with one argument - a frame.
4142 Functions affected by this option are those that bury a buffer
4143 shown in a separate frame like `quit-window' and `bury-buffer'."
4144 :type '(choice (const :tag "Iconify" iconify-frame)
4145 (const :tag "Delete" delete-frame)
4146 (const :tag "Do nothing" ignore)
4147 function)
4148 :group 'windows
4149 :group 'frames
4150 :version "24.1")
4152 (defun window--delete (&optional window dedicated-only kill)
4153 "Delete WINDOW if possible.
4154 WINDOW must be a live window and defaults to the selected one.
4155 Optional argument DEDICATED-ONLY non-nil means to delete WINDOW
4156 only if it's dedicated to its buffer. Optional argument KILL
4157 means the buffer shown in window will be killed. Return non-nil
4158 if WINDOW gets deleted or its frame is auto-hidden."
4159 (setq window (window-normalize-window window t))
4160 (unless (and dedicated-only (not (window-dedicated-p window)))
4161 (let ((deletable (window-deletable-p window)))
4162 (cond
4163 ((eq deletable 'frame)
4164 (let ((frame (window-frame window)))
4165 (cond
4166 (kill
4167 (delete-frame frame))
4168 ((functionp frame-auto-hide-function)
4169 (funcall frame-auto-hide-function frame))))
4170 'frame)
4171 (deletable
4172 (delete-window window)
4173 t)))))
4175 (defun bury-buffer (&optional buffer-or-name)
4176 "Put BUFFER-OR-NAME at the end of the list of all buffers.
4177 There it is the least likely candidate for `other-buffer' to
4178 return; thus, the least likely buffer for \\[switch-to-buffer] to
4179 select by default.
4181 You can specify a buffer name as BUFFER-OR-NAME, or an actual
4182 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
4183 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
4184 remove the current buffer from the selected window if it is
4185 displayed there."
4186 (interactive)
4187 (let* ((buffer (window-normalize-buffer buffer-or-name)))
4188 ;; If `buffer-or-name' is not on the selected frame we unrecord it
4189 ;; although it's not "here" (call it a feature).
4190 (bury-buffer-internal buffer)
4191 ;; Handle case where `buffer-or-name' is nil and the current buffer
4192 ;; is shown in the selected window.
4193 (cond
4194 ((or buffer-or-name (not (eq buffer (window-buffer)))))
4195 ((window--delete nil t))
4196 (t
4197 ;; Switch to another buffer in window.
4198 (set-window-dedicated-p nil nil)
4199 (switch-to-prev-buffer nil 'bury)))
4201 ;; Always return nil.
4202 nil))
4204 (defun unbury-buffer ()
4205 "Switch to the last buffer in the buffer list."
4206 (interactive)
4207 (switch-to-buffer (last-buffer)))
4209 (defun next-buffer ()
4210 "In selected window switch to next buffer."
4211 (interactive)
4212 (cond
4213 ((window-minibuffer-p)
4214 (error "Cannot switch buffers in minibuffer window"))
4215 ((eq (window-dedicated-p) t)
4216 (error "Window is strongly dedicated to its buffer"))
4217 (t
4218 (switch-to-next-buffer))))
4220 (defun previous-buffer ()
4221 "In selected window switch to previous buffer."
4222 (interactive)
4223 (cond
4224 ((window-minibuffer-p)
4225 (error "Cannot switch buffers in minibuffer window"))
4226 ((eq (window-dedicated-p) t)
4227 (error "Window is strongly dedicated to its buffer"))
4228 (t
4229 (switch-to-prev-buffer))))
4231 (defun delete-windows-on (&optional buffer-or-name frame)
4232 "Delete all windows showing BUFFER-OR-NAME.
4233 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
4234 and defaults to the current buffer.
4236 The following non-nil values of the optional argument FRAME
4237 have special meanings:
4239 - t means consider all windows on the selected frame only.
4241 - `visible' means consider all windows on all visible frames on
4242 the current terminal.
4244 - 0 (the number zero) means consider all windows on all visible
4245 and iconified frames on the current terminal.
4247 - A frame means consider all windows on that frame only.
4249 Any other value of FRAME means consider all windows on all
4250 frames.
4252 When a window showing BUFFER-OR-NAME is dedicated and the only
4253 window of its frame, that frame is deleted when there are other
4254 frames left."
4255 (interactive "BDelete windows on (buffer):\nP")
4256 (let ((buffer (window-normalize-buffer buffer-or-name))
4257 ;; Handle the "inverted" meaning of the FRAME argument wrt other
4258 ;; `window-list-1' based function.
4259 (all-frames (cond ((not frame) t) ((eq frame t) nil) (t frame))))
4260 (dolist (window (window-list-1 nil nil all-frames))
4261 (if (eq (window-buffer window) buffer)
4262 (let ((deletable (window-deletable-p window)))
4263 (cond
4264 ((and (eq deletable 'frame) (window-dedicated-p window))
4265 ;; Delete frame if and only if window is dedicated.
4266 (delete-frame (window-frame window)))
4267 ((eq deletable t)
4268 ;; Delete window.
4269 (delete-window window))
4270 (t
4271 ;; In window switch to previous buffer.
4272 (set-window-dedicated-p window nil)
4273 (switch-to-prev-buffer window 'bury))))
4274 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
4275 (unrecord-window-buffer window buffer)))))
4277 (defun replace-buffer-in-windows (&optional buffer-or-name)
4278 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
4279 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
4280 and defaults to the current buffer.
4282 When a window showing BUFFER-OR-NAME is dedicated, that window is
4283 deleted. If that window is the only window on its frame, the
4284 frame is deleted too when there are other frames left. If there
4285 are no other frames left, some other buffer is displayed in that
4286 window.
4288 This function removes the buffer denoted by BUFFER-OR-NAME from
4289 all window-local buffer lists."
4290 (interactive "bBuffer to replace: ")
4291 (let ((buffer (window-normalize-buffer buffer-or-name)))
4292 (dolist (window (window-list-1 nil nil t))
4293 (if (eq (window-buffer window) buffer)
4294 (unless (window--delete window t t)
4295 ;; Switch to another buffer in window.
4296 (set-window-dedicated-p window nil)
4297 (switch-to-prev-buffer window 'kill))
4298 ;; Unrecord BUFFER in WINDOW.
4299 (unrecord-window-buffer window buffer)))))
4301 (defun quit-restore-window (&optional window bury-or-kill)
4302 "Quit WINDOW and deal with its buffer.
4303 WINDOW must be a live window and defaults to the selected one.
4305 According to information stored in WINDOW's `quit-restore' window
4306 parameter either (1) delete WINDOW and its frame, (2) delete
4307 WINDOW, (3) restore the buffer previously displayed in WINDOW,
4308 or (4) make WINDOW display some other buffer than the present
4309 one. If non-nil, reset `quit-restore' parameter to nil.
4311 Optional second argument BURY-OR-KILL tells how to proceed with
4312 the buffer of WINDOW. The following values are handled:
4314 nil means to not handle the buffer in a particular way. This
4315 means that if WINDOW is not deleted by this function, invoking
4316 `switch-to-prev-buffer' will usually show the buffer again.
4318 `append' means that if WINDOW is not deleted, move its buffer to
4319 the end of WINDOW's previous buffers so it's less likely that a
4320 future invocation of `switch-to-prev-buffer' will switch to it.
4321 Also, move the buffer to the end of the frame's buffer list.
4323 `bury' means that if WINDOW is not deleted, remove its buffer
4324 from WINDOW'S list of previous buffers. Also, move the buffer
4325 to the end of the frame's buffer list. This value provides the
4326 most reliable remedy to not have `switch-to-prev-buffer' switch
4327 to this buffer again without killing the buffer.
4329 `kill' means to kill WINDOW's buffer."
4330 (setq window (window-normalize-window window t))
4331 (let* ((buffer (window-buffer window))
4332 (quit-restore (window-parameter window 'quit-restore))
4333 (prev-buffer
4334 (let* ((prev-buffers (window-prev-buffers window))
4335 (prev-buffer (caar prev-buffers)))
4336 (and (or (not (eq prev-buffer buffer))
4337 (and (cdr prev-buffers)
4338 (not (eq (setq prev-buffer (cadr prev-buffers))
4339 buffer))))
4340 prev-buffer)))
4341 quad entry)
4342 (cond
4343 ((and (not prev-buffer)
4344 (or (eq (nth 1 quit-restore) 'frame)
4345 (and (eq (nth 1 quit-restore) 'window)
4346 ;; If the window has been created on an existing
4347 ;; frame and ended up as the sole window on that
4348 ;; frame, do not delete it (Bug#12764).
4349 (not (eq window (frame-root-window window)))))
4350 (eq (nth 3 quit-restore) buffer)
4351 ;; Delete WINDOW if possible.
4352 (window--delete window nil (eq bury-or-kill 'kill)))
4353 ;; If the previously selected window is still alive, select it.
4354 (when (window-live-p (nth 2 quit-restore))
4355 (select-window (nth 2 quit-restore))))
4356 ((and (listp (setq quad (nth 1 quit-restore)))
4357 (buffer-live-p (car quad))
4358 (eq (nth 3 quit-restore) buffer))
4359 ;; Show another buffer stored in quit-restore parameter.
4360 (when (and (integerp (nth 3 quad))
4361 (/= (nth 3 quad) (window-total-height window)))
4362 ;; Try to resize WINDOW to its old height but don't signal an
4363 ;; error.
4364 (condition-case nil
4365 (window-resize window (- (nth 3 quad) (window-total-height window)))
4366 (error nil)))
4367 (set-window-dedicated-p window nil)
4368 ;; Restore WINDOW's previous buffer, start and point position.
4369 (set-window-buffer-start-and-point
4370 window (nth 0 quad) (nth 1 quad) (nth 2 quad))
4371 ;; Deal with the buffer we just removed from WINDOW.
4372 (setq entry (and (eq bury-or-kill 'append)
4373 (assq buffer (window-prev-buffers window))))
4374 (when bury-or-kill
4375 ;; Remove buffer from WINDOW's previous and next buffers.
4376 (set-window-prev-buffers
4377 window (assq-delete-all buffer (window-prev-buffers window)))
4378 (set-window-next-buffers
4379 window (delq buffer (window-next-buffers window))))
4380 (when entry
4381 ;; Append old buffer's entry to list of WINDOW's previous
4382 ;; buffers so it's less likely to get switched to soon but
4383 ;; `display-buffer-in-previous-window' can nevertheless find it.
4384 (set-window-prev-buffers
4385 window (append (window-prev-buffers window) (list entry))))
4386 ;; Reset the quit-restore parameter.
4387 (set-window-parameter window 'quit-restore nil)
4388 ;; Select old window.
4389 (when (window-live-p (nth 2 quit-restore))
4390 (select-window (nth 2 quit-restore))))
4391 (t
4392 ;; Show some other buffer in WINDOW and reset the quit-restore
4393 ;; parameter.
4394 (set-window-parameter window 'quit-restore nil)
4395 ;; Make sure that WINDOW is no more dedicated.
4396 (set-window-dedicated-p window nil)
4397 (switch-to-prev-buffer window bury-or-kill)))
4399 ;; Deal with the buffer.
4400 (cond
4401 ((not (buffer-live-p buffer)))
4402 ((eq bury-or-kill 'kill)
4403 (kill-buffer buffer))
4404 (bury-or-kill
4405 (bury-buffer-internal buffer)))))
4407 (defun quit-window (&optional kill window)
4408 "Quit WINDOW and bury its buffer.
4409 WINDOW must be a live window and defaults to the selected one.
4410 With prefix argument KILL non-nil, kill the buffer instead of
4411 burying it.
4413 According to information stored in WINDOW's `quit-restore' window
4414 parameter either (1) delete WINDOW and its frame, (2) delete
4415 WINDOW, (3) restore the buffer previously displayed in WINDOW,
4416 or (4) make WINDOW display some other buffer than the present
4417 one. If non-nil, reset `quit-restore' parameter to nil."
4418 (interactive "P")
4419 (quit-restore-window window (if kill 'kill 'bury)))
4421 (defun quit-windows-on (&optional buffer-or-name kill frame)
4422 "Quit all windows showing BUFFER-OR-NAME.
4423 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
4424 and defaults to the current buffer. Optional argument KILL
4425 non-nil means to kill BUFFER-OR-NAME. KILL nil means to bury
4426 BUFFER-OR-NAME. Optional argument FRAME is handled as by
4427 `delete-windows-on'.
4429 This function calls `quit-window' on all candidate windows
4430 showing BUFFER-OR-NAME."
4431 (interactive "BQuit windows on (buffer):\nP")
4432 (let ((buffer (window-normalize-buffer buffer-or-name))
4433 ;; Handle the "inverted" meaning of the FRAME argument wrt other
4434 ;; `window-list-1' based function.
4435 (all-frames (cond ((not frame) t) ((eq frame t) nil) (t frame))))
4436 (dolist (window (window-list-1 nil nil all-frames))
4437 (if (eq (window-buffer window) buffer)
4438 (quit-window kill window)
4439 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
4440 (unrecord-window-buffer window buffer)))))
4441 \f
4442 (defun split-window (&optional window size side pixelwise)
4443 "Make a new window adjacent to WINDOW.
4444 WINDOW must be a valid window and defaults to the selected one.
4445 Return the new window which is always a live window.
4447 Optional argument SIZE a positive number means make WINDOW SIZE
4448 lines or columns tall. If SIZE is negative, make the new window
4449 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
4450 absolute value can be less than `window-min-height' or
4451 `window-min-width'; so this command can make a new window as
4452 small as one line or two columns. SIZE defaults to half of
4453 WINDOW's size.
4455 Optional third argument SIDE nil (or `below') specifies that the
4456 new window shall be located below WINDOW. SIDE `above' means the
4457 new window shall be located above WINDOW. In both cases SIZE
4458 specifies the new number of lines for WINDOW (or the new window
4459 if SIZE is negative) including space reserved for the mode and/or
4460 header line.
4462 SIDE t (or `right') specifies that the new window shall be
4463 located on the right side of WINDOW. SIDE `left' means the new
4464 window shall be located on the left of WINDOW. In both cases
4465 SIZE specifies the new number of columns for WINDOW (or the new
4466 window provided SIZE is negative) including space reserved for
4467 fringes and the scrollbar or a divider column. Any other non-nil
4468 value for SIDE is currently handled like t (or `right').
4470 PIXELWISE, if non-nil, means to interpret SIZE pixelwise.
4472 If the variable `ignore-window-parameters' is non-nil or the
4473 `split-window' parameter of WINDOW equals t, do not process any
4474 parameters of WINDOW. Otherwise, if the `split-window' parameter
4475 of WINDOW specifies a function, call that function with all three
4476 arguments and return the value returned by that function.
4478 Otherwise, if WINDOW is part of an atomic window, \"split\" the
4479 root of that atomic window. The new window does not become a
4480 member of that atomic window.
4482 If WINDOW is live, properties of the new window like margins and
4483 scrollbars are inherited from WINDOW. If WINDOW is an internal
4484 window, these properties as well as the buffer displayed in the
4485 new window are inherited from the window selected on WINDOW's
4486 frame. The selected window is not changed by this function."
4487 (setq window (window-normalize-window window))
4488 (let* ((side (cond
4489 ((not side) 'below)
4490 ((memq side '(below above right left)) side)
4491 (t 'right)))
4492 (horizontal (not (memq side '(below above))))
4493 (frame (window-frame window))
4494 (parent (window-parent window))
4495 (function (window-parameter window 'split-window))
4496 (window-side (window-parameter window 'window-side))
4497 ;; Rebind the following two variables since in some cases we
4498 ;; have to override their value.
4499 (window-combination-limit window-combination-limit)
4500 (window-combination-resize window-combination-resize)