; Fix more-recent commit messages too
[emacs.git] / lisp / window.el
1 ;;; window.el --- GNU Emacs window commands aside from those written in C
2
3 ;; Copyright (C) 1985, 1989, 1992-1994, 2000-2015 Free Software
4 ;; Foundation, Inc.
5
6 ;; Maintainer: emacs-devel@gnu.org
7 ;; Keywords: internal
8 ;; Package: emacs
9
10 ;; This file is part of GNU Emacs.
11
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.
16
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.
21
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/>.
24
25 ;;; Commentary:
26
27 ;; Window tree functions.
28
29 ;;; Code:
30
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)))))
51
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)))
59
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.
63
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.
70
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)))))
81
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.")
86
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.")
91
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)))
110
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))
130                        t
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))))
144
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).
149
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.
156
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.
162
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.
167
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.
173
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.
179
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)))
197
198          (if (functionp ,vquit-function)
199              (funcall ,vquit-function ,window ,value)
200            ,value)))))
201
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)))
220
221          (if (functionp ,vquit-function)
222              (funcall ,vquit-function ,window ,value)
223            ,value)))))
224
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))))
246
247          (let ((inhibit-read-only t)
248                (inhibit-modification-hooks t))
249            (setq ,value (progn ,@body)))
250
251          (set-window-point ,window (point-min))
252
253          (when (functionp (cdr (assq 'window-height (cdr ,vaction))))
254            (ignore-errors
255              (funcall (cdr (assq 'window-height (cdr ,vaction))) ,window)))
256
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)))))
262
263          (if (functionp ,vquit-function)
264              (funcall ,vquit-function ,window ,value)
265            ,value)))))
266
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)))
277
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)))
283
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)))
288
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))
298
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)
306
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))))
321
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)))
330
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))))
348
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.
357
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))))
370
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'.
375
376 An application may bind this to a non-nil value around calls to
377 these functions to inhibit processing of window parameters.")
378
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.")
383
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))))
388
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.
395
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)
404
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)))
409
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.")
414
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)))
419
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.
426
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)
435
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)))
440
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)))
448
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)))
456
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.
460
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)))))
471
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)))
481
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))))
516
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))))))
534
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.
541
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.
547
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)))))
561
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.
569
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))
575
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.
583
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))))
597
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))
609
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))
621
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.
630
631 ALIST is an association list of symbols and values.  The
632 following symbols can be used.
633
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.
642
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.
647
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))))
675
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))))
702
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)))
710
711 ;; Side windows.
712 (defvar window-sides '(left top right bottom)
713   "Window sides.")
714
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")
721
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)
764
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)))))
773
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.
778
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))))
798
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))))))
841
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))))
887
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)))
894
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.
899
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'.
903
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)))
917
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)
940
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)))))))
978
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.
986
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)))))))))
1026
1027 (defun window--side-check (&optional frame)
1028   "Check the side window configuration of FRAME.
1029 FRAME defaults to the selected frame.
1030
1031 A valid side window configuration preserves the following two
1032 invariants:
1033
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.
1037
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.
1042
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))))
1093
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))
1099
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")))
1140
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))))
1179
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.
1184
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.
1189
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.
1194
1195 If WINDOW is internal, return the respective size of the screen
1196 areas spanned by its children.
1197
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)))
1203
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.
1207
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'.
1211
1212 Optional argument PIXELWISE means return the pixel size of WINDOW
1213 like `window-pixel-height' and `window-pixel-width'.
1214
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))))
1225
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.
1231
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)
1236
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))))
1246
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.
1252
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.
1258
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.
1264
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)))))))
1283
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))))
1296
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)))))
1304
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.
1311
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)))
1322
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.
1329
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))
1335
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)))))
1343
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)
1400                      0
1401                    (window-min-pixel-width window)))
1402               (max
1403                (ceiling pixel-width char-size)
1404                (if (window--min-size-ignore-p window horizontal ignore)
1405                    0
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)
1421                      0
1422                    (window-min-pixel-height window)))
1423               (max (ceiling pixel-height char-size)
1424                    (if (window--min-size-ignore-p window horizontal ignore)
1425                        0
1426                      window-min-height))))))))))
1427
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.
1434
1435 This function looks only at WINDOW and, recursively, its child
1436 windows.  The function `window-resizable' looks at other windows
1437 as well.
1438
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.
1443
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.
1448
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)
1460         0
1461       delta))
1462    (t 0)))
1463
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)))
1475
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))))))))))
1511
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'.
1518
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)))
1525
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.
1530       0
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))))))
1565
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.
1570
1571 Optional argument HORIZONTAL non-nil means return number of
1572 columns by which WINDOW can be shrunk.
1573
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.
1580
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.
1586
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)))))
1606
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))))
1620
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))))))
1661
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.
1666
1667 Optional argument HORIZONTAL non-nil means return maximum number
1668 of columns by which WINDOW can be enlarged.
1669
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.
1676
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.
1683
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.
1690       0
1691     ;; WINDOW has no fixed size.
1692     (window--max-delta-1 window 0 horizontal ignore trail noup pixelwise)))
1693
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.
1701
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.
1706
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.
1711
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.
1717
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.
1724
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)))
1738
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'.
1744
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)))
1755
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.
1762
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.
1767
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.
1772
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.
1781
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))
1786
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)))
1800
1801 ;; Aliases of functions defined in window.c.
1802 (defalias 'window-height 'window-total-height)
1803 (defalias 'window-width 'window-body-width)
1804
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)))))
1816
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))))
1825
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.
1829
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)))
1837
1838 (defun window-font-width (&optional window face)
1839    "Return average character width for the font of FACE used in WINDOW.
1840 WINDOW must be a live window and defaults to the selected one.
1841
1842 If FACE is nil or omitted, the default face is used.  If FACE is
1843 remapped (see `face-remapping-alist'), the function returns the
1844 information for the remapped face."
1845    (with-selected-window (window-normalize-window window t)
1846      (if (display-multi-font-p)
1847          (let* ((face (if face face 'default))
1848                 (info (font-info (face-font face)))
1849                 (width (aref info 11)))
1850            (if (> width 0)
1851               width
1852              (aref info 10)))
1853        (frame-char-width))))
1854
1855 (defun window-font-height (&optional window face)
1856    "Return character height for the font of FACE used in WINDOW.
1857 WINDOW must be a live window and defaults to the selected one.
1858
1859 If FACE is nil or omitted, the default face is used.  If FACE is
1860 remapped (see `face-remapping-alist'), the function returns the
1861 information for the remapped face."
1862    (with-selected-window (window-normalize-window window t)
1863      (if (display-multi-font-p)
1864          (let* ((face (if face face 'default))
1865                 (info (font-info (face-font face))))
1866            (aref info 3))
1867        (frame-char-height))))
1868
1869 (defun window-max-chars-per-line (&optional window face)
1870   "Return the number of characters that can be displayed on one line in WINDOW.
1871 WINDOW must be a live window and defaults to the selected one.
1872
1873 The character width of FACE is used for the calculation.  If FACE
1874 is nil or omitted, the default face is used.  If FACE is
1875 remapped (see `face-remapping-alist'), the function uses the
1876 remapped face.
1877
1878 This function is different from `window-body-width' in two
1879 ways.  First, it accounts for the portions of the line reserved
1880 for the continuation glyph.  Second, it accounts for the size of
1881 the font."
1882   (with-selected-window (window-normalize-window window t)
1883     (let* ((window-width (window-body-width window t))
1884            (font-width (window-font-width window face))
1885            (ncols (/ window-width font-width)))
1886       (if (and (display-graphic-p)
1887                overflow-newline-into-fringe
1888                (/= (frame-parameter nil 'left-fringe) 0)
1889                (/= (frame-parameter nil 'right-fringe) 0))
1890           ncols
1891         (1- ncols)))))
1892
1893 (defun window-current-scroll-bars (&optional window)
1894   "Return the current scroll bar types for WINDOW.
1895 WINDOW must be a live window and defaults to the selected one.
1896
1897 The return value is a cons cell (VERTICAL . HORIZONTAL) where
1898 VERTICAL specifies the current location of the vertical scroll
1899 bar (`left', `right' or nil), and HORIZONTAL specifies the
1900 current location of the horizontal scroll bar (`bottom' or nil).
1901
1902 Unlike `window-scroll-bars', this function reports the scroll bar
1903 type actually used, once frame defaults and `scroll-bar-mode' are
1904 taken into account."
1905   (setq window (window-normalize-window window t))
1906   (let ((vertical (nth 2 (window-scroll-bars window)))
1907         (horizontal (nth 5 (window-scroll-bars window)))
1908         (inherited (frame-current-scroll-bars (window-frame window))))
1909     (when (eq vertical t)
1910       (setq vertical (car inherited)))
1911     (when (eq horizontal t)
1912       (setq horizontal (cdr inherited)))
1913     (cons vertical (and horizontal 'bottom))))
1914
1915 (defun walk-windows (fun &optional minibuf all-frames)
1916   "Cycle through all live windows, calling FUN for each one.
1917 FUN must specify a function with a window as its sole argument.
1918 The optional arguments MINIBUF and ALL-FRAMES specify the set of
1919 windows to include in the walk.
1920
1921 MINIBUF t means include the minibuffer window even if the
1922 minibuffer is not active.  MINIBUF nil or omitted means include
1923 the minibuffer window only if the minibuffer is active.  Any
1924 other value means do not include the minibuffer window even if
1925 the minibuffer is active.
1926
1927 ALL-FRAMES nil or omitted means consider all windows on the
1928 selected frame, plus the minibuffer window if specified by the
1929 MINIBUF argument.  If the minibuffer counts, consider all windows
1930 on all frames that share that minibuffer too.  The following
1931 non-nil values of ALL-FRAMES have special meanings:
1932
1933 - t means consider all windows on all existing frames.
1934
1935 - `visible' means consider all windows on all visible frames on
1936   the current terminal.
1937
1938 - 0 (the number zero) means consider all windows on all visible
1939   and iconified frames on the current terminal.
1940
1941 - A frame means consider all windows on that frame only.
1942
1943 Anything else means consider all windows on the selected frame
1944 and no others.
1945
1946 This function changes neither the order of recently selected
1947 windows nor the buffer list."
1948   ;; If we start from the minibuffer window, don't fail to come
1949   ;; back to it.
1950   (when (window-minibuffer-p)
1951     (setq minibuf t))
1952   ;; Make sure to not mess up the order of recently selected
1953   ;; windows.  Use `save-selected-window' and `select-window'
1954   ;; with second argument non-nil for this purpose.
1955   (save-selected-window
1956     (when (framep all-frames)
1957       (select-window (frame-first-window all-frames) 'norecord))
1958     (dolist (walk-windows-window (window-list-1 nil minibuf all-frames))
1959       (funcall fun walk-windows-window))))
1960
1961 (defun window-at-side-p (&optional window side)
1962   "Return t if WINDOW is at SIDE of its containing frame.
1963 WINDOW must be a valid window and defaults to the selected one.
1964 SIDE can be any of the symbols `left', `top', `right' or
1965 `bottom'.  The default value nil is handled like `bottom'."
1966   (setq window (window-normalize-window window))
1967   (let ((edge
1968          (cond
1969           ((eq side 'left) 0)
1970           ((eq side 'top) 1)
1971           ((eq side 'right) 2)
1972           ((memq side '(bottom nil)) 3))))
1973     (= (nth edge (window-pixel-edges window))
1974        (nth edge (window-pixel-edges (frame-root-window window))))))
1975
1976 (defun window-at-side-list (&optional frame side)
1977   "Return list of all windows on SIDE of FRAME.
1978 FRAME must be a live frame and defaults to the selected frame.
1979 SIDE can be any of the symbols `left', `top', `right' or
1980 `bottom'.  The default value nil is handled like `bottom'."
1981   (setq frame (window-normalize-frame frame))
1982   (let (windows)
1983     (walk-window-tree
1984      (lambda (window)
1985        (when (window-at-side-p window side)
1986          (setq windows (cons window windows))))
1987      frame nil 'nomini)
1988     (nreverse windows)))
1989
1990 (defun window--in-direction-2 (window posn &optional horizontal)
1991   "Support function for `window-in-direction'."
1992   (if horizontal
1993       (let ((top (window-pixel-top window)))
1994         (if (> top posn)
1995             (- top posn)
1996           (- posn top (window-pixel-height window))))
1997     (let ((left (window-pixel-left window)))
1998       (if (> left posn)
1999           (- left posn)
2000         (- posn left (window-pixel-width window))))))
2001
2002 ;; Predecessors to the below have been devised by Julian Assange in
2003 ;; change-windows-intuitively.el and Hovav Shacham in windmove.el.
2004 ;; Neither of these allow to selectively ignore specific windows
2005 ;; (windows whose `no-other-window' parameter is non-nil) as targets of
2006 ;; the movement.
2007 (defun window-in-direction (direction &optional window ignore sign wrap mini)
2008   "Return window in DIRECTION as seen from WINDOW.
2009 More precisely, return the nearest window in direction DIRECTION
2010 as seen from the position of `window-point' in window WINDOW.
2011 DIRECTION must be one of `above', `below', `left' or `right'.
2012 WINDOW must be a live window and defaults to the selected one.
2013
2014 Do not return a window whose `no-other-window' parameter is
2015 non-nil.  If the nearest window's `no-other-window' parameter is
2016 non-nil, try to find another window in the indicated direction.
2017 If, however, the optional argument IGNORE is non-nil, return that
2018 window even if its `no-other-window' parameter is non-nil.
2019
2020 Optional argument SIGN a negative number means to use the right
2021 or bottom edge of WINDOW as reference position instead of
2022 `window-point'.  SIGN a positive number means to use the left or
2023 top edge of WINDOW as reference position.
2024
2025 Optional argument WRAP non-nil means to wrap DIRECTION around
2026 frame borders.  This means to return for WINDOW at the top of the
2027 frame and DIRECTION `above' the minibuffer window if the frame
2028 has one, and a window at the bottom of the frame otherwise.
2029
2030 Optional argument MINI nil means to return the minibuffer window
2031 if and only if it is currently active.  MINI non-nil means to
2032 return the minibuffer window even when it's not active.  However,
2033 if WRAP non-nil, always act as if MINI were nil.
2034
2035 Return nil if no suitable window can be found."
2036   (setq window (window-normalize-window window t))
2037   (unless (memq direction '(above below left right))
2038     (error "Wrong direction %s" direction))
2039   (let* ((frame (window-frame window))
2040          (hor (memq direction '(left right)))
2041          (first (if hor
2042                     (window-pixel-left window)
2043                   (window-pixel-top window)))
2044          (last (+ first (window-size window hor t)))
2045          ;; The column / row value of `posn-at-point' can be nil for the
2046          ;; mini-window, guard against that.
2047          (posn
2048           (cond
2049            ((and (numberp sign) (< sign 0))
2050             (if hor
2051                 (1- (+ (window-pixel-top window) (window-pixel-height window)))
2052               (1- (+ (window-pixel-left window) (window-pixel-width window)))))
2053            ((and (numberp sign) (> sign 0))
2054             (if hor
2055                 (window-pixel-top window)
2056               (window-pixel-left window)))
2057            ((let ((posn-cons (nth 2 (posn-at-point (window-point window) window))))
2058               (if hor
2059                   (+ (or (cdr posn-cons) 1) (window-pixel-top window))
2060                 (+ (or (car posn-cons) 1) (window-pixel-left window)))))))
2061          (best-edge
2062           (cond
2063            ((eq direction 'below) (frame-pixel-height frame))
2064            ((eq direction 'right) (frame-pixel-width frame))
2065            (t -1)))
2066          (best-edge-2 best-edge)
2067          (best-diff-2 (if hor (frame-pixel-height frame) (frame-pixel-width frame)))
2068          best best-2 best-diff-2-new)
2069     (walk-window-tree
2070      (lambda (w)
2071        (let* ((w-top (window-pixel-top w))
2072               (w-left (window-pixel-left w)))
2073          (cond
2074           ((or (eq window w)
2075                ;; Ignore ourselves.
2076                (and (window-parameter w 'no-other-window)
2077                     ;; Ignore W unless IGNORE is non-nil.
2078                     (not ignore))))
2079           (hor
2080            (cond
2081             ((and (<= w-top posn)
2082                   (< posn (+ w-top (window-pixel-height w))))
2083              ;; W is to the left or right of WINDOW and covers POSN.
2084              (when (or (and (eq direction 'left)
2085                             (or (and (<= w-left first) (> w-left best-edge))
2086                                 (and wrap
2087                                      (window-at-side-p window 'left)
2088                                      (window-at-side-p w 'right))))
2089                        (and (eq direction 'right)
2090                             (or (and (>= w-left last) (< w-left best-edge))
2091                                 (and wrap
2092                                      (window-at-side-p window 'right)
2093                                      (window-at-side-p w 'left)))))
2094                (setq best-edge w-left)
2095                (setq best w)))
2096             ((and (or (and (eq direction 'left)
2097                            (<= (+ w-left (window-pixel-width w)) first))
2098                       (and (eq direction 'right) (<= last w-left)))
2099                   ;; W is to the left or right of WINDOW but does not
2100                   ;; cover POSN.
2101                   (setq best-diff-2-new
2102                         (window--in-direction-2 w posn hor))
2103                   (or (< best-diff-2-new best-diff-2)
2104                       (and (= best-diff-2-new best-diff-2)
2105                            (if (eq direction 'left)
2106                                (> w-left best-edge-2)
2107                              (< w-left best-edge-2)))))
2108              (setq best-edge-2 w-left)
2109              (setq best-diff-2 best-diff-2-new)
2110              (setq best-2 w))))
2111           ((and (<= w-left posn)
2112                 (< posn (+ w-left (window-pixel-width w))))
2113            ;; W is above or below WINDOW and covers POSN.
2114            (when (or (and (eq direction 'above)
2115                           (or (and (<= w-top first) (> w-top best-edge))
2116                               (and wrap
2117                                    (window-at-side-p window 'top)
2118                                    (if (active-minibuffer-window)
2119                                        (minibuffer-window-active-p w)
2120                                      (window-at-side-p w 'bottom)))))
2121                      (and (eq direction 'below)
2122                           (or (and (>= w-top first) (< w-top best-edge))
2123                               (and wrap
2124                                    (if (active-minibuffer-window)
2125                                        (minibuffer-window-active-p window)
2126                                      (window-at-side-p window 'bottom))
2127                                    (window-at-side-p w 'top)))))
2128              (setq best-edge w-top)
2129              (setq best w)))
2130           ((and (or (and (eq direction 'above)
2131                          (<= (+ w-top (window-pixel-height w)) first))
2132                     (and (eq direction 'below) (<= last w-top)))
2133                 ;; W is above or below WINDOW but does not cover POSN.
2134                 (setq best-diff-2-new
2135                       (window--in-direction-2 w posn hor))
2136                 (or (< best-diff-2-new best-diff-2)
2137                     (and (= best-diff-2-new best-diff-2)
2138                          (if (eq direction 'above)
2139                              (> w-top best-edge-2)
2140                            (< w-top best-edge-2)))))
2141            (setq best-edge-2 w-top)
2142            (setq best-diff-2 best-diff-2-new)
2143            (setq best-2 w)))))
2144      frame nil (and mini t))
2145     (or best best-2)))
2146
2147 (defun get-window-with-predicate (predicate &optional minibuf all-frames default)
2148   "Return a live window satisfying PREDICATE.
2149 More precisely, cycle through all windows calling the function
2150 PREDICATE on each one of them with the window as its sole
2151 argument.  Return the first window for which PREDICATE returns
2152 non-nil.  Windows are scanned starting with the window following
2153 the selected window.  If no window satisfies PREDICATE, return
2154 DEFAULT.
2155
2156 MINIBUF t means include the minibuffer window even if the
2157 minibuffer is not active.  MINIBUF nil or omitted means include
2158 the minibuffer window only if the minibuffer is active.  Any
2159 other value means do not include the minibuffer window even if
2160 the minibuffer is active.
2161
2162 ALL-FRAMES nil or omitted means consider all windows on the selected
2163 frame, plus the minibuffer window if specified by the MINIBUF
2164 argument.  If the minibuffer counts, consider all windows on all
2165 frames that share that minibuffer too.  The following non-nil
2166 values of ALL-FRAMES have special meanings:
2167
2168 - t means consider all windows on all existing frames.
2169
2170 - `visible' means consider all windows on all visible frames on
2171   the current terminal.
2172
2173 - 0 (the number zero) means consider all windows on all visible
2174   and iconified frames on the current terminal.
2175
2176 - A frame means consider all windows on that frame only.
2177
2178 Anything else means consider all windows on the selected frame
2179 and no others."
2180   (catch 'found
2181     (dolist (window (window-list-1
2182                      (next-window nil minibuf all-frames)
2183                      minibuf all-frames))
2184       (when (funcall predicate window)
2185         (throw 'found window)))
2186     default))
2187
2188 (defalias 'some-window 'get-window-with-predicate)
2189
2190 (defun get-lru-window (&optional all-frames dedicated not-selected)
2191    "Return the least recently used window on frames specified by ALL-FRAMES.
2192 Return a full-width window if possible.  A minibuffer window is
2193 never a candidate.  A dedicated window is never a candidate
2194 unless DEDICATED is non-nil, so if all windows are dedicated, the
2195 value is nil.  Avoid returning the selected window if possible.
2196 Optional argument NOT-SELECTED non-nil means never return the
2197 selected window.
2198
2199 The following non-nil values of the optional argument ALL-FRAMES
2200 have special meanings:
2201
2202 - t means consider all windows on all existing frames.
2203
2204 - `visible' means consider all windows on all visible frames on
2205   the current terminal.
2206
2207 - 0 (the number zero) means consider all windows on all visible
2208   and iconified frames on the current terminal.
2209
2210 - A frame means consider all windows on that frame only.
2211
2212 Any other value of ALL-FRAMES means consider all windows on the
2213 selected frame and no others."
2214    (let (best-window best-time second-best-window second-best-time time)
2215     (dolist (window (window-list-1 nil 'nomini all-frames))
2216       (when (and (or dedicated (not (window-dedicated-p window)))
2217                  (or (not not-selected) (not (eq window (selected-window)))))
2218         (setq time (window-use-time window))
2219         (if (or (eq window (selected-window))
2220                 (not (window-full-width-p window)))
2221             (when (or (not second-best-time) (< time second-best-time))
2222               (setq second-best-time time)
2223               (setq second-best-window window))
2224           (when (or (not best-time) (< time best-time))
2225             (setq best-time time)
2226             (setq best-window window)))))
2227     (or best-window second-best-window)))
2228
2229 (defun get-mru-window (&optional all-frames dedicated not-selected)
2230    "Return the most recently used window on frames specified by ALL-FRAMES.
2231 A minibuffer window is never a candidate.  A dedicated window is
2232 never a candidate unless DEDICATED is non-nil, so if all windows
2233 are dedicated, the value is nil.  Optional argument NOT-SELECTED
2234 non-nil means never return the selected window.
2235
2236 The following non-nil values of the optional argument ALL-FRAMES
2237 have special meanings:
2238
2239 - t means consider all windows on all existing frames.
2240
2241 - `visible' means consider all windows on all visible frames on
2242   the current terminal.
2243
2244 - 0 (the number zero) means consider all windows on all visible
2245   and iconified frames on the current terminal.
2246
2247 - A frame means consider all windows on that frame only.
2248
2249 Any other value of ALL-FRAMES means consider all windows on the
2250 selected frame and no others."
2251    (let (best-window best-time time)
2252     (dolist (window (window-list-1 nil 'nomini all-frames))
2253       (setq time (window-use-time window))
2254       (when (and (or dedicated (not (window-dedicated-p window)))
2255                  (or (not not-selected) (not (eq window (selected-window))))
2256                  (or (not best-time) (> time best-time)))
2257         (setq best-time time)
2258         (setq best-window window)))
2259     best-window))
2260
2261 (defun get-largest-window (&optional all-frames dedicated not-selected)
2262   "Return the largest window on frames specified by ALL-FRAMES.
2263 A minibuffer window is never a candidate.  A dedicated window is
2264 never a candidate unless DEDICATED is non-nil, so if all windows
2265 are dedicated, the value is nil.  Optional argument NOT-SELECTED
2266 non-nil means never return the selected window.
2267
2268 The following non-nil values of the optional argument ALL-FRAMES
2269 have special meanings:
2270
2271 - t means consider all windows on all existing frames.
2272
2273 - `visible' means consider all windows on all visible frames on
2274   the current terminal.
2275
2276 - 0 (the number zero) means consider all windows on all visible
2277   and iconified frames on the current terminal.
2278
2279 - A frame means consider all windows on that frame only.
2280
2281 Any other value of ALL-FRAMES means consider all windows on the
2282 selected frame and no others."
2283   (let ((best-size 0)
2284         best-window size)
2285     (dolist (window (window-list-1 nil 'nomini all-frames))
2286       (when (and (or dedicated (not (window-dedicated-p window)))
2287                  (or (not not-selected) (not (eq window (selected-window)))))
2288         (setq size (* (window-pixel-height window)
2289                       (window-pixel-width window)))
2290         (when (> size best-size)
2291           (setq best-size size)
2292           (setq best-window window))))
2293     best-window))
2294
2295 (defun get-buffer-window-list (&optional buffer-or-name minibuf all-frames)
2296   "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
2297 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2298 and defaults to the current buffer.  Windows are scanned starting
2299 with the selected window.
2300
2301 MINIBUF t means include the minibuffer window even if the
2302 minibuffer is not active.  MINIBUF nil or omitted means include
2303 the minibuffer window only if the minibuffer is active.  Any
2304 other value means do not include the minibuffer window even if
2305 the minibuffer is active.
2306
2307 ALL-FRAMES nil or omitted means consider all windows on the
2308 selected frame, plus the minibuffer window if specified by the
2309 MINIBUF argument.  If the minibuffer counts, consider all windows
2310 on all frames that share that minibuffer too.  The following
2311 non-nil values of ALL-FRAMES have special meanings:
2312
2313 - t means consider all windows on all existing frames.
2314
2315 - `visible' means consider all windows on all visible frames on
2316   the current terminal.
2317
2318 - 0 (the number zero) means consider all windows on all visible
2319   and iconified frames on the current terminal.
2320
2321 - A frame means consider all windows on that frame only.
2322
2323 Anything else means consider all windows on the selected frame
2324 and no others."
2325   (let ((buffer (window-normalize-buffer buffer-or-name))
2326         windows)
2327     (dolist (window (window-list-1 (selected-window) minibuf all-frames))
2328       (when (eq (window-buffer window) buffer)
2329         (setq windows (cons window windows))))
2330     (nreverse windows)))
2331
2332 (defun minibuffer-window-active-p (window)
2333   "Return t if WINDOW is the currently active minibuffer window."
2334   (eq window (active-minibuffer-window)))
2335
2336 (defun count-windows (&optional minibuf)
2337    "Return the number of live windows on the selected frame.
2338 The optional argument MINIBUF specifies whether the minibuffer
2339 window shall be counted.  See `walk-windows' for the precise
2340 meaning of this argument."
2341    (length (window-list-1 nil minibuf)))
2342 \f
2343 ;;; Resizing windows.
2344 (defun window--size-to-pixel (window size &optional horizontal pixelwise round-maybe)
2345   "For WINDOW convert SIZE lines to pixels.
2346 SIZE is supposed to specify a height of WINDOW in terms of text
2347 lines.  The return value is the number of pixels specifying that
2348 height.
2349
2350 WINDOW must be a valid window.  Optional argument HORIZONTAL
2351 non-nil means convert SIZE columns to pixels.
2352
2353 Optional argument PIXELWISE non-nil means SIZE already specifies
2354 pixels but may have to be adjusted to a multiple of the character
2355 size of WINDOW's frame.  Optional argument ROUND-MAYBE non-nil
2356 means round to the nearest multiple of the character size of
2357 WINDOW's frame if the option `window-resize-pixelwise' is nil."
2358   (setq window (window-normalize-window window))
2359   (let ((char-size (frame-char-size window horizontal)))
2360     (if pixelwise
2361         (if (and round-maybe (not window-resize-pixelwise))
2362             (* (round size char-size) char-size)
2363           size)
2364       (* size char-size))))
2365
2366 (defun window--pixel-to-total-1 (window horizontal char-size)
2367   "Subroutine of `window--pixel-to-total'."
2368   (let ((child (window-child window)))
2369     (if (window-combination-p window horizontal)
2370         ;; In an iso-combination distribute sizes proportionally.
2371         (let ((remainder (window-new-total window))
2372               size best-child rem best-rem)
2373           ;; Initialize total sizes to each child's floor.
2374           (while child
2375             (setq size (max (/ (window-size child horizontal t) char-size) 1))
2376             (set-window-new-total child size)
2377             (setq remainder (- remainder size))
2378             (setq child (window-next-sibling child)))
2379           ;; Distribute remainder.
2380           (while (> remainder 0)
2381             (setq child (window-last-child window))
2382             (setq best-child nil)
2383             (setq best-rem 0)
2384             (while child
2385               (when (and (<= (window-new-total child)
2386                              (/ (window-size child horizontal t) char-size))
2387                          (> (setq rem (% (window-size child horizontal t)
2388                                          char-size))
2389                             best-rem))
2390                    (setq best-child child)
2391                    (setq best-rem rem))
2392               (setq child (window-prev-sibling child)))
2393             ;; We MUST have a best-child here.
2394             (set-window-new-total best-child 1 t)
2395             (setq remainder (1- remainder)))
2396           ;; Recurse.
2397           (setq child (window-child window))
2398           (while child
2399             (window--pixel-to-total-1 child horizontal char-size)
2400             (setq child (window-next-sibling child))))
2401       ;; In an ortho-combination assign new sizes directly.
2402       (let ((size (window-new-total window)))
2403         (while child
2404           (set-window-new-total child size)
2405           (window--pixel-to-total-1 child horizontal char-size)
2406           (setq child (window-next-sibling child)))))))
2407
2408 (defun window--pixel-to-total (&optional frame horizontal)
2409   "On FRAME assign new total window heights from pixel heights.
2410 FRAME must be a live frame and defaults to the selected frame.
2411
2412 Optional argument HORIZONTAL non-nil means assign new total
2413 window widths from pixel widths."
2414   (setq frame (window-normalize-frame frame))
2415   (let* ((char-size (frame-char-size frame horizontal))
2416          (root (frame-root-window frame))
2417          (root-size (window-size root horizontal t))
2418          ;; We have to care about the minibuffer window only if it
2419          ;; appears together with the root window on this frame.
2420          (mini (let ((mini (minibuffer-window frame)))
2421                  (and (eq (window-frame mini) frame)
2422                       (not (eq mini root)) mini)))
2423          (mini-size (and mini (window-size mini horizontal t))))
2424     ;; We round the line/column sizes of windows here to the nearest
2425     ;; integer.  In some cases this can make windows appear _larger_
2426     ;; than the containing frame (line/column-wise) because the latter's
2427     ;; sizes are not (yet) rounded.  We might eventually fix that.
2428     (if (and mini (not horizontal))
2429         (let (lines)
2430           (set-window-new-total root (max (/ root-size char-size) 1))
2431           (set-window-new-total mini (max (/ mini-size char-size) 1))
2432           (setq lines (- (round (+ root-size mini-size) char-size)
2433                          (+ (window-new-total root) (window-new-total mini))))
2434           (while (> lines 0)
2435             (if (>= (% root-size (window-new-total root))
2436                     (% mini-size (window-new-total mini)))
2437                 (set-window-new-total root 1 t)
2438               (set-window-new-total mini 1 t))
2439             (setq lines (1- lines))))
2440       (set-window-new-total root (round root-size char-size))
2441       (when mini
2442         ;; This is taken in the horizontal case only.
2443         (set-window-new-total mini (round mini-size char-size))))
2444     (unless (window-buffer root)
2445       (window--pixel-to-total-1 root horizontal char-size))
2446     ;; Apply the new sizes.
2447     (window-resize-apply-total frame horizontal)))
2448
2449 (defun window--resize-reset (&optional frame horizontal)
2450   "Reset resize values for all windows on FRAME.
2451 FRAME defaults to the selected frame.
2452
2453 This function stores the current value of `window-size' applied
2454 with argument HORIZONTAL in the new total size of all windows on
2455 FRAME.  It also resets the new normal size of each of these
2456 windows."
2457   (window--resize-reset-1
2458    (frame-root-window (window-normalize-frame frame)) horizontal))
2459
2460 (defun window--resize-reset-1 (window horizontal)
2461   "Internal function of `window--resize-reset'."
2462   ;; Register old size in the new total size.
2463   (set-window-new-pixel window (window-size window horizontal t))
2464   (set-window-new-total window (window-size window horizontal))
2465   ;; Reset new normal size.
2466   (set-window-new-normal window)
2467   (when (window-child window)
2468     (window--resize-reset-1 (window-child window) horizontal))
2469   (when (window-right window)
2470     (window--resize-reset-1 (window-right window) horizontal)))
2471
2472 ;; The following routine is used to manually resize the minibuffer
2473 ;; window and is currently used, for example, by ispell.el.
2474 (defun window--resize-mini-window (window delta)
2475   "Resize minibuffer window WINDOW by DELTA pixels.
2476 If WINDOW cannot be resized by DELTA pixels make it as large (or
2477 as small) as possible, but don't signal an error."
2478   (when (window-minibuffer-p window)
2479     (let* ((frame (window-frame window))
2480            (root (frame-root-window frame))
2481            (height (window-pixel-height window))
2482            (min-delta
2483             (- (window-pixel-height root)
2484                (window-min-size root nil nil t))))
2485       ;; Sanitize DELTA.
2486       (cond
2487        ((<= (+ height delta) 0)
2488         (setq delta (- (frame-char-height (window-frame window)) height)))
2489        ((> delta min-delta)
2490         (setq delta min-delta)))
2491
2492       (unless (zerop delta)
2493         ;; Resize now.
2494         (window--resize-reset frame)
2495         ;; Ideally we should be able to resize just the last child of root
2496         ;; here.  See the comment in `resize-root-window-vertically' for
2497         ;; why we do not do that.
2498         (window--resize-this-window root (- delta) nil nil t)
2499         (set-window-new-pixel window (+ height delta))
2500         ;; The following routine catches the case where we want to resize
2501         ;; a minibuffer-only frame.
2502         (when (resize-mini-window-internal window)
2503           (window--pixel-to-total frame)
2504           (run-window-configuration-change-hook frame))))))
2505
2506 (defun window--resize-apply-p (frame &optional horizontal)
2507   "Return t when a window on FRAME shall be resized vertically.
2508 Optional argument HORIZONTAL non-nil means return t when a window
2509 shall be resized horizontally."
2510 (catch 'apply
2511     (walk-window-tree
2512      (lambda (window)
2513        (unless (= (window-new-pixel window)
2514                   (window-size window horizontal t))
2515          (throw 'apply t)))
2516      frame t)
2517     nil))
2518
2519 (defun window-resize (window delta &optional horizontal ignore pixelwise)
2520   "Resize WINDOW vertically by DELTA lines.
2521 WINDOW can be an arbitrary window and defaults to the selected
2522 one.  An attempt to resize the root window of a frame will raise
2523 an error though.
2524
2525 DELTA a positive number means WINDOW shall be enlarged by DELTA
2526 lines.  DELTA negative means WINDOW shall be shrunk by -DELTA
2527 lines.
2528
2529 Optional argument HORIZONTAL non-nil means resize WINDOW
2530 horizontally by DELTA columns.  In this case a positive DELTA
2531 means enlarge WINDOW by DELTA columns.  DELTA negative means
2532 WINDOW shall be shrunk by -DELTA columns.
2533
2534 Optional argument IGNORE, if non-nil, means to ignore restraints
2535 induced by fixed size windows or the values of the variables
2536 `window-min-height' and `window-min-width'.  The following values
2537 have special meanings: `safe' means that in addition live windows
2538 are allowed to get as small as `window-safe-min-height' lines and
2539 `window-safe-min-width' columns.  `preserved' means to ignore
2540 only restrictions induced by `window-preserve-size'.  If IGNORE
2541 is a window, then ignore restrictions for that window only.
2542
2543 Optional argument PIXELWISE non-nil means resize WINDOW by DELTA
2544 pixels.
2545
2546 This function resizes other windows proportionally and never
2547 deletes any windows.  If you want to move only the low (right)
2548 edge of WINDOW consider using `adjust-window-trailing-edge'
2549 instead."
2550   (setq window (window-normalize-window window))
2551   (let* ((frame (window-frame window))
2552          (minibuffer-window (minibuffer-window frame))
2553          sibling)
2554     (setq delta (window--size-to-pixel
2555                  window delta horizontal pixelwise t))
2556     (cond
2557      ((eq window (frame-root-window frame))
2558       (error "Cannot resize the root window of a frame"))
2559      ((window-minibuffer-p window)
2560       (if horizontal
2561           (error "Cannot resize minibuffer window horizontally")
2562         (window--resize-mini-window window delta)))
2563      ((and (not horizontal)
2564            (window-full-height-p window)
2565            (eq (window-frame minibuffer-window) frame)
2566            (or (not resize-mini-windows)
2567                (eq minibuffer-window (active-minibuffer-window))))
2568       ;; If WINDOW is full height and either `resize-mini-windows' is
2569       ;; nil or the minibuffer window is active, resize the minibuffer
2570       ;; window.
2571       (window--resize-mini-window minibuffer-window (- delta)))
2572      ((or (window--resizable-p
2573            window delta horizontal ignore nil nil nil t)
2574           (and (not ignore)
2575                (setq ignore 'preserved)
2576                (window--resizable-p
2577                 window delta horizontal ignore nil nil nil t)))
2578       (window--resize-reset frame horizontal)
2579       (window--resize-this-window window delta horizontal ignore t)
2580       (if (and (not window-combination-resize)
2581                (window-combined-p window horizontal)
2582                (setq sibling (or (window-right window) (window-left window)))
2583                (window-sizable-p
2584                 sibling (- delta) horizontal ignore t))
2585           ;; If window-combination-resize is nil, WINDOW is part of an
2586           ;; iso-combination, and WINDOW's neighboring right or left
2587           ;; sibling can be resized as requested, resize that sibling.
2588           (let ((normal-delta
2589                  (/ (float delta)
2590                     (window-size (window-parent window) horizontal t))))
2591             (window--resize-this-window sibling (- delta) horizontal nil t)
2592             (set-window-new-normal
2593              window (+ (window-normal-size window horizontal)
2594                        normal-delta))
2595             (set-window-new-normal
2596              sibling (- (window-normal-size sibling horizontal)
2597                         normal-delta)))
2598         ;; Otherwise, resize all other windows in the same combination.
2599         (window--resize-siblings window delta horizontal ignore))
2600       (when (window--resize-apply-p frame horizontal)
2601         (if (window-resize-apply frame horizontal)
2602             (progn
2603               (window--pixel-to-total frame horizontal)
2604               (run-window-configuration-change-hook frame))
2605           (error "Failed to apply resizing %s" window))))
2606      (t
2607       (error "Cannot resize window %s" window)))))
2608
2609 (defun window-resize-no-error (window delta &optional horizontal ignore pixelwise)
2610   "Resize WINDOW vertically if it is resizable by DELTA lines.
2611 This function is like `window-resize' but does not signal an
2612 error when WINDOW cannot be resized.  For the meaning of the
2613 optional arguments see the documentation of `window-resize'.
2614
2615 Optional argument PIXELWISE non-nil means interpret DELTA as
2616 pixels."
2617   (when (window--resizable-p
2618          window delta horizontal ignore nil nil nil pixelwise)
2619     (window-resize window delta horizontal ignore pixelwise)))
2620
2621 (defun window--resize-child-windows-skip-p (window)
2622   "Return non-nil if WINDOW shall be skipped by resizing routines."
2623   (memq (window-new-normal window) '(ignore stuck skip)))
2624
2625 (defun window--resize-child-windows-normal (parent horizontal window this-delta &optional trail other-delta)
2626   "Recursively set new normal height of child windows of window PARENT.
2627 HORIZONTAL non-nil means set the new normal width of these
2628 windows.  WINDOW specifies a child window of PARENT that has been
2629 resized by THIS-DELTA lines (columns).
2630
2631 Optional argument TRAIL either `before' or `after' means set values
2632 only for windows before or after WINDOW.  Optional argument
2633 OTHER-DELTA, a number, specifies that this many lines (columns)
2634 have been obtained from (or returned to) an ancestor window of
2635 PARENT in order to resize WINDOW."
2636   (let* ((delta-normal
2637           (if (and (= (- this-delta)
2638                       (window-size window horizontal t))
2639                    (zerop other-delta))
2640               ;; When WINDOW gets deleted and we can return its entire
2641               ;; space to its siblings, use WINDOW's normal size as the
2642               ;; normal delta.
2643               (- (window-normal-size window horizontal))
2644             ;; In any other case calculate the normal delta from the
2645             ;; relation of THIS-DELTA to the total size of PARENT.
2646             (/ (float this-delta)
2647                (window-size parent horizontal t))))
2648          (sub (window-child parent))
2649          (parent-normal 0.0)
2650          (skip (eq trail 'after)))
2651
2652     ;; Set parent-normal to the sum of the normal sizes of all child
2653     ;; windows of PARENT that shall be resized, excluding only WINDOW
2654     ;; and any windows specified by the optional TRAIL argument.
2655     (while sub
2656       (cond
2657        ((eq sub window)
2658         (setq skip (eq trail 'before)))
2659        (skip)
2660        (t
2661         (setq parent-normal
2662               (+ parent-normal (window-normal-size sub horizontal)))))
2663       (setq sub (window-right sub)))
2664
2665     ;; Set the new normal size of all child windows of PARENT from what
2666     ;; they should have contributed for recovering THIS-DELTA lines
2667     ;; (columns).
2668     (setq sub (window-child parent))
2669     (setq skip (eq trail 'after))
2670     (while sub
2671       (cond
2672        ((eq sub window)
2673         (setq skip (eq trail 'before)))
2674        (skip)
2675        (t
2676         (let ((old-normal (window-normal-size sub horizontal)))
2677           (set-window-new-normal
2678            sub (min 1.0 ; Don't get larger than 1.
2679                     (max (- old-normal
2680                             (* (/ old-normal parent-normal)
2681                                delta-normal))
2682                          ;; Don't drop below 0.
2683                          0.0))))))
2684       (setq sub (window-right sub)))
2685
2686     (when (numberp other-delta)
2687       ;; Set the new normal size of windows from what they should have
2688       ;; contributed for recovering OTHER-DELTA lines (columns).
2689       (setq delta-normal (/ (float (window-size parent horizontal t))
2690                             (+ (window-size parent horizontal t)
2691                                other-delta)))
2692       (setq sub (window-child parent))
2693       (setq skip (eq trail 'after))
2694       (while sub
2695         (cond
2696          ((eq sub window)
2697           (setq skip (eq trail 'before)))
2698          (skip)
2699          (t
2700           (set-window-new-normal
2701            sub (min 1.0 ; Don't get larger than 1.
2702                     (max (* (window-new-normal sub) delta-normal)
2703                          ;; Don't drop below 0.
2704                          0.0)))))
2705         (setq sub (window-right sub))))
2706
2707     ;; Set the new normal size of WINDOW to what is left by the sum of
2708     ;; the normal sizes of its siblings.
2709     (set-window-new-normal
2710      window
2711      (let ((sum 0))
2712        (setq sub (window-child parent))
2713        (while sub
2714          (cond
2715           ((eq sub window))
2716           ((not (numberp (window-new-normal sub)))
2717            (setq sum (+ sum (window-normal-size sub horizontal))))
2718           (t
2719            (setq sum (+ sum (window-new-normal sub)))))
2720          (setq sub (window-right sub)))
2721        ;; Don't get larger than 1 or smaller than 0.
2722        (min 1.0 (max (- 1.0 sum) 0.0))))))
2723
2724 (defun window--resize-child-windows (parent delta &optional horizontal window ignore trail edge char-size)
2725   "Resize child windows of window PARENT vertically by DELTA pixels.
2726 PARENT must be a vertically combined internal window.
2727
2728 Optional argument HORIZONTAL non-nil means resize child windows
2729 of PARENT horizontally by DELTA pixels.  In this case PARENT must
2730 be a horizontally combined internal window.
2731
2732 WINDOW, if specified, must denote a child window of PARENT that
2733 is resized by DELTA pixels.
2734
2735 The optional argument IGNORE has the same meaning as for
2736 `window-resizable'.
2737
2738 Optional arguments TRAIL and EDGE, when non-nil, restrict the set
2739 of windows that shall be resized.  If TRAIL equals `before',
2740 resize only windows on the left or above EDGE.  If TRAIL equals
2741 `after', resize only windows on the right or below EDGE.  Also,
2742 preferably only resize windows adjacent to EDGE.
2743
2744 If the optional argument CHAR-SIZE is a positive integer, it specifies
2745 the number of pixels by which windows are incrementally resized.
2746 If CHAR-SIZE is nil, this means to use the value of
2747 `frame-char-height' or `frame-char-width' of WINDOW's frame.
2748
2749 Return the symbol `normalized' if new normal sizes have been
2750 already set by this routine."
2751   (let* ((first (window-child parent))
2752          (last (window-last-child parent))
2753          (parent-total (+ (window-size parent horizontal t)
2754                           delta))
2755          (char-size (or char-size
2756                         (and window-resize-pixelwise 1)
2757                         (frame-char-size window horizontal)))
2758          sub best-window best-value best-delta)
2759
2760     (if (and edge (memq trail '(before after))
2761              (progn
2762                (setq sub first)
2763                (while (and (window-right sub)
2764                            (or (and (eq trail 'before)
2765                                     (not (window--resize-child-windows-skip-p
2766                                           (window-right sub))))
2767                                (and (eq trail 'after)
2768                                     (window--resize-child-windows-skip-p sub))))
2769                  (setq sub (window-right sub)))
2770                sub)
2771              (if horizontal
2772                  (if (eq trail 'before)
2773                      (= (+ (window-pixel-left sub) (window-pixel-width sub))
2774                         edge)
2775                    (= (window-pixel-left sub) edge))
2776                (if (eq trail 'before)
2777                    (= (+ (window-pixel-top sub) (window-pixel-height sub))
2778                       edge)
2779                  (= (window-pixel-top sub) edge)))
2780              (window-sizable-p sub delta horizontal ignore t))
2781         ;; Resize only windows adjacent to EDGE.
2782         (progn
2783           (window--resize-this-window
2784            sub delta horizontal ignore t trail edge)
2785           (if (and window (eq (window-parent sub) parent))
2786               (progn
2787                 ;; Assign new normal sizes.
2788                 (set-window-new-normal
2789                  sub (/ (float (window-new-pixel sub)) parent-total))
2790                 (set-window-new-normal
2791                  window (- (window-normal-size window horizontal)
2792                            (- (window-new-normal sub)
2793                               (window-normal-size sub horizontal)))))
2794             (window--resize-child-windows-normal
2795              parent horizontal sub 0 trail delta))
2796           ;; Return 'normalized to notify `window--resize-siblings' that
2797           ;; normal sizes have been already set.
2798           'normalized)
2799       ;; Resize all windows proportionally.
2800       (setq sub last)
2801       (while sub
2802         (cond
2803          ((or (window--resize-child-windows-skip-p sub)
2804               ;; Ignore windows to skip and fixed-size child windows -
2805               ;; in the latter case make it a window to skip.
2806               (and (not ignore)
2807                    (window-size-fixed-p sub horizontal ignore)
2808                    (set-window-new-normal sub 'ignore))))
2809          ((< delta 0)
2810           ;; When shrinking store the number of lines/cols we can get
2811           ;; from this window here together with the total/normal size
2812           ;; factor.
2813           (set-window-new-normal
2814            sub
2815            (cons
2816             ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
2817             (window-min-delta sub horizontal ignore trail t nil t)
2818             (- (/ (float (window-size sub horizontal t))
2819                   parent-total)
2820                (window-normal-size sub horizontal)))))
2821          ((> delta 0)
2822           ;; When enlarging store the total/normal size factor only
2823           (set-window-new-normal
2824            sub
2825            (- (/ (float (window-size sub horizontal t))
2826                  parent-total)
2827               (window-normal-size sub horizontal)))))
2828
2829         (setq sub (window-left sub)))
2830
2831       (cond
2832        ((< delta 0)
2833         ;; Shrink windows by delta.
2834         (setq best-window t)
2835         (while (and best-window (not (zerop delta)))
2836           (setq sub last)
2837           (setq best-window nil)
2838           (setq best-value most-negative-fixnum)
2839           (while sub
2840             (when (and (consp (window-new-normal sub))
2841                        (not (<= (car (window-new-normal sub)) 0))
2842                        (> (cdr (window-new-normal sub)) best-value))
2843               (setq best-window sub)
2844               (setq best-value (cdr (window-new-normal sub))))
2845
2846             (setq sub (window-left sub)))
2847
2848           (when best-window
2849             (setq best-delta (min (car (window-new-normal best-window))
2850                                   char-size (- delta)))
2851             (setq delta (+ delta best-delta))
2852             (set-window-new-pixel best-window (- best-delta) t)
2853             (set-window-new-normal
2854              best-window
2855              (if (= (car (window-new-normal best-window)) best-delta)
2856                  'skip      ; We can't shrink best-window any further.
2857                (cons (- (car (window-new-normal best-window)) best-delta)
2858                      (- (/ (float (window-new-pixel best-window))
2859                            parent-total)
2860                         (window-normal-size best-window horizontal))))))))
2861        ((> delta 0)
2862         ;; Enlarge windows by delta.
2863         (setq best-window t)
2864         (while (and best-window (not (zerop delta)))
2865           (setq sub last)
2866           (setq best-window nil)
2867           (setq best-value most-positive-fixnum)
2868           (while sub
2869             (when (and (numberp (window-new-normal sub))
2870                        (< (window-new-normal sub) best-value))
2871               (setq best-window sub)
2872               (setq best-value (window-new-normal sub)))
2873
2874             (setq sub (window-left sub)))
2875
2876           (when best-window
2877             (setq best-delta (min delta char-size))
2878             (setq delta (- delta best-delta))
2879             (set-window-new-pixel best-window best-delta t)
2880             (set-window-new-normal
2881              best-window
2882              (- (/ (float (window-new-pixel best-window))
2883                    parent-total)
2884                 (window-normal-size best-window horizontal)))))))
2885
2886       (when best-window
2887         (setq sub last)
2888         (while sub
2889           (when (or (consp (window-new-normal sub))
2890                     (numberp (window-new-normal sub)))
2891             ;; Reset new normal size fields so `window-resize-apply'
2892             ;; won't use them to apply new sizes.
2893             (set-window-new-normal sub))
2894
2895           (unless (eq (window-new-normal sub) 'ignore)
2896             ;; Resize this window's child windows (back-engineering
2897             ;; delta from sub's old and new total sizes).
2898             (let ((delta (- (window-new-pixel sub)
2899                             (window-size sub horizontal t))))
2900               (unless (and (zerop delta) (not trail))
2901                 ;; For the TRAIL non-nil case we have to resize SUB
2902                 ;; recursively even if it's size does not change.
2903                 (window--resize-this-window
2904                  sub delta horizontal ignore nil trail edge))))
2905           (setq sub (window-left sub)))))))
2906
2907 (defun window--resize-siblings (window delta &optional horizontal ignore trail edge char-size)
2908   "Resize other windows when WINDOW is resized vertically by DELTA pixels.
2909 Optional argument HORIZONTAL non-nil means resize other windows
2910 when WINDOW is resized horizontally by DELTA pixels.  WINDOW
2911 itself is not resized by this function.
2912
2913 The optional argument IGNORE has the same meaning as for
2914 `window-resizable'.
2915
2916 Optional arguments TRAIL and EDGE, when non-nil, refine the set
2917 of windows that shall be resized.  If TRAIL equals `before',
2918 resize only windows on the left or above EDGE.  If TRAIL equals
2919 `after', resize only windows on the right or below EDGE.  Also,
2920 preferably only resize windows adjacent to EDGE."
2921   (when (window-parent window)
2922     (let* ((parent (window-parent window))
2923            (sub (window-child parent)))
2924       (if (window-combined-p sub horizontal)
2925           ;; In an iso-combination try to extract DELTA from WINDOW's
2926           ;; siblings.
2927           (let ((skip (eq trail 'after))
2928                 this-delta other-delta)
2929             ;; Decide which windows shall be left alone.
2930             (while sub
2931               (cond
2932                ((eq sub window)
2933                 ;; Make sure WINDOW is left alone when
2934                 ;; resizing its siblings.
2935                 (set-window-new-normal sub 'ignore)
2936                 (setq skip (eq trail 'before)))
2937                (skip
2938                 ;; Make sure this sibling is left alone when
2939                 ;; resizing its siblings.
2940                 (set-window-new-normal sub 'ignore))
2941                ((not (window-size-fixed-p sub horizontal ignore))
2942                 ;; Set this-delta to t to signal that we found a sibling
2943                 ;; of WINDOW whose size is not fixed.
2944                 (setq this-delta t)))
2945
2946               (setq sub (window-right sub)))
2947
2948             ;; Set this-delta to what we can get from WINDOW's siblings.
2949             (if (= (- delta) (window-size window horizontal t))
2950                 ;; A deletion, presumably.  We must handle this case
2951                 ;; specially since `window--resizable' can't be used.
2952                 (if this-delta
2953                     ;; There's at least one resizable sibling we can
2954                     ;; give WINDOW's size to.
2955                     (setq this-delta delta)
2956                   ;; No resizable sibling exists.
2957                   (setq this-delta 0))
2958               ;; Any other form of resizing.
2959               (setq this-delta
2960                     (window--resizable
2961                      window delta horizontal ignore trail t nil t)))
2962
2963             ;; Set other-delta to what we still have to get from
2964             ;; ancestor windows of parent.
2965             (setq other-delta (- delta this-delta))
2966             (unless (zerop other-delta)
2967               ;; Unless we got everything from WINDOW's siblings, PARENT
2968               ;; must be resized by other-delta lines or columns.
2969               (set-window-new-pixel parent other-delta 'add))
2970
2971             (if (zerop this-delta)
2972                 ;; We haven't got anything from WINDOW's siblings but we
2973                 ;; must update the normal sizes to respect other-delta.
2974                 (window--resize-child-windows-normal
2975                  parent horizontal window this-delta trail other-delta)
2976               ;; We did get something from WINDOW's siblings which means
2977               ;; we have to resize their child windows.
2978               (unless (eq (window--resize-child-windows
2979                            parent (- this-delta) horizontal
2980                            window ignore trail edge char-size)
2981                           ;; If `window--resize-child-windows' returns
2982                           ;; 'normalized, this means it has set the
2983                           ;; normal sizes already.
2984                           'normalized)
2985                 ;; Set the normal sizes.
2986                 (window--resize-child-windows-normal
2987                  parent horizontal window this-delta trail other-delta))
2988               ;; Set DELTA to what we still have to get from ancestor
2989               ;; windows.
2990               (setq delta other-delta)))
2991
2992         ;; In an ortho-combination all siblings of WINDOW must be
2993         ;; resized by DELTA.
2994         (set-window-new-pixel parent delta 'add)
2995         (while sub
2996           (unless (eq sub window)
2997             (window--resize-this-window
2998              sub delta horizontal ignore t))
2999           (setq sub (window-right sub))))
3000
3001       (unless (zerop delta)
3002         ;; "Go up."
3003         (window--resize-siblings
3004          parent delta horizontal ignore trail edge char-size)))))
3005
3006 (defun window--resize-this-window (window delta &optional horizontal ignore add trail edge char-size)
3007   "Resize WINDOW vertically by DELTA pixels.
3008 Optional argument HORIZONTAL non-nil means resize WINDOW
3009 horizontally by DELTA pixels.
3010
3011 The optional argument IGNORE has the same meaning as for
3012 `window-resizable'.  Optional argument ADD non-nil means add
3013 DELTA to the new total size of WINDOW.
3014
3015 Optional arguments TRAIL and EDGE, when non-nil, refine the set
3016 of windows that shall be resized.  If TRAIL equals `before',
3017 resize only windows on the left or above EDGE.  If TRAIL equals
3018 `after', resize only windows on the right or below EDGE.  Also,
3019 preferably only resize windows adjacent to EDGE.
3020
3021 If the optional argument CHAR-SIZE is a positive integer, it specifies
3022 the number of pixels by which windows are incrementally resized.
3023 If CHAR-SIZE is nil, this means to use the value of
3024 `frame-char-height' or `frame-char-width' of WINDOW's frame.
3025
3026 This function recursively resizes WINDOW's child windows to fit the
3027 new size.  Make sure that WINDOW is `window--resizable' before
3028 calling this function.  Note that this function does not resize
3029 siblings of WINDOW or WINDOW's parent window.  You have to
3030 eventually call `window-resize-apply' in order to make resizing
3031 actually take effect."
3032   (when add
3033     ;; Add DELTA to the new total size of WINDOW.
3034     (set-window-new-pixel window delta t))
3035
3036   (let ((sub (window-child window)))
3037     (cond
3038      ((not sub))
3039      ((window-combined-p sub horizontal)
3040       ;; In an iso-combination resize child windows according to their
3041       ;; normal sizes.
3042       (window--resize-child-windows
3043        window delta horizontal nil ignore trail edge char-size))
3044      ;; In an ortho-combination resize each child window by DELTA.
3045      (t
3046       (while sub
3047         (window--resize-this-window
3048          sub delta horizontal ignore t trail edge char-size)
3049         (setq sub (window-right sub)))))))
3050
3051 (defun window--resize-root-window (window delta horizontal ignore pixelwise)
3052   "Resize root window WINDOW vertically by DELTA lines.
3053 HORIZONTAL non-nil means resize root window WINDOW horizontally
3054 by DELTA columns.
3055
3056 IGNORE non-nil means ignore any restrictions imposed by fixed
3057 size windows, `window-min-height' or `window-min-width' settings.
3058
3059 This function is only called by the frame resizing routines.  It
3060 resizes windows proportionally and never deletes any windows."
3061   (when (and (windowp window) (numberp delta))
3062     (let ((pixel-delta
3063            (if pixelwise
3064                delta
3065              (window--size-to-pixel window delta horizontal))))
3066       (when (window-sizable-p window pixel-delta horizontal ignore t)
3067         (window--resize-reset (window-frame window) horizontal)
3068         (window--resize-this-window
3069          window pixel-delta horizontal ignore t)))))
3070
3071 (defun window--resize-root-window-vertically (window delta pixelwise)
3072   "Resize root window WINDOW vertically by DELTA lines.
3073 If DELTA is less than zero and we can't shrink WINDOW by DELTA
3074 lines, shrink it as much as possible.  If DELTA is greater than
3075 zero, this function can resize fixed-size windows in order to
3076 recover the necessary lines.  Return the number of lines that
3077 were recovered.
3078
3079 Third argument PIXELWISE non-nil means to interpret DELTA as
3080 pixels and return the number of pixels that were recovered.
3081
3082 This function is called by the minibuffer window resizing
3083 routines."
3084   (let* ((frame (window-frame window))
3085          (pixel-delta
3086           (cond
3087            (pixelwise
3088             delta)
3089            ((numberp delta)
3090             (* (frame-char-height frame) delta))
3091            (t 0)))
3092          ignore)
3093     (cond
3094      ((zerop pixel-delta))
3095      ((< pixel-delta 0)
3096       (setq pixel-delta (window-sizable window pixel-delta nil nil pixelwise))
3097       (window--resize-reset frame)
3098       ;; When shrinking the root window, emulate an edge drag in order
3099       ;; to not resize other windows if we can avoid it (Bug#12419).
3100       (window--resize-this-window
3101        window pixel-delta nil ignore t 'before
3102        (+ (window-pixel-top window) (window-pixel-height window)))
3103       ;; Don't record new normal sizes to make sure that shrinking back
3104       ;; proportionally works as intended.
3105       (walk-window-tree
3106        (lambda (window) (set-window-new-normal window 'ignore)) frame t))
3107      ((> pixel-delta 0)
3108       (window--resize-reset frame)
3109       (unless (window-sizable window pixel-delta nil nil pixelwise)
3110         (setq ignore t))
3111       ;; When growing the root window, resize proportionally.  This
3112       ;; should give windows back their original sizes (hopefully).
3113       (window--resize-this-window
3114        window pixel-delta nil ignore t)))
3115      ;; Return the possibly adjusted DELTA.
3116      (if pixelwise
3117          pixel-delta
3118        (/ pixel-delta (frame-char-height frame)))))
3119
3120 (defun window--sanitize-window-sizes (frame horizontal)
3121   "Assert that all windows on FRAME are large enough.
3122 If necessary and possible, make sure that every window on frame
3123 FRAME has its minimum height.  Optional argument HORIZONTAL
3124 non-nil means to make sure that every window on frame FRAME has
3125 its minimum width.  The minimum height/width of a window is the
3126 respective value returned by `window-min-size' for that window.
3127
3128 Return t if all windows were resized appropriately.  Return nil
3129 if at least one window could not be resized as requested, which
3130 may happen when the FRAME is not large enough to accommodate it."
3131   (let ((value t))
3132     (walk-window-tree
3133      (lambda (window)
3134        (let  ((delta (- (window-min-size window horizontal nil t)
3135                         (window-size window horizontal t))))
3136          (when (> delta 0)
3137            (if (window-resizable-p window delta horizontal nil t)
3138                (window-resize window delta horizontal nil t)
3139              (setq value nil))))))
3140     value))
3141
3142 (defun adjust-window-trailing-edge (window delta &optional horizontal pixelwise)
3143   "Move WINDOW's bottom edge by DELTA lines.
3144 Optional argument HORIZONTAL non-nil means move WINDOW's right
3145 edge by DELTA columns.  WINDOW must be a valid window and
3146 defaults to the selected one.
3147
3148 Optional argument PIXELWISE non-nil means interpret DELTA as
3149 number of pixels.
3150
3151 If DELTA is greater than zero, move the edge downwards or to the
3152 right.  If DELTA is less than zero, move the edge upwards or to
3153 the left.  If the edge can't be moved by DELTA lines or columns,
3154 move it as far as possible in the desired direction."
3155   (setq window (window-normalize-window window))
3156   (let* ((frame (window-frame window))
3157          (minibuffer-window (minibuffer-window frame))
3158          (right window)
3159          left this-delta min-delta max-delta ignore)
3160
3161     (unless pixelwise
3162       (setq pixelwise t)
3163       (setq delta (* delta (frame-char-size window horizontal))))
3164
3165     ;; Find the edge we want to move.
3166     (while (and (or (not (window-combined-p right horizontal))
3167                     (not (window-right right)))
3168                 (setq right (window-parent right))))
3169     (cond
3170      ((and (not right) (not horizontal)
3171            ;; Resize the minibuffer window if it's on the same frame as
3172            ;; and immediately below WINDOW and it's either active or
3173            ;; `resize-mini-windows' is nil.
3174            (eq (window-frame minibuffer-window) frame)
3175            (= (nth 1 (window-pixel-edges minibuffer-window))
3176               (nth 3 (window-pixel-edges window)))
3177            (or (not resize-mini-windows)
3178                (eq minibuffer-window (active-minibuffer-window))))
3179       (window--resize-mini-window minibuffer-window (- delta)))
3180      ((or (not (setq left right)) (not (setq right (window-right right))))
3181       (if horizontal
3182           (user-error "No window on the right of this one")
3183         (user-error "No window below this one")))
3184      (t
3185       ;; Set LEFT to the first resizable window on the left.  This step is
3186       ;; needed to handle fixed-size windows.
3187       (while (and left
3188                   (or (window-size-fixed-p left horizontal)
3189                       (and (< delta 0)
3190                            (<= (window-size left horizontal t)
3191                                (window-min-size left horizontal nil t)))))
3192         (setq left
3193               (or (window-left left)
3194                   (progn
3195                     (while (and (setq left (window-parent left))
3196                                 (not (window-combined-p left horizontal))))
3197                     (window-left left)))))
3198       (unless left
3199         (setq ignore 'preserved)
3200         (setq left window)
3201         (while (and left
3202                     (or (window-size-fixed-p left horizontal 'preserved)
3203                         (<= (window-size left horizontal t)
3204                             (window-min-size left horizontal 'preserved t))))
3205           (setq left
3206                 (or (window-left left)
3207                     (progn
3208                       (while (and (setq left (window-parent left))
3209                                   (not (window-combined-p left horizontal))))
3210                       (window-left left)))))
3211
3212         (unless left
3213           (if horizontal
3214               (user-error "No resizable window on the left of this one")
3215             (user-error "No resizable window above this one"))))
3216
3217       ;; Set RIGHT to the first resizable window on the right.  This step
3218       ;; is needed to handle fixed-size windows.
3219       (while (and right
3220                   (or (window-size-fixed-p right horizontal)
3221                       (and (> delta 0)
3222                            (<= (window-size right horizontal t)
3223                                (window-min-size right horizontal 'preserved t)))))
3224         (setq right
3225               (or (window-right right)
3226                   (progn
3227                     (while (and (setq right (window-parent right))
3228                                 (not (window-combined-p right horizontal))))
3229                     (window-right right)))))
3230       (unless right
3231         (setq ignore 'preserved)
3232         (setq right (window-right window))
3233         (while (and right
3234                     (or (window-size-fixed-p right horizontal 'preserved))
3235                     (<= (window-size right horizontal t)
3236                         (window-min-size right horizontal nil t)))
3237           (setq right
3238                 (or (window-right right)
3239                     (progn
3240                       (while (and (setq right (window-parent right))
3241                                   (not (window-combined-p right horizontal))))
3242                       (window-right right)))))
3243         (unless right
3244           (if horizontal
3245               (user-error "No resizable window on the right of this one")
3246             (user-error "No resizable window below this one"))))
3247
3248       ;; LEFT and RIGHT (which might be both internal windows) are now the
3249       ;; two windows we want to resize.
3250       (cond
3251        ((> delta 0)
3252         (setq max-delta
3253               (window--max-delta-1
3254                left 0 horizontal ignore 'after nil pixelwise))
3255         (setq min-delta
3256               (window--min-delta-1
3257                right (- delta) horizontal ignore 'before nil pixelwise))
3258         (when (or (< max-delta delta) (> min-delta (- delta)))
3259           ;; We can't get the whole DELTA - move as far as possible.
3260           (setq delta (min max-delta (- min-delta))))
3261         (unless (zerop delta)
3262           ;; Start resizing.
3263           (window--resize-reset frame horizontal)
3264           ;; Try to enlarge LEFT first.
3265           (setq this-delta (window--resizable
3266                             left delta horizontal ignore 'after nil nil pixelwise))
3267           (unless (zerop this-delta)
3268             (window--resize-this-window
3269              left this-delta horizontal ignore t 'before
3270              (if horizontal
3271                  (+ (window-pixel-left left) (window-pixel-width left))
3272                (+ (window-pixel-top left) (window-pixel-height left)))))
3273           ;; Shrink windows on right of LEFT.
3274           (window--resize-siblings
3275            left delta horizontal ignore 'after
3276            (if horizontal
3277                (window-pixel-left right)
3278              (window-pixel-top right)))))
3279        ((< delta 0)
3280         (setq max-delta
3281               (window--max-delta-1
3282                right 0 horizontal ignore 'before nil pixelwise))
3283         (setq min-delta
3284               (window--min-delta-1
3285                left delta horizontal ignore 'after nil pixelwise))
3286         (when (or (< max-delta (- delta)) (> min-delta delta))
3287           ;; We can't get the whole DELTA - move as far as possible.
3288           (setq delta (max (- max-delta) min-delta)))
3289         (unless (zerop delta)
3290           ;; Start resizing.
3291           (window--resize-reset frame horizontal)
3292           ;; Try to enlarge RIGHT.
3293           (setq this-delta
3294                 (window--resizable
3295                  right (- delta) horizontal ignore 'before nil nil pixelwise))
3296           (unless (zerop this-delta)
3297             (window--resize-this-window
3298              right this-delta horizontal ignore t 'after
3299              (if horizontal
3300                  (window-pixel-left right)
3301                (window-pixel-top right))))
3302           ;; Shrink windows on left of RIGHT.
3303           (window--resize-siblings
3304            right (- delta) horizontal ignore 'before
3305            (if horizontal
3306                (+ (window-pixel-left left) (window-pixel-width left))
3307              (+ (window-pixel-top left) (window-pixel-height left)))))))
3308       (unless (zerop delta)
3309         ;; Don't report an error in the standard case.
3310         (when (window--resize-apply-p frame horizontal)
3311           (if (window-resize-apply frame horizontal)
3312               (progn
3313                 (window--pixel-to-total frame horizontal)
3314                 (run-window-configuration-change-hook frame))
3315             ;; But do report an error if applying the changes fails.
3316             (error "Failed adjusting window %s" window))))))))
3317
3318 (defun enlarge-window (delta &optional horizontal)
3319   "Make the selected window DELTA lines taller.
3320 Interactively, if no argument is given, make the selected window
3321 one line taller.  If optional argument HORIZONTAL is non-nil,
3322 make selected window wider by DELTA columns.  If DELTA is
3323 negative, shrink selected window by -DELTA lines or columns."
3324   (interactive "p")
3325   (let ((minibuffer-window (minibuffer-window)))
3326     (when (window-preserved-size nil horizontal)
3327       (window-preserve-size nil horizontal))
3328     (cond
3329      ((zerop delta))
3330      ((window-size-fixed-p nil horizontal)
3331       (error "Selected window has fixed size"))
3332      ((window-minibuffer-p)
3333       (if horizontal
3334           (error "Cannot resize minibuffer window horizontally")
3335         (window--resize-mini-window (selected-window) delta)))
3336      ((and (not horizontal)
3337            (window-full-height-p)
3338            (eq (window-frame minibuffer-window) (selected-frame))
3339            (not resize-mini-windows))
3340       ;; If the selected window is full height and `resize-mini-windows'
3341       ;; is nil, resize the minibuffer window.
3342       (window--resize-mini-window minibuffer-window (- delta)))
3343      ((window--resizable-p nil delta horizontal)
3344       (window-resize nil delta horizontal))
3345      (t
3346       (window-resize
3347        nil (if (> delta 0)
3348                (window-max-delta nil horizontal)
3349              (- (window-min-delta nil horizontal)))
3350        horizontal)))))
3351
3352 (defun shrink-window (delta &optional horizontal)
3353   "Make the selected window DELTA lines smaller.
3354 Interactively, if no argument is given, make the selected window
3355 one line smaller.  If optional argument HORIZONTAL is non-nil,
3356 make selected window narrower by DELTA columns.  If DELTA is
3357 negative, enlarge selected window by -DELTA lines or columns.
3358 Also see the `window-min-height' variable."
3359   (interactive "p")
3360   (let ((minibuffer-window (minibuffer-window)))
3361     (when (window-preserved-size nil horizontal)
3362       (window-preserve-size nil horizontal))
3363     (cond
3364      ((zerop delta))
3365      ((window-size-fixed-p nil horizontal)
3366       (error "Selected window has fixed size"))
3367      ((window-minibuffer-p)
3368       (if horizontal
3369           (error "Cannot resize minibuffer window horizontally")
3370         (window--resize-mini-window (selected-window) (- delta))))
3371      ((and (not horizontal)
3372            (window-full-height-p)
3373            (eq (window-frame minibuffer-window) (selected-frame))
3374            (not resize-mini-windows))
3375       ;; If the selected window is full height and `resize-mini-windows'
3376       ;; is nil, resize the minibuffer window.
3377       (window--resize-mini-window minibuffer-window delta))
3378      ((window--resizable-p nil (- delta) horizontal)
3379       (window-resize nil (- delta) horizontal))
3380      (t
3381       (window-resize
3382        nil (if (> delta 0)
3383                (- (window-min-delta nil horizontal))
3384              (window-max-delta nil horizontal))
3385        horizontal)))))
3386
3387 (defun maximize-window (&optional window)
3388   "Maximize WINDOW.
3389 Make WINDOW as large as possible without deleting any windows.
3390 WINDOW must be a valid window and defaults to the selected one.
3391
3392 If the option `window-resize-pixelwise' is non-nil maximize
3393 WINDOW pixelwise."
3394   (interactive)
3395   (setq window (window-normalize-window window))
3396   (window-resize
3397    window (window-max-delta window nil nil nil nil nil window-resize-pixelwise)
3398    nil nil window-resize-pixelwise)
3399   (window-resize
3400    window (window-max-delta window t nil nil nil nil window-resize-pixelwise)
3401    t nil window-resize-pixelwise))
3402
3403 (defun minimize-window (&optional window)
3404   "Minimize WINDOW.
3405 Make WINDOW as small as possible without deleting any windows.
3406 WINDOW must be a valid window and defaults to the selected one.
3407
3408 If the option `window-resize-pixelwise' is non-nil minimize
3409 WINDOW pixelwise."
3410   (interactive)
3411   (setq window (window-normalize-window window))
3412   (window-resize
3413    window
3414    (- (window-min-delta window nil nil nil nil nil window-resize-pixelwise))
3415    nil nil window-resize-pixelwise)
3416   (window-resize
3417    window
3418    (- (window-min-delta window t nil nil nil nil window-resize-pixelwise))
3419    t nil window-resize-pixelwise))
3420 \f
3421 (defun frame-root-window-p (window)
3422   "Return non-nil if WINDOW is the root window of its frame."
3423   (eq window (frame-root-window window)))
3424
3425 (defun window--subtree (window &optional next)
3426   "Return window subtree rooted at WINDOW.
3427 Optional argument NEXT non-nil means include WINDOW's right
3428 siblings in the return value.
3429
3430 See the documentation of `window-tree' for a description of the
3431 return value."
3432   (let (list)
3433     (while window
3434       (setq list
3435             (cons
3436              (cond
3437               ((window-top-child window)
3438                (cons t (cons (window-edges window)
3439                              (window--subtree (window-top-child window) t))))
3440               ((window-left-child window)
3441                (cons nil (cons (window-edges window)
3442                                (window--subtree (window-left-child window) t))))
3443               (t window))
3444              list))
3445       (setq window (when next (window-next-sibling window))))
3446     (nreverse list)))
3447
3448 (defun window-tree (&optional frame)
3449   "Return the window tree of frame FRAME.
3450 FRAME must be a live frame and defaults to the selected frame.
3451 The return value is a list of the form (ROOT MINI), where ROOT
3452 represents the window tree of the frame's root window, and MINI
3453 is the frame's minibuffer window.
3454
3455 If the root window is not split, ROOT is the root window itself.
3456 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
3457 for a horizontal split, and t for a vertical split.  EDGES gives
3458 the combined size and position of the child windows in the split,
3459 and the rest of the elements are the child windows in the split.
3460 Each of the child windows may again be a window or a list
3461 representing a window split, and so on.  EDGES is a list (LEFT
3462 TOP RIGHT BOTTOM) as returned by `window-edges'."
3463   (setq frame (window-normalize-frame frame))
3464   (window--subtree (frame-root-window frame) t))
3465 \f
3466 (defun other-window (count &optional all-frames)
3467   "Select another window in cyclic ordering of windows.
3468 COUNT specifies the number of windows to skip, starting with the
3469 selected window, before making the selection.  If COUNT is
3470 positive, skip COUNT windows forwards.  If COUNT is negative,
3471 skip -COUNT windows backwards.  COUNT zero means do not skip any
3472 window, so select the selected window.  In an interactive call,
3473 COUNT is the numeric prefix argument.  Return nil.
3474
3475 If the `other-window' parameter of the selected window is a
3476 function and `ignore-window-parameters' is nil, call that
3477 function with the arguments COUNT and ALL-FRAMES.
3478
3479 This function does not select a window whose `no-other-window'
3480 window parameter is non-nil.
3481
3482 This function uses `next-window' for finding the window to
3483 select.  The argument ALL-FRAMES has the same meaning as in
3484 `next-window', but the MINIBUF argument of `next-window' is
3485 always effectively nil."
3486   (interactive "p")
3487   (let* ((window (selected-window))
3488          (function (and (not ignore-window-parameters)
3489                         (window-parameter window 'other-window)))
3490          old-window old-count)
3491     (if (functionp function)
3492         (funcall function count all-frames)
3493       ;; `next-window' and `previous-window' may return a window we are
3494       ;; not allowed to select.  Hence we need an exit strategy in case
3495       ;; all windows are non-selectable.
3496       (catch 'exit
3497         (while (> count 0)
3498           (setq window (next-window window nil all-frames))
3499           (cond
3500            ((eq window old-window)
3501             (when (= count old-count)
3502               ;; Keep out of infinite loops.  When COUNT has not changed
3503               ;; since we last looked at `window' we're probably in one.
3504               (throw 'exit nil)))
3505            ((window-parameter window 'no-other-window)
3506             (unless old-window
3507               ;; The first non-selectable window `next-window' got us:
3508               ;; Remember it and the current value of COUNT.
3509               (setq old-window window)
3510               (setq old-count count)))
3511            (t
3512             (setq count (1- count)))))
3513         (while (< count 0)
3514           (setq window (previous-window window nil all-frames))
3515           (cond
3516            ((eq window old-window)
3517             (when (= count old-count)
3518               ;; Keep out of infinite loops.  When COUNT has not changed
3519               ;; since we last looked at `window' we're probably in one.
3520               (throw 'exit nil)))
3521            ((window-parameter window 'no-other-window)
3522             (unless old-window
3523               ;; The first non-selectable window `previous-window' got
3524               ;; us: Remember it and the current value of COUNT.
3525               (setq old-window window)
3526               (setq old-count count)))
3527            (t
3528             (setq count (1+ count)))))
3529
3530         (select-window window)
3531         ;; Always return nil.
3532         nil))))
3533
3534 ;; This should probably return non-nil when the selected window is part
3535 ;; of an atomic window whose root is the frame's root window.
3536 (defun one-window-p (&optional nomini all-frames)
3537   "Return non-nil if the selected window is the only window.
3538 Optional arg NOMINI non-nil means don't count the minibuffer
3539 even if it is active.  Otherwise, the minibuffer is counted
3540 when it is active.
3541
3542 Optional argument ALL-FRAMES specifies the set of frames to
3543 consider, see also `next-window'.  ALL-FRAMES nil or omitted
3544 means consider windows on the selected frame only, plus the
3545 minibuffer window if specified by the NOMINI argument.  If the
3546 minibuffer counts, consider all windows on all frames that share
3547 that minibuffer too.  The remaining non-nil values of ALL-FRAMES
3548 with a special meaning are:
3549
3550 - t means consider all windows on all existing frames.
3551
3552 - `visible' means consider all windows on all visible frames on
3553   the current terminal.
3554
3555 - 0 (the number zero) means consider all windows on all visible
3556   and iconified frames on the current terminal.
3557
3558 - A frame means consider all windows on that frame only.
3559
3560 Anything else means consider all windows on the selected frame
3561 and no others."
3562   (let ((base-window (selected-window)))
3563     (if (and nomini (eq base-window (minibuffer-window)))
3564         (setq base-window (next-window base-window)))
3565     (eq base-window
3566         (next-window base-window (if nomini 'arg) all-frames))))
3567 \f
3568 ;;; Deleting windows.
3569 (defun window-deletable-p (&optional window)
3570   "Return t if WINDOW can be safely deleted from its frame.
3571 WINDOW must be a valid window and defaults to the selected one.
3572 Return 'frame if deleting WINDOW should also delete its frame."
3573   (setq window (window-normalize-window window))
3574
3575   (unless (or ignore-window-parameters
3576               (eq (window-parameter window 'delete-window) t))
3577     ;; Handle atomicity.
3578     (when (window-parameter window 'window-atom)
3579       (setq window (window-atom-root window))))
3580
3581   (let ((frame (window-frame window)))
3582     (cond
3583      ((frame-root-window-p window)
3584       ;; WINDOW's frame can be deleted only if there are other frames
3585       ;; on the same terminal, and it does not contain the active
3586       ;; minibuffer.
3587       (unless (or (eq frame (next-frame frame 0))
3588                   ;; We can delete our frame only if no other frame
3589                   ;; currently uses our minibuffer window.
3590                   (catch 'other
3591                     (dolist (other (frame-list))
3592                       (when (and (not (eq other frame))
3593                                  (eq (window-frame (minibuffer-window other))
3594                                      frame))
3595                         (throw 'other t))))
3596                   (let ((minibuf (active-minibuffer-window)))
3597                     (and minibuf (eq frame (window-frame minibuf)))))
3598         'frame))
3599      ((or ignore-window-parameters
3600           (not (eq window (window--major-non-side-window frame))))
3601       ;; WINDOW can be deleted unless it is the major non-side window of
3602       ;; its frame.
3603       t))))
3604
3605 (defun window--in-subtree-p (window root)
3606   "Return t if WINDOW is either ROOT or a member of ROOT's subtree."
3607   (or (eq window root)
3608       (let ((parent (window-parent window)))
3609         (catch 'done
3610           (while parent
3611             (if (eq parent root)
3612                 (throw 'done t)
3613               (setq parent (window-parent parent))))))))
3614
3615 (defun delete-window (&optional window)
3616   "Delete WINDOW.
3617 WINDOW must be a valid window and defaults to the selected one.
3618 Return nil.
3619
3620 If the variable `ignore-window-parameters' is non-nil or the
3621 `delete-window' parameter of WINDOW equals t, do not process any
3622 parameters of WINDOW.  Otherwise, if the `delete-window'
3623 parameter of WINDOW specifies a function, call that function with
3624 WINDOW as its sole argument and return the value returned by that
3625 function.
3626
3627 Otherwise, if WINDOW is part of an atomic window, call
3628 `delete-window' with the root of the atomic window as its
3629 argument.  Signal an error if WINDOW is either the only window on
3630 its frame, the last non-side window, or part of an atomic window
3631 that is its frame's root window."
3632   (interactive)
3633   (setq window (window-normalize-window window))
3634   (let* ((frame (window-frame window))
3635          (function (window-parameter window 'delete-window))
3636          (parent (window-parent window))
3637          atom-root)
3638     (window--check frame)
3639     (catch 'done
3640       ;; Handle window parameters.
3641       (cond
3642        ;; Ignore window parameters if `ignore-window-parameters' tells
3643        ;; us so or `delete-window' equals t.
3644        ((or ignore-window-parameters (eq function t)))
3645        ((functionp function)
3646         ;; The `delete-window' parameter specifies the function to call.
3647         ;; If that function is `ignore' nothing is done.  It's up to the
3648         ;; function called here to avoid infinite recursion.
3649         (throw 'done (funcall function window)))
3650        ((and (window-parameter window 'window-atom)
3651              (setq atom-root (window-atom-root window))
3652              (not (eq atom-root window)))
3653         (if (eq atom-root (frame-root-window frame))
3654             (error "Root of atomic window is root window of its frame")
3655           (throw 'done (delete-window atom-root))))
3656        ((not parent)
3657         (error "Attempt to delete minibuffer or sole ordinary window"))
3658        ((eq window (window--major-non-side-window frame))
3659         (error "Attempt to delete last non-side window")))
3660
3661       (let* ((horizontal (window-left-child parent))
3662              (size (window-size window horizontal t))
3663              (frame-selected
3664               (window--in-subtree-p (frame-selected-window frame) window))
3665              ;; Emacs 23 preferably gives WINDOW's space to its left
3666              ;; sibling.
3667              (sibling (or (window-left window) (window-right window))))
3668         (window--resize-reset frame horizontal)
3669         (cond
3670          ((and (not window-combination-resize)
3671                sibling (window-sizable-p sibling size horizontal nil t))
3672           ;; Resize WINDOW's sibling.
3673           (window--resize-this-window sibling size horizontal nil t)
3674           (set-window-new-normal
3675            sibling (+ (window-normal-size sibling horizontal)
3676                       (window-normal-size window horizontal))))
3677          ((window--resizable-p window (- size) horizontal nil nil nil t t)
3678           ;; Can do without resizing fixed-size windows.
3679           (window--resize-siblings window (- size) horizontal))
3680          (t
3681           ;; Can't do without resizing fixed-size windows.
3682           (window--resize-siblings window (- size) horizontal t)))
3683         ;; Actually delete WINDOW.
3684         (delete-window-internal window)
3685         (window--pixel-to-total frame horizontal)
3686         (when (and frame-selected
3687                    (window-parameter
3688                     (frame-selected-window frame) 'no-other-window))
3689           ;; `delete-window-internal' has selected a window that should
3690           ;; not be selected, fix this here.
3691           (other-window -1 frame))
3692         (run-window-configuration-change-hook frame)
3693         (window--check frame)
3694         ;; Always return nil.
3695         nil))))
3696
3697 (defun delete-other-windows (&optional window)
3698   "Make WINDOW fill its frame.
3699 WINDOW must be a valid window and defaults to the selected one.
3700 Return nil.
3701
3702 If the variable `ignore-window-parameters' is non-nil or the
3703 `delete-other-windows' parameter of WINDOW equals t, do not
3704 process any parameters of WINDOW.  Otherwise, if the
3705 `delete-other-windows' parameter of WINDOW specifies a function,
3706 call that function with WINDOW as its sole argument and return
3707 the value returned by that function.
3708
3709 Otherwise, if WINDOW is part of an atomic window, call this
3710 function with the root of the atomic window as its argument.  If
3711 WINDOW is a non-side window, make WINDOW the only non-side window
3712 on the frame.  Side windows are not deleted.  If WINDOW is a side
3713 window signal an error."
3714   (interactive)
3715   (setq window (window-normalize-window window))
3716   (let* ((frame (window-frame window))
3717          (function (window-parameter window 'delete-other-windows))
3718          (window-side (window-parameter window 'window-side))
3719          atom-root side-main)
3720     (window--check frame)
3721     (catch 'done
3722       (cond
3723        ;; Ignore window parameters if `ignore-window-parameters' is t or
3724        ;; `delete-other-windows' is t.
3725        ((or ignore-window-parameters (eq function t)))
3726        ((functionp function)
3727         ;; The `delete-other-windows' parameter specifies the function
3728         ;; to call.  If the function is `ignore' no windows are deleted.
3729         ;; It's up to the function called to avoid infinite recursion.
3730         (throw 'done (funcall function window)))
3731        ((and (window-parameter window 'window-atom)
3732              (setq atom-root (window-atom-root window))
3733              (not (eq atom-root window)))
3734         (if (eq atom-root (frame-root-window frame))
3735             (error "Root of atomic window is root window of its frame")
3736           (throw 'done (delete-other-windows atom-root))))
3737        ((memq window-side window-sides)
3738         (error "Cannot make side window the only window"))
3739        ((and (window-minibuffer-p window)
3740              (not (eq window (frame-root-window window))))
3741         (error "Can't expand minibuffer to full frame")))
3742
3743       ;; If WINDOW is the major non-side window, do nothing.
3744       (if (window-with-parameter 'window-side)
3745           (setq side-main (window--major-non-side-window frame))
3746         (setq side-main (frame-root-window frame)))
3747       (unless (eq window side-main)
3748         (delete-other-windows-internal window side-main)
3749         (run-window-configuration-change-hook frame)
3750         (window--check frame))
3751       ;; Always return nil.
3752       nil)))
3753
3754 (defun delete-other-windows-vertically (&optional window)
3755   "Delete the windows in the same column with WINDOW, but not WINDOW itself.
3756 This may be a useful alternative binding for \\[delete-other-windows]
3757  if you often split windows horizontally."
3758   (interactive)
3759   (let* ((window (or window (selected-window)))
3760          (edges (window-edges window))
3761          (w window) delenda)
3762     (while (not (eq (setq w (next-window w 1)) window))
3763       (let ((e (window-edges w)))
3764         (when (and (= (car e) (car edges))
3765                    (= (nth 2 e) (nth 2 edges)))
3766           (push w delenda))))
3767     (mapc 'delete-window delenda)))
3768
3769 ;;; Windows and buffers.
3770
3771 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
3772 ;; for (1) determining which buffer to show in the window when its
3773 ;; buffer shall be buried or killed and (2) which buffer to show for
3774 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
3775
3776 ;; `prev-buffers' consists of <buffer, window-start, window-point>
3777 ;; triples.  The entries on this list are ordered by the time their
3778 ;; buffer has been removed from the window, the most recently removed
3779 ;; buffer's entry being first.  The window-start and window-point
3780 ;; components are `window-start' and `window-point' at the time the
3781 ;; buffer was removed from the window which implies that the entry must
3782 ;; be added when `set-window-buffer' removes the buffer from the window.
3783
3784 ;; `next-buffers' is the list of buffers that have been replaced
3785 ;; recently by `switch-to-prev-buffer'.  These buffers are the least
3786 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
3787 ;; candidates of `switch-to-next-buffer' to switch to.  This list is
3788 ;; reset to nil by any action changing the window's buffer with the
3789 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
3790 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
3791 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
3792
3793 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
3794 ;; if such a buffer was killed while the window was hidden within a
3795 ;; window configuration.  Such killed buffers get removed whenever
3796 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
3797
3798 ;; The following function is called by `set-window-buffer' _before_ it
3799 ;; replaces the buffer of the argument window with the new buffer.
3800 (defun record-window-buffer (&optional window)
3801   "Record WINDOW's buffer.
3802 WINDOW must be a live window and defaults to the selected one."
3803   (let* ((window (window-normalize-window window t))
3804          (buffer (window-buffer window))
3805          (entry (assq buffer (window-prev-buffers window))))
3806     ;; Reset WINDOW's next buffers.  If needed, they are resurrected by
3807     ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
3808     (set-window-next-buffers window nil)
3809
3810     (when entry
3811       ;; Remove all entries for BUFFER from WINDOW's previous buffers.
3812       (set-window-prev-buffers
3813        window (assq-delete-all buffer (window-prev-buffers window))))
3814
3815     ;; Don't record insignificant buffers.
3816     (unless (eq (aref (buffer-name buffer) 0) ?\s)
3817       ;; Add an entry for buffer to WINDOW's previous buffers.
3818       (with-current-buffer buffer
3819         (let ((start (window-start window))
3820               (point (window-point window)))
3821           (setq entry
3822                 (cons buffer
3823                       (if entry
3824                           ;; We have an entry, update marker positions.
3825                           (list (set-marker (nth 1 entry) start)
3826                                 (set-marker (nth 2 entry) point))
3827                         ;; Make new markers.
3828                         (list (copy-marker start)
3829                               (copy-marker
3830                                ;; Preserve window-point-insertion-type
3831                                ;; (Bug#12588).
3832                                point window-point-insertion-type)))))
3833           (set-window-prev-buffers
3834            window (cons entry (window-prev-buffers window)))))
3835
3836       (run-hooks 'buffer-list-update-hook))))
3837
3838 (defun unrecord-window-buffer (&optional window buffer)
3839   "Unrecord BUFFER in WINDOW.
3840 WINDOW must be a live window and defaults to the selected one.
3841 BUFFER must be a live buffer and defaults to the buffer of
3842 WINDOW."
3843   (let* ((window (window-normalize-window window t))
3844          (buffer (or buffer (window-buffer window))))
3845     (set-window-prev-buffers
3846      window (assq-delete-all buffer (window-prev-buffers window)))
3847     (set-window-next-buffers
3848      window (delq buffer (window-next-buffers window)))))
3849
3850 (defun set-window-buffer-start-and-point (window buffer &optional start point)
3851   "Set WINDOW's buffer to BUFFER.
3852 WINDOW must be a live window and defaults to the selected one.
3853 Optional argument START non-nil means set WINDOW's start position
3854 to START.  Optional argument POINT non-nil means set WINDOW's
3855 point to POINT.  If WINDOW is selected this also sets BUFFER's
3856 `point' to POINT.  If WINDOW is selected and the buffer it showed
3857 before was current this also makes BUFFER the current buffer."
3858   (setq window (window-normalize-window window t))
3859   (let ((selected (eq window (selected-window)))
3860         (current (eq (window-buffer window) (current-buffer))))
3861     (set-window-buffer window buffer)
3862     (when (and selected current)
3863       (set-buffer buffer))
3864     (when start
3865       ;; Don't force window-start here (even if POINT is nil).
3866       (set-window-start window start t))
3867     (when point
3868       (set-window-point window point))))
3869
3870 (defcustom switch-to-visible-buffer t
3871   "If non-nil, allow switching to an already visible buffer.
3872 If this variable is non-nil, `switch-to-prev-buffer' and
3873 `switch-to-next-buffer' may switch to an already visible buffer
3874 provided the buffer was shown before in the window specified as
3875 argument to those functions.  If this variable is nil,
3876 `switch-to-prev-buffer' and `switch-to-next-buffer' always try to
3877 avoid switching to a buffer that is already visible in another
3878 window on the same frame."
3879   :type 'boolean
3880   :version "24.1"
3881   :group 'windows)
3882
3883 (defun switch-to-prev-buffer (&optional window bury-or-kill)
3884   "In WINDOW switch to previous buffer.
3885 WINDOW must be a live window and defaults to the selected one.
3886 Return the buffer switched to, nil if no suitable buffer could be
3887 found.
3888
3889 Optional argument BURY-OR-KILL non-nil means the buffer currently
3890 shown in WINDOW is about to be buried or killed and consequently
3891 shall not be switched to in future invocations of this command.
3892
3893 As a special case, if BURY-OR-KILL equals `append', this means to
3894 move the buffer to the end of WINDOW's previous buffers list so a
3895 future invocation of `switch-to-prev-buffer' less likely switches
3896 to it."
3897   (interactive)
3898   (let* ((window (window-normalize-window window t))
3899          (frame (window-frame window))
3900          (old-buffer (window-buffer window))
3901          ;; Save this since it's destroyed by `set-window-buffer'.
3902          (next-buffers (window-next-buffers window))
3903          (pred (frame-parameter frame 'buffer-predicate))
3904          entry new-buffer killed-buffers visible)
3905     (when (window-minibuffer-p window)
3906       ;; Don't switch in minibuffer window.
3907       (unless (setq window (minibuffer-selected-window))
3908         (error "Window %s is a minibuffer window" window)))
3909
3910     (when (window-dedicated-p window)
3911       ;; Don't switch in dedicated window.
3912       (error "Window %s is dedicated to buffer %s" window old-buffer))
3913
3914     (catch 'found
3915       ;; Scan WINDOW's previous buffers first, skipping entries of next
3916       ;; buffers.
3917       (dolist (entry (window-prev-buffers window))
3918         (when (and (setq new-buffer (car entry))
3919                    (or (buffer-live-p new-buffer)
3920                        (not (setq killed-buffers
3921                                   (cons new-buffer killed-buffers))))
3922                    (not (eq new-buffer old-buffer))
3923                    (or (null pred) (funcall pred new-buffer))
3924                    ;; When BURY-OR-KILL is nil, avoid switching to a
3925                    ;; buffer in WINDOW's next buffers list.
3926                    (or bury-or-kill (not (memq new-buffer next-buffers))))
3927           (if (and (not switch-to-visible-buffer)
3928                    (get-buffer-window new-buffer frame))
3929               ;; Try to avoid showing a buffer visible in some other
3930               ;; window.
3931               (setq visible new-buffer)
3932             (set-window-buffer-start-and-point
3933              window new-buffer (nth 1 entry) (nth 2 entry))
3934             (throw 'found t))))
3935       ;; Scan reverted buffer list of WINDOW's frame next, skipping
3936       ;; entries of next buffers.  Note that when we bury or kill a
3937       ;; buffer we don't reverse the global buffer list to avoid showing
3938       ;; a buried buffer instead.  Otherwise, we must reverse the global
3939       ;; buffer list in order to make sure that switching to the
3940       ;; previous/next buffer traverse it in opposite directions.
3941       (dolist (buffer (if bury-or-kill
3942                           (buffer-list frame)
3943                         (nreverse (buffer-list frame))))
3944         (when (and (buffer-live-p buffer)
3945                    (not (eq buffer old-buffer))
3946                    (or (null pred) (funcall pred buffer))
3947                    (not (eq (aref (buffer-name buffer) 0) ?\s))
3948                    (or bury-or-kill (not (memq buffer next-buffers))))
3949           (if (get-buffer-window buffer frame)
3950               ;; Try to avoid showing a buffer visible in some other window.
3951               (unless visible
3952                 (setq visible buffer))
3953             (setq new-buffer buffer)
3954             (set-window-buffer-start-and-point window new-buffer)
3955             (throw 'found t))))
3956       (unless bury-or-kill
3957         ;; Scan reverted next buffers last (must not use nreverse
3958         ;; here!).
3959         (dolist (buffer (reverse next-buffers))
3960           ;; Actually, buffer _must_ be live here since otherwise it
3961           ;; would have been caught in the scan of previous buffers.
3962           (when (and (or (buffer-live-p buffer)
3963                          (not (setq killed-buffers
3964                                     (cons buffer killed-buffers))))
3965                      (not (eq buffer old-buffer))
3966                      (or (null pred) (funcall pred buffer))
3967                      (setq entry (assq buffer (window-prev-buffers window))))
3968             (setq new-buffer buffer)
3969             (set-window-buffer-start-and-point
3970              window new-buffer (nth 1 entry) (nth 2 entry))
3971             (throw 'found t))))
3972
3973       ;; Show a buffer visible in another window.
3974       (when visible
3975         (setq new-buffer visible)
3976         (set-window-buffer-start-and-point window new-buffer)))
3977
3978     (if bury-or-kill
3979         (let ((entry (and (eq bury-or-kill 'append)
3980                           (assq old-buffer (window-prev-buffers window)))))
3981           ;; Remove `old-buffer' from WINDOW's previous and (restored list
3982           ;; of) next buffers.
3983           (set-window-prev-buffers
3984            window (assq-delete-all old-buffer (window-prev-buffers window)))
3985           (set-window-next-buffers window (delq old-buffer next-buffers))
3986           (when entry
3987             ;; Append old-buffer's entry to list of WINDOW's previous
3988             ;; buffers so it's less likely to get switched to soon but
3989             ;; `display-buffer-in-previous-window' can nevertheless find
3990             ;; it.
3991             (set-window-prev-buffers
3992              window (append (window-prev-buffers window) (list entry)))))
3993       ;; Move `old-buffer' to head of WINDOW's restored list of next
3994       ;; buffers.
3995       (set-window-next-buffers
3996        window (cons old-buffer (delq old-buffer next-buffers))))
3997
3998     ;; Remove killed buffers from WINDOW's previous and next buffers.
3999     (when killed-buffers
4000       (dolist (buffer killed-buffers)
4001         (set-window-prev-buffers
4002          window (assq-delete-all buffer (window-prev-buffers window)))
4003         (set-window-next-buffers
4004          window (delq buffer (window-next-buffers window)))))
4005
4006     ;; Return new-buffer.
4007     new-buffer))
4008
4009 (defun switch-to-next-buffer (&optional window)
4010   "In WINDOW switch to next buffer.
4011 WINDOW must be a live window and defaults to the selected one.
4012 Return the buffer switched to, nil if no suitable buffer could be
4013 found."
4014   (interactive)
4015   (let* ((window (window-normalize-window window t))
4016          (frame (window-frame window))
4017          (old-buffer (window-buffer window))
4018          (next-buffers (window-next-buffers window))
4019          (pred (frame-parameter frame 'buffer-predicate))
4020          new-buffer entry killed-buffers visible)
4021     (when (window-minibuffer-p window)
4022       ;; Don't switch in minibuffer window.
4023       (unless (setq window (minibuffer-selected-window))
4024         (error "Window %s is a minibuffer window" window)))
4025
4026     (when (window-dedicated-p window)
4027       ;; Don't switch in dedicated window.
4028       (error "Window %s is dedicated to buffer %s" window old-buffer))
4029
4030     (catch 'found
4031       ;; Scan WINDOW's next buffers first.
4032       (dolist (buffer next-buffers)
4033         (when (and (or (buffer-live-p buffer)
4034                        (not (setq killed-buffers
4035                                   (cons buffer killed-buffers))))
4036                    (not (eq buffer old-buffer))
4037                    (or (null pred) (funcall pred buffer))
4038                    (setq entry (assq buffer (window-prev-buffers window))))
4039           (setq new-buffer buffer)
4040           (set-window-buffer-start-and-point
4041            window new-buffer (nth 1 entry) (nth 2 entry))
4042           (throw 'found t)))
4043       ;; Scan the buffer list of WINDOW's frame next, skipping previous
4044       ;; buffers entries.
4045       (dolist (buffer (buffer-list frame))
4046         (when (and (buffer-live-p buffer)
4047                    (not (eq buffer old-buffer))
4048                    (or (null pred) (funcall pred buffer))
4049                    (not (eq (aref (buffer-name buffer) 0) ?\s))
4050                    (not (assq buffer (window-prev-buffers window))))
4051           (if (get-buffer-window buffer frame)
4052               ;; Try to avoid showing a buffer visible in some other window.
4053               (setq visible buffer)
4054             (setq new-buffer buffer)
4055             (set-window-buffer-start-and-point window new-buffer)
4056             (throw 'found t))))
4057       ;; Scan WINDOW's reverted previous buffers last (must not use
4058       ;; nreverse here!)
4059       (dolist (entry (reverse (window-prev-buffers window)))
4060         (when (and (setq new-buffer (car entry))
4061                    (or (buffer-live-p new-buffer)
4062                        (not (setq killed-buffers
4063                                   (cons new-buffer killed-buffers))))
4064                    (not (eq new-buffer old-buffer))
4065                    (or (null pred) (funcall pred new-buffer)))
4066           (if (and (not switch-to-visible-buffer)
4067                    (get-buffer-window new-buffer frame))
4068               ;; Try to avoid showing a buffer visible in some other window.
4069               (unless visible
4070                 (setq visible new-buffer))
4071             (set-window-buffer-start-and-point
4072              window new-buffer (nth 1 entry) (nth 2 entry))
4073             (throw 'found t))))
4074
4075       ;; Show a buffer visible in another window.
4076       (when visible
4077         (setq new-buffer visible)
4078         (set-window-buffer-start-and-point window new-buffer)))
4079
4080     ;; Remove `new-buffer' from and restore WINDOW's next buffers.
4081     (set-window-next-buffers window (delq new-buffer next-buffers))
4082
4083     ;; Remove killed buffers from WINDOW's previous and next buffers.
4084     (when killed-buffers
4085       (dolist (buffer killed-buffers)
4086         (set-window-prev-buffers
4087          window (assq-delete-all buffer (window-prev-buffers window)))
4088         (set-window-next-buffers
4089          window (delq buffer (window-next-buffers window)))))
4090
4091     ;; Return new-buffer.
4092     new-buffer))
4093
4094 (defun get-next-valid-buffer (list &optional buffer visible-ok frame)
4095   "Search LIST for a valid buffer to display in FRAME.
4096 Return nil when all buffers in LIST are undesirable for display,
4097 otherwise return the first suitable buffer in LIST.
4098
4099 Buffers not visible in windows are preferred to visible buffers,
4100 unless VISIBLE-OK is non-nil.
4101 If the optional argument FRAME is nil, it defaults to the selected frame.
4102 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
4103   ;; This logic is more or less copied from other-buffer.
4104   (setq frame (or frame (selected-frame)))
4105   (let ((pred (frame-parameter frame 'buffer-predicate))
4106         found buf)
4107     (while (and (not found) list)
4108       (setq buf (car list))
4109       (if (and (not (eq buffer buf))
4110                (buffer-live-p buf)
4111                (or (null pred) (funcall pred buf))
4112                (not (eq (aref (buffer-name buf) 0) ?\s))
4113                (or visible-ok (null (get-buffer-window buf 'visible))))
4114           (setq found buf)
4115         (setq list (cdr list))))
4116     (car list)))
4117
4118 (defun last-buffer (&optional buffer visible-ok frame)
4119   "Return the last buffer in FRAME's buffer list.
4120 If BUFFER is the last buffer, return the preceding buffer
4121 instead.  Buffers not visible in windows are preferred to visible
4122 buffers, unless optional argument VISIBLE-OK is non-nil.
4123 Optional third argument FRAME nil or omitted means use the
4124 selected frame's buffer list.  If no such buffer exists, return
4125 the buffer `*scratch*', creating it if necessary."
4126   (setq frame (or frame (selected-frame)))
4127   (or (get-next-valid-buffer (nreverse (buffer-list frame))
4128                              buffer visible-ok frame)
4129       (get-buffer "*scratch*")
4130       (let ((scratch (get-buffer-create "*scratch*")))
4131         (set-buffer-major-mode scratch)
4132         scratch)))
4133
4134 (defcustom frame-auto-hide-function #'iconify-frame
4135   "Function called to automatically hide frames.
4136 The function is called with one argument - a frame.
4137
4138 Functions affected by this option are those that bury a buffer
4139 shown in a separate frame like `quit-window' and `bury-buffer'."
4140   :type '(choice (const :tag "Iconify" iconify-frame)
4141                  (const :tag "Delete" delete-frame)
4142                  (const :tag "Do nothing" ignore)
4143                  function)
4144   :group 'windows
4145   :group 'frames
4146   :version "24.1")
4147
4148 (defun window--delete (&optional window dedicated-only kill)
4149   "Delete WINDOW if possible.
4150 WINDOW must be a live window and defaults to the selected one.
4151 Optional argument DEDICATED-ONLY non-nil means to delete WINDOW
4152 only if it's dedicated to its buffer.  Optional argument KILL
4153 means the buffer shown in window will be killed.  Return non-nil
4154 if WINDOW gets deleted or its frame is auto-hidden."
4155   (setq window (window-normalize-window window t))
4156   (unless (and dedicated-only (not (window-dedicated-p window)))
4157     (let ((deletable (window-deletable-p window)))
4158       (cond
4159        ((eq deletable 'frame)
4160         (let ((frame (window-frame window)))
4161           (cond
4162            (kill
4163             (delete-frame frame))
4164            ((functionp frame-auto-hide-function)
4165             (funcall frame-auto-hide-function frame))))
4166         'frame)
4167        (deletable
4168         (delete-window window)
4169         t)))))
4170
4171 (defun bury-buffer (&optional buffer-or-name)
4172   "Put BUFFER-OR-NAME at the end of the list of all buffers.
4173 There it is the least likely candidate for `other-buffer' to
4174 return; thus, the least likely buffer for \\[switch-to-buffer] to
4175 select by default.
4176
4177 You can specify a buffer name as BUFFER-OR-NAME, or an actual
4178 buffer object.  If BUFFER-OR-NAME is nil or omitted, bury the
4179 current buffer.  Also, if BUFFER-OR-NAME is nil or omitted,
4180 remove the current buffer from the selected window if it is
4181 displayed there."
4182   (interactive)
4183   (let* ((buffer (window-normalize-buffer buffer-or-name)))
4184     ;; If `buffer-or-name' is not on the selected frame we unrecord it
4185     ;; although it's not "here" (call it a feature).
4186     (bury-buffer-internal buffer)
4187     ;; Handle case where `buffer-or-name' is nil and the current buffer
4188     ;; is shown in the selected window.
4189     (cond
4190      ((or buffer-or-name (not (eq buffer (window-buffer)))))
4191      ((window--delete nil t))
4192      (t
4193       ;; Switch to another buffer in window.
4194       (set-window-dedicated-p nil nil)
4195       (switch-to-prev-buffer nil 'bury)))
4196
4197     ;; Always return nil.
4198     nil))
4199
4200 (defun unbury-buffer ()
4201   "Switch to the last buffer in the buffer list."
4202   (interactive)
4203   (switch-to-buffer (last-buffer)))
4204
4205 (defun next-buffer ()
4206   "In selected window switch to next buffer."
4207   (interactive)
4208   (cond
4209    ((window-minibuffer-p)
4210     (error "Cannot switch buffers in minibuffer window"))
4211    ((eq (window-dedicated-p) t)
4212     (error "Window is strongly dedicated to its buffer"))
4213    (t
4214     (switch-to-next-buffer))))
4215
4216 (defun previous-buffer ()
4217   "In selected window switch to previous buffer."
4218   (interactive)
4219   (cond
4220    ((window-minibuffer-p)
4221     (error "Cannot switch buffers in minibuffer window"))
4222    ((eq (window-dedicated-p) t)
4223     (error "Window is strongly dedicated to its buffer"))
4224    (t
4225     (switch-to-prev-buffer))))
4226
4227 (defun delete-windows-on (&optional buffer-or-name frame)
4228   "Delete all windows showing BUFFER-OR-NAME.
4229 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
4230 and defaults to the current buffer.
4231
4232 The following non-nil values of the optional argument FRAME
4233 have special meanings:
4234
4235 - t means consider all windows on the selected frame only.
4236
4237 - `visible' means consider all windows on all visible frames on
4238   the current terminal.
4239
4240 - 0 (the number zero) means consider all windows on all visible
4241   and iconified frames on the current terminal.
4242
4243 - A frame means consider all windows on that frame only.
4244
4245 Any other value of FRAME means consider all windows on all
4246 frames.
4247
4248 When a window showing BUFFER-OR-NAME is dedicated and the only
4249 window of its frame, that frame is deleted when there are other
4250 frames left."
4251   (interactive "BDelete windows on (buffer):\nP")
4252   (let ((buffer (window-normalize-buffer buffer-or-name))
4253         ;; Handle the "inverted" meaning of the FRAME argument wrt other
4254         ;; `window-list-1' based function.
4255         (all-frames (cond ((not frame) t) ((eq frame t) nil) (t frame))))
4256     (dolist (window (window-list-1 nil nil all-frames))
4257       (if (eq (window-buffer window) buffer)
4258           (let ((deletable (window-deletable-p window)))
4259             (cond
4260              ((and (eq deletable 'frame) (window-dedicated-p window))
4261               ;; Delete frame if and only if window is dedicated.
4262               (delete-frame (window-frame window)))
4263              ((eq deletable t)
4264               ;; Delete window.
4265               (delete-window window))
4266              (t
4267               ;; In window switch to previous buffer.
4268               (set-window-dedicated-p window nil)
4269               (switch-to-prev-buffer window 'bury))))
4270         ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
4271         (unrecord-window-buffer window buffer)))))
4272
4273 (defun replace-buffer-in-windows (&optional buffer-or-name)
4274   "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
4275 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
4276 and defaults to the current buffer.
4277
4278 When a window showing BUFFER-OR-NAME is dedicated, that window is
4279 deleted.  If that window is the only window on its frame, the
4280 frame is deleted too when there are other frames left.  If there
4281 are no other frames left, some other buffer is displayed in that
4282 window.
4283
4284 This function removes the buffer denoted by BUFFER-OR-NAME from
4285 all window-local buffer lists."
4286   (interactive "bBuffer to replace: ")
4287   (let ((buffer (window-normalize-buffer buffer-or-name)))
4288     (dolist (window (window-list-1 nil nil t))
4289       (if (eq (window-buffer window) buffer)
4290           (unless (window--delete window t t)
4291             ;; Switch to another buffer in window.
4292             (set-window-dedicated-p window nil)
4293             (switch-to-prev-buffer window 'kill))
4294         ;; Unrecord BUFFER in WINDOW.
4295         (unrecord-window-buffer window buffer)))))
4296
4297 (defun quit-restore-window (&optional window bury-or-kill)
4298   "Quit WINDOW and deal with its buffer.
4299 WINDOW must be a live window and defaults to the selected one.
4300
4301 According to information stored in WINDOW's `quit-restore' window
4302 parameter either (1) delete WINDOW and its frame, (2) delete
4303 WINDOW, (3) restore the buffer previously displayed in WINDOW,
4304 or (4) make WINDOW display some other buffer than the present
4305 one.  If non-nil, reset `quit-restore' parameter to nil.
4306
4307 Optional second argument BURY-OR-KILL tells how to proceed with
4308 the buffer of WINDOW.  The following values are handled:
4309
4310 `nil' means to not handle the buffer in a particular way.  This
4311   means that if WINDOW is not deleted by this function, invoking
4312   `switch-to-prev-buffer' will usually show the buffer again.
4313
4314 `append' means that if WINDOW is not deleted, move its buffer to
4315   the end of WINDOW's previous buffers so it's less likely that a
4316   future invocation of `switch-to-prev-buffer' will switch to it.
4317   Also, move the buffer to the end of the frame's buffer list.
4318
4319 `bury' means that if WINDOW is not deleted, remove its buffer
4320   from WINDOW'S list of previous buffers.  Also, move the buffer
4321   to the end of the frame's buffer list.  This value provides the
4322   most reliable remedy to not have `switch-to-prev-buffer' switch
4323   to this buffer again without killing the buffer.
4324
4325 `kill' means to kill WINDOW's buffer."
4326   (setq window (window-normalize-window window t))
4327   (let* ((buffer (window-buffer window))
4328          (quit-restore (window-parameter window 'quit-restore))
4329          (prev-buffer
4330           (let* ((prev-buffers (window-prev-buffers window))
4331                  (prev-buffer (caar prev-buffers)))
4332             (and (or (not (eq prev-buffer buffer))
4333                      (and (cdr prev-buffers)
4334                           (not (eq (setq prev-buffer (cadr prev-buffers))
4335                                    buffer))))
4336                  prev-buffer)))
4337          quad entry)
4338     (cond
4339      ((and (not prev-buffer)
4340            (or (eq (nth 1 quit-restore) 'frame)
4341                (and (eq (nth 1 quit-restore) 'window)
4342                     ;; If the window has been created on an existing
4343                     ;; frame and ended up as the sole window on that
4344                     ;; frame, do not delete it (Bug#12764).
4345                     (not (eq window (frame-root-window window)))))
4346            (eq (nth 3 quit-restore) buffer)
4347            ;; Delete WINDOW if possible.
4348            (window--delete window nil (eq bury-or-kill 'kill)))
4349       ;; If the previously selected window is still alive, select it.
4350       (when (window-live-p (nth 2 quit-restore))
4351         (select-window (nth 2 quit-restore))))
4352      ((and (listp (setq quad (nth 1 quit-restore)))
4353            (buffer-live-p (car quad))
4354            (eq (nth 3 quit-restore) buffer))
4355       ;; Show another buffer stored in quit-restore parameter.
4356       (when (and (integerp (nth 3 quad))
4357                  (/= (nth 3 quad) (window-total-height window)))
4358         ;; Try to resize WINDOW to its old height but don't signal an
4359         ;; error.
4360         (condition-case nil
4361             (window-resize window (- (nth 3 quad) (window-total-height window)))
4362           (error nil)))
4363       (set-window-dedicated-p window nil)
4364       ;; Restore WINDOW's previous buffer, start and point position.
4365       (set-window-buffer-start-and-point
4366        window (nth 0 quad) (nth 1 quad) (nth 2 quad))
4367       ;; Deal with the buffer we just removed from WINDOW.
4368       (setq entry (and (eq bury-or-kill 'append)
4369                        (assq buffer (window-prev-buffers window))))
4370       (when bury-or-kill
4371         ;; Remove buffer from WINDOW's previous and next buffers.
4372         (set-window-prev-buffers
4373          window (assq-delete-all buffer (window-prev-buffers window)))
4374         (set-window-next-buffers
4375          window (delq buffer (window-next-buffers window))))
4376       (when entry
4377         ;; Append old buffer's entry to list of WINDOW's previous
4378         ;; buffers so it's less likely to get switched to soon but
4379         ;; `display-buffer-in-previous-window' can nevertheless find it.
4380         (set-window-prev-buffers
4381          window (append (window-prev-buffers window) (list entry))))
4382       ;; Reset the quit-restore parameter.
4383       (set-window-parameter window 'quit-restore nil)
4384       ;; Select old window.
4385       (when (window-live-p (nth 2 quit-restore))
4386         (select-window (nth 2 quit-restore))))
4387      (t
4388       ;; Show some other buffer in WINDOW and reset the quit-restore
4389       ;; parameter.
4390       (set-window-parameter window 'quit-restore nil)
4391       ;; Make sure that WINDOW is no more dedicated.
4392       (set-window-dedicated-p window nil)
4393       (switch-to-prev-buffer window bury-or-kill)))
4394
4395     ;; Deal with the buffer.
4396     (cond
4397      ((not (buffer-live-p buffer)))
4398      ((eq bury-or-kill 'kill)
4399       (kill-buffer buffer))
4400      (bury-or-kill
4401       (bury-buffer-internal buffer)))))
4402
4403 (defun quit-window (&optional kill window)
4404   "Quit WINDOW and bury its buffer.
4405 WINDOW must be a live window and defaults to the selected one.
4406 With prefix argument KILL non-nil, kill the buffer instead of
4407 burying it.
4408
4409 According to information stored in WINDOW's `quit-restore' window
4410 parameter either (1) delete WINDOW and its frame, (2) delete
4411 WINDOW, (3) restore the buffer previously displayed in WINDOW,
4412 or (4) make WINDOW display some other buffer than the present
4413 one.  If non-nil, reset `quit-restore' parameter to nil."
4414   (interactive "P")
4415   (quit-restore-window window (if kill 'kill 'bury)))
4416
4417 (defun quit-windows-on (&optional buffer-or-name kill frame)
4418   "Quit all windows showing BUFFER-OR-NAME.
4419 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
4420 and defaults to the current buffer.  Optional argument KILL
4421 non-nil means to kill BUFFER-OR-NAME.  KILL nil means to bury
4422 BUFFER-OR-NAME.  Optional argument FRAME is handled as by
4423 `delete-windows-on'.
4424
4425 This function calls `quit-window' on all candidate windows
4426 showing BUFFER-OR-NAME."
4427   (interactive "BQuit windows on (buffer):\nP")
4428   (let ((buffer (window-normalize-buffer buffer-or-name))
4429         ;; Handle the "inverted" meaning of the FRAME argument wrt other
4430         ;; `window-list-1' based function.
4431         (all-frames (cond ((not frame) t) ((eq frame t) nil) (t frame))))
4432     (dolist (window (window-list-1 nil nil all-frames))
4433       (if (eq (window-buffer window) buffer)
4434           (quit-window kill window)
4435         ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
4436         (unrecord-window-buffer window buffer)))))
4437 \f
4438 (defun split-window (&optional window size side pixelwise)
4439   "Make a new window adjacent to WINDOW.
4440 WINDOW must be a valid window and defaults to the selected one.
4441 Return the new window which is always a live window.
4442
4443 Optional argument SIZE a positive number means make WINDOW SIZE
4444 lines or columns tall.  If SIZE is negative, make the new window
4445 -SIZE lines or columns tall.  If and only if SIZE is non-nil, its
4446 absolute value can be less than `window-min-height' or
4447 `window-min-width'; so this command can make a new window as
4448 small as one line or two columns.  SIZE defaults to half of
4449 WINDOW's size.
4450
4451 Optional third argument SIDE nil (or `below') specifies that the
4452 new window shall be located below WINDOW.  SIDE `above' means the
4453 new window shall be located above WINDOW.  In both cases SIZE
4454 specifies the new number of lines for WINDOW (or the new window
4455 if SIZE is negative) including space reserved for the mode and/or
4456 header line.
4457
4458 SIDE t (or `right') specifies that the new window shall be
4459 located on the right side of WINDOW.  SIDE `left' means the new
4460 window shall be located on the left of WINDOW.  In both cases
4461 SIZE specifies the new number of columns for WINDOW (or the new
4462 window provided SIZE is negative) including space reserved for
4463 fringes and the scrollbar or a divider column.  Any other non-nil
4464 value for SIDE is currently handled like t (or `right').
4465
4466 PIXELWISE, if non-nil, means to interpret SIZE pixelwise.
4467
4468 If the variable `ignore-window-parameters' is non-nil or the
4469 `split-window' parameter of WINDOW equals t, do not process any
4470 parameters of WINDOW.  Otherwise, if the `split-window' parameter
4471 of WINDOW specifies a function, call that function with all three
4472 arguments and return the value returned by that function.
4473
4474 Otherwise, if WINDOW is part of an atomic window, \"split\" the
4475 root of that atomic window.  The new window does not become a
4476 member of that atomic window.
4477
4478 If WINDOW is live, properties of the new window like margins and
4479 scrollbars are inherited from WINDOW.  If WINDOW is an internal
4480 window, these properties as well as the buffer displayed in the
4481 new window are inherited from the window selected on WINDOW's
4482 frame.  The selected window is not changed by this function."
4483   (setq window (window-normalize-window window))
4484   (let* ((side (cond
4485                 ((not side) 'below)
4486                 ((memq side '(below above right left)) side)
4487                 (t 'right)))
4488          (horizontal (not (memq side '(below above))))
4489          (frame (window-frame window))
4490          (parent (window-parent window))
4491          (function (window-parameter window 'split-window))
4492          (window-side (window-parameter window 'window-side))
4493          ;; Rebind the following two variables since in some cases we
4494          ;; have to override their value.
4495          (window-combination-limit window-combination-limit)
4496          (window-combination-resize window-combination-resize)
4497          (char-size (frame-char-size window horizontal))
4498          (pixel-size
4499           (when (numberp size)
4500             (window--size-to-pixel window size horizontal pixelwise t)))
4501          (divider-width (if horizontal
4502                             (frame-right-divider-width frame)
4503                           (frame-bottom-divider-width frame)))
4504          atom-root ignore)
4505     (window--check frame)
4506     (catch 'done
4507       (cond
4508        ;; Ignore window parameters if either `ignore-window-parameters'
4509        ;; is t or the `split-window' parameter equals t.
4510        ((or ignore-window-parameters (eq function t)))
4511        ((functionp function)
4512         ;; The `split-window' parameter specifies the function to call.
4513         ;; If that function is `ignore', do nothing.
4514         (throw 'done (funcall function window size side)))
4515        ;; If WINDOW is part of an atomic window, split the root window
4516        ;; of that atomic window instead.
4517        ((and (window-parameter window 'window-atom)
4518              (setq atom-root (window-atom-root window))
4519              (not (eq atom-root window)))
4520         (throw 'done (split-window atom-root size side pixelwise)))
4521        ;; If WINDOW is a side window or its first or last child is a
4522        ;; side window, throw an error unless `window-combination-resize'
4523        ;; equals 'side.
4524        ((and (not (eq window-combination-resize 'side))
4525              (window--side-window-p window))
4526         (error "Cannot split side window or parent of side window"))
4527        ;; If `window-combination-resize' is 'side and window has a side
4528        ;; window sibling, bind `window-combination-limit' to t.
4529        ((and (not (eq window-combination-resize 'side))
4530              (or (and (window-prev-sibling window)
4531                       (window-parameter
4532                        (window-prev-sibling window) 'window-side))
4533                  (and (window-next-sibling window)
4534                       (window-parameter
4535                        (window-next-sibling window) 'window-side))))
4536         (setq window-combination-limit t)))
4537
4538       ;; If `window-combination-resize' is t and SIZE is non-negative,
4539       ;; bind `window-combination-limit' to t.
4540       (when (and (eq window-combination-resize t)
4541                  pixel-size (> pixel-size 0))
4542         (setq window-combination-limit t))
4543
4544       (let* ((parent-pixel-size
4545               ;; `parent-pixel-size' is the pixel size of WINDOW's
4546               ;; parent, provided it has one.
4547               (when parent (window-size parent horizontal t)))
4548              ;; `resize' non-nil means we are supposed to resize other
4549              ;; windows in WINDOW's combination.
4550              (resize
4551               (and window-combination-resize
4552                    (or (window-parameter window 'window-side)
4553                        (not (eq window-combination-resize 'side)))
4554                    (not (eq window-combination-limit t))
4555                    ;; Resize makes sense in iso-combinations only.
4556                    (window-combined-p window horizontal)))
4557              ;; `old-pixel-size' is the current pixel size of WINDOW.
4558              (old-pixel-size (window-size window horizontal t))
4559              ;; `new-size' is the specified or calculated size of the
4560              ;; new window.
4561              new-pixel-size new-parent new-normal)
4562         (cond
4563          ((not pixel-size)
4564           (setq new-pixel-size
4565                 (if resize
4566                     ;; When resizing try to give the new window the
4567                     ;; average size of a window in its combination.
4568                     (max (min (- parent-pixel-size
4569                                  (window-min-size parent horizontal nil t))
4570                               (/ parent-pixel-size
4571                                  (1+ (window-combinations parent horizontal))))
4572                          (window-min-pixel-size))
4573                   ;; Else try to give the new window half the size
4574                   ;; of WINDOW (plus an eventual odd pixel).
4575                   (/ old-pixel-size 2)))
4576           (unless window-resize-pixelwise
4577             ;; Round to nearest char-size multiple.
4578             (setq new-pixel-size
4579                   (* char-size (round new-pixel-size char-size)))))
4580          ((>= pixel-size 0)
4581           ;; SIZE non-negative specifies the new size of WINDOW.
4582
4583           ;; Note: Specifying a non-negative SIZE is practically
4584           ;; always done as workaround for making the new window
4585           ;; appear above or on the left of the new window (the
4586           ;; ispell window is a typical example of that).  In all
4587           ;; these cases the SIDE argument should be set to 'above
4588           ;; or 'left in order to support the 'resize option.
4589           ;; Here we have to nest the windows instead, see above.
4590           (setq new-pixel-size (- old-pixel-size pixel-size)))
4591          (t
4592           ;; SIZE negative specifies the size of the new window.
4593           (setq new-pixel-size (- pixel-size))))
4594
4595         ;; Check SIZE.
4596         (cond
4597          ((not pixel-size)
4598           (cond
4599            (resize
4600             ;; SIZE unspecified, resizing.
4601             (unless (or (window-sizable-p
4602                          parent (- (+ new-pixel-size divider-width)) horizontal
4603                          nil t)
4604                         (window-sizable-p
4605                          parent (- (+ new-pixel-size divider-width)) horizontal
4606                          (setq ignore 'preserved) t))
4607               (error "Window %s too small for splitting (1)" parent)))
4608            ((and (> (+ new-pixel-size divider-width
4609                        (window-min-size window horizontal nil t))
4610                     old-pixel-size)
4611                  (> (+ new-pixel-size divider-width
4612                        (window-min-size
4613                         window horizontal (setq ignore 'preserved) t))
4614                     old-pixel-size))
4615             ;; SIZE unspecified, no resizing.
4616             (error "Window %s too small for splitting (2)" window))))
4617          ((and (>= pixel-size 0)
4618                (or (>= pixel-size old-pixel-size)
4619                    (< new-pixel-size
4620                       (window-safe-min-pixel-size window horizontal))))
4621           ;; SIZE specified as new size of old window.  If the new size
4622           ;; is larger than the old size or the size of the new window
4623           ;; would be less than the safe minimum, signal an error.
4624           (error "Window %s too small for splitting (3)" window))
4625          (resize
4626           ;; SIZE specified, resizing.
4627           (unless (or (window-sizable-p
4628                        parent (- (+ new-pixel-size divider-width)) horizontal
4629                        nil t)
4630                       (window-sizable-p
4631                        parent (- (+ new-pixel-size divider-width)) horizontal
4632                        (setq ignore 'preserved) t))
4633             ;; If we cannot resize the parent give up.
4634             (error "Window %s too small for splitting (4)" parent)))
4635          ((or (< new-pixel-size
4636                  (window-safe-min-pixel-size window horizontal))
4637               (< (- old-pixel-size new-pixel-size)
4638                  (window-safe-min-pixel-size window horizontal)))
4639           ;; SIZE specification violates minimum size restrictions.
4640           (error "Window %s too small for splitting (5)" window)))
4641
4642         (window--resize-reset frame horizontal)
4643
4644         (setq new-parent
4645               ;; Make new-parent non-nil if we need a new parent window;
4646               ;; either because we want to nest or because WINDOW is not
4647               ;; iso-combined.
4648               (or (eq window-combination-limit t)
4649                   (not (window-combined-p window horizontal))))
4650         (setq new-normal
4651               ;; Make new-normal the normal size of the new window.
4652               (cond
4653                (pixel-size (/ (float new-pixel-size)
4654                               (if new-parent old-pixel-size parent-pixel-size)))
4655                (new-parent 0.5)
4656                (resize (/ 1.0 (1+ (window-combinations parent horizontal))))
4657                (t (/ (window-normal-size window horizontal) 2.0))))
4658
4659         (if resize
4660             ;; Try to get space from OLD's siblings.  We could go "up" and
4661             ;; try getting additional space from surrounding windows but
4662             ;; we won't be able to return space to those windows when we
4663             ;; delete the one we create here.  Hence we do not go up.
4664             (progn
4665               (window--resize-child-windows
4666                parent (- new-pixel-size) horizontal nil ignore)
4667               (let* ((normal (- 1.0 new-normal))
4668                      (sub (window-child parent)))
4669                 (while sub
4670                   (set-window-new-normal
4671                    sub (* (window-normal-size sub horizontal) normal))
4672                   (setq sub (window-right sub)))))
4673           ;; Get entire space from WINDOW.
4674           (set-window-new-pixel
4675            window (- old-pixel-size new-pixel-size))
4676           (window--resize-this-window
4677            window (- new-pixel-size) horizontal ignore)
4678           (set-window-new-normal
4679            window (- (if new-parent 1.0 (window-normal-size window horizontal))
4680                      new-normal)))
4681
4682         (let* ((new (split-window-internal window new-pixel-size side new-normal)))
4683           (window--pixel-to-total frame horizontal)
4684           ;; Assign window-side parameters, if any.
4685           (cond
4686            ((eq window-combination-resize 'side)
4687             (let ((window-side
4688                    (cond
4689                     (window-side window-side)
4690                     ((eq side 'above) 'top)
4691                     ((eq side 'below) 'bottom)
4692                     (t side))))
4693               ;; We made a new side window.
4694               (set-window-parameter new 'window-side window-side)
4695               (when (and new-parent (window-parameter window 'window-side))
4696                 ;; We've been splitting a side root window.  Give the
4697                 ;; new parent the same window-side parameter.
4698                 (set-window-parameter
4699                  (window-parent new) 'window-side window-side))))
4700            ((eq window-combination-resize 'atom)
4701             ;; Make sure `window--check-frame' won't destroy an existing
4702             ;; atomic window in case the new window gets nested inside.
4703             (unless (window-parameter window 'window-atom)
4704               (set-window-parameter window 'window-atom t))
4705             (when new-parent
4706               (set-window-parameter (window-parent new) 'window-atom t))
4707             (set-window-parameter new 'window-atom t)))
4708
4709           ;; Sanitize sizes.
4710           (window--sanitize-window-sizes frame horizontal)
4711
4712           (run-window-configuration-change-hook frame)
4713           (run-window-scroll-functions new)
4714           (window--check frame)
4715           ;; Always return the new window.
4716           new)))))
4717
4718 ;; I think this should be the default; I think people will prefer it--rms.
4719 (defcustom split-window-keep-point t
4720   "If non-nil, \\[split-window-below] preserves point in the new window.
4721 If nil, adjust point in the two windows to minimize redisplay.
4722 This option applies only to `split-window-below' and functions
4723 that call it.  The low-level `split-window' function always keeps
4724 the original point in both windows."
4725   :type 'boolean
4726   :group 'windows)
4727
4728 (defun split-window-below (&optional size)
4729   "Split the selected window into two windows, one above the other.
4730 The selected window is above.  The newly split-off window is
4731 below and displays the same buffer.  Return the new window.
4732
4733 If optional argument SIZE is omitted or nil, both windows get the
4734 same height, or close to it.  If SIZE is positive, the upper
4735 \(selected) window gets SIZE lines.  If SIZE is negative, the
4736 lower (new) window gets -SIZE lines.
4737
4738 If the variable `split-window-keep-point' is non-nil, both
4739 windows get the same value of point as the selected window.
4740 Otherwise, the window starts are chosen so as to minimize the
4741 amount of redisplay; this is convenient on slow terminals."
4742   (interactive "P")
4743   (let ((old-window (selected-window))
4744         (old-point (window-point))
4745         (size (and size (prefix-numeric-value size)))
4746         moved-by-window-height moved new-window bottom)
4747     (when (and size (< size 0) (< (- size) window-min-height))
4748       ;; `split-window' would not signal an error here.
4749       (error "Size of new window too small"))
4750     (setq new-window (split-window nil size))
4751     (unless split-window-keep-point
4752       (with-current-buffer (window-buffer)
4753         ;; Use `save-excursion' around vertical movements below
4754         ;; (Bug#10971).  Note: When the selected window's buffer has a
4755         ;; header line, up to two lines of the buffer may not show up
4756         ;; in the resulting configuration.
4757         (save-excursion
4758           (goto-char (window-start))
4759           (setq moved (vertical-motion (window-height)))
4760           (set-window-start new-window (point))
4761           (when (> (point) (window-point new-window))
4762             (set-window-point new-window (point)))
4763           (when (= moved (window-height))
4764             (setq moved-by-window-height t)
4765             (vertical-motion -1))
4766           (setq bottom (point)))
4767         (and moved-by-window-height
4768              (<= bottom (point))
4769              (set-window-point old-window (1- bottom)))
4770         (and moved-by-window-height
4771              (<= (window-start new-window) old-point)
4772              (set-window-point new-window old-point)
4773              (select-window new-window))))
4774     ;; Always copy quit-restore parameter in interactive use.
4775     (let ((quit-restore (window-parameter old-window 'quit-restore)))
4776       (when quit-restore
4777         (set-window-parameter new-window 'quit-restore quit-restore)))
4778     new-window))
4779
4780 (defalias 'split-window-vertically 'split-window-below)
4781
4782 (defun split-window-right (&optional size)
4783   "Split the selected window into two side-by-side windows.
4784 The selected window is on the left.  The newly split-off window
4785 is on the right and displays the same buffer.  Return the new
4786 window.
4787
4788 If optional argument SIZE is omitted or nil, both windows get the
4789 same width, or close to it.  If SIZE is positive, the left-hand
4790 \(selected) window gets SIZE columns.  If SIZE is negative, the
4791 right-hand (new) window gets -SIZE columns.  Here, SIZE includes
4792 the width of the window's scroll bar; if there are no scroll
4793 bars, it includes the width of the divider column to the window's
4794 right, if any."
4795   (interactive "P")
4796   (let ((old-window (selected-window))
4797         (size (and size (prefix-numeric-value size)))
4798         new-window)
4799     (when (and size (< size 0) (< (- size) window-min-width))
4800       ;; `split-window' would not signal an error here.
4801       (error "Size of new window too small"))
4802     (setq new-window (split-window nil size t))
4803     ;; Always copy quit-restore parameter in interactive use.
4804     (let ((quit-restore (window-parameter old-window 'quit-restore)))
4805       (when quit-restore
4806         (set-window-parameter new-window 'quit-restore quit-restore)))
4807     new-window))
4808
4809 (defalias 'split-window-horizontally 'split-window-right)
4810 \f
4811 ;;; Balancing windows.
4812
4813 ;; The following routine uses the recycled code from an old version of
4814 ;; `window--resize-child-windows'.  It's not very pretty, but coding it the way the
4815 ;; new `window--resize-child-windows' code does would hardly make it any shorter or
4816 ;; more readable (FWIW we'd need three loops - one to calculate the
4817 ;; minimum sizes per window, one to enlarge or shrink windows until the
4818 ;; new parent-size matches, and one where we shrink the largest/enlarge
4819 ;; the smallest window).
4820 (defun balance-windows-2 (window horizontal)
4821   "Subroutine of `balance-windows-1'.
4822 WINDOW must be a vertical combination (horizontal if HORIZONTAL
4823 is non-nil)."
4824   (let* ((char-size (if window-resize-pixelwise
4825                         1
4826                       (frame-char-size window horizontal)))
4827          (first (window-child window))
4828          (sub first)
4829          (number-of-children 0)
4830          (parent-size (window-new-pixel window))
4831          (total-sum parent-size)
4832          failed size sub-total sub-delta sub-amount rest)
4833     (while sub
4834       (setq number-of-children (1+ number-of-children))
4835       (when (window-size-fixed-p sub horizontal)
4836         (setq total-sum
4837               (- total-sum (window-size sub horizontal t)))
4838         (set-window-new-normal sub 'ignore))
4839       (setq sub (window-right sub)))
4840
4841     (setq failed t)
4842     (while (and failed (> number-of-children 0))
4843       (setq size (/ total-sum number-of-children))
4844       (setq failed nil)
4845       (setq sub first)
4846       (while (and sub (not failed))
4847         ;; Ignore child windows that should be ignored or are stuck.
4848         (unless (window--resize-child-windows-skip-p sub)
4849           (setq sub-total (window-size sub horizontal t))
4850           (setq sub-delta (- size sub-total))
4851           (setq sub-amount
4852                 (window-sizable sub sub-delta horizontal nil t))
4853           ;; Register the new total size for this child window.
4854           (set-window-new-pixel sub (+ sub-total sub-amount))
4855           (unless (= sub-amount sub-delta)
4856             (setq total-sum (- total-sum sub-total sub-amount))
4857             (setq number-of-children (1- number-of-children))
4858             ;; We failed and need a new round.
4859             (setq failed t)
4860             (set-window-new-normal sub 'skip)))
4861         (setq sub (window-right sub))))
4862
4863     ;; How can we be sure that `number-of-children' is NOT zero here ?
4864     (setq rest (% total-sum number-of-children))
4865     ;; Fix rounding by trying to enlarge non-stuck windows by one line
4866     ;; (column) until `rest' is zero.
4867     (setq sub first)
4868     (while (and sub (> rest 0))
4869       (unless (window--resize-child-windows-skip-p window)
4870         (set-window-new-pixel sub (min rest char-size) t)
4871         (setq rest (- rest char-size)))
4872       (setq sub (window-right sub)))
4873
4874     ;; Fix rounding by trying to enlarge stuck windows by one line
4875     ;; (column) until `rest' equals zero.
4876     (setq sub first)
4877     (while (and sub (> rest 0))
4878       (unless (eq (window-new-normal sub) 'ignore)
4879         (set-window-new-pixel sub (min rest char-size) t)
4880         (setq rest (- rest char-size)))
4881       (setq sub (window-right sub)))
4882
4883     (setq sub first)
4884     (while sub
4885       ;; Record new normal sizes.
4886       (set-window-new-normal
4887        sub (/ (if (eq (window-new-normal sub) 'ignore)
4888                   (window-size sub horizontal t)
4889                 (window-new-pixel sub))
4890               (float parent-size)))
4891       ;; Recursively balance each window's child windows.
4892       (balance-windows-1 sub horizontal)
4893       (setq sub (window-right sub)))))
4894
4895 (defun balance-windows-1 (window &optional horizontal)
4896   "Subroutine of `balance-windows'."
4897   (if (window-child window)
4898       (let ((sub (window-child window)))
4899         (if (window-combined-p sub horizontal)
4900             (balance-windows-2 window horizontal)
4901           (let ((size (window-new-pixel window)))
4902             (while sub
4903               (set-window-new-pixel sub size)
4904               (balance-windows-1 sub horizontal)
4905               (setq sub (window-right sub))))))))
4906
4907 (defun balance-windows (&optional window-or-frame)
4908   "Balance the sizes of windows of WINDOW-OR-FRAME.
4909 WINDOW-OR-FRAME is optional and defaults to the selected frame.
4910 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
4911 windows of that frame.  If WINDOW-OR-FRAME denotes a window,
4912 recursively balance the sizes of all child windows of that
4913 window."
4914   (interactive)
4915   (let* ((window
4916           (cond
4917            ((or (not window-or-frame)
4918                 (frame-live-p window-or-frame))
4919             (frame-root-window window-or-frame))
4920            ((or (window-live-p window-or-frame)
4921                 (window-child window-or-frame))
4922             window-or-frame)
4923            (t
4924             (error "Not a window or frame %s" window-or-frame))))
4925          (frame (window-frame window)))
4926     ;; Balance vertically.
4927     (window--resize-reset (window-frame window))
4928     (balance-windows-1 window)
4929     (when (window--resize-apply-p frame)
4930       (window-resize-apply frame)
4931       (window--pixel-to-to