Fix typo in charset_ordered_list_tick patch
[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-2014 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 ,buffer ,vaction)))
241
242          (let ((inhibit-read-only t)
243                (inhibit-modification-hooks t))
244            (setq ,value (progn ,@body)))
245
246          (set-window-point ,window (point-min))
247
248          (when (functionp (cdr (assq 'window-height (cdr ,vaction))))
249            (ignore-errors
250              (funcall (cdr (assq 'window-height (cdr ,vaction))) ,window)))
251
252          (when (consp (cdr (assq 'preserve-size (cdr ,vaction))))
253            (window-preserve-size
254             ,window t (cadr (assq 'preserve-size (cdr ,vaction))))
255           (window-preserve-size
256             ,window nil (cddr (assq 'preserve-size (cdr ,vaction)))))
257
258          (if (functionp ,vquit-function)
259              (funcall ,vquit-function ,window ,value)
260            ,value)))))
261
262 ;; The following two functions are like `window-next-sibling' and
263 ;; `window-prev-sibling' but the WINDOW argument is _not_ optional (so
264 ;; they don't substitute the selected window for nil), and they return
265 ;; nil when WINDOW doesn't have a parent (like a frame's root window or
266 ;; a minibuffer window).
267 (defun window-right (window)
268   "Return WINDOW's right sibling.
269 Return nil if WINDOW is the root window of its frame.  WINDOW can
270 be any window."
271   (and window (window-parent window) (window-next-sibling window)))
272
273 (defun window-left (window)
274   "Return WINDOW's left sibling.
275 Return nil if WINDOW is the root window of its frame.  WINDOW can
276 be any window."
277   (and window (window-parent window) (window-prev-sibling window)))
278
279 (defun window-child (window)
280   "Return WINDOW's first child window.
281 WINDOW can be any window."
282   (or (window-top-child window) (window-left-child window)))
283
284 (defun window-child-count (window)
285   "Return number of WINDOW's child windows.
286 WINDOW can be any window."
287   (let ((count 0))
288     (when (and (windowp window) (setq window (window-child window)))
289       (while window
290         (setq count (1+ count))
291         (setq window (window-next-sibling window))))
292     count))
293
294 (defun window-last-child (window)
295   "Return last child window of WINDOW.
296 WINDOW can be any window."
297   (when (and (windowp window) (setq window (window-child window)))
298     (while (window-next-sibling window)
299       (setq window (window-next-sibling window))))
300   window)
301
302 (defun window-normalize-buffer (buffer-or-name)
303   "Return buffer specified by BUFFER-OR-NAME.
304 BUFFER-OR-NAME must be either a buffer or a string naming a live
305 buffer and defaults to the current buffer."
306   (cond
307    ((not buffer-or-name)
308     (current-buffer))
309    ((bufferp buffer-or-name)
310     (if (buffer-live-p buffer-or-name)
311         buffer-or-name
312       (error "Buffer %s is not a live buffer" buffer-or-name)))
313    ((get-buffer buffer-or-name))
314    (t
315     (error "No such buffer %s" buffer-or-name))))
316
317 (defun window-normalize-frame (frame)
318   "Return frame specified by FRAME.
319 FRAME must be a live frame and defaults to the selected frame."
320   (if frame
321       (if (frame-live-p frame)
322           frame
323         (error "%s is not a live frame" frame))
324     (selected-frame)))
325
326 (defun window-normalize-window (window &optional live-only)
327   "Return the window specified by WINDOW.
328 If WINDOW is nil, return the selected window.  Otherwise, if
329 WINDOW is a live or an internal window, return WINDOW; if
330 LIVE-ONLY is non-nil, return WINDOW for a live window only.
331 Otherwise, signal an error."
332   (cond
333    ((null window)
334     (selected-window))
335    (live-only
336     (if (window-live-p window)
337         window
338       (error "%s is not a live window" window)))
339    ((window-valid-p window)
340     window)
341    (t
342     (error "%s is not a valid window" window))))
343
344 ;; Maybe this should go to frame.el.
345 (defun frame-char-size (&optional window-or-frame horizontal)
346   "Return the value of `frame-char-height' for WINDOW-OR-FRAME.
347 If WINDOW-OR-FRAME is a live frame, return the value of
348 `frame-char-height' for that frame.  If WINDOW-OR-FRAME is a
349 valid window, return the value of `frame-char-height' for that
350 window's frame.  In any other case, return the value of
351 `frame-char-height' for the selected frame.
352
353 Optional argument HORIZONTAL non-nil means to return the value of
354 `frame-char-width' for WINDOW-OR-FRAME."
355   (let ((frame
356          (cond
357           ((window-valid-p window-or-frame)
358            (window-frame window-or-frame))
359           ((frame-live-p window-or-frame)
360            window-or-frame)
361           (t (selected-frame)))))
362     (if horizontal
363         (frame-char-width frame)
364       (frame-char-height frame))))
365
366 (defvar ignore-window-parameters nil
367   "If non-nil, standard functions ignore window parameters.
368 The functions currently affected by this are `split-window',
369 `delete-window', `delete-other-windows' and `other-window'.
370
371 An application may bind this to a non-nil value around calls to
372 these functions to inhibit processing of window parameters.")
373
374 ;; This must go to C, finally (or get removed).
375 (defconst window-safe-min-height 1
376   "The absolute minimum number of lines of any window.
377 Anything less might crash Emacs.")
378
379 (defun window-safe-min-pixel-height (&optional window)
380   "Return the absolute minimum pixel height of WINDOW."
381   (* window-safe-min-height
382      (frame-char-size (window-normalize-window window))))
383
384 (defcustom window-min-height 4
385   "The minimum total height, in lines, of any window.
386 The value has to accommodate one text line, a mode and header
387 line, a horizontal scroll bar and a bottom divider, if present.
388 A value less than `window-safe-min-height' is ignored.  The value
389 of this variable is honored when windows are resized or split.
390
391 Applications should never rebind this variable.  To resize a
392 window to a height less than the one specified here, an
393 application should instead call `window-resize' with a non-nil
394 IGNORE argument.  In order to have `split-window' make a window
395 shorter, explicitly specify the SIZE argument of that function."
396   :type 'integer
397   :version "24.1"
398   :group 'windows)
399
400 (defun window-min-pixel-height (&optional window)
401   "Return the minimum pixel height of window WINDOW."
402   (* (max window-min-height window-safe-min-height)
403      (frame-char-size window)))
404
405 ;; This must go to C, finally (or get removed).
406 (defconst window-safe-min-width 2
407   "The absolute minimum number of columns of a window.
408 Anything less might crash Emacs.")
409
410 (defun window-safe-min-pixel-width (&optional window)
411   "Return the absolute minimum pixel width of WINDOW."
412   (* window-safe-min-width
413      (frame-char-size (window-normalize-window window) t)))
414
415 (defcustom window-min-width 10
416   "The minimum total width, in columns, of any window.
417 The value has to accommodate two text columns as well as margins,
418 fringes, a scroll bar and a right divider, if present.  A value
419 less than `window-safe-min-width' is ignored.  The value of this
420 variable is honored when windows are resized or split.
421
422 Applications should never rebind this variable.  To resize a
423 window to a width less than the one specified here, an
424 application should instead call `window-resize' with a non-nil
425 IGNORE argument.  In order to have `split-window' make a window
426 narrower, explicitly specify the SIZE argument of that function."
427   :type 'integer
428   :version "24.1"
429   :group 'windows)
430
431 (defun window-min-pixel-width (&optional window)
432   "Return the minimum pixel width of window WINDOW."
433   (* (max window-min-width window-safe-min-width)
434      (frame-char-size window t)))
435
436 (defun window-safe-min-pixel-size (&optional window horizontal)
437   "Return the absolute minimum pixel height of WINDOW.
438 Optional argument HORIZONTAL non-nil means return the absolute
439 minimum pixel width of WINDOW."
440   (if horizontal
441       (window-safe-min-pixel-width window)
442     (window-safe-min-pixel-height window)))
443
444 (defun window-min-pixel-size (&optional window horizontal)
445   "Return the minimum pixel height of WINDOW.
446 Optional argument HORIZONTAL non-nil means return the minimum
447 pixel width of WINDOW."
448   (if horizontal
449       (window-min-pixel-width window)
450     (window-min-pixel-height window)))
451
452 (defun window-combined-p (&optional window horizontal)
453   "Return non-nil if WINDOW has siblings in a given direction.
454 WINDOW must be a valid window and defaults to the selected one.
455
456 HORIZONTAL determines a direction for the window combination.  If
457 HORIZONTAL is omitted or nil, return non-nil if WINDOW is part of
458 a vertical window combination.  If HORIZONTAL is non-nil, return
459 non-nil if WINDOW is part of a horizontal window combination."
460   (setq window (window-normalize-window window))
461   (let ((parent (window-parent window)))
462     (and parent
463          (if horizontal
464              (window-left-child parent)
465            (window-top-child parent)))))
466
467 (defun window-combination-p (&optional window horizontal)
468   "Return WINDOW's first child if WINDOW is a vertical combination.
469 WINDOW can be any window and defaults to the selected one.
470 Optional argument HORIZONTAL non-nil means return WINDOW's first
471 child if WINDOW is a horizontal combination."
472   (setq window (window-normalize-window window))
473   (if horizontal
474       (window-left-child window)
475     (window-top-child window)))
476
477 (defun window-combinations (window &optional horizontal)
478   "Return largest number of windows vertically arranged within WINDOW.
479 WINDOW must be a valid window and defaults to the selected one.
480 If HORIZONTAL is non-nil, return the largest number of
481 windows horizontally arranged within WINDOW."
482   (setq window (window-normalize-window window))
483   (cond
484    ((window-live-p window)
485     ;; If WINDOW is live, return 1.
486     1)
487    ((if horizontal
488         (window-left-child window)
489       (window-top-child window))
490     ;; If WINDOW is iso-combined, return the sum of the values for all
491     ;; child windows of WINDOW.
492     (let ((child (window-child window))
493           (count 0))
494       (while child
495         (setq count
496               (+ (window-combinations child horizontal)
497                  count))
498         (setq child (window-right child)))
499       count))
500    (t
501     ;; If WINDOW is not iso-combined, return the maximum value of any
502     ;; child window of WINDOW.
503     (let ((child (window-child window))
504           (count 1))
505       (while child
506         (setq count
507               (max (window-combinations child horizontal)
508                    count))
509         (setq child (window-right child)))
510       count))))
511
512 (defun walk-window-tree-1 (fun walk-window-tree-window any &optional sub-only)
513   "Helper function for `walk-window-tree' and `walk-window-subtree'."
514   (let (walk-window-tree-buffer)
515     (while walk-window-tree-window
516       (setq walk-window-tree-buffer
517             (window-buffer walk-window-tree-window))
518       (when (or walk-window-tree-buffer any)
519         (funcall fun walk-window-tree-window))
520       (unless walk-window-tree-buffer
521         (walk-window-tree-1
522          fun (window-left-child walk-window-tree-window) any)
523         (walk-window-tree-1
524          fun (window-top-child walk-window-tree-window) any))
525       (if sub-only
526           (setq walk-window-tree-window nil)
527         (setq walk-window-tree-window
528               (window-right walk-window-tree-window))))))
529
530 (defun walk-window-tree (fun &optional frame any minibuf)
531   "Run function FUN on each live window of FRAME.
532 FUN must be a function with one argument - a window.  FRAME must
533 be a live frame and defaults to the selected one.  ANY, if
534 non-nil, means to run FUN on all live and internal windows of
535 FRAME.
536
537 Optional argument MINIBUF t means run FUN on FRAME's minibuffer
538 window even if it isn't active.  MINIBUF nil or omitted means run
539 FUN on FRAME's minibuffer window only if it's active.  In both
540 cases the minibuffer window must be part of FRAME.  MINIBUF
541 neither nil nor t means never run FUN on the minibuffer window.
542
543 This function performs a pre-order, depth-first traversal of the
544 window tree.  If FUN changes the window tree, the result is
545 unpredictable."
546   (setq frame (window-normalize-frame frame))
547   (walk-window-tree-1 fun (frame-root-window frame) any)
548   (when (memq minibuf '(nil t))
549     ;; Run FUN on FRAME's minibuffer window if requested.
550     (let ((minibuffer-window (minibuffer-window frame)))
551       (when (and (window-live-p minibuffer-window)
552                  (eq (window-frame minibuffer-window) frame)
553                  (or (eq minibuf t)
554                      (minibuffer-window-active-p minibuffer-window)))
555         (funcall fun minibuffer-window)))))
556
557 (defun walk-window-subtree (fun &optional window any)
558   "Run function FUN on the subtree of windows rooted at WINDOW.
559 WINDOW defaults to the selected window.  FUN must be a function
560 with one argument - a window.  By default, run FUN only on live
561 windows of the subtree.  If the optional argument ANY is non-nil,
562 run FUN on all live and internal windows of the subtree.  If
563 WINDOW is live, run FUN on WINDOW only.
564
565 This function performs a pre-order, depth-first traversal of the
566 subtree rooted at WINDOW.  If FUN changes that tree, the result
567 is unpredictable."
568   (setq window (window-normalize-window window))
569   (walk-window-tree-1 fun window any t))
570
571 (defun window-with-parameter (parameter &optional value frame any minibuf)
572   "Return first window on FRAME with PARAMETER non-nil.
573 FRAME defaults to the selected frame.  Optional argument VALUE
574 non-nil means only return a window whose window-parameter value
575 for PARAMETER equals VALUE (comparison is done with `equal').
576 Optional argument ANY non-nil means consider internal windows
577 too.
578
579 Optional argument MINIBUF t means consider FRAME's minibuffer
580 window even if it isn't active.  MINIBUF nil or omitted means
581 consider FRAME's minibuffer window only if it's active.  In both
582 cases the minibuffer window must be part of FRAME.  MINIBUF
583 neither nil nor t means never consider the minibuffer window."
584   (let (this-value)
585     (catch 'found
586       (walk-window-tree
587        (lambda (window)
588          (when (and (setq this-value (window-parameter window parameter))
589                     (or (not value) (equal value this-value)))
590            (throw 'found window)))
591        frame any minibuf))))
592
593 ;;; Atomic windows.
594 (defun window-atom-root (&optional window)
595   "Return root of atomic window WINDOW is a part of.
596 WINDOW must be a valid window and defaults to the selected one.
597 Return nil if WINDOW is not part of an atomic window."
598   (setq window (window-normalize-window window))
599   (let (root)
600     (while (and window (window-parameter window 'window-atom))
601       (setq root window)
602       (setq window (window-parent window)))
603     root))
604
605 (defun window-make-atom (window)
606   "Make WINDOW an atomic window.
607 WINDOW must be an internal window.  Return WINDOW."
608   (if (not (window-child window))
609       (error "Window %s is not an internal window" window)
610     (walk-window-subtree
611      (lambda (window)
612        (unless (window-parameter window 'window-atom)
613          (set-window-parameter window 'window-atom t)))
614      window t)
615     window))
616
617 (defun display-buffer-in-atom-window (buffer alist)
618   "Display BUFFER in an atomic window.
619 This function displays BUFFER in a new window that will be
620 combined with an existing window to form an atomic window.  If
621 the existing window is already part of an atomic window, add the
622 new window to that atomic window.  Operations like `split-window'
623 or `delete-window', when applied to a constituent of an atomic
624 window, are applied atomically to the root of that atomic window.
625
626 ALIST is an association list of symbols and values.  The
627 following symbols can be used.
628
629 `window' specifies the existing window the new window shall be
630   combined with.  Use `window-atom-root' to make the new window a
631   sibling of an atomic window's root.  If an internal window is
632   specified here, all children of that window become part of the
633   atomic window too.  If no window is specified, the new window
634   becomes a sibling of the selected window.  By default, the
635   `window-atom' parameter of the existing window is set to `main'
636   provided it is live and was not set before.
637
638 `side' denotes the side of the existing window where the new
639   window shall be located.  Valid values are `below', `right',
640   `above' and `left'.  The default is `below'.  By default, the
641   `window-atom' parameter of the new window is set to this value.
642
643 The return value is the new window, nil when creating that window
644 failed."
645   (let* ((ignore-window-parameters t)
646          (window-combination-limit t)
647          (window-combination-resize 'atom)
648          (window (cdr (assq 'window alist)))
649          (side (cdr (assq 'side alist)))
650          (atom (when window (window-parameter window 'window-atom)))
651          root new)
652     (setq window (window-normalize-window window))
653     (setq root (window-atom-root window))
654     ;; Split off new window.
655     (when (setq new (split-window window nil side))
656       (window-make-atom
657        (if (and root (not (eq root window)))
658            ;; When WINDOW was part of an atomic window and we did not
659            ;; split its root, root atomic window at old root.
660            root
661          ;; Otherwise, root atomic window at WINDOW's new parent.
662          (window-parent window)))
663       ;; Assign `window-atom' parameters, if needed.
664       (when (and (not atom) (window-live-p window))
665         (set-window-parameter window 'window-atom 'main))
666       (set-window-parameter new 'window-atom side)
667       ;; Display BUFFER in NEW and return NEW.
668       (window--display-buffer
669        buffer new 'window alist display-buffer-mark-dedicated))))
670
671 (defun window--atom-check-1 (window)
672   "Subroutine of `window--atom-check'."
673   (when window
674     (if (window-parameter window 'window-atom)
675         (let ((count 0))
676           (when (or (catch 'reset
677                       (walk-window-subtree
678                        (lambda (window)
679                          (if (window-parameter window 'window-atom)
680                              (setq count (1+ count))
681                            (throw 'reset t)))
682                        window t))
683                     ;; count >= 1 must hold here.  If there's no other
684                     ;; window around dissolve this atomic window.
685                     (= count 1))
686             ;; Dissolve atomic window.
687             (walk-window-subtree
688              (lambda (window)
689                (set-window-parameter window 'window-atom nil))
690              window t)))
691       ;; Check children.
692       (unless (window-buffer window)
693         (window--atom-check-1 (window-left-child window))
694         (window--atom-check-1 (window-top-child window))))
695     ;; Check right sibling
696     (window--atom-check-1 (window-right window))))
697
698 (defun window--atom-check (&optional frame)
699   "Check atomicity of all windows on FRAME.
700 FRAME defaults to the selected frame.  If an atomic window is
701 wrongly configured, reset the atomicity of all its windows on
702 FRAME to nil.  An atomic window is wrongly configured if it has
703 no child windows or one of its child windows is not atomic."
704   (window--atom-check-1 (frame-root-window frame)))
705
706 ;; Side windows.
707 (defvar window-sides '(left top right bottom)
708   "Window sides.")
709
710 (defcustom window-sides-vertical nil
711   "If non-nil, left and right side windows are full height.
712 Otherwise, top and bottom side windows are full width."
713   :type 'boolean
714   :group 'windows
715   :version "24.1")
716
717 (defcustom window-sides-slots '(nil nil nil nil)
718   "Maximum number of side window slots.
719 The value is a list of four elements specifying the number of
720 side window slots on (in this order) the left, top, right and
721 bottom side of each frame.  If an element is a number, this means
722 to display at most that many side windows on the corresponding
723 side.  If an element is nil, this means there's no bound on the
724 number of slots on that side."
725   :version "24.1"
726   :risky t
727   :type
728   '(list
729     :value (nil nil nil nil)
730     (choice
731      :tag "Left"
732      :help-echo "Maximum slots of left side window."
733      :value nil
734      :format "%[Left%] %v\n"
735      (const :tag "Unlimited" :format "%t" nil)
736      (integer :tag "Number" :value 2 :size 5))
737     (choice
738      :tag "Top"
739      :help-echo "Maximum slots of top side window."
740      :value nil
741      :format "%[Top%] %v\n"
742      (const :tag "Unlimited" :format "%t" nil)
743      (integer :tag "Number" :value 3 :size 5))
744     (choice
745      :tag "Right"
746      :help-echo "Maximum slots of right side window."
747      :value nil
748      :format "%[Right%] %v\n"
749      (const :tag "Unlimited" :format "%t" nil)
750      (integer :tag "Number" :value 2 :size 5))
751     (choice
752      :tag "Bottom"
753      :help-echo "Maximum slots of bottom side window."
754      :value nil
755      :format "%[Bottom%] %v\n"
756      (const :tag "Unlimited" :format "%t" nil)
757      (integer :tag "Number" :value 3 :size 5)))
758   :group 'windows)
759
760 (defun window--side-window-p (window)
761   "Return non-nil if WINDOW is a side window or the parent of one."
762   (or (window-parameter window 'window-side)
763       (and (window-child window)
764            (or (window-parameter
765                 (window-child window) 'window-side)
766                (window-parameter
767                 (window-last-child window) 'window-side)))))
768
769 (defun window--major-non-side-window (&optional frame)
770   "Return the major non-side window of frame FRAME.
771 The optional argument FRAME must be a live frame and defaults to
772 the selected one.
773
774 If FRAME has at least one side window, the major non-side window
775 is either an internal non-side window such that all other
776 non-side windows on FRAME descend from it, or the single live
777 non-side window of FRAME.  If FRAME has no side windows, return
778 its root window."
779   (let ((frame (window-normalize-frame frame))
780         major sibling)
781     ;; Set major to the _last_ window found by `walk-window-tree' that
782     ;; is not a side window but has a side window as its sibling.
783     (walk-window-tree
784      (lambda (window)
785        (and (not (window-parameter window 'window-side))
786             (or (and (setq sibling (window-prev-sibling window))
787                      (window-parameter sibling 'window-side))
788                 (and (setq sibling (window-next-sibling window))
789                      (window-parameter sibling 'window-side)))
790             (setq major window)))
791      frame t 'nomini)
792     (or major (frame-root-window frame))))
793
794 (defun window--major-side-window (side)
795   "Return major side window on SIDE.
796 SIDE must be one of the symbols `left', `top', `right' or
797 `bottom'.  Return nil if no such window exists."
798   (let ((root (frame-root-window))
799         window)
800     ;; (1) If a window on the opposite side exists, return that window's
801     ;;     sibling.
802     ;; (2) If the new window shall span the entire side, return the
803     ;;     frame's root window.
804     ;; (3) If a window on an orthogonal side exists, return that
805     ;;     window's sibling.
806     ;; (4) Otherwise return the frame's root window.
807     (cond
808      ((or (and (eq side 'left)
809                (setq window (window-with-parameter 'window-side 'right nil t)))
810           (and (eq side 'top)
811                (setq window (window-with-parameter 'window-side 'bottom nil t))))
812       (window-prev-sibling window))
813      ((or (and (eq side 'right)
814                (setq window (window-with-parameter 'window-side 'left nil t)))
815           (and (eq side 'bottom)
816                (setq window (window-with-parameter 'window-side 'top nil t))))
817       (window-next-sibling window))
818      ((memq side '(left right))
819       (cond
820        (window-sides-vertical
821         root)
822        ((setq window (window-with-parameter 'window-side 'top nil t))
823         (window-next-sibling window))
824        ((setq window (window-with-parameter 'window-side 'bottom nil t))
825         (window-prev-sibling window))
826        (t root)))
827      ((memq side '(top bottom))
828       (cond
829        ((not window-sides-vertical)
830         root)
831        ((setq window (window-with-parameter 'window-side 'left nil t))
832         (window-next-sibling window))
833        ((setq window (window-with-parameter 'window-side 'right nil t))
834         (window-prev-sibling window))
835        (t root))))))
836
837 (defun display-buffer-in-major-side-window (buffer side slot &optional alist)
838   "Display BUFFER in a new window on SIDE of the selected frame.
839 SIDE must be one of `left', `top', `right' or `bottom'.  SLOT
840 specifies the slot to use.  ALIST is an association list of
841 symbols and values as passed to `display-buffer-in-side-window'.
842 This function may be called only if no window on SIDE exists yet.
843 The new window automatically becomes the \"major\" side window on
844 SIDE.  Return the new window, nil if its creation window failed."
845   (let* ((left-or-right (memq side '(left right)))
846          (major (window--major-side-window side))
847          (on-side (cond
848                    ((eq side 'top) 'above)
849                    ((eq side 'bottom) 'below)
850                    (t side)))
851          ;; The following two bindings will tell `split-window' to take
852          ;; the space for the new window from `major' and not make a new
853          ;; parent window unless needed.
854          (window-combination-resize 'side)
855          (window-combination-limit nil)
856          (new (split-window major nil on-side)))
857     (when new
858       ;; Initialize `window-side' parameter of new window to SIDE.
859       (set-window-parameter new 'window-side side)
860       ;; Install `window-slot' parameter of new window.
861       (set-window-parameter new 'window-slot slot)
862       ;; Install `delete-window' parameter thus making sure that when
863       ;; the new window is deleted, a side window on the opposite side
864       ;; does not get resized.
865       (set-window-parameter new 'delete-window 'delete-side-window)
866       ;; Auto-adjust height/width of new window unless a size has been
867       ;; explicitly requested.
868       (unless (if left-or-right
869                   (cdr (assq 'window-width alist))
870                 (cdr (assq 'window-height alist)))
871         (setq alist
872               (cons
873                (cons
874                 (if left-or-right 'window-width 'window-height)
875                 (/ (window-total-size (frame-root-window) left-or-right)
876                    ;; By default use a fourth of the size of the frame's
877                    ;; root window.
878                    4))
879                alist)))
880       ;; Install BUFFER in new window and return NEW.
881       (window--display-buffer buffer new 'window alist 'side))))
882
883 (defun delete-side-window (window)
884   "Delete side window WINDOW."
885   (let ((window-combination-resize
886          (window-parameter (window-parent window) 'window-side))
887         (ignore-window-parameters t))
888     (delete-window window)))
889
890 (defun display-buffer-in-side-window (buffer alist)
891   "Display BUFFER in a side window of the selected frame.
892 ALIST is an association list of symbols and values.  The
893 following special symbols can be used in ALIST.
894
895 `side' denotes the side of the frame where the new window shall
896   be located.  Valid values are `bottom', `right', `top' and
897   `left'.  The default is `bottom'.
898
899 `slot' if non-nil, specifies the window slot where to display
900   BUFFER.  A value of zero or nil means use the middle slot on
901   the specified side.  A negative value means use a slot
902   preceding (that is, above or on the left of) the middle slot.
903   A positive value means use a slot following (that is, below or
904   on the right of) the middle slot.  The default is zero."
905   (let ((side (or (cdr (assq 'side alist)) 'bottom))
906         (slot (or (cdr (assq 'slot alist)) 0)))
907     (cond
908      ((not (memq side '(top bottom left right)))
909       (error "Invalid side %s specified" side))
910      ((not (numberp slot))
911       (error "Invalid slot %s specified" slot)))
912
913     (let* ((major (window-with-parameter 'window-side side nil t))
914            ;; `major' is the major window on SIDE, `windows' the list of
915            ;; life windows on SIDE.
916            (windows
917             (when major
918               (let (windows)
919                 (walk-window-tree
920                  (lambda (window)
921                    (when (eq (window-parameter window 'window-side) side)
922                      (setq windows (cons window windows))))
923                  nil nil 'nomini)
924                 (nreverse windows))))
925            (slots (when major (max 1 (window-child-count major))))
926            (max-slots
927             (nth (cond
928                   ((eq side 'left) 0)
929                   ((eq side 'top) 1)
930                   ((eq side 'right) 2)
931                   ((eq side 'bottom) 3))
932                  window-sides-slots))
933            window this-window this-slot prev-window next-window
934            best-window best-slot abs-slot)
935
936       (cond
937        ((and (numberp max-slots) (<= max-slots 0))
938         ;; No side-slots available on this side.  Don't create an error,
939         ;; just return nil.
940         nil)
941        ((not windows)
942         ;; No major window exists on this side, make one.
943         (display-buffer-in-major-side-window buffer side slot alist))
944        (t
945         ;; Scan windows on SIDE.
946         (catch 'found
947           (dolist (window windows)
948             (setq this-slot (window-parameter window 'window-slot))
949             (cond
950              ;; The following should not happen and probably be checked
951              ;; by window--side-check.
952              ((not (numberp this-slot)))
953              ((= this-slot slot)
954               ;; A window with a matching slot has been found.
955               (setq this-window window)
956               (throw 'found t))
957              (t
958               ;; Check if this window has a better slot value wrt the
959               ;; slot of the window we want.
960               (setq abs-slot
961                     (if (or (and (> this-slot 0) (> slot 0))
962                             (and (< this-slot 0) (< slot 0)))
963                         (abs (- slot this-slot))
964                       (+ (abs slot) (abs this-slot))))
965               (unless (and best-slot (<= best-slot abs-slot))
966                 (setq best-window window)
967                 (setq best-slot abs-slot))
968               (cond
969                ((<= this-slot slot)
970                 (setq prev-window window))
971                ((not next-window)
972                 (setq next-window window)))))))
973
974         ;; `this-window' is the first window with the same SLOT.
975         ;; `prev-window' is the window with the largest slot < SLOT.  A new
976         ;; window will be created after it.
977         ;; `next-window' is the window with the smallest slot > SLOT.  A new
978         ;; window will be created before it.
979         ;; `best-window' is the window with the smallest absolute difference
980         ;; of its slot and SLOT.
981
982         ;; Note: We dedicate the window used softly to its buffer to
983         ;; avoid that "other" (non-side) buffer display functions steal
984         ;; it from us.  This must eventually become customizable via
985         ;; ALIST (or, better, avoided in the "other" functions).
986         (or (and this-window
987                  ;; Reuse `this-window'.
988                  (window--display-buffer buffer this-window 'reuse alist 'side))
989             (and (or (not max-slots) (< slots max-slots))
990                  (or (and next-window
991                           ;; Make new window before `next-window'.
992                           (let ((next-side
993                                  (if (memq side '(left right)) 'above 'left))
994                                 (window-combination-resize 'side))
995                             (setq window (split-window next-window nil next-side))
996                             ;; When the new window is deleted, its space
997                             ;; is returned to other side windows.
998                             (set-window-parameter
999                              window 'delete-window 'delete-side-window)
1000                             window))
1001                      (and prev-window
1002                           ;; Make new window after `prev-window'.
1003                           (let ((prev-side
1004                                  (if (memq side '(left right)) 'below 'right))
1005                                 (window-combination-resize 'side))
1006                             (setq window (split-window prev-window nil prev-side))
1007                             ;; When the new window is deleted, its space
1008                             ;; is returned to other side windows.
1009                             (set-window-parameter
1010                              window 'delete-window 'delete-side-window)
1011                             window)))
1012                    (set-window-parameter window 'window-slot slot)
1013                    (window--display-buffer buffer window 'window alist 'side))
1014             (and best-window
1015                  ;; Reuse `best-window'.
1016                  (progn
1017                    ;; Give best-window the new slot value.
1018                    (set-window-parameter best-window 'window-slot slot)
1019                    (window--display-buffer
1020                     buffer best-window 'reuse alist 'side)))))))))
1021
1022 (defun window--side-check (&optional frame)
1023   "Check the side window configuration of FRAME.
1024 FRAME defaults to the selected frame.
1025
1026 A valid side window configuration preserves the following two
1027 invariants:
1028
1029 - If there exists a window whose window-side parameter is
1030   non-nil, there must exist at least one live window whose
1031   window-side parameter is nil.
1032
1033 - If a window W has a non-nil window-side parameter (i) it must
1034   have a parent window and that parent's window-side parameter
1035   must be either nil or the same as for W, and (ii) any child
1036   window of W must have the same window-side parameter as W.
1037
1038 If the configuration is invalid, reset the window-side parameters
1039 of all windows on FRAME to nil."
1040   (let (left top right bottom none side parent parent-side)
1041     (when (or (catch 'reset
1042                 (walk-window-tree
1043                  (lambda (window)
1044                    (setq side (window-parameter window 'window-side))
1045                    (setq parent (window-parent window))
1046                    (setq parent-side
1047                          (and parent (window-parameter parent 'window-side)))
1048                    ;; The following `cond' seems a bit tedious, but I'd
1049                    ;; rather stick to using just the stack.
1050                    (cond
1051                     (parent-side
1052                      (when (not (eq parent-side side))
1053                        ;; A parent whose window-side is non-nil must
1054                        ;; have a child with the same window-side.
1055                        (throw 'reset t)))
1056                     ((not side)
1057                      (when (window-buffer window)
1058                        ;; Record that we have at least one non-side,
1059                        ;; live window.
1060                        (setq none t)))
1061                     ((if (memq side '(left top))
1062                          (window-prev-sibling window)
1063                        (window-next-sibling window))
1064                      ;; Left and top major side windows must not have a
1065                      ;; previous sibling, right and bottom major side
1066                      ;; windows must not have a next sibling.
1067                      (throw 'reset t))
1068                     ;; Now check that there's no more than one major
1069                     ;; window for any of left, top, right and bottom.
1070                     ((eq side 'left)
1071                      (if left (throw 'reset t) (setq left t)))
1072                     ((eq side 'top)
1073                      (if top (throw 'reset t) (setq top t)))
1074                     ((eq side 'right)
1075                      (if right (throw 'reset t) (setq right t)))
1076                     ((eq side 'bottom)
1077                      (if bottom (throw 'reset t) (setq bottom t)))
1078                     (t
1079                      (throw 'reset t))))
1080                  frame t 'nomini))
1081               ;; If there's a side window, there must be at least one
1082               ;; non-side window.
1083               (and (or left top right bottom) (not none)))
1084       (walk-window-tree
1085        (lambda (window)
1086          (set-window-parameter window 'window-side nil))
1087        frame t 'nomini))))
1088
1089 (defun window--check (&optional frame)
1090   "Check atomic and side windows on FRAME.
1091 FRAME defaults to the selected frame."
1092   (window--side-check frame)
1093   (window--atom-check frame))
1094
1095 ;; Dumping frame/window contents.
1096 (defun window--dump-window (&optional window erase)
1097   "Dump WINDOW to buffer *window-frame-dump*.
1098 WINDOW must be a valid window and defaults to the selected one.
1099 Optional argument ERASE non-nil means erase *window-frame-dump*
1100 before writing to it."
1101   (setq window (window-normalize-window window))
1102   (with-current-buffer (get-buffer-create "*window-frame-dump*")
1103     (when erase (erase-buffer))
1104     (insert
1105      (format "%s   parent: %s\n" window (window-parent window))
1106      (format "pixel left: %s   top: %s   size: %s x %s   new: %s\n"
1107              (window-pixel-left window) (window-pixel-top window)
1108              (window-size window t t) (window-size window nil t)
1109              (window-new-pixel window))
1110      (format "char left: %s   top: %s   size: %s x %s   new: %s\n"
1111              (window-left-column window) (window-top-line window)
1112              (window-total-size window t) (window-total-size window)
1113              (window-new-total window))
1114      (format "normal: %s x %s   new: %s\n"
1115              (window-normal-size window t) (window-normal-size window)
1116              (window-new-normal window)))
1117     (when (window-live-p window)
1118       (let ((fringes (window-fringes window))
1119             (margins (window-margins window)))
1120         (insert
1121          (format "body pixel: %s x %s   char: %s x %s\n"
1122                  (window-body-width window t) (window-body-height window t)
1123                  (window-body-width window) (window-body-height window))
1124          (format "width left fringe: %s  left margin: %s  right margin: %s\n"
1125                  (car fringes) (or (car margins) 0) (or (cdr margins) 0))
1126          (format "width right fringe: %s  scroll-bar: %s  divider: %s\n"
1127                  (cadr fringes)
1128                  (window-scroll-bar-width window)
1129                  (window-right-divider-width window))
1130          (format "height header-line: %s  mode-line: %s  divider: %s\n"
1131                  (window-header-line-height window)
1132                  (window-mode-line-height window)
1133                  (window-bottom-divider-width window)))))
1134     (insert "\n")))
1135
1136 (defun window--dump-frame (&optional window-or-frame)
1137   "Dump WINDOW-OR-FRAME to buffer *window-frame-dump*.
1138 WINDOW-OR-FRAME can be a frame or a window and defaults to the
1139 selected frame.  When WINDOW-OR-FRAME is a window, dump that
1140 window's frame.  The buffer *window-frame-dump* is erased before
1141 dumping to it."
1142   (let* ((window
1143           (cond
1144            ((or (not window-or-frame)
1145                 (frame-live-p window-or-frame))
1146             (frame-root-window window-or-frame))
1147            ((or (window-live-p window-or-frame)
1148                 (window-child window-or-frame))
1149             window-or-frame)
1150            (t
1151             (frame-root-window))))
1152          (frame (window-frame window)))
1153     (with-current-buffer (get-buffer-create "*window-frame-dump*")
1154       (erase-buffer)
1155       (insert
1156        (format "frame pixel: %s x %s   cols/lines: %s x %s   units: %s x %s\n"
1157                (frame-pixel-width frame) (frame-pixel-height frame)
1158                (frame-total-cols frame) (frame-text-lines frame) ; (frame-total-lines frame)
1159                (frame-char-width frame) (frame-char-height frame))
1160        (format "frame text pixel: %s x %s   cols/lines: %s x %s\n"
1161                (frame-text-width frame) (frame-text-height frame)
1162                (frame-text-cols frame) (frame-text-lines frame))
1163        (format "tool: %s  scroll: %s/%s  fringe: %s  border: %s  right: %s  bottom: %s\n\n"
1164                (if (fboundp 'tool-bar-height)
1165                    (tool-bar-height frame t)
1166                  "0")
1167                (frame-scroll-bar-width frame)
1168                (frame-scroll-bar-height frame)
1169                (frame-fringe-width frame)
1170                (frame-border-width frame)
1171                (frame-right-divider-width frame)
1172                (frame-bottom-divider-width frame)))
1173       (walk-window-tree 'window--dump-window frame t t))))
1174
1175 ;;; Window sizes.
1176 (defun window-total-size (&optional window horizontal round)
1177   "Return the total height or width of WINDOW.
1178 WINDOW must be a valid window and defaults to the selected one.
1179
1180 If HORIZONTAL is omitted or nil, return the total height of
1181 WINDOW, in lines.  If WINDOW is live, its total height includes,
1182 in addition to the height of WINDOW's text, the heights of
1183 WINDOW's mode and header line and a bottom divider, if any.
1184
1185 If HORIZONTAL is non-nil, return the total width of WINDOW, in
1186 columns.  If WINDOW is live, its total width includes, in
1187 addition to the width of WINDOW's text, the widths of WINDOW's
1188 fringes, margins, scroll bars and its right divider, if any.
1189
1190 If WINDOW is internal, return the respective size of the screen
1191 areas spanned by its children.
1192
1193 Optional argument ROUND is handled as for `window-total-height'
1194 and `window-total-width'."
1195   (if horizontal
1196       (window-total-width window round)
1197     (window-total-height window round)))
1198
1199 (defun window-size (&optional window horizontal pixelwise round)
1200   "Return the height or width of WINDOW.
1201 WINDOW must be a valid window and defaults to the selected one.
1202
1203 If HORIZONTAL is omitted or nil, return the total height of
1204 WINDOW, in lines, like `window-total-height'.  Otherwise return
1205 the total width, in columns, like `window-total-width'.
1206
1207 Optional argument PIXELWISE means return the pixel size of WINDOW
1208 like `window-pixel-height' and `window-pixel-width'.
1209
1210 Optional argument ROUND is ignored if PIXELWISE is non-nil and
1211 handled as for `window-total-height' and `window-total-width'
1212 otherwise."
1213   (if horizontal
1214       (if pixelwise
1215           (window-pixel-width window)
1216         (window-total-width window round))
1217     (if pixelwise
1218         (window-pixel-height window)
1219       (window-total-height window round))))
1220
1221 (defvar window-size-fixed nil
1222   "Non-nil in a buffer means windows displaying the buffer are fixed-size.
1223 If the value is `height', then only the window's height is fixed.
1224 If the value is `width', then only the window's width is fixed.
1225 Any other non-nil value fixes both the width and the height.
1226
1227 Emacs won't change the size of any window displaying that buffer,
1228 unless it has no other choice (like when deleting a neighboring
1229 window).")
1230 (make-variable-buffer-local 'window-size-fixed)
1231
1232 (defun window--preservable-size (window &optional horizontal)
1233   "Return height of WINDOW as `window-preserve-size' would preserve it.
1234 Optional argument HORIZONTAL non-nil means to return the width of
1235 WINDOW as `window-preserve-size' would preserve it."
1236   (if horizontal
1237       (window-body-width window t)
1238     (+ (window-body-height window t)
1239        (window-header-line-height window)
1240        (window-mode-line-height window))))
1241
1242 (defun window-preserve-size (&optional window horizontal preserve)
1243   "Preserve height of window WINDOW.
1244 WINDOW must be a live window and defaults to the selected one.
1245 Optional argument HORIZONTAL non-nil means preserve the width of
1246 WINDOW.
1247
1248 PRESERVE t means to preserve the current height/width of WINDOW's
1249 body in frame and window resizing operations whenever possible.
1250 The height/width of WINDOW will change only if Emacs has no other
1251 choice.  Resizing a window whose height/width is preserved never
1252 throws an error.
1253
1254 PRESERVE nil means to stop preserving the height/width of WINDOW,
1255 lifting the respective restraint induced by a previous call of
1256 `window-preserve-size' for WINDOW.  Calling `enlarge-window',
1257 `shrink-window', `split-window' or `fit-window-to-buffer' with
1258 WINDOW as argument also removes the respective restraint.
1259
1260 Other values of PRESERVE are reserved for future use."
1261   (setq window (window-normalize-window window t))
1262   (let* ((parameter (window-parameter window 'window-preserved-size))
1263          (width (nth 1 parameter))
1264          (height (nth 2 parameter)))
1265     (if horizontal
1266         (set-window-parameter
1267          window 'window-preserved-size
1268          (list
1269           (window-buffer window)
1270           (and preserve (window--preservable-size window t))
1271           height))
1272       (set-window-parameter
1273        window 'window-preserved-size
1274        (list
1275         (window-buffer window)
1276         width
1277         (and preserve (window--preservable-size window)))))))
1278
1279 (defun window-preserved-size (&optional window horizontal)
1280   "Return preserved height of window WINDOW.
1281 WINDOW must be a live window and defaults to the selected one.
1282 Optional argument HORIZONTAL non-nil means to return preserved
1283 width of WINDOW."
1284   (setq window (window-normalize-window window t))
1285   (let* ((parameter (window-parameter window 'window-preserved-size))
1286          (buffer (nth 0 parameter))
1287          (width (nth 1 parameter))
1288          (height (nth 2 parameter)))
1289     (when (eq buffer (window-buffer window))
1290       (if horizontal width height))))
1291
1292 (defun window--preserve-size (window horizontal)
1293   "Return non-nil when the height of WINDOW shall be preserved.
1294 Optional argument HORIZONTAL non-nil means to return non-nil when
1295 the width of WINDOW shall be preserved."
1296   (let ((size (window-preserved-size window horizontal)))
1297     (and (numberp size)
1298          (= size (window--preservable-size window horizontal)))))
1299
1300 (defun window-safe-min-size (&optional window horizontal pixelwise)
1301   "Return safe minimum size of WINDOW.
1302 WINDOW must be a valid window and defaults to the selected one.
1303 Optional argument HORIZONTAL non-nil means return the minimum
1304 number of columns of WINDOW; otherwise return the minimum number
1305 of WINDOW's lines.
1306
1307 Optional argument PIXELWISE non-nil means return the minimum pixel-size
1308 of WINDOW."
1309   (setq window (window-normalize-window window))
1310   (if pixelwise
1311       (if horizontal
1312           (* window-safe-min-width
1313              (frame-char-width (window-frame window)))
1314         (* window-safe-min-height
1315            (frame-char-height (window-frame window))))
1316     (if horizontal window-safe-min-width window-safe-min-height)))
1317
1318 (defun window-min-size (&optional window horizontal ignore pixelwise)
1319   "Return the minimum size of WINDOW.
1320 WINDOW must be a valid window and defaults to the selected one.
1321 Optional argument HORIZONTAL non-nil means return the minimum
1322 number of columns of WINDOW; otherwise return the minimum number
1323 of WINDOW's lines.
1324
1325 The optional argument IGNORE has the same meaning as for
1326 `window-resizable'.  Optional argument PIXELWISE non-nil means
1327 return the minimum pixel-size of WINDOW."
1328   (window--min-size-1
1329    (window-normalize-window window) horizontal ignore pixelwise))
1330
1331 (defun window--min-size-ignore-p (window horizontal ignore)
1332   "Return non-nil if IGNORE says to ignore height restrictions for WINDOW.
1333 HORIZONTAL non-nil means to return non-nil if IGNORE says to
1334 ignore width restrictions for WINDOW."
1335   (if (window-valid-p ignore)
1336       (eq window ignore)
1337     (not (memq ignore '(nil preserved)))))
1338
1339 (defun window--min-size-1 (window horizontal ignore pixelwise)
1340   "Internal function of `window-min-size'."
1341   (let ((sub (window-child window)))
1342     (if sub
1343         (let ((value 0))
1344           ;; WINDOW is an internal window.
1345           (if (window-combined-p sub horizontal)
1346               ;; The minimum size of an iso-combination is the sum of
1347               ;; the minimum sizes of its child windows.
1348               (while sub
1349                 (setq value (+ value
1350                                (window--min-size-1
1351                                 sub horizontal ignore pixelwise)))
1352                 (setq sub (window-right sub)))
1353             ;; The minimum size of an ortho-combination is the maximum
1354             ;; of the minimum sizes of its child windows.
1355             (while sub
1356               (setq value (max value
1357                                (window--min-size-1
1358                                 sub horizontal ignore pixelwise)))
1359               (setq sub (window-right sub))))
1360           value)
1361       (with-current-buffer (window-buffer window)
1362         (cond
1363          ((window-minibuffer-p window)
1364           (if pixelwise (frame-char-height (window-frame window)) 1))
1365          ((window-size-fixed-p window horizontal ignore)
1366           ;; The minimum size of a fixed size window is its size.
1367           (window-size window horizontal pixelwise))
1368          ((eq ignore 'safe)
1369           ;; If IGNORE equals `safe' return the safe value.
1370           (window-safe-min-size window horizontal pixelwise))
1371          (horizontal
1372           ;; For the minimum width of a window take fringes and
1373           ;; scroll-bars into account.  This is questionable and should
1374           ;; be removed as soon as we are able to split (and resize)
1375           ;; windows such that the new (or resized) windows can get a
1376           ;; size less than the user-specified `window-min-height' and
1377           ;; `window-min-width'.
1378           (let* ((char-size (frame-char-size window t))
1379                  (fringes (window-fringes window))
1380                  (margins (window-margins window))
1381                  (pixel-width
1382                   (+ (window-safe-min-size window t t)
1383                      (* (or (car margins) 0) char-size)
1384                      (* (or (cdr margins) 0) char-size)
1385                      (car fringes) (cadr fringes)
1386                      (window-scroll-bar-width window)
1387                      (window-right-divider-width window))))
1388             (if pixelwise
1389                 (max
1390                  (if window-resize-pixelwise
1391                      pixel-width
1392                    ;; Round up to next integral of columns.
1393                    (* (ceiling pixel-width char-size) char-size))
1394                  (if (window--min-size-ignore-p window horizontal ignore)
1395                      0
1396                    (window-min-pixel-width window)))
1397               (max
1398                (ceiling pixel-width char-size)
1399                (if (window--min-size-ignore-p window horizontal ignore)
1400                    0
1401                  window-min-width)))))
1402          ((let ((char-size (frame-char-size window))
1403                 (pixel-height
1404                  (+ (window-safe-min-size window nil t)
1405                     (window-header-line-height window)
1406                     (window-scroll-bar-height window)
1407                     (window-mode-line-height window)
1408                     (window-bottom-divider-width window))))
1409             (if pixelwise
1410                 (max
1411                  (if window-resize-pixelwise
1412                      pixel-height
1413                    ;; Round up to next integral of lines.
1414                    (* (ceiling pixel-height char-size) char-size))
1415                  (if (window--min-size-ignore-p window horizontal ignore)
1416                      0
1417                    (window-min-pixel-height window)))
1418               (max (ceiling pixel-height char-size)
1419                    (if (window--min-size-ignore-p window horizontal ignore)
1420                        0
1421                      window-min-height))))))))))
1422
1423 (defun window-sizable (window delta &optional horizontal ignore pixelwise)
1424   "Return DELTA if DELTA lines can be added to WINDOW.
1425 WINDOW must be a valid window and defaults to the selected one.
1426 Optional argument HORIZONTAL non-nil means return DELTA if DELTA
1427 columns can be added to WINDOW.  A return value of zero means
1428 that no lines (or columns) can be added to WINDOW.
1429
1430 This function looks only at WINDOW and, recursively, its child
1431 windows.  The function `window-resizable' looks at other windows
1432 as well.
1433
1434 DELTA positive means WINDOW shall be enlarged by DELTA lines or
1435 columns.  If WINDOW cannot be enlarged by DELTA lines or columns
1436 return the maximum value in the range 0..DELTA by which WINDOW
1437 can be enlarged.
1438
1439 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
1440 columns.  If WINDOW cannot be shrunk by -DELTA lines or columns,
1441 return the minimum value in the range DELTA..0 by which WINDOW
1442 can be shrunk.
1443
1444 The optional argument IGNORE has the same meaning as for
1445 `window-resizable'.  Optional argument PIXELWISE non-nil means
1446 interpret DELTA as pixels."
1447   (setq window (window-normalize-window window))
1448   (cond
1449    ((< delta 0)
1450     (max (- (window-min-size window horizontal ignore pixelwise)
1451             (window-size window horizontal pixelwise))
1452          delta))
1453    ((> delta 0)
1454     (if (window-size-fixed-p window horizontal ignore)
1455         0
1456       delta))
1457    (t 0)))
1458
1459 (defun window-sizable-p (window delta &optional horizontal ignore pixelwise)
1460   "Return t if WINDOW can be resized by DELTA lines.
1461 WINDOW must be a valid window and defaults to the selected one.
1462 For the meaning of the arguments of this function see the
1463 doc-string of `window-sizable'."
1464   (setq window (window-normalize-window window))
1465   (if (> delta 0)
1466       (>= (window-sizable window delta horizontal ignore pixelwise)
1467           delta)
1468     (<= (window-sizable window delta horizontal ignore pixelwise)
1469         delta)))
1470
1471 (defun window--size-fixed-1 (window horizontal ignore)
1472   "Internal function for `window-size-fixed-p'."
1473   (let ((sub (window-child window)))
1474     (catch 'fixed
1475       (if sub
1476           ;; WINDOW is an internal window.
1477           (if (window-combined-p sub horizontal)
1478               ;; An iso-combination is fixed size if all its child
1479               ;; windows are fixed-size.
1480               (progn
1481                 (while sub
1482                   (unless (window--size-fixed-1 sub horizontal ignore)
1483                     ;; We found a non-fixed-size child window, so
1484                     ;; WINDOW's size is not fixed.
1485                     (throw 'fixed nil))
1486                   (setq sub (window-right sub)))
1487                 ;; All child windows are fixed-size, so WINDOW's size is
1488                 ;; fixed.
1489                 (throw 'fixed t))
1490             ;; An ortho-combination is fixed-size if at least one of its
1491             ;; child windows is fixed-size.
1492             (while sub
1493               (when (window--size-fixed-1 sub horizontal ignore)
1494                 ;; We found a fixed-size child window, so WINDOW's size
1495                 ;; is fixed.
1496                 (throw 'fixed t))
1497               (setq sub (window-right sub))))
1498         ;; WINDOW is a live window.
1499         (and (or (not (windowp ignore)) (not (eq window ignore)))
1500              (or (and (not (eq ignore 'preserved))
1501                       (window--preserve-size window horizontal))
1502                  (with-current-buffer (window-buffer window)
1503                    (if horizontal
1504                        (memq window-size-fixed '(width t))
1505                      (memq window-size-fixed '(height t))))))))))
1506
1507 (defun window-size-fixed-p (&optional window horizontal ignore)
1508   "Return non-nil if WINDOW's height is fixed.
1509 WINDOW must be a valid window and defaults to the selected one.
1510 Optional argument HORIZONTAL non-nil means return non-nil if
1511 WINDOW's width is fixed.  The optional argument IGNORE has the
1512 same meaning as for `window-resizable'.
1513
1514 If this function returns nil, this does not necessarily mean that
1515 WINDOW can be resized in the desired direction.  The function
1516 `window-resizable' can tell that."
1517   (when (or (windowp ignore) (memq ignore '(nil preserved)))
1518     (window--size-fixed-1
1519      (window-normalize-window window) horizontal ignore)))
1520
1521 (defun window--min-delta-1 (window delta &optional horizontal ignore trail noup pixelwise)
1522   "Internal function for `window-min-delta'."
1523   (if (not (window-parent window))
1524       ;; If we can't go up, return zero.
1525       0
1526     ;; Else try to find a non-fixed-size sibling of WINDOW.
1527     (let* ((parent (window-parent window))
1528            (sub (window-child parent)))
1529       (catch 'done
1530         (if (window-combined-p sub horizontal)
1531             ;; In an iso-combination throw DELTA if we find at least one
1532             ;; child window and that window is either not fixed-size or
1533             ;; we can ignore fixed-sizeness.
1534             (let ((skip (eq trail 'after)))
1535               (while sub
1536                 (cond
1537                  ((eq sub window)
1538                   (setq skip (eq trail 'before)))
1539                  (skip)
1540                  ((window-size-fixed-p sub horizontal ignore))
1541                  (t
1542                   ;; We found a non-fixed-size child window.
1543                   (throw 'done delta)))
1544                 (setq sub (window-right sub))))
1545           ;; In an ortho-combination set DELTA to the minimum value by
1546           ;; which other child windows can shrink.
1547           (while sub
1548             (unless (eq sub window)
1549               (setq delta
1550                     (min delta
1551                          (max (- (window-size sub horizontal pixelwise 'ceiling)
1552                                  (window-min-size
1553                                   sub horizontal ignore pixelwise))
1554                               0))))
1555             (setq sub (window-right sub))))
1556         (if noup
1557             delta
1558           (window--min-delta-1
1559            parent delta horizontal ignore trail nil pixelwise))))))
1560
1561 (defun window-min-delta (&optional window horizontal ignore trail noup nodown pixelwise)
1562   "Return number of lines by which WINDOW can be shrunk.
1563 WINDOW must be a valid window and defaults to the selected one.
1564 Return zero if WINDOW cannot be shrunk.
1565
1566 Optional argument HORIZONTAL non-nil means return number of
1567 columns by which WINDOW can be shrunk.
1568
1569 The optional argument IGNORE has the same meaning as for
1570 `window-resizable'.  Optional argument TRAIL restricts the
1571 windows that can be enlarged.  If its value is `before', only
1572 windows to the left of or above WINDOW can be enlarged.  If it is
1573 `after', only windows to the right of or below WINDOW can be
1574 enlarged.
1575
1576 Optional argument NOUP non-nil means don't go up in the window
1577 tree, but try to enlarge windows within WINDOW's combination
1578 only.  Optional argument NODOWN non-nil means don't check whether
1579 WINDOW itself (and its child windows) can be shrunk; check only
1580 whether at least one other window can be enlarged appropriately.
1581
1582 Optional argument PIXELWISE non-nil means return number of pixels
1583 by which WINDOW can be shrunk."
1584   (setq window (window-normalize-window window))
1585   (let ((size (window-size window horizontal pixelwise 'floor))
1586         (minimum (window-min-size window horizontal ignore pixelwise)))
1587     (cond
1588      (nodown
1589       ;; If NODOWN is t, try to recover the entire size of WINDOW.
1590       (window--min-delta-1
1591        window size horizontal ignore trail noup pixelwise))
1592      ((<= size minimum)
1593       ;; If NODOWN is nil and WINDOW's size is already at its minimum,
1594       ;; there's nothing to recover.
1595       0)
1596      (t
1597       ;; Otherwise, try to recover whatever WINDOW is larger than its
1598       ;; minimum size.
1599       (window--min-delta-1
1600        window (- size minimum) horizontal ignore trail noup pixelwise)))))
1601
1602 (defun frame-windows-min-size (&optional frame horizontal ignore pixelwise)
1603   "Return minimum number of lines of FRAME's windows.
1604 HORIZONTAL non-nil means return number of columns of FRAME's
1605 windows.  The optional argument IGNORE has the same meaning as
1606 for `window-resizable'.  PIXELWISE non-nil means return sizes in
1607 pixels."
1608   (setq frame (window-normalize-frame frame))
1609   (let* ((root (frame-root-window frame))
1610          (mini (window-next-sibling root)))
1611     (+ (window-min-size root horizontal ignore pixelwise)
1612        (if (and mini (not horizontal))
1613            (window-min-size mini horizontal nil pixelwise)
1614          0))))
1615
1616 (defun window--max-delta-1 (window delta &optional horizontal ignore trail noup pixelwise)
1617   "Internal function of `window-max-delta'."
1618   (if (not (window-parent window))
1619       ;; Can't go up.  Return DELTA.
1620       delta
1621     (let* ((parent (window-parent window))
1622            (sub (window-child parent)))
1623       (catch 'fixed
1624         (if (window-combined-p sub horizontal)
1625             ;; For an iso-combination calculate how much we can get from
1626             ;; other child windows.
1627             (let ((skip (eq trail 'after)))
1628               (while sub
1629                 (cond
1630                  ((eq sub window)
1631                   (setq skip (eq trail 'before)))
1632                  (skip)
1633                  (t
1634                   (setq delta
1635                         (+ delta
1636                            (max
1637                             (- (window-size sub horizontal pixelwise 'floor)
1638                                (window-min-size
1639                                 sub horizontal ignore pixelwise))
1640                             0)))))
1641                 (setq sub (window-right sub))))
1642           ;; For an ortho-combination throw DELTA when at least one
1643           ;; child window is fixed-size.
1644           (while sub
1645             (when (and (not (eq sub window))
1646                        (window-size-fixed-p sub horizontal ignore))
1647               (throw 'fixed delta))
1648             (setq sub (window-right sub))))
1649         (if noup
1650             ;; When NOUP is nil, DELTA is all we can get.
1651             delta
1652           ;; Else try with parent of WINDOW, passing the DELTA we
1653           ;; recovered so far.
1654           (window--max-delta-1
1655            parent delta horizontal ignore trail nil pixelwise))))))
1656
1657 (defun window-max-delta (&optional window horizontal ignore trail noup nodown pixelwise)
1658   "Return maximum number of lines by which WINDOW can be enlarged.
1659 WINDOW must be a valid window and defaults to the selected one.
1660 The return value is zero if WINDOW cannot be enlarged.
1661
1662 Optional argument HORIZONTAL non-nil means return maximum number
1663 of columns by which WINDOW can be enlarged.
1664
1665 The optional argument IGNORE has the same meaning as for
1666 `window-resizable'.  Optional argument TRAIL restricts the
1667 windows that can be enlarged.  If its value is `before', only
1668 windows to the left of or above WINDOW can be enlarged.  If it is
1669 `after', only windows to the right of or below WINDOW can be
1670 enlarged.
1671
1672 Optional argument NOUP non-nil means don't go up in the window
1673 tree but try to obtain the entire space from windows within
1674 WINDOW's combination.  Optional argument NODOWN non-nil means do
1675 not check whether WINDOW itself (and its child windows) can be
1676 enlarged; check only whether other windows can be shrunk
1677 appropriately.
1678
1679 Optional argument PIXELWISE non-nil means return number of
1680 pixels by which WINDOW can be enlarged."
1681   (setq window (window-normalize-window window))
1682   (if (and (not nodown) (window-size-fixed-p window horizontal ignore))
1683       ;; With IGNORE and NOWDON nil return zero if WINDOW has fixed
1684       ;; size.
1685       0
1686     ;; WINDOW has no fixed size.
1687     (window--max-delta-1 window 0 horizontal ignore trail noup pixelwise)))
1688
1689 ;; Make NOUP also inhibit the min-size check.
1690 (defun window--resizable (window delta &optional horizontal ignore trail noup nodown pixelwise)
1691   "Return DELTA if WINDOW can be resized vertically by DELTA lines.
1692 WINDOW must be a valid window and defaults to the selected one.
1693 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
1694 can be resized horizontally by DELTA columns.  A return value of
1695 zero means that WINDOW is not resizable.
1696
1697 DELTA positive means WINDOW shall be enlarged by DELTA lines or
1698 columns.  If WINDOW cannot be enlarged by DELTA lines or columns,
1699 return the maximum value in the range 0..DELTA by which WINDOW
1700 can be enlarged.
1701
1702 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
1703 columns.  If WINDOW cannot be shrunk by -DELTA lines or columns,
1704 return the minimum value in the range DELTA..0 that can be used
1705 for shrinking WINDOW.
1706
1707 The optional argument IGNORE has the same meaning as for
1708 `window-resizable'.  Optional argument TRAIL `before' means only
1709 windows to the left of or below WINDOW can be shrunk.  Optional
1710 argument TRAIL `after' means only windows to the right of or
1711 above WINDOW can be shrunk.
1712
1713 Optional argument NOUP non-nil means don't go up in the window
1714 tree but check only whether space can be obtained from (or given
1715 to) WINDOW's siblings.  Optional argument NODOWN non-nil means
1716 don't go down in the window tree.  This means do not check
1717 whether resizing would violate size restrictions of WINDOW or its
1718 child windows.
1719
1720 Optional argument PIXELWISE non-nil means interpret DELTA as
1721 number of pixels."
1722   (setq window (window-normalize-window window))
1723   (cond
1724    ((< delta 0)
1725     (max (- (window-min-delta
1726              window horizontal ignore trail noup nodown pixelwise))
1727          delta))
1728    ((> delta 0)
1729     (min (window-max-delta
1730           window horizontal ignore trail noup nodown pixelwise)
1731          delta))
1732    (t 0)))
1733
1734 (defun window--resizable-p (window delta &optional horizontal ignore trail noup nodown pixelwise)
1735   "Return t if WINDOW can be resized vertically by DELTA lines.
1736 WINDOW must be a valid window and defaults to the selected one.
1737 For the meaning of the arguments of this function see the
1738 doc-string of `window--resizable'.
1739
1740 Optional argument PIXELWISE non-nil means interpret DELTA as
1741 pixels."
1742   (setq window (window-normalize-window window))
1743   (if (> delta 0)
1744       (>= (window--resizable
1745            window delta horizontal ignore trail noup nodown pixelwise)
1746           delta)
1747     (<= (window--resizable
1748          window delta horizontal ignore trail noup nodown pixelwise)
1749         delta)))
1750
1751 (defun window-resizable (window delta &optional horizontal ignore pixelwise)
1752   "Return DELTA if WINDOW can be resized vertically by DELTA lines.
1753 WINDOW must be a valid window and defaults to the selected one.
1754 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
1755 can be resized horizontally by DELTA columns.  A return value of
1756 zero means that WINDOW is not resizable.
1757
1758 DELTA positive means WINDOW shall be enlarged by DELTA lines or
1759 columns.  If WINDOW cannot be enlarged by DELTA lines or columns
1760 return the maximum value in the range 0..DELTA by which WINDOW
1761 can be enlarged.
1762
1763 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
1764 columns.  If WINDOW cannot be shrunk by -DELTA lines or columns,
1765 return the minimum value in the range DELTA..0 that can be used
1766 for shrinking WINDOW.
1767
1768 Optional argument IGNORE, if non-nil, means to ignore restraints
1769 induced by fixed size windows or the values of the variables
1770 `window-min-height' and `window-min-width'.  The following values
1771 have special meanings: `safe' means that in addition live windows
1772 are allowed to get as small as `window-safe-min-height' lines and
1773 `window-safe-min-width' columns.  `preserved' means to ignore
1774 only restrictions induced by `window-preserve-size'.  If IGNORE
1775 is a window, then ignore restrictions for that window only.
1776
1777 Optional argument PIXELWISE non-nil means interpret DELTA as
1778 pixels."
1779   (setq window (window-normalize-window window))
1780   (window--resizable window delta horizontal ignore nil nil nil pixelwise))
1781
1782 (defun window-resizable-p (window delta &optional horizontal ignore pixelwise)
1783   "Return t if WINDOW can be resized vertically by DELTA lines.
1784 WINDOW must be a valid window and defaults to the selected one.
1785 For the meaning of the arguments of this function see the
1786 doc-string of `window-resizable'."
1787   (setq window (window-normalize-window window))
1788   (if (> delta 0)
1789       (>= (window--resizable
1790            window delta horizontal ignore nil nil nil pixelwise)
1791           delta)
1792     (<= (window--resizable
1793          window delta horizontal ignore nil nil nil pixelwise)
1794         delta)))
1795
1796 ;; Aliases of functions defined in window.c.
1797 (defalias 'window-height 'window-total-height)
1798 (defalias 'window-width 'window-body-width)
1799
1800 (defun window-full-height-p (&optional window)
1801   "Return t if WINDOW is as high as its containing frame.
1802 More precisely, return t if and only if the total height of
1803 WINDOW equals the total height of the root window of WINDOW's
1804 frame.  WINDOW must be a valid window and defaults to the
1805 selected one."
1806   (setq window (window-normalize-window window))
1807   (if (window-minibuffer-p window)
1808       (eq window (frame-root-window (window-frame window)))
1809     (= (window-pixel-height window)
1810        (window-pixel-height (frame-root-window window)))))
1811
1812 (defun window-full-width-p (&optional window)
1813   "Return t if WINDOW is as wide as its containing frame.
1814 More precisely, return t if and only if the total width of WINDOW
1815 equals the total width of the root window of WINDOW's frame.
1816 WINDOW must be a valid window and defaults to the selected one."
1817   (setq window (window-normalize-window window))
1818   (= (window-pixel-width window)
1819      (window-pixel-width (frame-root-window window))))
1820
1821 (defun window-body-size (&optional window horizontal pixelwise)
1822   "Return the height or width of WINDOW's text area.
1823 WINDOW must be a live window and defaults to the selected one.
1824
1825 If HORIZONTAL is omitted or nil, return the height of the text
1826 area, like `window-body-height'.  Otherwise, return the width of
1827 the text area, like `window-body-width'.  In either case, the
1828 optional argument PIXELWISE is passed to the functions."
1829   (if horizontal
1830       (window-body-width window pixelwise)
1831     (window-body-height window pixelwise)))
1832
1833 (defun window-current-scroll-bars (&optional window)
1834   "Return the current scroll bar types for WINDOW.
1835 WINDOW must be a live window and defaults to the selected one.
1836
1837 The return value is a cons cell (VERTICAL . HORIZONTAL) where
1838 VERTICAL specifies the current location of the vertical scroll
1839 bar (`left', `right' or nil), and HORIZONTAL specifies the
1840 current location of the horizontal scroll bar (`bottom' or nil).
1841
1842 Unlike `window-scroll-bars', this function reports the scroll bar
1843 type actually used, once frame defaults and `scroll-bar-mode' are
1844 taken into account."
1845   (setq window (window-normalize-window window t))
1846   (let ((vertical (nth 2 (window-scroll-bars window)))
1847         (horizontal (nth 5 (window-scroll-bars window)))
1848         (inherited (frame-current-scroll-bars (window-frame window))))
1849     (when (eq vertical t)
1850       (setq vertical (car inherited)))
1851     (when (eq horizontal t)
1852       (setq horizontal (cdr inherited)))
1853     (cons vertical (and horizontal 'bottom))))
1854
1855 (defun walk-windows (fun &optional minibuf all-frames)
1856   "Cycle through all live windows, calling FUN for each one.
1857 FUN must specify a function with a window as its sole argument.
1858 The optional arguments MINIBUF and ALL-FRAMES specify the set of
1859 windows to include in the walk.
1860
1861 MINIBUF t means include the minibuffer window even if the
1862 minibuffer is not active.  MINIBUF nil or omitted means include
1863 the minibuffer window only if the minibuffer is active.  Any
1864 other value means do not include the minibuffer window even if
1865 the minibuffer is active.
1866
1867 ALL-FRAMES nil or omitted means consider all windows on the
1868 selected frame, plus the minibuffer window if specified by the
1869 MINIBUF argument.  If the minibuffer counts, consider all windows
1870 on all frames that share that minibuffer too.  The following
1871 non-nil values of ALL-FRAMES have special meanings:
1872
1873 - t means consider all windows on all existing frames.
1874
1875 - `visible' means consider all windows on all visible frames on
1876   the current terminal.
1877
1878 - 0 (the number zero) means consider all windows on all visible
1879   and iconified frames on the current terminal.
1880
1881 - A frame means consider all windows on that frame only.
1882
1883 Anything else means consider all windows on the selected frame
1884 and no others.
1885
1886 This function changes neither the order of recently selected
1887 windows nor the buffer list."
1888   ;; If we start from the minibuffer window, don't fail to come
1889   ;; back to it.
1890   (when (window-minibuffer-p)
1891     (setq minibuf t))
1892   ;; Make sure to not mess up the order of recently selected
1893   ;; windows.  Use `save-selected-window' and `select-window'
1894   ;; with second argument non-nil for this purpose.
1895   (save-selected-window
1896     (when (framep all-frames)
1897       (select-window (frame-first-window all-frames) 'norecord))
1898     (dolist (walk-windows-window (window-list-1 nil minibuf all-frames))
1899       (funcall fun walk-windows-window))))
1900
1901 (defun window-at-side-p (&optional window side)
1902   "Return t if WINDOW is at SIDE of its containing frame.
1903 WINDOW must be a valid window and defaults to the selected one.
1904 SIDE can be any of the symbols `left', `top', `right' or
1905 `bottom'.  The default value nil is handled like `bottom'."
1906   (setq window (window-normalize-window window))
1907   (let ((edge
1908          (cond
1909           ((eq side 'left) 0)
1910           ((eq side 'top) 1)
1911           ((eq side 'right) 2)
1912           ((memq side '(bottom nil)) 3))))
1913     (= (nth edge (window-pixel-edges window))
1914        (nth edge (window-pixel-edges (frame-root-window window))))))
1915
1916 (defun window-at-side-list (&optional frame side)
1917   "Return list of all windows on SIDE of FRAME.
1918 FRAME must be a live frame and defaults to the selected frame.
1919 SIDE can be any of the symbols `left', `top', `right' or
1920 `bottom'.  The default value nil is handled like `bottom'."
1921   (setq frame (window-normalize-frame frame))
1922   (let (windows)
1923     (walk-window-tree
1924      (lambda (window)
1925        (when (window-at-side-p window side)
1926          (setq windows (cons window windows))))
1927      frame nil 'nomini)
1928     (nreverse windows)))
1929
1930 (defun window--in-direction-2 (window posn &optional horizontal)
1931   "Support function for `window-in-direction'."
1932   (if horizontal
1933       (let ((top (window-pixel-top window)))
1934         (if (> top posn)
1935             (- top posn)
1936           (- posn top (window-pixel-height window))))
1937     (let ((left (window-pixel-left window)))
1938       (if (> left posn)
1939           (- left posn)
1940         (- posn left (window-pixel-width window))))))
1941
1942 ;; Predecessors to the below have been devised by Julian Assange in
1943 ;; change-windows-intuitively.el and Hovav Shacham in windmove.el.
1944 ;; Neither of these allow to selectively ignore specific windows
1945 ;; (windows whose `no-other-window' parameter is non-nil) as targets of
1946 ;; the movement.
1947 (defun window-in-direction (direction &optional window ignore sign wrap mini)
1948   "Return window in DIRECTION as seen from WINDOW.
1949 More precisely, return the nearest window in direction DIRECTION
1950 as seen from the position of `window-point' in window WINDOW.
1951 DIRECTION must be one of `above', `below', `left' or `right'.
1952 WINDOW must be a live window and defaults to the selected one.
1953
1954 Do not return a window whose `no-other-window' parameter is
1955 non-nil.  If the nearest window's `no-other-window' parameter is
1956 non-nil, try to find another window in the indicated direction.
1957 If, however, the optional argument IGNORE is non-nil, return that
1958 window even if its `no-other-window' parameter is non-nil.
1959
1960 Optional argument SIGN a negative number means to use the right
1961 or bottom edge of WINDOW as reference position instead of
1962 `window-point'.  SIGN a positive number means to use the left or
1963 top edge of WINDOW as reference position.
1964
1965 Optional argument WRAP non-nil means to wrap DIRECTION around
1966 frame borders.  This means to return for WINDOW at the top of the
1967 frame and DIRECTION `above' the minibuffer window if the frame
1968 has one, and a window at the bottom of the frame otherwise.
1969
1970 Optional argument MINI nil means to return the minibuffer window
1971 if and only if it is currently active.  MINI non-nil means to
1972 return the minibuffer window even when it's not active.  However,
1973 if WRAP non-nil, always act as if MINI were nil.
1974
1975 Return nil if no suitable window can be found."
1976   (setq window (window-normalize-window window t))
1977   (unless (memq direction '(above below left right))
1978     (error "Wrong direction %s" direction))
1979   (let* ((frame (window-frame window))
1980          (hor (memq direction '(left right)))
1981          (first (if hor
1982                     (window-pixel-left window)
1983                   (window-pixel-top window)))
1984          (last (+ first (window-size window hor t)))
1985          ;; The column / row value of `posn-at-point' can be nil for the
1986          ;; mini-window, guard against that.
1987          (posn
1988           (cond
1989            ((and (numberp sign) (< sign 0))
1990             (if hor
1991                 (1- (+ (window-pixel-top window) (window-pixel-height window)))
1992               (1- (+ (window-pixel-left window) (window-pixel-width window)))))
1993            ((and (numberp sign) (> sign 0))
1994             (if hor
1995                 (window-pixel-top window)
1996               (window-pixel-left window)))
1997            ((let ((posn-cons (nth 2 (posn-at-point (window-point window) window))))
1998               (if hor
1999                   (+ (or (cdr posn-cons) 1) (window-pixel-top window))
2000                 (+ (or (car posn-cons) 1) (window-pixel-left window)))))))
2001          (best-edge
2002           (cond
2003            ((eq direction 'below) (frame-pixel-height frame))
2004            ((eq direction 'right) (frame-pixel-width frame))
2005            (t -1)))
2006          (best-edge-2 best-edge)
2007          (best-diff-2 (if hor (frame-pixel-height frame) (frame-pixel-width frame)))
2008          best best-2 best-diff-2-new)
2009     (walk-window-tree
2010      (lambda (w)
2011        (let* ((w-top (window-pixel-top w))
2012               (w-left (window-pixel-left w)))
2013          (cond
2014           ((or (eq window w)
2015                ;; Ignore ourselves.
2016                (and (window-parameter w 'no-other-window)
2017                     ;; Ignore W unless IGNORE is non-nil.
2018                     (not ignore))))
2019           (hor
2020            (cond
2021             ((and (<= w-top posn)
2022                   (< posn (+ w-top (window-pixel-height w))))
2023              ;; W is to the left or right of WINDOW and covers POSN.
2024              (when (or (and (eq direction 'left)
2025                             (or (and (<= w-left first) (> w-left best-edge))
2026                                 (and wrap
2027                                      (window-at-side-p window 'left)
2028                                      (window-at-side-p w 'right))))
2029                        (and (eq direction 'right)
2030                             (or (and (>= w-left last) (< w-left best-edge))
2031                                 (and wrap
2032                                      (window-at-side-p window 'right)
2033                                      (window-at-side-p w 'left)))))
2034                (setq best-edge w-left)
2035                (setq best w)))
2036             ((and (or (and (eq direction 'left)
2037                            (<= (+ w-left (window-pixel-width w)) first))
2038                       (and (eq direction 'right) (<= last w-left)))
2039                   ;; W is to the left or right of WINDOW but does not
2040                   ;; cover POSN.
2041                   (setq best-diff-2-new
2042                         (window--in-direction-2 w posn hor))
2043                   (or (< best-diff-2-new best-diff-2)
2044                       (and (= best-diff-2-new best-diff-2)
2045                            (if (eq direction 'left)
2046                                (> w-left best-edge-2)
2047                              (< w-left best-edge-2)))))
2048              (setq best-edge-2 w-left)
2049              (setq best-diff-2 best-diff-2-new)
2050              (setq best-2 w))))
2051           ((and (<= w-left posn)
2052                 (< posn (+ w-left (window-pixel-width w))))
2053            ;; W is above or below WINDOW and covers POSN.
2054            (when (or (and (eq direction 'above)
2055                           (or (and (<= w-top first) (> w-top best-edge))
2056                               (and wrap
2057                                    (window-at-side-p window 'top)
2058                                    (if (active-minibuffer-window)
2059                                        (minibuffer-window-active-p w)
2060                                      (window-at-side-p w 'bottom)))))
2061                      (and (eq direction 'below)
2062                           (or (and (>= w-top first) (< w-top best-edge))
2063                               (and wrap
2064                                    (if (active-minibuffer-window)
2065                                        (minibuffer-window-active-p window)
2066                                      (window-at-side-p window 'bottom))
2067                                    (window-at-side-p w 'top)))))
2068              (setq best-edge w-top)
2069              (setq best w)))
2070           ((and (or (and (eq direction 'above)
2071                          (<= (+ w-top (window-pixel-height w)) first))
2072                     (and (eq direction 'below) (<= last w-top)))
2073                 ;; W is above or below WINDOW but does not cover POSN.
2074                 (setq best-diff-2-new
2075                       (window--in-direction-2 w posn hor))
2076                 (or (< best-diff-2-new best-diff-2)
2077                     (and (= best-diff-2-new best-diff-2)
2078                          (if (eq direction 'above)
2079                              (> w-top best-edge-2)
2080                            (< w-top best-edge-2)))))
2081            (setq best-edge-2 w-top)
2082            (setq best-diff-2 best-diff-2-new)
2083            (setq best-2 w)))))
2084      frame nil (and mini t))
2085     (or best best-2)))
2086
2087 (defun get-window-with-predicate (predicate &optional minibuf all-frames default)
2088   "Return a live window satisfying PREDICATE.
2089 More precisely, cycle through all windows calling the function
2090 PREDICATE on each one of them with the window as its sole
2091 argument.  Return the first window for which PREDICATE returns
2092 non-nil.  Windows are scanned starting with the window following
2093 the selected window.  If no window satisfies PREDICATE, return
2094 DEFAULT.
2095
2096 MINIBUF t means include the minibuffer window even if the
2097 minibuffer is not active.  MINIBUF nil or omitted means include
2098 the minibuffer window only if the minibuffer is active.  Any
2099 other value means do not include the minibuffer window even if
2100 the minibuffer is active.
2101
2102 ALL-FRAMES nil or omitted means consider all windows on the selected
2103 frame, plus the minibuffer window if specified by the MINIBUF
2104 argument.  If the minibuffer counts, consider all windows on all
2105 frames that share that minibuffer too.  The following non-nil
2106 values of ALL-FRAMES have special meanings:
2107
2108 - t means consider all windows on all existing frames.
2109
2110 - `visible' means consider all windows on all visible frames on
2111   the current terminal.
2112
2113 - 0 (the number zero) means consider all windows on all visible
2114   and iconified frames on the current terminal.
2115
2116 - A frame means consider all windows on that frame only.
2117
2118 Anything else means consider all windows on the selected frame
2119 and no others."
2120   (catch 'found
2121     (dolist (window (window-list-1
2122                      (next-window nil minibuf all-frames)
2123                      minibuf all-frames))
2124       (when (funcall predicate window)
2125         (throw 'found window)))
2126     default))
2127
2128 (defalias 'some-window 'get-window-with-predicate)
2129
2130 (defun get-lru-window (&optional all-frames dedicated not-selected)
2131    "Return the least recently used window on frames specified by ALL-FRAMES.
2132 Return a full-width window if possible.  A minibuffer window is
2133 never a candidate.  A dedicated window is never a candidate
2134 unless DEDICATED is non-nil, so if all windows are dedicated, the
2135 value is nil.  Avoid returning the selected window if possible.
2136 Optional argument NOT-SELECTED non-nil means never return the
2137 selected window.
2138
2139 The following non-nil values of the optional argument ALL-FRAMES
2140 have special meanings:
2141
2142 - t means consider all windows on all existing frames.
2143
2144 - `visible' means consider all windows on all visible frames on
2145   the current terminal.
2146
2147 - 0 (the number zero) means consider all windows on all visible
2148   and iconified frames on the current terminal.
2149
2150 - A frame means consider all windows on that frame only.
2151
2152 Any other value of ALL-FRAMES means consider all windows on the
2153 selected frame and no others."
2154    (let (best-window best-time second-best-window second-best-time time)
2155     (dolist (window (window-list-1 nil 'nomini all-frames))
2156       (when (and (or dedicated (not (window-dedicated-p window)))
2157                  (or (not not-selected) (not (eq window (selected-window)))))
2158         (setq time (window-use-time window))
2159         (if (or (eq window (selected-window))
2160                 (not (window-full-width-p window)))
2161             (when (or (not second-best-time) (< time second-best-time))
2162               (setq second-best-time time)
2163               (setq second-best-window window))
2164           (when (or (not best-time) (< time best-time))
2165             (setq best-time time)
2166             (setq best-window window)))))
2167     (or best-window second-best-window)))
2168
2169 (defun get-mru-window (&optional all-frames dedicated not-selected)
2170    "Return the most recently used window on frames specified by ALL-FRAMES.
2171 A minibuffer window is never a candidate.  A dedicated window is
2172 never a candidate unless DEDICATED is non-nil, so if all windows
2173 are dedicated, the value is nil.  Optional argument NOT-SELECTED
2174 non-nil means never return the selected window.
2175
2176 The following non-nil values of the optional argument ALL-FRAMES
2177 have special meanings:
2178
2179 - t means consider all windows on all existing frames.
2180
2181 - `visible' means consider all windows on all visible frames on
2182   the current terminal.
2183
2184 - 0 (the number zero) means consider all windows on all visible
2185   and iconified frames on the current terminal.
2186
2187 - A frame means consider all windows on that frame only.
2188
2189 Any other value of ALL-FRAMES means consider all windows on the
2190 selected frame and no others."
2191    (let (best-window best-time time)
2192     (dolist (window (window-list-1 nil 'nomini all-frames))
2193       (setq time (window-use-time window))
2194       (when (and (or dedicated (not (window-dedicated-p window)))
2195                  (or (not not-selected) (not (eq window (selected-window))))
2196                  (or (not best-time) (> time best-time)))
2197         (setq best-time time)
2198         (setq best-window window)))
2199     best-window))
2200
2201 (defun get-largest-window (&optional all-frames dedicated not-selected)
2202   "Return the largest window on frames specified by ALL-FRAMES.
2203 A minibuffer window is never a candidate.  A dedicated window is
2204 never a candidate unless DEDICATED is non-nil, so if all windows
2205 are dedicated, the value is nil.  Optional argument NOT-SELECTED
2206 non-nil means never return the selected window.
2207
2208 The following non-nil values of the optional argument ALL-FRAMES
2209 have special meanings:
2210
2211 - t means consider all windows on all existing frames.
2212
2213 - `visible' means consider all windows on all visible frames on
2214   the current terminal.
2215
2216 - 0 (the number zero) means consider all windows on all visible
2217   and iconified frames on the current terminal.
2218
2219 - A frame means consider all windows on that frame only.
2220
2221 Any other value of ALL-FRAMES means consider all windows on the
2222 selected frame and no others."
2223   (let ((best-size 0)
2224         best-window size)
2225     (dolist (window (window-list-1 nil 'nomini all-frames))
2226       (when (and (or dedicated (not (window-dedicated-p window)))
2227                  (or (not not-selected) (not (eq window (selected-window)))))
2228         (setq size (* (window-pixel-height window)
2229                       (window-pixel-width window)))
2230         (when (> size best-size)
2231           (setq best-size size)
2232           (setq best-window window))))
2233     best-window))
2234
2235 (defun get-buffer-window-list (&optional buffer-or-name minibuf all-frames)
2236   "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
2237 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2238 and defaults to the current buffer.  Windows are scanned starting
2239 with the selected window.
2240
2241 MINIBUF t means include the minibuffer window even if the
2242 minibuffer is not active.  MINIBUF nil or omitted means include
2243 the minibuffer window only if the minibuffer is active.  Any
2244 other value means do not include the minibuffer window even if
2245 the minibuffer is active.
2246
2247 ALL-FRAMES nil or omitted means consider all windows on the
2248 selected frame, plus the minibuffer window if specified by the
2249 MINIBUF argument.  If the minibuffer counts, consider all windows
2250 on all frames that share that minibuffer too.  The following
2251 non-nil values of ALL-FRAMES have special meanings:
2252
2253 - t means consider all windows on all existing frames.
2254
2255 - `visible' means consider all windows on all visible frames on
2256   the current terminal.
2257
2258 - 0 (the number zero) means consider all windows on all visible
2259   and iconified frames on the current terminal.
2260
2261 - A frame means consider all windows on that frame only.
2262
2263 Anything else means consider all windows on the selected frame
2264 and no others."
2265   (let ((buffer (window-normalize-buffer buffer-or-name))
2266         windows)
2267     (dolist (window (window-list-1 (selected-window) minibuf all-frames))
2268       (when (eq (window-buffer window) buffer)
2269         (setq windows (cons window windows))))
2270     (nreverse windows)))
2271
2272 (defun minibuffer-window-active-p (window)
2273   "Return t if WINDOW is the currently active minibuffer window."
2274   (eq window (active-minibuffer-window)))
2275
2276 (defun count-windows (&optional minibuf)
2277    "Return the number of live windows on the selected frame.
2278 The optional argument MINIBUF specifies whether the minibuffer
2279 window shall be counted.  See `walk-windows' for the precise
2280 meaning of this argument."
2281    (length (window-list-1 nil minibuf)))
2282 \f
2283 ;;; Resizing windows.
2284 (defun window--size-to-pixel (window size &optional horizontal pixelwise round-maybe)
2285   "For WINDOW convert SIZE lines to pixels.
2286 SIZE is supposed to specify a height of WINDOW in terms of text
2287 lines.  The return value is the number of pixels specifying that
2288 height.
2289
2290 WINDOW must be a valid window.  Optional argument HORIZONTAL
2291 non-nil means convert SIZE columns to pixels.
2292
2293 Optional argument PIXELWISE non-nil means SIZE already specifies
2294 pixels but may have to be adjusted to a multiple of the character
2295 size of WINDOW's frame.  Optional argument ROUND-MAYBE non-nil
2296 means round to the nearest multiple of the character size of
2297 WINDOW's frame if the option `window-resize-pixelwise' is nil."
2298   (setq window (window-normalize-window window))
2299   (let ((char-size (frame-char-size window horizontal)))
2300     (if pixelwise
2301         (if (and round-maybe (not window-resize-pixelwise))
2302             (* (round size char-size) char-size)
2303           size)
2304       (* size char-size))))
2305
2306 (defun window--pixel-to-total-1 (window horizontal char-size)
2307   "Subroutine of `window--pixel-to-total'."
2308   (let ((child (window-child window)))
2309     (if (window-combination-p window horizontal)
2310         ;; In an iso-combination distribute sizes proportionally.
2311         (let ((remainder (window-new-total window))
2312               size best-child rem best-rem)
2313           ;; Initialize total sizes to each child's floor.
2314           (while child
2315             (setq size (max (/ (window-size child horizontal t) char-size) 1))
2316             (set-window-new-total child size)
2317             (setq remainder (- remainder size))
2318             (setq child (window-next-sibling child)))
2319           ;; Distribute remainder.
2320           (while (> remainder 0)
2321             (setq child (window-last-child window))
2322             (setq best-child nil)
2323             (setq best-rem 0)
2324             (while child
2325               (when (and (<= (window-new-total child)
2326                              (/ (window-size child horizontal t) char-size))
2327                          (> (setq rem (% (window-size child horizontal t)
2328                                          char-size))
2329                             best-rem))
2330                    (setq best-child child)
2331                    (setq best-rem rem))
2332               (setq child (window-prev-sibling child)))
2333             ;; We MUST have a best-child here.
2334             (set-window-new-total best-child 1 t)
2335             (setq remainder (1- remainder)))
2336           ;; Recurse.
2337           (setq child (window-child window))
2338           (while child
2339             (window--pixel-to-total-1 child horizontal char-size)
2340             (setq child (window-next-sibling child))))
2341       ;; In an ortho-combination assign new sizes directly.
2342       (let ((size (window-new-total window)))
2343         (while child
2344           (set-window-new-total child size)
2345           (window--pixel-to-total-1 child horizontal char-size)
2346           (setq child (window-next-sibling child)))))))
2347
2348 (defun window--pixel-to-total (&optional frame horizontal)
2349   "On FRAME assign new total window heights from pixel heights.
2350 FRAME must be a live frame and defaults to the selected frame.
2351
2352 Optional argument HORIZONTAL non-nil means assign new total
2353 window widths from pixel widths."
2354   (setq frame (window-normalize-frame frame))
2355   (let* ((char-size (frame-char-size frame horizontal))
2356          (root (frame-root-window frame))
2357          (root-size (window-size root horizontal t))
2358          ;; We have to care about the minibuffer window only if it
2359          ;; appears together with the root window on this frame.
2360          (mini (let ((mini (minibuffer-window frame)))
2361                  (and (eq (window-frame mini) frame)
2362                       (not (eq mini root)) mini)))
2363          (mini-size (and mini (window-size mini horizontal t))))
2364     ;; We round the line/column sizes of windows here to the nearest
2365     ;; integer.  In some cases this can make windows appear _larger_
2366     ;; than the containing frame (line/column-wise) because the latter's
2367     ;; sizes are not (yet) rounded.  We might eventually fix that.
2368     (if (and mini (not horizontal))
2369         (let (lines)
2370           (set-window-new-total root (max (/ root-size char-size) 1))
2371           (set-window-new-total mini (max (/ mini-size char-size) 1))
2372           (setq lines (- (round (+ root-size mini-size) char-size)
2373                          (+ (window-new-total root) (window-new-total mini))))
2374           (while (> lines 0)
2375             (if (>= (% root-size (window-new-total root))
2376                     (% mini-size (window-new-total mini)))
2377                 (set-window-new-total root 1 t)
2378               (set-window-new-total mini 1 t))
2379             (setq lines (1- lines))))
2380       (set-window-new-total root (round root-size char-size))
2381       (when mini
2382         ;; This is taken in the horizontal case only.
2383         (set-window-new-total mini (round mini-size char-size))))
2384     (unless (window-buffer root)
2385       (window--pixel-to-total-1 root horizontal char-size))
2386     ;; Apply the new sizes.
2387     (window-resize-apply-total frame horizontal)))
2388
2389 (defun window--resize-reset (&optional frame horizontal)
2390   "Reset resize values for all windows on FRAME.
2391 FRAME defaults to the selected frame.
2392
2393 This function stores the current value of `window-size' applied
2394 with argument HORIZONTAL in the new total size of all windows on
2395 FRAME.  It also resets the new normal size of each of these
2396 windows."
2397   (window--resize-reset-1
2398    (frame-root-window (window-normalize-frame frame)) horizontal))
2399
2400 (defun window--resize-reset-1 (window horizontal)
2401   "Internal function of `window--resize-reset'."
2402   ;; Register old size in the new total size.
2403   (set-window-new-pixel window (window-size window horizontal t))
2404   (set-window-new-total window (window-size window horizontal))
2405   ;; Reset new normal size.
2406   (set-window-new-normal window)
2407   (when (window-child window)
2408     (window--resize-reset-1 (window-child window) horizontal))
2409   (when (window-right window)
2410     (window--resize-reset-1 (window-right window) horizontal)))
2411
2412 ;; The following routine is used to manually resize the minibuffer
2413 ;; window and is currently used, for example, by ispell.el.
2414 (defun window--resize-mini-window (window delta)
2415   "Resize minibuffer window WINDOW by DELTA pixels.
2416 If WINDOW cannot be resized by DELTA pixels make it as large (or
2417 as small) as possible, but don't signal an error."
2418   (when (window-minibuffer-p window)
2419     (let* ((frame (window-frame window))
2420            (root (frame-root-window frame))
2421            (height (window-pixel-height window))
2422            (min-delta
2423             (- (window-pixel-height root)
2424                (window-min-size root nil nil t))))
2425       ;; Sanitize DELTA.
2426       (cond
2427        ((<= (+ height delta) 0)
2428         (setq delta (- (frame-char-height (window-frame window)) height)))
2429        ((> delta min-delta)
2430         (setq delta min-delta)))
2431
2432       (unless (zerop delta)
2433         ;; Resize now.
2434         (window--resize-reset frame)
2435         ;; Ideally we should be able to resize just the last child of root
2436         ;; here.  See the comment in `resize-root-window-vertically' for
2437         ;; why we do not do that.
2438         (window--resize-this-window root (- delta) nil nil t)
2439         (set-window-new-pixel window (+ height delta))
2440         ;; The following routine catches the case where we want to resize
2441         ;; a minibuffer-only frame.
2442         (when (resize-mini-window-internal window)
2443           (window--pixel-to-total frame)
2444           (run-window-configuration-change-hook frame))))))
2445
2446 (defun window--resize-apply-p (frame &optional horizontal)
2447   "Return t when a window on FRAME shall be resized vertically.
2448 Optional argument HORIZONTAL non-nil means return t when a window
2449 shall be resized horizontally."
2450 (catch 'apply
2451     (walk-window-tree
2452      (lambda (window)
2453        (unless (= (window-new-pixel window)
2454                   (window-size window horizontal t))
2455          (throw 'apply t)))
2456      frame t)
2457     nil))
2458
2459 (defun window-resize (window delta &optional horizontal ignore pixelwise)
2460   "Resize WINDOW vertically by DELTA lines.
2461 WINDOW can be an arbitrary window and defaults to the selected
2462 one.  An attempt to resize the root window of a frame will raise
2463 an error though.
2464
2465 DELTA a positive number means WINDOW shall be enlarged by DELTA
2466 lines.  DELTA negative means WINDOW shall be shrunk by -DELTA
2467 lines.
2468
2469 Optional argument HORIZONTAL non-nil means resize WINDOW
2470 horizontally by DELTA columns.  In this case a positive DELTA
2471 means enlarge WINDOW by DELTA columns.  DELTA negative means
2472 WINDOW shall be shrunk by -DELTA columns.
2473
2474 Optional argument IGNORE, if non-nil, means to ignore restraints
2475 induced by fixed size windows or the values of the variables
2476 `window-min-height' and `window-min-width'.  The following values
2477 have special meanings: `safe' means that in addition live windows
2478 are allowed to get as small as `window-safe-min-height' lines and
2479 `window-safe-min-width' columns.  `preserved' means to ignore
2480 only restrictions induced by `window-preserve-size'.  If IGNORE
2481 is a window, then ignore restrictions for that window only.
2482
2483 Optional argument PIXELWISE non-nil means resize WINDOW by DELTA
2484 pixels.
2485
2486 This function resizes other windows proportionally and never
2487 deletes any windows.  If you want to move only the low (right)
2488 edge of WINDOW consider using `adjust-window-trailing-edge'
2489 instead."
2490   (setq window (window-normalize-window window))
2491   (let* ((frame (window-frame window))
2492          (minibuffer-window (minibuffer-window frame))
2493          sibling)
2494     (setq delta (window--size-to-pixel
2495                  window delta horizontal pixelwise t))
2496     (cond
2497      ((eq window (frame-root-window frame))
2498       (error "Cannot resize the root window of a frame"))
2499      ((window-minibuffer-p window)
2500       (if horizontal
2501           (error "Cannot resize minibuffer window horizontally")
2502         (window--resize-mini-window window delta)))
2503      ((and (not horizontal)
2504            (window-full-height-p window)
2505            (eq (window-frame minibuffer-window) frame)
2506            (or (not resize-mini-windows)
2507                (eq minibuffer-window (active-minibuffer-window))))
2508       ;; If WINDOW is full height and either `resize-mini-windows' is
2509       ;; nil or the minibuffer window is active, resize the minibuffer
2510       ;; window.
2511       (window--resize-mini-window minibuffer-window (- delta)))
2512      ((or (window--resizable-p
2513            window delta horizontal ignore nil nil nil t)
2514           (and (not ignore)
2515                (setq ignore 'preserved)
2516                (window--resizable-p
2517                 window delta horizontal ignore nil nil nil t)))
2518       (window--resize-reset frame horizontal)
2519       (window--resize-this-window window delta horizontal ignore t)
2520       (if (and (not window-combination-resize)
2521                (window-combined-p window horizontal)
2522                (setq sibling (or (window-right window) (window-left window)))
2523                (window-sizable-p
2524                 sibling (- delta) horizontal ignore t))
2525           ;; If window-combination-resize is nil, WINDOW is part of an
2526           ;; iso-combination, and WINDOW's neighboring right or left
2527           ;; sibling can be resized as requested, resize that sibling.
2528           (let ((normal-delta
2529                  (/ (float delta)
2530                     (window-size (window-parent window) horizontal t))))
2531             (window--resize-this-window sibling (- delta) horizontal nil t)
2532             (set-window-new-normal
2533              window (+ (window-normal-size window horizontal)
2534                        normal-delta))
2535             (set-window-new-normal
2536              sibling (- (window-normal-size sibling horizontal)
2537                         normal-delta)))
2538         ;; Otherwise, resize all other windows in the same combination.
2539         (window--resize-siblings window delta horizontal ignore))
2540       (when (window--resize-apply-p frame horizontal)
2541         (if (window-resize-apply frame horizontal)
2542             (progn
2543               (window--pixel-to-total frame horizontal)
2544               (run-window-configuration-change-hook frame))
2545           (error "Failed to apply resizing %s" window))))
2546      (t
2547       (error "Cannot resize window %s" window)))))
2548
2549 (defun window-resize-no-error (window delta &optional horizontal ignore pixelwise)
2550   "Resize WINDOW vertically if it is resizable by DELTA lines.
2551 This function is like `window-resize' but does not signal an
2552 error when WINDOW cannot be resized.  For the meaning of the
2553 optional arguments see the documentation of `window-resize'.
2554
2555 Optional argument PIXELWISE non-nil means interpret DELTA as
2556 pixels."
2557   (when (window--resizable-p
2558          window delta horizontal ignore nil nil nil pixelwise)
2559     (window-resize window delta horizontal ignore pixelwise)))
2560
2561 (defun window--resize-child-windows-skip-p (window)
2562   "Return non-nil if WINDOW shall be skipped by resizing routines."
2563   (memq (window-new-normal window) '(ignore stuck skip)))
2564
2565 (defun window--resize-child-windows-normal (parent horizontal window this-delta &optional trail other-delta)
2566   "Recursively set new normal height of child windows of window PARENT.
2567 HORIZONTAL non-nil means set the new normal width of these
2568 windows.  WINDOW specifies a child window of PARENT that has been
2569 resized by THIS-DELTA lines (columns).
2570
2571 Optional argument TRAIL either `before' or `after' means set values
2572 only for windows before or after WINDOW.  Optional argument
2573 OTHER-DELTA, a number, specifies that this many lines (columns)
2574 have been obtained from (or returned to) an ancestor window of
2575 PARENT in order to resize WINDOW."
2576   (let* ((delta-normal
2577           (if (and (= (- this-delta)
2578                       (window-size window horizontal t))
2579                    (zerop other-delta))
2580               ;; When WINDOW gets deleted and we can return its entire
2581               ;; space to its siblings, use WINDOW's normal size as the
2582               ;; normal delta.
2583               (- (window-normal-size window horizontal))
2584             ;; In any other case calculate the normal delta from the
2585             ;; relation of THIS-DELTA to the total size of PARENT.
2586             (/ (float this-delta)
2587                (window-size parent horizontal t))))
2588          (sub (window-child parent))
2589          (parent-normal 0.0)
2590          (skip (eq trail 'after)))
2591
2592     ;; Set parent-normal to the sum of the normal sizes of all child
2593     ;; windows of PARENT that shall be resized, excluding only WINDOW
2594     ;; and any windows specified by the optional TRAIL argument.
2595     (while sub
2596       (cond
2597        ((eq sub window)
2598         (setq skip (eq trail 'before)))
2599        (skip)
2600        (t
2601         (setq parent-normal
2602               (+ parent-normal (window-normal-size sub horizontal)))))
2603       (setq sub (window-right sub)))
2604
2605     ;; Set the new normal size of all child windows of PARENT from what
2606     ;; they should have contributed for recovering THIS-DELTA lines
2607     ;; (columns).
2608     (setq sub (window-child parent))
2609     (setq skip (eq trail 'after))
2610     (while sub
2611       (cond
2612        ((eq sub window)
2613         (setq skip (eq trail 'before)))
2614        (skip)
2615        (t
2616         (let ((old-normal (window-normal-size sub horizontal)))
2617           (set-window-new-normal
2618            sub (min 1.0 ; Don't get larger than 1.
2619                     (max (- old-normal
2620                             (* (/ old-normal parent-normal)
2621                                delta-normal))
2622                          ;; Don't drop below 0.
2623                          0.0))))))
2624       (setq sub (window-right sub)))
2625
2626     (when (numberp other-delta)
2627       ;; Set the new normal size of windows from what they should have
2628       ;; contributed for recovering OTHER-DELTA lines (columns).
2629       (setq delta-normal (/ (float (window-size parent horizontal t))
2630                             (+ (window-size parent horizontal t)
2631                                other-delta)))
2632       (setq sub (window-child parent))
2633       (setq skip (eq trail 'after))
2634       (while sub
2635         (cond
2636          ((eq sub window)
2637           (setq skip (eq trail 'before)))
2638          (skip)
2639          (t
2640           (set-window-new-normal
2641            sub (min 1.0 ; Don't get larger than 1.
2642                     (max (* (window-new-normal sub) delta-normal)
2643                          ;; Don't drop below 0.
2644                          0.0)))))
2645         (setq sub (window-right sub))))
2646
2647     ;; Set the new normal size of WINDOW to what is left by the sum of
2648     ;; the normal sizes of its siblings.
2649     (set-window-new-normal
2650      window
2651      (let ((sum 0))
2652        (setq sub (window-child parent))
2653        (while sub
2654          (cond
2655           ((eq sub window))
2656           ((not (numberp (window-new-normal sub)))
2657            (setq sum (+ sum (window-normal-size sub horizontal))))
2658           (t
2659            (setq sum (+ sum (window-new-normal sub)))))
2660          (setq sub (window-right sub)))
2661        ;; Don't get larger than 1 or smaller than 0.
2662        (min 1.0 (max (- 1.0 sum) 0.0))))))
2663
2664 (defun window--resize-child-windows (parent delta &optional horizontal window ignore trail edge char-size)
2665   "Resize child windows of window PARENT vertically by DELTA pixels.
2666 PARENT must be a vertically combined internal window.
2667
2668 Optional argument HORIZONTAL non-nil means resize child windows
2669 of PARENT horizontally by DELTA pixels.  In this case PARENT must
2670 be a horizontally combined internal window.
2671
2672 WINDOW, if specified, must denote a child window of PARENT that
2673 is resized by DELTA pixels.
2674
2675 The optional argument IGNORE has the same meaning as for
2676 `window-resizable'.
2677
2678 Optional arguments TRAIL and EDGE, when non-nil, restrict the set
2679 of windows that shall be resized.  If TRAIL equals `before',
2680 resize only windows on the left or above EDGE.  If TRAIL equals
2681 `after', resize only windows on the right or below EDGE.  Also,
2682 preferably only resize windows adjacent to EDGE.
2683
2684 If the optional argument CHAR-SIZE is a positive integer, it specifies
2685 the number of pixels by which windows are incrementally resized.
2686 If CHAR-SIZE is nil, this means to use the value of
2687 `frame-char-height' or `frame-char-width' of WINDOW's frame.
2688
2689 Return the symbol `normalized' if new normal sizes have been
2690 already set by this routine."
2691   (let* ((first (window-child parent))
2692          (last (window-last-child parent))
2693          (parent-total (+ (window-size parent horizontal t)
2694                           delta))
2695          (char-size (or char-size
2696                         (and window-resize-pixelwise 1)
2697                         (frame-char-size window horizontal)))
2698          sub best-window best-value best-delta)
2699
2700     (if (and edge (memq trail '(before after))
2701              (progn
2702                (setq sub first)
2703                (while (and (window-right sub)
2704                            (or (and (eq trail 'before)
2705                                     (not (window--resize-child-windows-skip-p
2706                                           (window-right sub))))
2707                                (and (eq trail 'after)
2708                                     (window--resize-child-windows-skip-p sub))))
2709                  (setq sub (window-right sub)))
2710                sub)
2711              (if horizontal
2712                  (if (eq trail 'before)
2713                      (= (+ (window-pixel-left sub) (window-pixel-width sub))
2714                         edge)
2715                    (= (window-pixel-left sub) edge))
2716                (if (eq trail 'before)
2717                    (= (+ (window-pixel-top sub) (window-pixel-height sub))
2718                       edge)
2719                  (= (window-pixel-top sub) edge)))
2720              (window-sizable-p sub delta horizontal ignore t))
2721         ;; Resize only windows adjacent to EDGE.
2722         (progn
2723           (window--resize-this-window
2724            sub delta horizontal ignore t trail edge)
2725           (if (and window (eq (window-parent sub) parent))
2726               (progn
2727                 ;; Assign new normal sizes.
2728                 (set-window-new-normal
2729                  sub (/ (float (window-new-pixel sub)) parent-total))
2730                 (set-window-new-normal
2731                  window (- (window-normal-size window horizontal)
2732                            (- (window-new-normal sub)
2733                               (window-normal-size sub horizontal)))))
2734             (window--resize-child-windows-normal
2735              parent horizontal sub 0 trail delta))
2736           ;; Return 'normalized to notify `window--resize-siblings' that
2737           ;; normal sizes have been already set.
2738           'normalized)
2739       ;; Resize all windows proportionally.
2740       (setq sub last)
2741       (while sub
2742         (cond
2743          ((or (window--resize-child-windows-skip-p sub)
2744               ;; Ignore windows to skip and fixed-size child windows -
2745               ;; in the latter case make it a window to skip.
2746               (and (not ignore)
2747                    (window-size-fixed-p sub horizontal ignore)
2748                    (set-window-new-normal sub 'ignore))))
2749          ((< delta 0)
2750           ;; When shrinking store the number of lines/cols we can get
2751           ;; from this window here together with the total/normal size
2752           ;; factor.
2753           (set-window-new-normal
2754            sub
2755            (cons
2756             ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
2757             (window-min-delta sub horizontal ignore trail t nil t)
2758             (- (/ (float (window-size sub horizontal t))
2759                   parent-total)
2760                (window-normal-size sub horizontal)))))
2761          ((> delta 0)
2762           ;; When enlarging store the total/normal size factor only
2763           (set-window-new-normal
2764            sub
2765            (- (/ (float (window-size sub horizontal t))
2766                  parent-total)
2767               (window-normal-size sub horizontal)))))
2768
2769         (setq sub (window-left sub)))
2770
2771       (cond
2772        ((< delta 0)
2773         ;; Shrink windows by delta.
2774         (setq best-window t)
2775         (while (and best-window (not (zerop delta)))
2776           (setq sub last)
2777           (setq best-window nil)
2778           (setq best-value most-negative-fixnum)
2779           (while sub
2780             (when (and (consp (window-new-normal sub))
2781                        (not (<= (car (window-new-normal sub)) 0))
2782                        (> (cdr (window-new-normal sub)) best-value))
2783               (setq best-window sub)
2784               (setq best-value (cdr (window-new-normal sub))))
2785
2786             (setq sub (window-left sub)))
2787
2788           (when best-window
2789             (setq best-delta (min (car (window-new-normal best-window))
2790                                   char-size (- delta)))
2791             (setq delta (+ delta best-delta))
2792             (set-window-new-pixel best-window (- best-delta) t)
2793             (set-window-new-normal
2794              best-window
2795              (if (= (car (window-new-normal best-window)) best-delta)
2796                  'skip      ; We can't shrink best-window any further.
2797                (cons (- (car (window-new-normal best-window)) best-delta)
2798                      (- (/ (float (window-new-pixel best-window))
2799                            parent-total)
2800                         (window-normal-size best-window horizontal))))))))
2801        ((> delta 0)
2802         ;; Enlarge windows by delta.
2803         (setq best-window t)
2804         (while (and best-window (not (zerop delta)))
2805           (setq sub last)
2806           (setq best-window nil)
2807           (setq best-value most-positive-fixnum)
2808           (while sub
2809             (when (and (numberp (window-new-normal sub))
2810                        (< (window-new-normal sub) best-value))
2811               (setq best-window sub)
2812               (setq best-value (window-new-normal sub)))
2813
2814             (setq sub (window-left sub)))
2815
2816           (when best-window
2817             (setq best-delta (min delta char-size))
2818             (setq delta (- delta best-delta))
2819             (set-window-new-pixel best-window best-delta t)
2820             (set-window-new-normal
2821              best-window
2822              (- (/ (float (window-new-pixel best-window))
2823                    parent-total)
2824                 (window-normal-size best-window horizontal)))))))
2825
2826       (when best-window
2827         (setq sub last)
2828         (while sub
2829           (when (or (consp (window-new-normal sub))
2830                     (numberp (window-new-normal sub)))
2831             ;; Reset new normal size fields so `window-resize-apply'
2832             ;; won't use them to apply new sizes.
2833             (set-window-new-normal sub))
2834
2835           (unless (eq (window-new-normal sub) 'ignore)
2836             ;; Resize this window's child windows (back-engineering
2837             ;; delta from sub's old and new total sizes).
2838             (let ((delta (- (window-new-pixel sub)
2839                             (window-size sub horizontal t))))
2840               (unless (and (zerop delta) (not trail))
2841                 ;; For the TRAIL non-nil case we have to resize SUB
2842                 ;; recursively even if it's size does not change.
2843                 (window--resize-this-window
2844                  sub delta horizontal ignore nil trail edge))))
2845           (setq sub (window-left sub)))))))
2846
2847 (defun window--resize-siblings (window delta &optional horizontal ignore trail edge char-size)
2848   "Resize other windows when WINDOW is resized vertically by DELTA pixels.
2849 Optional argument HORIZONTAL non-nil means resize other windows
2850 when WINDOW is resized horizontally by DELTA pixels.  WINDOW
2851 itself is not resized by this function.
2852
2853 The optional argument IGNORE has the same meaning as for
2854 `window-resizable'.
2855
2856 Optional arguments TRAIL and EDGE, when non-nil, refine the set
2857 of windows that shall be resized.  If TRAIL equals `before',
2858 resize only windows on the left or above EDGE.  If TRAIL equals
2859 `after', resize only windows on the right or below EDGE.  Also,
2860 preferably only resize windows adjacent to EDGE."
2861   (when (window-parent window)
2862     (let* ((parent (window-parent window))
2863            (sub (window-child parent)))
2864       (if (window-combined-p sub horizontal)
2865           ;; In an iso-combination try to extract DELTA from WINDOW's
2866           ;; siblings.
2867           (let ((skip (eq trail 'after))
2868                 this-delta other-delta)
2869             ;; Decide which windows shall be left alone.
2870             (while sub
2871               (cond
2872                ((eq sub window)
2873                 ;; Make sure WINDOW is left alone when
2874                 ;; resizing its siblings.
2875                 (set-window-new-normal sub 'ignore)
2876                 (setq skip (eq trail 'before)))
2877                (skip
2878                 ;; Make sure this sibling is left alone when
2879                 ;; resizing its siblings.
2880                 (set-window-new-normal sub 'ignore))
2881                ((not (window-size-fixed-p sub horizontal ignore))
2882                 ;; Set this-delta to t to signal that we found a sibling
2883                 ;; of WINDOW whose size is not fixed.
2884                 (setq this-delta t)))
2885
2886               (setq sub (window-right sub)))
2887
2888             ;; Set this-delta to what we can get from WINDOW's siblings.
2889             (if (= (- delta) (window-size window horizontal t))
2890                 ;; A deletion, presumably.  We must handle this case
2891                 ;; specially since `window--resizable' can't be used.
2892                 (if this-delta
2893                     ;; There's at least one resizable sibling we can
2894                     ;; give WINDOW's size to.
2895                     (setq this-delta delta)
2896                   ;; No resizable sibling exists.
2897                   (setq this-delta 0))
2898               ;; Any other form of resizing.
2899               (setq this-delta
2900                     (window--resizable
2901                      window delta horizontal ignore trail t nil t)))
2902
2903             ;; Set other-delta to what we still have to get from
2904             ;; ancestor windows of parent.
2905             (setq other-delta (- delta this-delta))
2906             (unless (zerop other-delta)
2907               ;; Unless we got everything from WINDOW's siblings, PARENT
2908               ;; must be resized by other-delta lines or columns.
2909               (set-window-new-pixel parent other-delta 'add))
2910
2911             (if (zerop this-delta)
2912                 ;; We haven't got anything from WINDOW's siblings but we
2913                 ;; must update the normal sizes to respect other-delta.
2914                 (window--resize-child-windows-normal
2915                  parent horizontal window this-delta trail other-delta)
2916               ;; We did get something from WINDOW's siblings which means
2917               ;; we have to resize their child windows.
2918               (unless (eq (window--resize-child-windows
2919                            parent (- this-delta) horizontal
2920                            window ignore trail edge char-size)
2921                           ;; If `window--resize-child-windows' returns
2922                           ;; 'normalized, this means it has set the
2923                           ;; normal sizes already.
2924                           'normalized)
2925                 ;; Set the normal sizes.
2926                 (window--resize-child-windows-normal
2927                  parent horizontal window this-delta trail other-delta))
2928               ;; Set DELTA to what we still have to get from ancestor
2929               ;; windows.
2930               (setq delta other-delta)))
2931
2932         ;; In an ortho-combination all siblings of WINDOW must be
2933         ;; resized by DELTA.
2934         (set-window-new-pixel parent delta 'add)
2935         (while sub
2936           (unless (eq sub window)
2937             (window--resize-this-window
2938              sub delta horizontal ignore t))
2939           (setq sub (window-right sub))))
2940
2941       (unless (zerop delta)
2942         ;; "Go up."
2943         (window--resize-siblings
2944          parent delta horizontal ignore trail edge char-size)))))
2945
2946 (defun window--resize-this-window (window delta &optional horizontal ignore add trail edge char-size)
2947   "Resize WINDOW vertically by DELTA pixels.
2948 Optional argument HORIZONTAL non-nil means resize WINDOW
2949 horizontally by DELTA pixels.
2950
2951 The optional argument IGNORE has the same meaning as for
2952 `window-resizable'.  Optional argument ADD non-nil means add
2953 DELTA to the new total size of WINDOW.
2954
2955 Optional arguments TRAIL and EDGE, when non-nil, refine the set
2956 of windows that shall be resized.  If TRAIL equals `before',
2957 resize only windows on the left or above EDGE.  If TRAIL equals
2958 `after', resize only windows on the right or below EDGE.  Also,
2959 preferably only resize windows adjacent to EDGE.
2960
2961 If the optional argument CHAR-SIZE is a positive integer, it specifies
2962 the number of pixels by which windows are incrementally resized.
2963 If CHAR-SIZE is nil, this means to use the value of
2964 `frame-char-height' or `frame-char-width' of WINDOW's frame.
2965
2966 This function recursively resizes WINDOW's child windows to fit the
2967 new size.  Make sure that WINDOW is `window--resizable' before
2968 calling this function.  Note that this function does not resize
2969 siblings of WINDOW or WINDOW's parent window.  You have to
2970 eventually call `window-resize-apply' in order to make resizing
2971 actually take effect."
2972   (when add
2973     ;; Add DELTA to the new total size of WINDOW.
2974     (set-window-new-pixel window delta t))
2975
2976   (let ((sub (window-child window)))
2977     (cond
2978      ((not sub))
2979      ((window-combined-p sub horizontal)
2980       ;; In an iso-combination resize child windows according to their
2981       ;; normal sizes.
2982       (window--resize-child-windows
2983        window delta horizontal nil ignore trail edge char-size))
2984      ;; In an ortho-combination resize each child window by DELTA.
2985      (t
2986       (while sub
2987         (window--resize-this-window
2988          sub delta horizontal ignore t trail edge char-size)
2989         (setq sub (window-right sub)))))))
2990
2991 (defun window--resize-root-window (window delta horizontal ignore pixelwise)
2992   "Resize root window WINDOW vertically by DELTA lines.
2993 HORIZONTAL non-nil means resize root window WINDOW horizontally
2994 by DELTA columns.
2995
2996 IGNORE non-nil means ignore any restrictions imposed by fixed
2997 size windows, `window-min-height' or `window-min-width' settings.
2998
2999 This function is only called by the frame resizing routines.  It
3000 resizes windows proportionally and never deletes any windows."
3001   (when (and (windowp window) (numberp delta))
3002     (let ((pixel-delta
3003            (if pixelwise
3004                delta
3005              (window--size-to-pixel window delta horizontal))))
3006       (when (window-sizable-p window pixel-delta horizontal ignore t)
3007         (window--resize-reset (window-frame window) horizontal)
3008         (window--resize-this-window
3009          window pixel-delta horizontal ignore t)))))
3010
3011 (defun window--resize-root-window-vertically (window delta pixelwise)
3012   "Resize root window WINDOW vertically by DELTA lines.
3013 If DELTA is less than zero and we can't shrink WINDOW by DELTA
3014 lines, shrink it as much as possible.  If DELTA is greater than
3015 zero, this function can resize fixed-size windows in order to
3016 recover the necessary lines.  Return the number of lines that
3017 were recovered.
3018
3019 Third argument PIXELWISE non-nil means to interpret DELTA as
3020 pixels and return the number of pixels that were recovered.
3021
3022 This function is called by the minibuffer window resizing
3023 routines."
3024   (let* ((frame (window-frame window))
3025          (pixel-delta
3026           (cond
3027            (pixelwise
3028             delta)
3029            ((numberp delta)
3030             (* (frame-char-height frame) delta))
3031            (t 0)))
3032          ignore)
3033     (cond
3034      ((zerop pixel-delta))
3035      ((< pixel-delta 0)
3036       (setq pixel-delta (window-sizable window pixel-delta nil nil pixelwise))
3037       (window--resize-reset frame)
3038       ;; When shrinking the root window, emulate an edge drag in order
3039       ;; to not resize other windows if we can avoid it (Bug#12419).
3040       (window--resize-this-window
3041        window pixel-delta nil ignore t 'before
3042        (+ (window-pixel-top window) (window-pixel-height window)))
3043       ;; Don't record new normal sizes to make sure that shrinking back
3044       ;; proportionally works as intended.
3045       (walk-window-tree
3046        (lambda (window) (set-window-new-normal window 'ignore)) frame t))
3047      ((> pixel-delta 0)
3048       (window--resize-reset frame)
3049       (unless (window-sizable window pixel-delta nil nil pixelwise)
3050         (setq ignore t))
3051       ;; When growing the root window, resize proportionally.  This
3052       ;; should give windows back their original sizes (hopefully).
3053       (window--resize-this-window
3054        window pixel-delta nil ignore t)))
3055      ;; Return the possibly adjusted DELTA.
3056      (if pixelwise
3057          pixel-delta
3058        (/ pixel-delta (frame-char-height frame)))))
3059
3060 (defun window--sanitize-window-sizes (frame horizontal)
3061   "Assert that all windows on FRAME are large enough.
3062 If necessary and possible, make sure that every window on frame
3063 FRAME has its minimum height.  Optional argument HORIZONTAL
3064 non-nil means to make sure that every window on frame FRAME has
3065 its minimum width.  The minimum height/width of a window is the
3066 respective value returned by `window-min-size' for that window.
3067
3068 Return t if all windows were resized appropriately.  Return nil
3069 if at least one window could not be resized as requested, which
3070 may happen when the FRAME is not large enough to accommodate it."
3071   (let ((value t))
3072     (walk-window-tree
3073      (lambda (window)
3074        (let  ((delta (- (window-min-size window horizontal nil t)
3075                         (window-size window horizontal t))))
3076          (when (> delta 0)
3077            (if (window-resizable-p window delta horizontal nil t)
3078                (window-resize window delta horizontal nil t)
3079              (setq value nil))))))
3080     value))
3081
3082 (defun adjust-window-trailing-edge (window delta &optional horizontal pixelwise)
3083   "Move WINDOW's bottom edge by DELTA lines.
3084 Optional argument HORIZONTAL non-nil means move WINDOW's right
3085 edge by DELTA columns.  WINDOW must be a valid window and
3086 defaults to the selected one.
3087
3088 Optional argument PIXELWISE non-nil means interpret DELTA as
3089 number of pixels.
3090
3091 If DELTA is greater than zero, move the edge downwards or to the
3092 right.  If DELTA is less than zero, move the edge upwards or to
3093 the left.  If the edge can't be moved by DELTA lines or columns,
3094 move it as far as possible in the desired direction."
3095   (setq window (window-normalize-window window))
3096   (let* ((frame (window-frame window))
3097          (minibuffer-window (minibuffer-window frame))
3098          (right window)
3099          left this-delta min-delta max-delta ignore)
3100
3101     (unless pixelwise
3102       (setq pixelwise t)
3103       (setq delta (* delta (frame-char-size window horizontal))))
3104
3105     ;; Find the edge we want to move.
3106     (while (and (or (not (window-combined-p right horizontal))
3107                     (not (window-right right)))
3108                 (setq right (window-parent right))))
3109     (cond
3110      ((and (not right) (not horizontal)
3111            ;; Resize the minibuffer window if it's on the same frame as
3112            ;; and immediately below WINDOW and it's either active or
3113            ;; `resize-mini-windows' is nil.
3114            (eq (window-frame minibuffer-window) frame)
3115            (= (nth 1 (window-pixel-edges minibuffer-window))
3116               (nth 3 (window-pixel-edges window)))
3117            (or (not resize-mini-windows)
3118                (eq minibuffer-window (active-minibuffer-window))))
3119       (window--resize-mini-window minibuffer-window (- delta)))
3120      ((or (not (setq left right)) (not (setq right (window-right right))))
3121       (if horizontal
3122           (user-error "No window on the right of this one")
3123         (user-error "No window below this one")))
3124      (t
3125       ;; Set LEFT to the first resizable window on the left.  This step is
3126       ;; needed to handle fixed-size windows.
3127       (while (and left
3128                   (or (window-size-fixed-p left horizontal)
3129                       (and (< delta 0)
3130                            (<= (window-size left horizontal t)
3131                                (window-min-size left horizontal nil t)))))
3132         (setq left
3133               (or (window-left left)
3134                   (progn
3135                     (while (and (setq left (window-parent left))
3136                                 (not (window-combined-p left horizontal))))
3137                     (window-left left)))))
3138       (unless left
3139         (setq ignore 'preserved)
3140         (setq left window)
3141         (while (and left
3142                     (or (window-size-fixed-p left horizontal 'preserved)
3143                         (<= (window-size left horizontal t)
3144                             (window-min-size left horizontal 'preserved t))))
3145           (setq left
3146                 (or (window-left left)
3147                     (progn
3148                       (while (and (setq left (window-parent left))
3149                                   (not (window-combined-p left horizontal))))
3150                       (window-left left)))))
3151
3152         (unless left
3153           (if horizontal
3154               (user-error "No resizable window on the left of this one")
3155             (user-error "No resizable window above this one"))))
3156
3157       ;; Set RIGHT to the first resizable window on the right.  This step
3158       ;; is needed to handle fixed-size windows.
3159       (while (and right
3160                   (or (window-size-fixed-p right horizontal)
3161                       (and (> delta 0)
3162                            (<= (window-size right horizontal t)
3163                                (window-min-size right horizontal 'preserved t)))))
3164         (setq right
3165               (or (window-right right)
3166                   (progn
3167                     (while (and (setq right (window-parent right))
3168                                 (not (window-combined-p right horizontal))))
3169                     (window-right right)))))
3170       (unless right
3171         (setq ignore 'preserved)
3172         (setq right (window-right window))
3173         (while (and right
3174                     (or (window-size-fixed-p right horizontal 'preserved))
3175                     (<= (window-size right horizontal t)
3176                         (window-min-size right horizontal nil t)))
3177           (setq right
3178                 (or (window-right right)
3179                     (progn
3180                       (while (and (setq right (window-parent right))
3181                                   (not (window-combined-p right horizontal))))
3182                       (window-right right)))))
3183         (unless right
3184           (if horizontal
3185               (user-error "No resizable window on the right of this one")
3186             (user-error "No resizable window below this one"))))
3187
3188       ;; LEFT and RIGHT (which might be both internal windows) are now the
3189       ;; two windows we want to resize.
3190       (cond
3191        ((> delta 0)
3192         (setq max-delta
3193               (window--max-delta-1
3194                left 0 horizontal ignore 'after nil pixelwise))
3195         (setq min-delta
3196               (window--min-delta-1
3197                right (- delta) horizontal ignore 'before nil pixelwise))
3198         (when (or (< max-delta delta) (> min-delta (- delta)))
3199           ;; We can't get the whole DELTA - move as far as possible.
3200           (setq delta (min max-delta (- min-delta))))
3201         (unless (zerop delta)
3202           ;; Start resizing.
3203           (window--resize-reset frame horizontal)
3204           ;; Try to enlarge LEFT first.
3205           (setq this-delta (window--resizable
3206                             left delta horizontal ignore 'after nil nil pixelwise))
3207           (unless (zerop this-delta)
3208             (window--resize-this-window
3209              left this-delta horizontal ignore t 'before
3210              (if horizontal
3211                  (+ (window-pixel-left left) (window-pixel-width left))
3212                (+ (window-pixel-top left) (window-pixel-height left)))))
3213           ;; Shrink windows on right of LEFT.
3214           (window--resize-siblings
3215            left delta horizontal ignore 'after
3216            (if horizontal
3217                (window-pixel-left right)
3218              (window-pixel-top right)))))
3219        ((< delta 0)
3220         (setq max-delta
3221               (window--max-delta-1
3222                right 0 horizontal ignore 'before nil pixelwise))
3223         (setq min-delta
3224               (window--min-delta-1
3225                left delta horizontal ignore 'after nil pixelwise))
3226         (when (or (< max-delta (- delta)) (> min-delta delta))
3227           ;; We can't get the whole DELTA - move as far as possible.
3228           (setq delta (max (- max-delta) min-delta)))
3229         (unless (zerop delta)
3230           ;; Start resizing.
3231           (window--resize-reset frame horizontal)
3232           ;; Try to enlarge RIGHT.
3233           (setq this-delta
3234                 (window--resizable
3235                  right (- delta) horizontal ignore 'before nil nil pixelwise))
3236           (unless (zerop this-delta)
3237             (window--resize-this-window
3238              right this-delta horizontal ignore t 'after
3239              (if horizontal
3240                  (window-pixel-left right)
3241                (window-pixel-top right))))
3242           ;; Shrink windows on left of RIGHT.
3243           (window--resize-siblings
3244            right (- delta) horizontal ignore 'before
3245            (if horizontal
3246                (+ (window-pixel-left left) (window-pixel-width left))
3247              (+ (window-pixel-top left) (window-pixel-height left)))))))
3248       (unless (zerop delta)
3249         ;; Don't report an error in the standard case.
3250         (when (window--resize-apply-p frame horizontal)
3251           (if (window-resize-apply frame horizontal)
3252               (progn
3253                 (window--pixel-to-total frame horizontal)
3254                 (run-window-configuration-change-hook frame))
3255             ;; But do report an error if applying the changes fails.
3256             (error "Failed adjusting window %s" window))))))))
3257
3258 (defun enlarge-window (delta &optional horizontal)
3259   "Make the selected window DELTA lines taller.
3260 Interactively, if no argument is given, make the selected window
3261 one line taller.  If optional argument HORIZONTAL is non-nil,
3262 make selected window wider by DELTA columns.  If DELTA is
3263 negative, shrink selected window by -DELTA lines or columns."
3264   (interactive "p")
3265   (let ((minibuffer-window (minibuffer-window)))
3266     (when (window-preserved-size nil horizontal)
3267       (window-preserve-size nil horizontal))
3268     (cond
3269      ((zerop delta))
3270      ((window-size-fixed-p nil horizontal)
3271       (error "Selected window has fixed size"))
3272      ((window-minibuffer-p)
3273       (if horizontal
3274           (error "Cannot resize minibuffer window horizontally")
3275         (window--resize-mini-window (selected-window) delta)))
3276      ((and (not horizontal)
3277            (window-full-height-p)
3278            (eq (window-frame minibuffer-window) (selected-frame))
3279            (not resize-mini-windows))
3280       ;; If the selected window is full height and `resize-mini-windows'
3281       ;; is nil, resize the minibuffer window.
3282       (window--resize-mini-window minibuffer-window (- delta)))
3283      ((window--resizable-p nil delta horizontal)
3284       (window-resize nil delta horizontal))
3285      (t
3286       (window-resize
3287        nil (if (> delta 0)
3288                (window-max-delta nil horizontal)
3289              (- (window-min-delta nil horizontal)))
3290        horizontal)))))
3291
3292 (defun shrink-window (delta &optional horizontal)
3293   "Make the selected window DELTA lines smaller.
3294 Interactively, if no argument is given, make the selected window
3295 one line smaller.  If optional argument HORIZONTAL is non-nil,
3296 make selected window narrower by DELTA columns.  If DELTA is
3297 negative, enlarge selected window by -DELTA lines or columns.
3298 Also see the `window-min-height' variable."
3299   (interactive "p")
3300   (let ((minibuffer-window (minibuffer-window)))
3301     (when (window-preserved-size nil horizontal)
3302       (window-preserve-size nil horizontal))
3303     (cond
3304      ((zerop delta))
3305      ((window-size-fixed-p nil horizontal)
3306       (error "Selected window has fixed size"))
3307      ((window-minibuffer-p)
3308       (if horizontal
3309           (error "Cannot resize minibuffer window horizontally")
3310         (window--resize-mini-window (selected-window) (- delta))))
3311      ((and (not horizontal)
3312            (window-full-height-p)
3313            (eq (window-frame minibuffer-window) (selected-frame))
3314            (not resize-mini-windows))
3315       ;; If the selected window is full height and `resize-mini-windows'
3316       ;; is nil, resize the minibuffer window.
3317       (window--resize-mini-window minibuffer-window delta))
3318      ((window--resizable-p nil (- delta) horizontal)
3319       (window-resize nil (- delta) horizontal))
3320      (t
3321       (window-resize
3322        nil (if (> delta 0)
3323                (- (window-min-delta nil horizontal))
3324              (window-max-delta nil horizontal))
3325        horizontal)))))
3326
3327 (defun maximize-window (&optional window)
3328   "Maximize WINDOW.
3329 Make WINDOW as large as possible without deleting any windows.
3330 WINDOW must be a valid window and defaults to the selected one.
3331
3332 If the option `window-resize-pixelwise' is non-nil maximize
3333 WINDOW pixelwise."
3334   (interactive)
3335   (setq window (window-normalize-window window))
3336   (window-resize
3337    window (window-max-delta window nil nil nil nil nil window-resize-pixelwise)
3338    nil nil window-resize-pixelwise)
3339   (window-resize
3340    window (window-max-delta window t nil nil nil nil window-resize-pixelwise)
3341    t nil window-resize-pixelwise))
3342
3343 (defun minimize-window (&optional window)
3344   "Minimize WINDOW.
3345 Make WINDOW as small as possible without deleting any windows.
3346 WINDOW must be a valid window and defaults to the selected one.
3347
3348 If the option `window-resize-pixelwise' is non-nil minimize
3349 WINDOW pixelwise."
3350   (interactive)
3351   (setq window (window-normalize-window window))
3352   (window-resize
3353    window
3354    (- (window-min-delta window nil nil nil nil nil window-resize-pixelwise))
3355    nil nil window-resize-pixelwise)
3356   (window-resize
3357    window
3358    (- (window-min-delta window t nil nil nil nil window-resize-pixelwise))
3359    t nil window-resize-pixelwise))
3360 \f
3361 (defun frame-root-window-p (window)
3362   "Return non-nil if WINDOW is the root window of its frame."
3363   (eq window (frame-root-window window)))
3364
3365 (defun window--subtree (window &optional next)
3366   "Return window subtree rooted at WINDOW.
3367 Optional argument NEXT non-nil means include WINDOW's right
3368 siblings in the return value.
3369
3370 See the documentation of `window-tree' for a description of the
3371 return value."
3372   (let (list)
3373     (while window
3374       (setq list
3375             (cons
3376              (cond
3377               ((window-top-child window)
3378                (cons t (cons (window-edges window)
3379                              (window--subtree (window-top-child window) t))))
3380               ((window-left-child window)
3381                (cons nil (cons (window-edges window)
3382                                (window--subtree (window-left-child window) t))))
3383               (t window))
3384              list))
3385       (setq window (when next (window-next-sibling window))))
3386     (nreverse list)))
3387
3388 (defun window-tree (&optional frame)
3389   "Return the window tree of frame FRAME.
3390 FRAME must be a live frame and defaults to the selected frame.
3391 The return value is a list of the form (ROOT MINI), where ROOT
3392 represents the window tree of the frame's root window, and MINI
3393 is the frame's minibuffer window.
3394
3395 If the root window is not split, ROOT is the root window itself.
3396 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
3397 for a horizontal split, and t for a vertical split.  EDGES gives
3398 the combined size and position of the child windows in the split,
3399 and the rest of the elements are the child windows in the split.
3400 Each of the child windows may again be a window or a list
3401 representing a window split, and so on.  EDGES is a list (LEFT
3402 TOP RIGHT BOTTOM) as returned by `window-edges'."
3403   (setq frame (window-normalize-frame frame))
3404   (window--subtree (frame-root-window frame) t))
3405 \f
3406 (defun other-window (count &optional all-frames)
3407   "Select another window in cyclic ordering of windows.
3408 COUNT specifies the number of windows to skip, starting with the
3409 selected window, before making the selection.  If COUNT is
3410 positive, skip COUNT windows forwards.  If COUNT is negative,
3411 skip -COUNT windows backwards.  COUNT zero means do not skip any
3412 window, so select the selected window.  In an interactive call,
3413 COUNT is the numeric prefix argument.  Return nil.
3414
3415 If the `other-window' parameter of the selected window is a
3416 function and `ignore-window-parameters' is nil, call that
3417 function with the arguments COUNT and ALL-FRAMES.
3418
3419 This function does not select a window whose `no-other-window'
3420 window parameter is non-nil.
3421
3422 This function uses `next-window' for finding the window to
3423 select.  The argument ALL-FRAMES has the same meaning as in
3424 `next-window', but the MINIBUF argument of `next-window' is
3425 always effectively nil."
3426   (interactive "p")
3427   (let* ((window (selected-window))
3428          (function (and (not ignore-window-parameters)
3429                         (window-parameter window 'other-window)))
3430          old-window old-count)
3431     (if (functionp function)
3432         (funcall function count all-frames)
3433       ;; `next-window' and `previous-window' may return a window we are
3434       ;; not allowed to select.  Hence we need an exit strategy in case
3435       ;; all windows are non-selectable.
3436       (catch 'exit
3437         (while (> count 0)
3438           (setq window (next-window window nil all-frames))
3439           (cond
3440            ((eq window old-window)
3441             (when (= count old-count)
3442               ;; Keep out of infinite loops.  When COUNT has not changed
3443               ;; since we last looked at `window' we're probably in one.
3444               (throw 'exit nil)))
3445            ((window-parameter window 'no-other-window)
3446             (unless old-window
3447               ;; The first non-selectable window `next-window' got us:
3448               ;; Remember it and the current value of COUNT.
3449               (setq old-window window)
3450               (setq old-count count)))
3451            (t
3452             (setq count (1- count)))))
3453         (while (< count 0)
3454           (setq window (previous-window window nil all-frames))
3455           (cond
3456            ((eq window old-window)
3457             (when (= count old-count)
3458               ;; Keep out of infinite loops.  When COUNT has not changed
3459               ;; since we last looked at `window' we're probably in one.
3460               (throw 'exit nil)))
3461            ((window-parameter window 'no-other-window)
3462             (unless old-window
3463               ;; The first non-selectable window `previous-window' got
3464               ;; us: Remember it and the current value of COUNT.
3465               (setq old-window window)
3466               (setq old-count count)))
3467            (t
3468             (setq count (1+ count)))))
3469
3470         (select-window window)
3471         ;; Always return nil.
3472         nil))))
3473
3474 ;; This should probably return non-nil when the selected window is part
3475 ;; of an atomic window whose root is the frame's root window.
3476 (defun one-window-p (&optional nomini all-frames)
3477   "Return non-nil if the selected window is the only window.
3478 Optional arg NOMINI non-nil means don't count the minibuffer
3479 even if it is active.  Otherwise, the minibuffer is counted
3480 when it is active.
3481
3482 Optional argument ALL-FRAMES specifies the set of frames to
3483 consider, see also `next-window'.  ALL-FRAMES nil or omitted
3484 means consider windows on the selected frame only, plus the
3485 minibuffer window if specified by the NOMINI argument.  If the
3486 minibuffer counts, consider all windows on all frames that share
3487 that minibuffer too.  The remaining non-nil values of ALL-FRAMES
3488 with a special meaning are:
3489
3490 - t means consider all windows on all existing frames.
3491
3492 - `visible' means consider all windows on all visible frames on
3493   the current terminal.
3494
3495 - 0 (the number zero) means consider all windows on all visible
3496   and iconified frames on the current terminal.
3497
3498 - A frame means consider all windows on that frame only.
3499
3500 Anything else means consider all windows on the selected frame
3501 and no others."
3502   (let ((base-window (selected-window)))
3503     (if (and nomini (eq base-window (minibuffer-window)))
3504         (setq base-window (next-window base-window)))
3505     (eq base-window
3506         (next-window base-window (if nomini 'arg) all-frames))))
3507 \f
3508 ;;; Deleting windows.
3509 (defun window-deletable-p (&optional window)
3510   "Return t if WINDOW can be safely deleted from its frame.
3511 WINDOW must be a valid window and defaults to the selected one.
3512 Return 'frame if deleting WINDOW should also delete its frame."
3513   (setq window (window-normalize-window window))
3514
3515   (unless (or ignore-window-parameters
3516               (eq (window-parameter window 'delete-window) t))
3517     ;; Handle atomicity.
3518     (when (window-parameter window 'window-atom)
3519       (setq window (window-atom-root window))))
3520
3521   (let ((frame (window-frame window)))
3522     (cond
3523      ((frame-root-window-p window)
3524       ;; WINDOW's frame can be deleted only if there are other frames
3525       ;; on the same terminal, and it does not contain the active
3526       ;; minibuffer.
3527       (unless (or (eq frame (next-frame frame 0))
3528                   ;; We can delete our frame only if no other frame
3529                   ;; currently uses our minibuffer window.
3530                   (catch 'other
3531                     (dolist (other (frame-list))
3532                       (when (and (not (eq other frame))
3533                                  (eq (window-frame (minibuffer-window other))
3534                                      frame))
3535                         (throw 'other t))))
3536                   (let ((minibuf (active-minibuffer-window)))
3537                     (and minibuf (eq frame (window-frame minibuf)))))
3538         'frame))
3539      ((or ignore-window-parameters
3540           (not (eq window (window--major-non-side-window frame))))
3541       ;; WINDOW can be deleted unless it is the major non-side window of
3542       ;; its frame.
3543       t))))
3544
3545 (defun window--in-subtree-p (window root)
3546   "Return t if WINDOW is either ROOT or a member of ROOT's subtree."
3547   (or (eq window root)
3548       (let ((parent (window-parent window)))
3549         (catch 'done
3550           (while parent
3551             (if (eq parent root)
3552                 (throw 'done t)
3553               (setq parent (window-parent parent))))))))
3554
3555 (defun delete-window (&optional window)
3556   "Delete WINDOW.
3557 WINDOW must be a valid window and defaults to the selected one.
3558 Return nil.
3559
3560 If the variable `ignore-window-parameters' is non-nil or the
3561 `delete-window' parameter of WINDOW equals t, do not process any
3562 parameters of WINDOW.  Otherwise, if the `delete-window'
3563 parameter of WINDOW specifies a function, call that function with
3564 WINDOW as its sole argument and return the value returned by that
3565 function.
3566
3567 Otherwise, if WINDOW is part of an atomic window, call
3568 `delete-window' with the root of the atomic window as its
3569 argument.  Signal an error if WINDOW is either the only window on
3570 its frame, the last non-side window, or part of an atomic window
3571 that is its frame's root window."
3572   (interactive)
3573   (setq window (window-normalize-window window))
3574   (let* ((frame (window-frame window))
3575          (function (window-parameter window 'delete-window))
3576          (parent (window-parent window))
3577          atom-root)
3578     (window--check frame)
3579     (catch 'done
3580       ;; Handle window parameters.
3581       (cond
3582        ;; Ignore window parameters if `ignore-window-parameters' tells
3583        ;; us so or `delete-window' equals t.
3584        ((or ignore-window-parameters (eq function t)))
3585        ((functionp function)
3586         ;; The `delete-window' parameter specifies the function to call.
3587         ;; If that function is `ignore' nothing is done.  It's up to the
3588         ;; function called here to avoid infinite recursion.
3589         (throw 'done (funcall function window)))
3590        ((and (window-parameter window 'window-atom)
3591              (setq atom-root (window-atom-root window))
3592              (not (eq atom-root window)))
3593         (if (eq atom-root (frame-root-window frame))
3594             (error "Root of atomic window is root window of its frame")
3595           (throw 'done (delete-window atom-root))))
3596        ((not parent)
3597         (error "Attempt to delete minibuffer or sole ordinary window"))
3598        ((eq window (window--major-non-side-window frame))
3599         (error "Attempt to delete last non-side window")))
3600
3601       (let* ((horizontal (window-left-child parent))
3602              (size (window-size window horizontal t))
3603              (frame-selected
3604               (window--in-subtree-p (frame-selected-window frame) window))
3605              ;; Emacs 23 preferably gives WINDOW's space to its left
3606              ;; sibling.
3607              (sibling (or (window-left window) (window-right window))))
3608         (window--resize-reset frame horizontal)
3609         (cond
3610          ((and (not window-combination-resize)
3611                sibling (window-sizable-p sibling size horizontal nil t))
3612           ;; Resize WINDOW's sibling.
3613           (window--resize-this-window sibling size horizontal nil t)
3614           (set-window-new-normal
3615            sibling (+ (window-normal-size sibling horizontal)
3616                       (window-normal-size window horizontal))))
3617          ((window--resizable-p window (- size) horizontal nil nil nil t t)
3618           ;; Can do without resizing fixed-size windows.
3619           (window--resize-siblings window (- size) horizontal))
3620          (t
3621           ;; Can't do without resizing fixed-size windows.
3622           (window--resize-siblings window (- size) horizontal t)))
3623         ;; Actually delete WINDOW.
3624         (delete-window-internal window)
3625         (window--pixel-to-total frame horizontal)
3626         (when (and frame-selected
3627                    (window-parameter
3628                     (frame-selected-window frame) 'no-other-window))
3629           ;; `delete-window-internal' has selected a window that should
3630           ;; not be selected, fix this here.
3631           (other-window -1 frame))
3632         (run-window-configuration-change-hook frame)
3633         (window--check frame)
3634         ;; Always return nil.
3635         nil))))
3636
3637 (defun delete-other-windows (&optional window)
3638   "Make WINDOW fill its frame.
3639 WINDOW must be a valid window and defaults to the selected one.
3640 Return nil.
3641
3642 If the variable `ignore-window-parameters' is non-nil or the
3643 `delete-other-windows' parameter of WINDOW equals t, do not
3644 process any parameters of WINDOW.  Otherwise, if the
3645 `delete-other-windows' parameter of WINDOW specifies a function,
3646 call that function with WINDOW as its sole argument and return
3647 the value returned by that function.
3648
3649 Otherwise, if WINDOW is part of an atomic window, call this
3650 function with the root of the atomic window as its argument.  If
3651 WINDOW is a non-side window, make WINDOW the only non-side window
3652 on the frame.  Side windows are not deleted.  If WINDOW is a side
3653 window signal an error."
3654   (interactive)
3655   (setq window (window-normalize-window window))
3656   (let* ((frame (window-frame window))
3657          (function (window-parameter window 'delete-other-windows))
3658          (window-side (window-parameter window 'window-side))
3659          atom-root side-main)
3660     (window--check frame)
3661     (catch 'done
3662       (cond
3663        ;; Ignore window parameters if `ignore-window-parameters' is t or
3664        ;; `delete-other-windows' is t.
3665        ((or ignore-window-parameters (eq function t)))
3666        ((functionp function)
3667         ;; The `delete-other-windows' parameter specifies the function
3668         ;; to call.  If the function is `ignore' no windows are deleted.
3669         ;; It's up to the function called to avoid infinite recursion.
3670         (throw 'done (funcall function window)))
3671        ((and (window-parameter window 'window-atom)
3672              (setq atom-root (window-atom-root window))
3673              (not (eq atom-root window)))
3674         (if (eq atom-root (frame-root-window frame))
3675             (error "Root of atomic window is root window of its frame")
3676           (throw 'done (delete-other-windows atom-root))))
3677        ((memq window-side window-sides)
3678         (error "Cannot make side window the only window"))
3679        ((and (window-minibuffer-p window)
3680              (not (eq window (frame-root-window window))))
3681         (error "Can't expand minibuffer to full frame")))
3682
3683       ;; If WINDOW is the major non-side window, do nothing.
3684       (if (window-with-parameter 'window-side)
3685           (setq side-main (window--major-non-side-window frame))
3686         (setq side-main (frame-root-window frame)))
3687       (unless (eq window side-main)
3688         (delete-other-windows-internal window side-main)
3689         (run-window-configuration-change-hook frame)
3690         (window--check frame))
3691       ;; Always return nil.
3692       nil)))
3693
3694 (defun delete-other-windows-vertically (&optional window)
3695   "Delete the windows in the same column with WINDOW, but not WINDOW itself.
3696 This may be a useful alternative binding for \\[delete-other-windows]
3697  if you often split windows horizontally."
3698   (interactive)
3699   (let* ((window (or window (selected-window)))
3700          (edges (window-edges window))
3701          (w window) delenda)
3702     (while (not (eq (setq w (next-window w 1)) window))
3703       (let ((e (window-edges w)))
3704         (when (and (= (car e) (car edges))
3705                    (= (nth 2 e) (nth 2 edges)))
3706           (push w delenda))))
3707     (mapc 'delete-window delenda)))
3708
3709 ;;; Windows and buffers.
3710
3711 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
3712 ;; for (1) determining which buffer to show in the window when its
3713 ;; buffer shall be buried or killed and (2) which buffer to show for
3714 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
3715
3716 ;; `prev-buffers' consists of <buffer, window-start, window-point>
3717 ;; triples.  The entries on this list are ordered by the time their
3718 ;; buffer has been removed from the window, the most recently removed
3719 ;; buffer's entry being first.  The window-start and window-point
3720 ;; components are `window-start' and `window-point' at the time the
3721 ;; buffer was removed from the window which implies that the entry must
3722 ;; be added when `set-window-buffer' removes the buffer from the window.
3723
3724 ;; `next-buffers' is the list of buffers that have been replaced
3725 ;; recently by `switch-to-prev-buffer'.  These buffers are the least
3726 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
3727 ;; candidates of `switch-to-next-buffer' to switch to.  This list is
3728 ;; reset to nil by any action changing the window's buffer with the
3729 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
3730 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
3731 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
3732
3733 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
3734 ;; if such a buffer was killed while the window was hidden within a
3735 ;; window configuration.  Such killed buffers get removed whenever
3736 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
3737
3738 ;; The following function is called by `set-window-buffer' _before_ it
3739 ;; replaces the buffer of the argument window with the new buffer.
3740 (defun record-window-buffer (&optional window)
3741   "Record WINDOW's buffer.
3742 WINDOW must be a live window and defaults to the selected one."
3743   (let* ((window (window-normalize-window window t))
3744          (buffer (window-buffer window))
3745          (entry (assq buffer (window-prev-buffers window))))
3746     ;; Reset WINDOW's next buffers.  If needed, they are resurrected by
3747     ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
3748     (set-window-next-buffers window nil)
3749
3750     (when entry
3751       ;; Remove all entries for BUFFER from WINDOW's previous buffers.
3752       (set-window-prev-buffers
3753        window (assq-delete-all buffer (window-prev-buffers window))))
3754
3755     ;; Don't record insignificant buffers.
3756     (unless (eq (aref (buffer-name buffer) 0) ?\s)
3757       ;; Add an entry for buffer to WINDOW's previous buffers.
3758       (with-current-buffer buffer
3759         (let ((start (window-start window))
3760               (point (window-point window)))
3761           (setq entry
3762                 (cons buffer
3763                       (if entry
3764                           ;; We have an entry, update marker positions.
3765                           (list (set-marker (nth 1 entry) start)
3766                                 (set-marker (nth 2 entry) point))
3767                         ;; Make new markers.
3768                         (list (copy-marker start)
3769                               (copy-marker
3770                                ;; Preserve window-point-insertion-type
3771                                ;; (Bug#12588).
3772                                point window-point-insertion-type)))))
3773           (set-window-prev-buffers
3774            window (cons entry (window-prev-buffers window)))))
3775
3776       (run-hooks 'buffer-list-update-hook))))
3777
3778 (defun unrecord-window-buffer (&optional window buffer)
3779   "Unrecord BUFFER in WINDOW.
3780 WINDOW must be a live window and defaults to the selected one.
3781 BUFFER must be a live buffer and defaults to the buffer of
3782 WINDOW."
3783   (let* ((window (window-normalize-window window t))
3784          (buffer (or buffer (window-buffer window))))
3785     (set-window-prev-buffers
3786      window (assq-delete-all buffer (window-prev-buffers window)))
3787     (set-window-next-buffers
3788      window (delq buffer (window-next-buffers window)))))
3789
3790 (defun set-window-buffer-start-and-point (window buffer &optional start point)
3791   "Set WINDOW's buffer to BUFFER.
3792 WINDOW must be a live window and defaults to the selected one.
3793 Optional argument START non-nil means set WINDOW's start position
3794 to START.  Optional argument POINT non-nil means set WINDOW's
3795 point to POINT.  If WINDOW is selected this also sets BUFFER's
3796 `point' to POINT.  If WINDOW is selected and the buffer it showed
3797 before was current this also makes BUFFER the current buffer."
3798   (setq window (window-normalize-window window t))
3799   (let ((selected (eq window (selected-window)))
3800         (current (eq (window-buffer window) (current-buffer))))
3801     (set-window-buffer window buffer)
3802     (when (and selected current)
3803       (set-buffer buffer))
3804     (when start
3805       ;; Don't force window-start here (even if POINT is nil).
3806       (set-window-start window start t))
3807     (when point
3808       (set-window-point window point))))
3809
3810 (defcustom switch-to-visible-buffer t
3811   "If non-nil, allow switching to an already visible buffer.
3812 If this variable is non-nil, `switch-to-prev-buffer' and
3813 `switch-to-next-buffer' may switch to an already visible buffer
3814 provided the buffer was shown before in the window specified as
3815 argument to those functions.  If this variable is nil,
3816 `switch-to-prev-buffer' and `switch-to-next-buffer' always try to
3817 avoid switching to a buffer that is already visible in another
3818 window on the same frame."
3819   :type 'boolean
3820   :version "24.1"
3821   :group 'windows)
3822
3823 (defun switch-to-prev-buffer (&optional window bury-or-kill)
3824   "In WINDOW switch to previous buffer.
3825 WINDOW must be a live window and defaults to the selected one.
3826 Return the buffer switched to, nil if no suitable buffer could be
3827 found.
3828
3829 Optional argument BURY-OR-KILL non-nil means the buffer currently
3830 shown in WINDOW is about to be buried or killed and consequently
3831 shall not be switched to in future invocations of this command.
3832
3833 As a special case, if BURY-OR-KILL equals `append', this means to
3834 move the buffer to the end of WINDOW's previous buffers list so a
3835 future invocation of `switch-to-prev-buffer' less likely switches
3836 to it."
3837   (interactive)
3838   (let* ((window (window-normalize-window window t))
3839          (frame (window-frame window))
3840          (old-buffer (window-buffer window))
3841          ;; Save this since it's destroyed by `set-window-buffer'.
3842          (next-buffers (window-next-buffers window))
3843          (pred (frame-parameter frame 'buffer-predicate))
3844          entry new-buffer killed-buffers visible)
3845     (when (window-minibuffer-p window)
3846       ;; Don't switch in minibuffer window.
3847       (unless (setq window (minibuffer-selected-window))
3848         (error "Window %s is a minibuffer window" window)))
3849
3850     (when (window-dedicated-p window)
3851       ;; Don't switch in dedicated window.
3852       (error "Window %s is dedicated to buffer %s" window old-buffer))
3853
3854     (catch 'found
3855       ;; Scan WINDOW's previous buffers first, skipping entries of next
3856       ;; buffers.
3857       (dolist (entry (window-prev-buffers window))
3858         (when (and (setq new-buffer (car entry))
3859                    (or (buffer-live-p new-buffer)
3860                        (not (setq killed-buffers
3861                                   (cons new-buffer killed-buffers))))
3862                    (not (eq new-buffer old-buffer))
3863                    (or (null pred) (funcall pred new-buffer))
3864                    ;; When BURY-OR-KILL is nil, avoid switching to a
3865                    ;; buffer in WINDOW's next buffers list.
3866                    (or bury-or-kill (not (memq new-buffer next-buffers))))
3867           (if (and (not switch-to-visible-buffer)
3868                    (get-buffer-window new-buffer frame))
3869               ;; Try to avoid showing a buffer visible in some other
3870               ;; window.
3871               (setq visible new-buffer)
3872             (set-window-buffer-start-and-point
3873              window new-buffer (nth 1 entry) (nth 2 entry))
3874             (throw 'found t))))
3875       ;; Scan reverted buffer list of WINDOW's frame next, skipping
3876       ;; entries of next buffers.  Note that when we bury or kill a
3877       ;; buffer we don't reverse the global buffer list to avoid showing
3878       ;; a buried buffer instead.  Otherwise, we must reverse the global
3879       ;; buffer list in order to make sure that switching to the
3880       ;; previous/next buffer traverse it in opposite directions.
3881       (dolist (buffer (if bury-or-kill
3882                           (buffer-list frame)
3883                         (nreverse (buffer-list frame))))
3884         (when (and (buffer-live-p buffer)
3885                    (not (eq buffer old-buffer))
3886                    (or (null pred) (funcall pred buffer))
3887                    (not (eq (aref (buffer-name buffer) 0) ?\s))
3888                    (or bury-or-kill (not (memq buffer next-buffers))))
3889           (if (get-buffer-window buffer frame)
3890               ;; Try to avoid showing a buffer visible in some other window.
3891               (unless visible
3892                 (setq visible buffer))
3893             (setq new-buffer buffer)
3894             (set-window-buffer-start-and-point window new-buffer)
3895             (throw 'found t))))
3896       (unless bury-or-kill
3897         ;; Scan reverted next buffers last (must not use nreverse
3898         ;; here!).
3899         (dolist (buffer (reverse next-buffers))
3900           ;; Actually, buffer _must_ be live here since otherwise it
3901           ;; would have been caught in the scan of previous buffers.
3902           (when (and (or (buffer-live-p buffer)
3903                          (not (setq killed-buffers
3904                                     (cons buffer killed-buffers))))
3905                      (not (eq buffer old-buffer))
3906                      (or (null pred) (funcall pred buffer))
3907                      (setq entry (assq buffer (window-prev-buffers window))))
3908             (setq new-buffer buffer)
3909             (set-window-buffer-start-and-point
3910              window new-buffer (nth 1 entry) (nth 2 entry))
3911             (throw 'found t))))
3912
3913       ;; Show a buffer visible in another window.
3914       (when visible
3915         (setq new-buffer visible)
3916         (set-window-buffer-start-and-point window new-buffer)))
3917
3918     (if bury-or-kill
3919         (let ((entry (and (eq bury-or-kill 'append)
3920                           (assq old-buffer (window-prev-buffers window)))))
3921           ;; Remove `old-buffer' from WINDOW's previous and (restored list
3922           ;; of) next buffers.
3923           (set-window-prev-buffers
3924            window (assq-delete-all old-buffer (window-prev-buffers window)))
3925           (set-window-next-buffers window (delq old-buffer next-buffers))
3926           (when entry
3927             ;; Append old-buffer's entry to list of WINDOW's previous
3928             ;; buffers so it's less likely to get switched to soon but
3929             ;; `display-buffer-in-previous-window' can nevertheless find
3930             ;; it.
3931             (set-window-prev-buffers
3932              window (append (window-prev-buffers window) (list entry)))))
3933       ;; Move `old-buffer' to head of WINDOW's restored list of next
3934       ;; buffers.
3935       (set-window-next-buffers
3936        window (cons old-buffer (delq old-buffer next-buffers))))
3937
3938     ;; Remove killed buffers from WINDOW's previous and next buffers.
3939     (when killed-buffers
3940       (dolist (buffer killed-buffers)
3941         (set-window-prev-buffers
3942          window (assq-delete-all buffer (window-prev-buffers window)))
3943         (set-window-next-buffers
3944          window (delq buffer (window-next-buffers window)))))
3945
3946     ;; Return new-buffer.
3947     new-buffer))
3948
3949 (defun switch-to-next-buffer (&optional window)
3950   "In WINDOW switch to next buffer.
3951 WINDOW must be a live window and defaults to the selected one.
3952 Return the buffer switched to, nil if no suitable buffer could be
3953 found."
3954   (interactive)
3955   (let* ((window (window-normalize-window window t))
3956          (frame (window-frame window))
3957          (old-buffer (window-buffer window))
3958          (next-buffers (window-next-buffers window))
3959          (pred (frame-parameter frame 'buffer-predicate))
3960          new-buffer entry killed-buffers visible)
3961     (when (window-minibuffer-p window)
3962       ;; Don't switch in minibuffer window.
3963       (unless (setq window (minibuffer-selected-window))
3964         (error "Window %s is a minibuffer window" window)))
3965
3966     (when (window-dedicated-p window)
3967       ;; Don't switch in dedicated window.
3968       (error "Window %s is dedicated to buffer %s" window old-buffer))
3969
3970     (catch 'found
3971       ;; Scan WINDOW's next buffers first.
3972       (dolist (buffer next-buffers)
3973         (when (and (or (buffer-live-p buffer)
3974                        (not (setq killed-buffers
3975                                   (cons buffer killed-buffers))))
3976                    (not (eq buffer old-buffer))
3977                    (or (null pred) (funcall pred buffer))
3978                    (setq entry (assq buffer (window-prev-buffers window))))
3979           (setq new-buffer buffer)
3980           (set-window-buffer-start-and-point
3981            window new-buffer (nth 1 entry) (nth 2 entry))
3982           (throw 'found t)))
3983       ;; Scan the buffer list of WINDOW's frame next, skipping previous
3984       ;; buffers entries.
3985       (dolist (buffer (buffer-list frame))
3986         (when (and (buffer-live-p buffer)
3987                    (not (eq buffer old-buffer))
3988                    (or (null pred) (funcall pred buffer))
3989                    (not (eq (aref (buffer-name buffer) 0) ?\s))
3990                    (not (assq buffer (window-prev-buffers window))))
3991           (if (get-buffer-window buffer frame)
3992               ;; Try to avoid showing a buffer visible in some other window.
3993               (setq visible buffer)
3994             (setq new-buffer buffer)
3995             (set-window-buffer-start-and-point window new-buffer)
3996             (throw 'found t))))
3997       ;; Scan WINDOW's reverted previous buffers last (must not use
3998       ;; nreverse here!)
3999       (dolist (entry (reverse (window-prev-buffers window)))
4000         (when (and (setq new-buffer (car entry))
4001                    (or (buffer-live-p new-buffer)
4002                        (not (setq killed-buffers
4003                                   (cons new-buffer killed-buffers))))
4004                    (not (eq new-buffer old-buffer))
4005                    (or (null pred) (funcall pred new-buffer)))
4006           (if (and (not switch-to-visible-buffer)
4007                    (get-buffer-window new-buffer frame))
4008               ;; Try to avoid showing a buffer visible in some other window.
4009               (unless visible
4010                 (setq visible new-buffer))
4011             (set-window-buffer-start-and-point
4012              window new-buffer (nth 1 entry) (nth 2 entry))
4013             (throw 'found t))))
4014
4015       ;; Show a buffer visible in another window.
4016       (when visible
4017         (setq new-buffer visible)
4018         (set-window-buffer-start-and-point window new-buffer)))
4019
4020     ;; Remove `new-buffer' from and restore WINDOW's next buffers.
4021     (set-window-next-buffers window (delq new-buffer next-buffers))
4022
4023     ;; Remove killed buffers from WINDOW's previous and next buffers.
4024     (when killed-buffers
4025       (dolist (buffer killed-buffers)
4026         (set-window-prev-buffers
4027          window (assq-delete-all buffer (window-prev-buffers window)))
4028         (set-window-next-buffers
4029          window (delq buffer (window-next-buffers window)))))
4030
4031     ;; Return new-buffer.
4032     new-buffer))
4033
4034 (defun get-next-valid-buffer (list &optional buffer visible-ok frame)
4035   "Search LIST for a valid buffer to display in FRAME.
4036 Return nil when all buffers in LIST are undesirable for display,
4037 otherwise return the first suitable buffer in LIST.
4038
4039 Buffers not visible in windows are preferred to visible buffers,
4040 unless VISIBLE-OK is non-nil.
4041 If the optional argument FRAME is nil, it defaults to the selected frame.
4042 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
4043   ;; This logic is more or less copied from other-buffer.
4044   (setq frame (or frame (selected-frame)))
4045   (let ((pred (frame-parameter frame 'buffer-predicate))
4046         found buf)
4047     (while (and (not found) list)
4048       (setq buf (car list))
4049       (if (and (not (eq buffer buf))
4050                (buffer-live-p buf)
4051                (or (null pred) (funcall pred buf))
4052                (not (eq (aref (buffer-name buf) 0) ?\s))
4053                (or visible-ok (null (get-buffer-window buf 'visible))))
4054           (setq found buf)
4055         (setq list (cdr list))))
4056     (car list)))
4057
4058 (defun last-buffer (&optional buffer visible-ok frame)
4059   "Return the last buffer in FRAME's buffer list.
4060 If BUFFER is the last buffer, return the preceding buffer
4061 instead.  Buffers not visible in windows are preferred to visible
4062 buffers, unless optional argument VISIBLE-OK is non-nil.
4063 Optional third argument FRAME nil or omitted means use the
4064 selected frame's buffer list.  If no such buffer exists, return
4065 the buffer `*scratch*', creating it if necessary."
4066   (setq frame (or frame (selected-frame)))
4067   (or (get-next-valid-buffer (nreverse (buffer-list frame))
4068                              buffer visible-ok frame)
4069       (get-buffer "*scratch*")
4070       (let ((scratch (get-buffer-create "*scratch*")))
4071         (set-buffer-major-mode scratch)
4072         scratch)))
4073
4074 (defcustom frame-auto-hide-function #'iconify-frame
4075   "Function called to automatically hide frames.
4076 The function is called with one argument - a frame.
4077
4078 Functions affected by this option are those that bury a buffer
4079 shown in a separate frame like `quit-window' and `bury-buffer'."
4080   :type '(choice (const :tag "Iconify" iconify-frame)
4081                  (const :tag "Delete" delete-frame)
4082                  (const :tag "Do nothing" ignore)
4083                  function)
4084   :group 'windows
4085   :group 'frames
4086   :version "24.1")
4087
4088 (defun window--delete (&optional window dedicated-only kill)
4089   "Delete WINDOW if possible.
4090 WINDOW must be a live window and defaults to the selected one.
4091 Optional argument DEDICATED-ONLY non-nil means to delete WINDOW
4092 only if it's dedicated to its buffer.  Optional argument KILL
4093 means the buffer shown in window will be killed.  Return non-nil
4094 if WINDOW gets deleted or its frame is auto-hidden."
4095   (setq window (window-normalize-window window t))
4096   (unless (and dedicated-only (not (window-dedicated-p window)))
4097     (let ((deletable (window-deletable-p window)))
4098       (cond
4099        ((eq deletable 'frame)
4100         (let ((frame (window-frame window)))
4101           (cond
4102            (kill
4103             (delete-frame frame))
4104            ((functionp frame-auto-hide-function)
4105             (funcall frame-auto-hide-function frame))))
4106         'frame)
4107        (deletable
4108         (delete-window window)
4109         t)))))
4110
4111 (defun bury-buffer (&optional buffer-or-name)
4112   "Put BUFFER-OR-NAME at the end of the list of all buffers.
4113 There it is the least likely candidate for `other-buffer' to
4114 return; thus, the least likely buffer for \\[switch-to-buffer] to
4115 select by default.
4116
4117 You can specify a buffer name as BUFFER-OR-NAME, or an actual
4118 buffer object.  If BUFFER-OR-NAME is nil or omitted, bury the
4119 current buffer.  Also, if BUFFER-OR-NAME is nil or omitted,
4120 remove the current buffer from the selected window if it is
4121 displayed there."
4122   (interactive)
4123   (let* ((buffer (window-normalize-buffer buffer-or-name)))
4124     ;; If `buffer-or-name' is not on the selected frame we unrecord it
4125     ;; although it's not "here" (call it a feature).
4126     (bury-buffer-internal buffer)
4127     ;; Handle case where `buffer-or-name' is nil and the current buffer
4128     ;; is shown in the selected window.
4129     (cond
4130      ((or buffer-or-name (not (eq buffer (window-buffer)))))
4131      ((window--delete nil t))
4132      (t
4133       ;; Switch to another buffer in window.
4134       (set-window-dedicated-p nil nil)
4135       (switch-to-prev-buffer nil 'bury)))
4136
4137     ;; Always return nil.
4138     nil))
4139
4140 (defun unbury-buffer ()
4141   "Switch to the last buffer in the buffer list."
4142   (interactive)
4143   (switch-to-buffer (last-buffer)))
4144
4145 (defun next-buffer ()
4146   "In selected window switch to next buffer."
4147   (interactive)
4148   (cond
4149    ((window-minibuffer-p)
4150     (error "Cannot switch buffers in minibuffer window"))
4151    ((eq (window-dedicated-p) t)
4152     (error "Window is strongly dedicated to its buffer"))
4153    (t
4154     (switch-to-next-buffer))))
4155
4156 (defun previous-buffer ()
4157   "In selected window switch to previous buffer."
4158   (interactive)
4159   (cond
4160    ((window-minibuffer-p)
4161     (error "Cannot switch buffers in minibuffer window"))
4162    ((eq (window-dedicated-p) t)
4163     (error "Window is strongly dedicated to its buffer"))
4164    (t
4165     (switch-to-prev-buffer))))
4166
4167 (defun delete-windows-on (&optional buffer-or-name frame)
4168   "Delete all windows showing BUFFER-OR-NAME.
4169 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
4170 and defaults to the current buffer.
4171
4172 The following non-nil values of the optional argument FRAME
4173 have special meanings:
4174
4175 - t means consider all windows on the selected frame only.
4176
4177 - `visible' means consider all windows on all visible frames on
4178   the current terminal.
4179
4180 - 0 (the number zero) means consider all windows on all visible
4181   and iconified frames on the current terminal.
4182
4183 - A frame means consider all windows on that frame only.
4184
4185 Any other value of FRAME means consider all windows on all
4186 frames.
4187
4188 When a window showing BUFFER-OR-NAME is dedicated and the only
4189 window of its frame, that frame is deleted when there are other
4190 frames left."
4191   (interactive "BDelete windows on (buffer):\nP")
4192   (let ((buffer (window-normalize-buffer buffer-or-name))
4193         ;; Handle the "inverted" meaning of the FRAME argument wrt other
4194         ;; `window-list-1' based function.
4195         (all-frames (cond ((not frame) t) ((eq frame t) nil) (t frame))))
4196     (dolist (window (window-list-1 nil nil all-frames))
4197       (if (eq (window-buffer window) buffer)
4198           (let ((deletable (window-deletable-p window)))
4199             (cond
4200              ((and (eq deletable 'frame) (window-dedicated-p window))
4201               ;; Delete frame if and only if window is dedicated.
4202               (delete-frame (window-frame window)))
4203              ((eq deletable t)
4204               ;; Delete window.
4205               (delete-window window))
4206              (t
4207               ;; In window switch to previous buffer.
4208               (set-window-dedicated-p window nil)
4209               (switch-to-prev-buffer window 'bury))))
4210         ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
4211         (unrecord-window-buffer window buffer)))))
4212
4213 (defun replace-buffer-in-windows (&optional buffer-or-name)
4214   "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
4215 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
4216 and defaults to the current buffer.
4217
4218 When a window showing BUFFER-OR-NAME is dedicated, that window is
4219 deleted.  If that window is the only window on its frame, the
4220 frame is deleted too when there are other frames left.  If there
4221 are no other frames left, some other buffer is displayed in that
4222 window.
4223
4224 This function removes the buffer denoted by BUFFER-OR-NAME from
4225 all window-local buffer lists."
4226   (interactive "bBuffer to replace: ")
4227   (let ((buffer (window-normalize-buffer buffer-or-name)))
4228     (dolist (window (window-list-1 nil nil t))
4229       (if (eq (window-buffer window) buffer)
4230           (unless (window--delete window t t)
4231             ;; Switch to another buffer in window.
4232             (set-window-dedicated-p window nil)
4233             (switch-to-prev-buffer window 'kill))
4234         ;; Unrecord BUFFER in WINDOW.
4235         (unrecord-window-buffer window buffer)))))
4236
4237 (defun quit-restore-window (&optional window bury-or-kill)
4238   "Quit WINDOW and deal with its buffer.
4239 WINDOW must be a live window and defaults to the selected one.
4240
4241 According to information stored in WINDOW's `quit-restore' window
4242 parameter either (1) delete WINDOW and its frame, (2) delete
4243 WINDOW, (3) restore the buffer previously displayed in WINDOW,
4244 or (4) make WINDOW display some other buffer than the present
4245 one.  If non-nil, reset `quit-restore' parameter to nil.
4246
4247 Optional second argument BURY-OR-KILL tells how to proceed with
4248 the buffer of WINDOW.  The following values are handled:
4249
4250 `nil' means to not handle the buffer in a particular way.  This
4251   means that if WINDOW is not deleted by this function, invoking
4252   `switch-to-prev-buffer' will usually show the buffer again.
4253
4254 `append' means that if WINDOW is not deleted, move its buffer to
4255   the end of WINDOW's previous buffers so it's less likely that a
4256   future invocation of `switch-to-prev-buffer' will switch to it.
4257   Also, move the buffer to the end of the frame's buffer list.
4258
4259 `bury' means that if WINDOW is not deleted, remove its buffer
4260   from WINDOW'S list of previous buffers.  Also, move the buffer
4261   to the end of the frame's buffer list.  This value provides the
4262   most reliable remedy to not have `switch-to-prev-buffer' switch
4263   to this buffer again without killing the buffer.
4264
4265 `kill' means to kill WINDOW's buffer."
4266   (setq window (window-normalize-window window t))
4267   (let* ((buffer (window-buffer window))
4268          (quit-restore (window-parameter window 'quit-restore))
4269          (prev-buffer
4270           (let* ((prev-buffers (window-prev-buffers window))
4271                  (prev-buffer (caar prev-buffers)))
4272             (and (or (not (eq prev-buffer buffer))
4273                      (and (cdr prev-buffers)
4274                           (not (eq (setq prev-buffer (cadr prev-buffers))
4275                                    buffer))))
4276                  prev-buffer)))
4277          quad entry)
4278     (cond
4279      ((and (not prev-buffer)
4280            (or (eq (nth 1 quit-restore) 'frame)
4281                (and (eq (nth 1 quit-restore) 'window)
4282                     ;; If the window has been created on an existing
4283                     ;; frame and ended up as the sole window on that
4284                     ;; frame, do not delete it (Bug#12764).
4285                     (not (eq window (frame-root-window window)))))
4286            (eq (nth 3 quit-restore) buffer)
4287            ;; Delete WINDOW if possible.
4288            (window--delete window nil (eq bury-or-kill 'kill)))
4289       ;; If the previously selected window is still alive, select it.
4290       (when (window-live-p (nth 2 quit-restore))
4291         (select-window (nth 2 quit-restore))))
4292      ((and (listp (setq quad (nth 1 quit-restore)))
4293            (buffer-live-p (car quad))
4294            (eq (nth 3 quit-restore) buffer))
4295       ;; Show another buffer stored in quit-restore parameter.
4296       (when (and (integerp (nth 3 quad))
4297                  (/= (nth 3 quad) (window-total-height window)))
4298         ;; Try to resize WINDOW to its old height but don't signal an
4299         ;; error.
4300         (condition-case nil
4301             (window-resize window (- (nth 3 quad) (window-total-height window)))
4302           (error nil)))
4303       (set-window-dedicated-p window nil)
4304       ;; Restore WINDOW's previous buffer, start and point position.
4305       (set-window-buffer-start-and-point
4306        window (nth 0 quad) (nth 1 quad) (nth 2 quad))
4307       ;; Deal with the buffer we just removed from WINDOW.
4308       (setq entry (and (eq bury-or-kill 'append)
4309                        (assq buffer (window-prev-buffers window))))
4310       (when bury-or-kill
4311         ;; Remove buffer from WINDOW's previous and next buffers.
4312         (set-window-prev-buffers
4313          window (assq-delete-all buffer (window-prev-buffers window)))
4314         (set-window-next-buffers
4315          window (delq buffer (window-next-buffers window))))
4316       (when entry
4317         ;; Append old buffer's entry to list of WINDOW's previous
4318         ;; buffers so it's less likely to get switched to soon but
4319         ;; `display-buffer-in-previous-window' can nevertheless find it.
4320         (set-window-prev-buffers
4321          window (append (window-prev-buffers window) (list entry))))
4322       ;; Reset the quit-restore parameter.
4323       (set-window-parameter window 'quit-restore nil)
4324       ;; Select old window.
4325       (when (window-live-p (nth 2 quit-restore))
4326         (select-window (nth 2 quit-restore))))
4327      (t
4328       ;; Show some other buffer in WINDOW and reset the quit-restore
4329       ;; parameter.
4330       (set-window-parameter window 'quit-restore nil)
4331       ;; Make sure that WINDOW is no more dedicated.
4332       (set-window-dedicated-p window nil)
4333       (switch-to-prev-buffer window bury-or-kill)))
4334
4335     ;; Deal with the buffer.
4336     (cond
4337      ((not (buffer-live-p buffer)))
4338      ((eq bury-or-kill 'kill)
4339       (kill-buffer buffer))
4340      (bury-or-kill
4341       (bury-buffer-internal buffer)))))
4342
4343 (defun quit-window (&optional kill window)
4344   "Quit WINDOW and bury its buffer.
4345 WINDOW must be a live window and defaults to the selected one.
4346 With prefix argument KILL non-nil, kill the buffer instead of
4347 burying it.
4348
4349 According to information stored in WINDOW's `quit-restore' window
4350 parameter either (1) delete WINDOW and its frame, (2) delete
4351 WINDOW, (3) restore the buffer previously displayed in WINDOW,
4352 or (4) make WINDOW display some other buffer than the present
4353 one.  If non-nil, reset `quit-restore' parameter to nil."
4354   (interactive "P")
4355   (quit-restore-window window (if kill 'kill 'bury)))
4356
4357 (defun quit-windows-on (&optional buffer-or-name kill frame)
4358   "Quit all windows showing BUFFER-OR-NAME.
4359 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
4360 and defaults to the current buffer.  Optional argument KILL
4361 non-nil means to kill BUFFER-OR-NAME.  KILL nil means to bury
4362 BUFFER-OR-NAME.  Optional argument FRAME is handled as by
4363 `delete-windows-on'.
4364
4365 This function calls `quit-window' on all candidate windows
4366 showing BUFFER-OR-NAME."
4367   (interactive "BQuit windows on (buffer):\nP")
4368   (let ((buffer (window-normalize-buffer buffer-or-name))
4369         ;; Handle the "inverted" meaning of the FRAME argument wrt other
4370         ;; `window-list-1' based function.
4371         (all-frames (cond ((not frame) t) ((eq frame t) nil) (t frame))))
4372     (dolist (window (window-list-1 nil nil all-frames))
4373       (if (eq (window-buffer window) buffer)
4374           (quit-window kill window)
4375         ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
4376         (unrecord-window-buffer window buffer)))))
4377 \f
4378 (defun split-window (&optional window size side pixelwise)
4379   "Make a new window adjacent to WINDOW.
4380 WINDOW must be a valid window and defaults to the selected one.
4381 Return the new window which is always a live window.
4382
4383 Optional argument SIZE a positive number means make WINDOW SIZE
4384 lines or columns tall.  If SIZE is negative, make the new window
4385 -SIZE lines or columns tall.  If and only if SIZE is non-nil, its
4386 absolute value can be less than `window-min-height' or
4387 `window-min-width'; so this command can make a new window as
4388 small as one line or two columns.  SIZE defaults to half of
4389 WINDOW's size.
4390
4391 Optional third argument SIDE nil (or `below') specifies that the
4392 new window shall be located below WINDOW.  SIDE `above' means the
4393 new window shall be located above WINDOW.  In both cases SIZE
4394 specifies the new number of lines for WINDOW (or the new window
4395 if SIZE is negative) including space reserved for the mode and/or
4396 header line.
4397
4398 SIDE t (or `right') specifies that the new window shall be
4399 located on the right side of WINDOW.  SIDE `left' means the new
4400 window shall be located on the left of WINDOW.  In both cases
4401 SIZE specifies the new number of columns for WINDOW (or the new
4402 window provided SIZE is negative) including space reserved for
4403 fringes and the scrollbar or a divider column.  Any other non-nil
4404 value for SIDE is currently handled like t (or `right').
4405
4406 PIXELWISE, if non-nil, means to interpret SIZE pixelwise.
4407
4408 If the variable `ignore-window-parameters' is non-nil or the
4409 `split-window' parameter of WINDOW equals t, do not process any
4410 parameters of WINDOW.  Otherwise, if the `split-window' parameter
4411 of WINDOW specifies a function, call that function with all three
4412 arguments and return the value returned by that function.
4413
4414 Otherwise, if WINDOW is part of an atomic window, \"split\" the
4415 root of that atomic window.  The new window does not become a
4416 member of that atomic window.
4417
4418 If WINDOW is live, properties of the new window like margins and
4419 scrollbars are inherited from WINDOW.  If WINDOW is an internal
4420 window, these properties as well as the buffer displayed in the
4421 new window are inherited from the window selected on WINDOW's
4422 frame.  The selected window is not changed by this function."
4423   (setq window (window-normalize-window window))
4424   (let* ((side (cond
4425                 ((not side) 'below)
4426                 ((memq side '(below above right left)) side)
4427                 (t 'right)))
4428          (horizontal (not (memq side '(below above))))
4429          (frame (window-frame window))
4430          (parent (window-parent window))
4431          (function (window-parameter window 'split-window))
4432          (window-side (window-parameter window 'window-side))
4433          ;; Rebind the following two variables since in some cases we
4434          ;; have to override their value.
4435          (window-combination-limit window-combination-limit)
4436          (window-combination-resize window-combination-resize)
4437          (char-size (frame-char-size window horizontal))
4438          (pixel-size
4439           (when (numberp size)
4440             (window--size-to-pixel window size horizontal pixelwise t)))
4441          (divider-width (if horizontal
4442                             (frame-right-divider-width frame)
4443                           (frame-bottom-divider-width frame)))
4444          atom-root ignore)
4445     (window--check frame)
4446     (catch 'done
4447       (cond
4448        ;; Ignore window parameters if either `ignore-window-parameters'
4449        ;; is t or the `split-window' parameter equals t.
4450        ((or ignore-window-parameters (eq function t)))
4451        ((functionp function)
4452         ;; The `split-window' parameter specifies the function to call.
4453         ;; If that function is `ignore', do nothing.
4454         (throw 'done (funcall function window size side)))
4455        ;; If WINDOW is part of an atomic window, split the root window
4456        ;; of that atomic window instead.
4457        ((and (window-parameter window 'window-atom)
4458              (setq atom-root (window-atom-root window))
4459              (not (eq atom-root window)))
4460         (throw 'done (split-window atom-root size side pixelwise)))
4461        ;; If WINDOW is a side window or its first or last child is a
4462        ;; side window, throw an error unless `window-combination-resize'
4463        ;; equals 'side.
4464        ((and (not (eq window-combination-resize 'side))
4465              (window--side-window-p window))
4466         (error "Cannot split side window or parent of side window"))
4467        ;; If `window-combination-resize' is 'side and window has a side
4468        ;; window sibling, bind `window-combination-limit' to t.
4469        ((and (not (eq window-combination-resize 'side))
4470              (or (and (window-prev-sibling window)
4471                       (window-parameter
4472                        (window-prev-sibling window) 'window-side))
4473                  (and (window-next-sibling window)
4474                       (window-parameter
4475                        (window-next-sibling window) 'window-side))))
4476         (setq window-combination-limit t)))
4477
4478       ;; If `window-combination-resize' is t and SIZE is non-negative,
4479       ;; bind `window-combination-limit' to t.
4480       (when (and (eq window-combination-resize t)
4481                  pixel-size (> pixel-size 0))
4482         (setq window-combination-limit t))
4483
4484       (let* ((parent-pixel-size
4485               ;; `parent-pixel-size' is the pixel size of WINDOW's
4486               ;; parent, provided it has one.
4487               (when parent (window-size parent horizontal t)))
4488              ;; `resize' non-nil means we are supposed to resize other
4489              ;; windows in WINDOW's combination.
4490              (resize
4491               (and window-combination-resize
4492                    (or (window-parameter window 'window-side)
4493                        (not (eq window-combination-resize 'side)))
4494                    (not (eq window-combination-limit t))
4495                    ;; Resize makes sense in iso-combinations only.
4496                    (window-combined-p window horizontal)))
4497              ;; `old-pixel-size' is the current pixel size of WINDOW.
4498              (old-pixel-size (window-size window horizontal t))
4499              ;; `new-size' is the specified or calculated size of the
4500              ;; new window.
4501              new-pixel-size new-parent new-normal)
4502         (cond
4503          ((not pixel-size)
4504           (setq new-pixel-size
4505                 (if resize
4506                     ;; When resizing try to give the new window the
4507                     ;; average size of a window in its combination.
4508                     (max (min (- parent-pixel-size
4509                                  (window-min-size parent horizontal nil t))
4510                               (/ parent-pixel-size
4511                                  (1+ (window-combinations parent horizontal))))
4512                          (window-min-pixel-size))
4513                   ;; Else try to give the new window half the size
4514                   ;; of WINDOW (plus an eventual odd pixel).
4515                   (/ old-pixel-size 2)))
4516           (unless window-resize-pixelwise
4517             ;; Round to nearest char-size multiple.
4518             (setq new-pixel-size
4519                   (* char-size (round new-pixel-size char-size)))))
4520          ((>= pixel-size 0)
4521           ;; SIZE non-negative specifies the new size of WINDOW.
4522
4523           ;; Note: Specifying a non-negative SIZE is practically
4524           ;; always done as workaround for making the new window
4525           ;; appear above or on the left of the new window (the
4526           ;; ispell window is a typical example of that).  In all
4527           ;; these cases the SIDE argument should be set to 'above
4528           ;; or 'left in order to support the 'resize option.
4529           ;; Here we have to nest the windows instead, see above.
4530           (setq new-pixel-size (- old-pixel-size pixel-size)))
4531          (t
4532           ;; SIZE negative specifies the size of the new window.
4533           (setq new-pixel-size (- pixel-size))))
4534
4535         ;; Check SIZE.
4536         (cond
4537          ((not pixel-size)
4538           (cond
4539            (resize
4540             ;; SIZE unspecified, resizing.
4541             (unless (or (window-sizable-p
4542                          parent (- (+ new-pixel-size divider-width)) horizontal
4543                          nil t)
4544                         (window-sizable-p
4545                          parent (- (+ new-pixel-size divider-width)) horizontal
4546                          (setq ignore 'preserved) t))
4547               (error "Window %s too small for splitting (1)" parent)))
4548            ((and (> (+ new-pixel-size divider-width
4549                        (window-min-size window horizontal nil t))
4550                     old-pixel-size)
4551                  (> (+ new-pixel-size divider-width
4552                        (window-min-size
4553                         window horizontal (setq ignore 'preserved) t))
4554                     old-pixel-size))
4555             ;; SIZE unspecified, no resizing.
4556             (error "Window %s too small for splitting (2)" window))))
4557          ((and (>= pixel-size 0)
4558                (or (>= pixel-size old-pixel-size)
4559                    (< new-pixel-size
4560                       (window-safe-min-pixel-size window horizontal))))
4561           ;; SIZE specified as new size of old window.  If the new size
4562           ;; is larger than the old size or the size of the new window
4563           ;; would be less than the safe minimum, signal an error.
4564           (error "Window %s too small for splitting (3)" window))
4565          (resize
4566           ;; SIZE specified, resizing.
4567           (unless (or (window-sizable-p
4568                        parent (- (+ new-pixel-size divider-width)) horizontal
4569                        nil t)
4570                       (window-sizable-p
4571                        parent (- (+ new-pixel-size divider-width)) horizontal
4572                        (setq ignore 'preserved) t))
4573             ;; If we cannot resize the parent give up.
4574             (error "Window %s too small for splitting (4)" parent)))
4575          ((or (< new-pixel-size
4576                  (window-safe-min-pixel-size window horizontal))
4577               (< (- old-pixel-size new-pixel-size)
4578                  (window-safe-min-pixel-size window horizontal)))
4579           ;; SIZE specification violates minimum size restrictions.
4580           (error "Window %s too small for splitting (5)" window)))
4581
4582         (window--resize-reset frame horizontal)
4583
4584         (setq new-parent
4585               ;; Make new-parent non-nil if we need a new parent window;
4586               ;; either because we want to nest or because WINDOW is not
4587               ;; iso-combined.
4588               (or (eq window-combination-limit t)
4589                   (not (window-combined-p window horizontal))))
4590         (setq new-normal
4591               ;; Make new-normal the normal size of the new window.
4592               (cond
4593                (pixel-size (/ (float new-pixel-size)
4594                               (if new-parent old-pixel-size parent-pixel-size)))
4595                (new-parent 0.5)
4596                (resize (/ 1.0 (1+ (window-combinations parent horizontal))))
4597                (t (/ (window-normal-size window horizontal) 2.0))))
4598
4599         (if resize
4600             ;; Try to get space from OLD's siblings.  We could go "up" and
4601             ;; try getting additional space from surrounding windows but
4602             ;; we won't be able to return space to those windows when we
4603             ;; delete the one we create here.  Hence we do not go up.
4604             (progn
4605               (window--resize-child-windows
4606                parent (- new-pixel-size) horizontal nil ignore)
4607               (let* ((normal (- 1.0 new-normal))
4608                      (sub (window-child parent)))
4609                 (while sub
4610                   (set-window-new-normal
4611                    sub (* (window-normal-size sub horizontal) normal))
4612                   (setq sub (window-right sub)))))
4613           ;; Get entire space from WINDOW.
4614           (set-window-new-pixel
4615            window (- old-pixel-size new-pixel-size))
4616           (window--resize-this-window
4617            window (- new-pixel-size) horizontal ignore)
4618           (set-window-new-normal
4619            window (- (if new-parent 1.0 (window-normal-size window horizontal))
4620                      new-normal)))
4621
4622         (let* ((new (split-window-internal window new-pixel-size side new-normal)))
4623           (window--pixel-to-total frame horizontal)
4624           ;; Assign window-side parameters, if any.
4625           (cond
4626            ((eq window-combination-resize 'side)
4627             (let ((window-side
4628                    (cond
4629                     (window-side window-side)
4630                     ((eq side 'above) 'top)
4631                     ((eq side 'below) 'bottom)
4632                     (t side))))
4633               ;; We made a new side window.
4634               (set-window-parameter new 'window-side window-side)
4635               (when (and new-parent (window-parameter window 'window-side))
4636                 ;; We've been splitting a side root window.  Give the
4637                 ;; new parent the same window-side parameter.
4638                 (set-window-parameter
4639                  (window-parent new) 'window-side window-side))))
4640            ((eq window-combination-resize 'atom)
4641             ;; Make sure `window--check-frame' won't destroy an existing
4642             ;; atomic window in case the new window gets nested inside.
4643             (unless (window-parameter window 'window-atom)
4644               (set-window-parameter window 'window-atom t))
4645             (when new-parent
4646               (set-window-parameter (window-parent new) 'window-atom t))
4647             (set-window-parameter new 'window-atom t)))
4648
4649           ;; Sanitize sizes.
4650           (window--sanitize-window-sizes frame horizontal)
4651
4652           (run-window-configuration-change-hook frame)
4653           (run-window-scroll-functions new)
4654           (window--check frame)
4655           ;; Always return the new window.
4656           new)))))
4657
4658 ;; I think this should be the default; I think people will prefer it--rms.
4659 (defcustom split-window-keep-point t
4660   "If non-nil, \\[split-window-below] preserves point in the new window.
4661 If nil, adjust point in the two windows to minimize redisplay.
4662 This option applies only to `split-window-below' and functions
4663 that call it.  The low-level `split-window' function always keeps
4664 the original point in both windows."
4665   :type 'boolean
4666   :group 'windows)
4667
4668 (defun split-window-below (&optional size)
4669   "Split the selected window into two windows, one above the other.
4670 The selected window is above.  The newly split-off window is
4671 below and displays the same buffer.  Return the new window.
4672
4673 If optional argument SIZE is omitted or nil, both windows get the
4674 same height, or close to it.  If SIZE is positive, the upper
4675 \(selected) window gets SIZE lines.  If SIZE is negative, the
4676 lower (new) window gets -SIZE lines.
4677
4678 If the variable `split-window-keep-point' is non-nil, both
4679 windows get the same value of point as the selected window.
4680 Otherwise, the window starts are chosen so as to minimize the
4681 amount of redisplay; this is convenient on slow terminals."
4682   (interactive "P")
4683   (let ((old-window (selected-window))
4684         (old-point (window-point))
4685         (size (and size (prefix-numeric-value size)))
4686         moved-by-window-height moved new-window bottom)
4687     (when (and size (< size 0) (< (- size) window-min-height))
4688       ;; `split-window' would not signal an error here.
4689       (error "Size of new window too small"))
4690     (setq new-window (split-window nil size))
4691     (unless split-window-keep-point
4692       (with-current-buffer (window-buffer)
4693         ;; Use `save-excursion' around vertical movements below
4694         ;; (Bug#10971).  Note: When the selected window's buffer has a
4695         ;; header line, up to two lines of the buffer may not show up
4696         ;; in the resulting configuration.
4697         (save-excursion
4698           (goto-char (window-start))
4699           (setq moved (vertical-motion (window-height)))
4700           (set-window-start new-window (point))
4701           (when (> (point) (window-point new-window))
4702             (set-window-point new-window (point)))
4703           (when (= moved (window-height))
4704             (setq moved-by-window-height t)
4705             (vertical-motion -1))
4706           (setq bottom (point)))
4707         (and moved-by-window-height
4708              (<= bottom (point))
4709              (set-window-point old-window (1- bottom)))
4710         (and moved-by-window-height
4711              (<= (window-start new-window) old-point)
4712              (set-window-point new-window old-point)
4713              (select-window new-window))))
4714     ;; Always copy quit-restore parameter in interactive use.
4715     (let ((quit-restore (window-parameter old-window 'quit-restore)))
4716       (when quit-restore
4717         (set-window-parameter new-window 'quit-restore quit-restore)))
4718     new-window))
4719
4720 (defalias 'split-window-vertically 'split-window-below)
4721
4722 (defun split-window-right (&optional size)
4723   "Split the selected window into two side-by-side windows.
4724 The selected window is on the left.  The newly split-off window
4725 is on the right and displays the same buffer.  Return the new
4726 window.
4727
4728 If optional argument SIZE is omitted or nil, both windows get the
4729 same width, or close to it.  If SIZE is positive, the left-hand
4730 \(selected) window gets SIZE columns.  If SIZE is negative, the
4731 right-hand (new) window gets -SIZE columns.  Here, SIZE includes
4732 the width of the window's scroll bar; if there are no scroll
4733 bars, it includes the width of the divider column to the window's
4734 right, if any."
4735   (interactive "P")
4736   (let ((old-window (selected-window))
4737         (size (and size (prefix-numeric-value size)))
4738         new-window)
4739     (when (and size (< size 0) (< (- size) window-min-width))
4740       ;; `split-window' would not signal an error here.
4741       (error "Size of new window too small"))
4742     (setq new-window (split-window nil size t))
4743     ;; Always copy quit-restore parameter in interactive use.
4744     (let ((quit-restore (window-parameter old-window 'quit-restore)))
4745       (when quit-restore
4746         (set-window-parameter new-window 'quit-restore quit-restore)))
4747     new-window))
4748
4749 (defalias 'split-window-horizontally 'split-window-right)
4750 \f
4751 ;;; Balancing windows.
4752
4753 ;; The following routine uses the recycled code from an old version of
4754 ;; `window--resize-child-windows'.  It's not very pretty, but coding it the way the
4755 ;; new `window--resize-child-windows' code does would hardly make it any shorter or
4756 ;; more readable (FWIW we'd need three loops - one to calculate the
4757 ;; minimum sizes per window, one to enlarge or shrink windows until the
4758 ;; new parent-size matches, and one where we shrink the largest/enlarge
4759 ;; the smallest window).
4760 (defun balance-windows-2 (window horizontal)
4761   "Subroutine of `balance-windows-1'.
4762 WINDOW must be a vertical combination (horizontal if HORIZONTAL
4763 is non-nil)."
4764   (let* ((char-size (if window-resize-pixelwise
4765                         1
4766                       (frame-char-size window horizontal)))
4767          (first (window-child window))
4768          (sub first)
4769          (number-of-children 0)
4770          (parent-size (window-new-pixel window))
4771          (total-sum parent-size)
4772          failed size sub-total sub-delta sub-amount rest)
4773     (while sub
4774       (setq number-of-children (1+ number-of-children))
4775       (when (window-size-fixed-p sub horizontal)
4776         (setq total-sum
4777               (- total-sum (window-size sub horizontal t)))
4778         (set-window-new-normal sub 'ignore))
4779       (setq sub (window-right sub)))
4780
4781     (setq failed t)
4782     (while (and failed (> number-of-children 0))
4783       (setq size (/ total-sum number-of-children))
4784       (setq failed nil)
4785       (setq sub first)
4786       (while (and sub (not failed))
4787         ;; Ignore child windows that should be ignored or are stuck.
4788         (unless (window--resize-child-windows-skip-p sub)
4789           (setq sub-total (window-size sub horizontal t))
4790           (setq sub-delta (- size sub-total))
4791           (setq sub-amount
4792                 (window-sizable sub sub-delta horizontal nil t))
4793           ;; Register the new total size for this child window.
4794           (set-window-new-pixel sub (+ sub-total sub-amount))
4795           (unless (= sub-amount sub-delta)
4796             (setq total-sum (- total-sum sub-total sub-amount))
4797             (setq number-of-children (1- number-of-children))
4798             ;; We failed and need a new round.
4799             (setq failed t)
4800             (set-window-new-normal sub 'skip)))
4801         (setq sub (window-right sub))))
4802
4803     ;; How can we be sure that `number-of-children' is NOT zero here ?
4804     (setq rest (% total-sum number-of-children))
4805     ;; Fix rounding by trying to enlarge non-stuck windows by one line
4806     ;; (column) until `rest' is zero.
4807     (setq sub first)
4808     (while (and sub (> rest 0))
4809       (unless (window--resize-child-windows-skip-p window)
4810         (set-window-new-pixel sub (min rest char-size) t)
4811         (setq rest (- rest char-size)))
4812       (setq sub (window-right sub)))
4813
4814     ;; Fix rounding by trying to enlarge stuck windows by one line
4815     ;; (column) until `rest' equals zero.
4816     (setq sub first)
4817     (while (and sub (> rest 0))
4818       (unless (eq (window-new-normal sub) 'ignore)
4819         (set-window-new-pixel sub (min rest char-size) t)
4820         (setq rest (- rest char-size)))
4821       (setq sub (window-right sub)))
4822
4823     (setq sub first)
4824     (while sub
4825       ;; Record new normal sizes.
4826       (set-window-new-normal
4827        sub (/ (if (eq (window-new-normal sub) 'ignore)
4828                   (window-size sub horizontal t)
4829                 (window-new-pixel sub))
4830               (float parent-size)))
4831       ;; Recursively balance each window's child windows.
4832       (balance-windows-1 sub horizontal)
4833       (setq sub (window-right sub)))))
4834
4835 (defun balance-windows-1 (window &optional horizontal)
4836   "Subroutine of `balance-windows'."
4837   (if (window-child window)
4838       (let ((sub (window-child window)))
4839         (if (window-combined-p sub horizontal)
4840             (balance-windows-2 window horizontal)
4841           (let ((size (window-new-pixel window)))
4842             (while sub
4843               (set-window-new-pixel sub size)
4844               (balance-windows-1 sub horizontal)
4845               (setq sub (window-right sub))))))))
4846
4847 (defun balance-windows (&optional window-or-frame)
4848   "Balance the sizes of windows of WINDOW-OR-FRAME.
4849 WINDOW-OR-FRAME is optional and defaults to the selected frame.
4850 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
4851 windows of that frame.  If WINDOW-OR-FRAME denotes a window,
4852 recursively balance the sizes of all child windows of that
4853 window."
4854   (interactive)
4855   (let* ((window
4856           (cond
4857            ((or (not window-or-frame)
4858                 (frame-live-p window-or-frame))
4859             (frame-root-window window-or-frame))
4860            ((or (window-live-p window-or-frame)
4861                 (window-child window-or-frame))
4862             window-or-frame)
4863            (t
4864             (error "Not a window or frame %s" window-or-frame))))
4865          (frame (window-frame window)))
4866     ;; Balance vertically.
4867     (window--resize-reset (window-frame window))
4868     (balance-windows-1 window)
4869     (when (window--resize-apply-p frame)
4870       (window-resize-apply frame)
4871       (window--pixel-to-total frame)
4872       (run-window-configuration-change-hook frame))
4873     ;; Balance horizontally.
4874     (window--resize-reset (window-frame window) t)
4875     (balance-windows-1 window t)
4876     (when (window--resize-apply-p frame t)
4877       (window-resize-apply frame t)
4878       (window--pixel-to-total frame t)
4879       (run-window-configuration-change-hook frame))))
4880
4881 (defun window-fixed-size-p (&optional window direction)
4882   "Return t if WINDOW cannot be resized in DIRECTION.
4883 WINDOW defaults to the selected window.  DIRECTION can be
4884 nil (i.e. any), `height' or `width'."
4885   (with-current-buffer (window-buffer window)
4886     (when (and (boundp 'window-size-fixed) window-size-fixed)
4887       (not (and direction
4888                 (member (cons direction window-size-fixed)
4889                         '((height . width) (width . height))))))))
4890
4891 ;;; A different solution to balance-windows.
4892 (defvar window-area-factor 1
4893   "Factor by which the window area should be over-estimated.
4894 This is used by `balance-windows-area'.
4895 Changing this globally has no effect.")
4896 (make-variable-buffer-local 'window-area-factor)
4897
4898 (defun balance-windows-area-adjust (window delta horizontal pixelwise)
4899   "Wrapper around `window-resize' with error checking.
4900 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
4901   ;; `window-resize' may fail if delta is too large.
4902   (while (>= (abs delta) 1)
4903     (condition-case nil
4904         (progn
4905           ;; It was wrong to use `window-resize' here.  Somehow
4906           ;; `balance-windows-area' depends on resizing windows
4907           ;; asymmetrically.
4908           (adjust-window-trailing-edge window delta horizontal pixelwise)
4909           (setq delta 0))
4910       (error
4911        ;;(message "adjust: %s" (error-message-string err))
4912        (setq delta (/ delta 2))))))
4913
4914 (defun balance-windows-area ()
4915   "Make all visible windows the same area (approximately).
4916 See also `window-area-factor' to change the relative size of
4917 specific buffers."
4918   (interactive)
4919   (let* ((unchanged 0) (carry 0) (round 0)
4920          ;; Remove fixed-size windows.
4921          (wins (delq nil (mapcar (lambda (win)
4922                                    (if (not (window-fixed-size-p win)) win))
4923                                  (window-list nil 'nomini))))
4924          (changelog nil)
4925          (pixelwise window-resize-pixelwise)
4926          next)
4927     ;; Resizing a window changes the size of surrounding windows in complex
4928     ;; ways, so it's difficult to balance them all.  The introduction of
4929     ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
4930     ;; very difficult to do.  `balance-window' above takes an off-line
4931     ;; approach: get the whole window tree, then balance it, then try to
4932     ;; adjust the windows so they fit the result.