Fix bug ref
[bpt/emacs.git] / lisp / window.el
CommitLineData
3c448ab6
MR
1;;; window.el --- GNU Emacs window commands aside from those written in C
2
acaf905b 3;; Copyright (C) 1985, 1989, 1992-1994, 2000-2012
3689984f 4;; Free Software Foundation, Inc.
3c448ab6
MR
5
6;; Maintainer: FSF
7;; Keywords: internal
bd78fa1d 8;; Package: emacs
3c448ab6
MR
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
3c448ab6
MR
31(defmacro save-selected-window (&rest body)
32 "Execute BODY, then select the previously selected window.
33The value returned is the value of the last form in BODY.
34
35This macro saves and restores the selected window, as well as the
36selected window in each frame. If the previously selected window
37is no longer live, then whatever window is selected at the end of
38BODY remains selected. If the previously selected window of some
39frame is no longer live at the end of BODY, that frame's selected
40window is left alone.
41
42This macro saves and restores the current buffer, since otherwise
43its normal operation could make a different buffer current. The
44order of recently selected windows and the buffer list ordering
45are not altered by this macro (unless they are altered in BODY)."
f291fe60 46 (declare (indent 0) (debug t))
3c448ab6 47 `(let ((save-selected-window-window (selected-window))
c6bf3022
CY
48 ;; We save and restore all frames' selected windows, because
49 ;; `select-window' can change the frame-selected-window of
50 ;; whatever frame that window is in. Each text terminal's
51 ;; top-frame is preserved by putting it last in the list.
3c448ab6 52 (save-selected-window-alist
c6bf3022
CY
53 (apply 'append
54 (mapcar (lambda (terminal)
55 (let ((frames (frames-on-display-list terminal))
56 (top-frame (tty-top-frame terminal))
57 alist)
58 (if top-frame
59 (setq frames
60 (cons top-frame
61 (delq top-frame frames))))
62 (dolist (f frames)
63 (push (cons f (frame-selected-window f))
64 alist))))
65 (terminal-list)))))
3c448ab6
MR
66 (save-current-buffer
67 (unwind-protect
68 (progn ,@body)
69 (dolist (elt save-selected-window-alist)
70 (and (frame-live-p (car elt))
71 (window-live-p (cdr elt))
72 (set-frame-selected-window (car elt) (cdr elt) 'norecord)))
73 (when (window-live-p save-selected-window-window)
74 (select-window save-selected-window-window 'norecord))))))
75
c5e28e39
MR
76(defvar temp-buffer-window-setup-hook nil
77 "Normal hook run by `with-temp-buffer-window' before buffer display.
78This hook is run by `with-temp-buffer-window' with the buffer to be
79displayed current.")
80
81(defvar temp-buffer-window-show-hook nil
82 "Normal hook run by `with-temp-buffer-window' after buffer display.
83This hook is run by `with-temp-buffer-window' with the buffer
84displayed and current and its window selected.")
85
86(defun temp-buffer-window-setup (buffer-or-name)
87 "Set up temporary buffer specified by BUFFER-OR-NAME
88Return the buffer."
89 (let ((old-dir default-directory)
90 (buffer (get-buffer-create buffer-or-name)))
91 (with-current-buffer buffer
92 (kill-all-local-variables)
93 (setq default-directory old-dir)
94 (delete-all-overlays)
95 (setq buffer-read-only nil)
96 (setq buffer-file-name nil)
97 (setq buffer-undo-list t)
98 (let ((inhibit-read-only t)
99 (inhibit-modification-hooks t))
100 (erase-buffer)
101 (run-hooks 'temp-buffer-window-setup-hook))
102 ;; Return the buffer.
103 buffer)))
104
105(defun temp-buffer-window-show (&optional buffer action)
106 "Show temporary buffer BUFFER in a window.
107Return the window showing BUFFER. Pass ACTION as action argument
108to `display-buffer'."
109 (let (window frame)
110 (with-current-buffer buffer
111 (set-buffer-modified-p nil)
112 (setq buffer-read-only t)
113 (goto-char (point-min))
8e17c9ba
MR
114 (when (let ((window-combination-limit
115 ;; When `window-combination-limit' equals
116 ;; `temp-buffer' or `temp-buffer-resize' and
117 ;; `temp-buffer-resize-mode' is enabled in this
118 ;; buffer bind it to t so resizing steals space
119 ;; preferably from the window that was split.
120 (if (or (eq window-combination-limit 'temp-buffer)
121 (and (eq window-combination-limit
122 'temp-buffer-resize)
123 temp-buffer-resize-mode))
124 t
125 window-combination-limit)))
126 (setq window (display-buffer buffer action)))
c5e28e39
MR
127 (setq frame (window-frame window))
128 (unless (eq frame (selected-frame))
129 (raise-frame frame))
130 (setq minibuffer-scroll-window window)
131 (set-window-hscroll window 0)
132 (with-selected-window window
133 (run-hooks 'temp-buffer-window-show-hook)
134 (when temp-buffer-resize-mode
135 (resize-temp-buffer-window window)))
136 ;; Return the window.
137 window))))
138
139(defmacro with-temp-buffer-window (buffer-or-name action quit-function &rest body)
140 "Evaluate BODY and display buffer specified by BUFFER-OR-NAME.
141BUFFER-OR-NAME must specify either a live buffer or the name of a
142buffer. If no buffer with such a name exists, create one.
143
144Make sure the specified buffer is empty before evaluating BODY.
145Do not make that buffer current for BODY. Instead, bind
146`standard-output' to that buffer, so that output generated with
147`prin1' and similar functions in BODY goes into that buffer.
148
149After evaluating BODY, mark the specified buffer unmodified and
150read-only, and display it in a window via `display-buffer'. Pass
151ACTION as action argument to `display-buffer'. Automatically
152shrink the window used if `temp-buffer-resize-mode' is enabled.
153
154Return the value returned by BODY unless QUIT-FUNCTION specifies
155a function. In that case, run the function with two arguments -
156the window showing the specified buffer and the value returned by
157BODY - and return the value returned by that function.
158
159If the buffer is displayed on a new frame, the window manager may
160decide to select that frame. In that case, it's usually a good
161strategy if the function specified by QUIT-FUNCTION selects the
162window showing the buffer before reading a value from the
163minibuffer, for example, when asking a `yes-or-no-p' question.
164
165This construct is similar to `with-output-to-temp-buffer' but
166does neither put the buffer in help mode nor does it call
167`temp-buffer-show-function'. It also runs different hooks,
168namely `temp-buffer-window-setup-hook' (with the specified buffer
169current) and `temp-buffer-window-show-hook' (with the specified
170buffer current and the window showing it selected).
171
172Since this macro calls `display-buffer', the window displaying
173the buffer is usually not selected and the specified buffer
174usually not made current. QUIT-FUNCTION can override that."
175 (declare (debug t))
176 (let ((buffer (make-symbol "buffer"))
177 (window (make-symbol "window"))
178 (value (make-symbol "value")))
179 `(let* ((,buffer (temp-buffer-window-setup ,buffer-or-name))
180 (standard-output ,buffer)
181 ,window ,value)
182 (with-current-buffer ,buffer
183 (setq ,value (progn ,@body))
184 (setq ,window (temp-buffer-window-show ,buffer ,action)))
185
186 (if (functionp ,quit-function)
187 (funcall ,quit-function ,window ,value)
188 ,value))))
189
d68443dc
MR
190;; The following two functions are like `window-next-sibling' and
191;; `window-prev-sibling' but the WINDOW argument is _not_ optional (so
192;; they don't substitute the selected window for nil), and they return
193;; nil when WINDOW doesn't have a parent (like a frame's root window or
194;; a minibuffer window).
4b0d61e3 195(defun window-right (window)
85cc1f11
MR
196 "Return WINDOW's right sibling.
197Return nil if WINDOW is the root window of its frame. WINDOW can
198be any window."
d68443dc 199 (and window (window-parent window) (window-next-sibling window)))
85cc1f11 200
4b0d61e3 201(defun window-left (window)
85cc1f11
MR
202 "Return WINDOW's left sibling.
203Return nil if WINDOW is the root window of its frame. WINDOW can
204be any window."
d68443dc 205 (and window (window-parent window) (window-prev-sibling window)))
85cc1f11 206
4b0d61e3 207(defun window-child (window)
85c2386b
MR
208 "Return WINDOW's first child window.
209WINDOW can be any window."
d68443dc 210 (or (window-top-child window) (window-left-child window)))
85cc1f11
MR
211
212(defun window-child-count (window)
85c2386b
MR
213 "Return number of WINDOW's child windows.
214WINDOW can be any window."
85cc1f11
MR
215 (let ((count 0))
216 (when (and (windowp window) (setq window (window-child window)))
217 (while window
218 (setq count (1+ count))
d68443dc 219 (setq window (window-next-sibling window))))
85cc1f11
MR
220 count))
221
222(defun window-last-child (window)
85c2386b
MR
223 "Return last child window of WINDOW.
224WINDOW can be any window."
85cc1f11 225 (when (and (windowp window) (setq window (window-child window)))
d68443dc
MR
226 (while (window-next-sibling window)
227 (setq window (window-next-sibling window))))
85cc1f11
MR
228 window)
229
4b0d61e3 230(defun window-normalize-buffer (buffer-or-name)
85cc1f11
MR
231 "Return buffer specified by BUFFER-OR-NAME.
232BUFFER-OR-NAME must be either a buffer or a string naming a live
233buffer and defaults to the current buffer."
234 (cond
235 ((not buffer-or-name)
236 (current-buffer))
237 ((bufferp buffer-or-name)
238 (if (buffer-live-p buffer-or-name)
239 buffer-or-name
240 (error "Buffer %s is not a live buffer" buffer-or-name)))
241 ((get-buffer buffer-or-name))
242 (t
243 (error "No such buffer %s" buffer-or-name))))
244
4b0d61e3 245(defun window-normalize-frame (frame)
85cc1f11
MR
246 "Return frame specified by FRAME.
247FRAME must be a live frame and defaults to the selected frame."
248 (if frame
249 (if (frame-live-p frame)
250 frame
251 (error "%s is not a live frame" frame))
252 (selected-frame)))
253
4b0d61e3 254(defun window-normalize-window (window &optional live-only)
85c2386b
MR
255 "Return the window specified by WINDOW.
256If WINDOW is nil, return the selected window. Otherwise, if
257WINDOW is a live or an internal window, return WINDOW; if
258LIVE-ONLY is non-nil, return WINDOW for a live window only.
447f16b8 259Otherwise, signal an error."
85c2386b
MR
260 (cond
261 ((null window)
262 (selected-window))
263 (live-only
264 (if (window-live-p window)
265 window
266 (error "%s is not a live window" window)))
267 ((window-valid-p window)
268 window)
269 (t
270 (error "%s is not a valid window" window))))
85cc1f11
MR
271
272(defvar ignore-window-parameters nil
273 "If non-nil, standard functions ignore window parameters.
274The functions currently affected by this are `split-window',
275`delete-window', `delete-other-windows' and `other-window'.
276
277An application may bind this to a non-nil value around calls to
278these functions to inhibit processing of window parameters.")
279
a1511caf 280(defconst window-safe-min-height 1
8da11505 281 "The absolute minimum number of lines of a window.
a1511caf
MR
282Anything less might crash Emacs.")
283
562dd5e9
MR
284(defcustom window-min-height 4
285 "The minimum number of lines of any window.
9173deec
JB
286The value has to accommodate a mode- or header-line if present.
287A value less than `window-safe-min-height' is ignored. The value
562dd5e9
MR
288of this variable is honored when windows are resized or split.
289
290Applications should never rebind this variable. To resize a
291window to a height less than the one specified here, an
d615d6d2 292application should instead call `window-resize' with a non-nil
562dd5e9 293IGNORE argument. In order to have `split-window' make a window
e4769531 294shorter, explicitly specify the SIZE argument of that function."
562dd5e9
MR
295 :type 'integer
296 :version "24.1"
297 :group 'windows)
298
a1511caf 299(defconst window-safe-min-width 2
8da11505 300 "The absolute minimum number of columns of a window.
a1511caf
MR
301Anything less might crash Emacs.")
302
562dd5e9
MR
303(defcustom window-min-width 10
304 "The minimum number of columns of any window.
a91adc7e 305The value has to accommodate margins, fringes, or scrollbars if
562dd5e9
MR
306present. A value less than `window-safe-min-width' is ignored.
307The value of this variable is honored when windows are resized or
308split.
309
310Applications should never rebind this variable. To resize a
311window to a width less than the one specified here, an
d615d6d2 312application should instead call `window-resize' with a non-nil
562dd5e9 313IGNORE argument. In order to have `split-window' make a window
e4769531 314narrower, explicitly specify the SIZE argument of that function."
562dd5e9
MR
315 :type 'integer
316 :version "24.1"
317 :group 'windows)
318
4b0d61e3 319(defun window-combined-p (&optional window horizontal)
49745b39 320 "Return non-nil if WINDOW has siblings in a given direction.
85c2386b 321WINDOW must be a valid window and defaults to the selected one.
49745b39
CY
322
323HORIZONTAL determines a direction for the window combination.
324If HORIZONTAL is omitted or nil, return non-nil if WINDOW is part
325of a vertical window combination.
326If HORIZONTAL is non-nil, return non-nil if WINDOW is part of a
327horizontal window combination."
447f16b8 328 (setq window (window-normalize-window window))
85cc1f11 329 (let ((parent (window-parent window)))
49745b39
CY
330 (and parent
331 (if horizontal
332 (window-left-child parent)
333 (window-top-child parent)))))
85cc1f11 334
be7f5545
MR
335(defun window-combinations (window &optional horizontal)
336 "Return largest number of windows vertically arranged within WINDOW.
85c2386b 337WINDOW must be a valid window and defaults to the selected one.
49745b39 338If HORIZONTAL is non-nil, return the largest number of
be7f5545 339windows horizontally arranged within WINDOW."
447f16b8 340 (setq window (window-normalize-window window))
85cc1f11
MR
341 (cond
342 ((window-live-p window)
343 ;; If WINDOW is live, return 1.
344 1)
49745b39
CY
345 ((if horizontal
346 (window-left-child window)
347 (window-top-child window))
85cc1f11 348 ;; If WINDOW is iso-combined, return the sum of the values for all
be7f5545 349 ;; child windows of WINDOW.
85cc1f11
MR
350 (let ((child (window-child window))
351 (count 0))
352 (while child
353 (setq count
3d8daefe 354 (+ (window-combinations child horizontal)
85cc1f11
MR
355 count))
356 (setq child (window-right child)))
357 count))
358 (t
359 ;; If WINDOW is not iso-combined, return the maximum value of any
be7f5545 360 ;; child window of WINDOW.
85cc1f11
MR
361 (let ((child (window-child window))
362 (count 1))
363 (while child
364 (setq count
3d8daefe 365 (max (window-combinations child horizontal)
85cc1f11
MR
366 count))
367 (setq child (window-right child)))
368 count))))
369
c7635a97 370(defun walk-window-tree-1 (fun walk-window-tree-window any &optional sub-only)
85cc1f11
MR
371 "Helper function for `walk-window-tree' and `walk-window-subtree'."
372 (let (walk-window-tree-buffer)
373 (while walk-window-tree-window
374 (setq walk-window-tree-buffer
375 (window-buffer walk-window-tree-window))
376 (when (or walk-window-tree-buffer any)
c7635a97 377 (funcall fun walk-window-tree-window))
85cc1f11
MR
378 (unless walk-window-tree-buffer
379 (walk-window-tree-1
c7635a97 380 fun (window-left-child walk-window-tree-window) any)
85cc1f11 381 (walk-window-tree-1
c7635a97 382 fun (window-top-child walk-window-tree-window) any))
85cc1f11
MR
383 (if sub-only
384 (setq walk-window-tree-window nil)
385 (setq walk-window-tree-window
386 (window-right walk-window-tree-window))))))
387
ea95074e 388(defun walk-window-tree (fun &optional frame any minibuf)
c7635a97
CY
389 "Run function FUN on each live window of FRAME.
390FUN must be a function with one argument - a window. FRAME must
85cc1f11 391be a live frame and defaults to the selected one. ANY, if
ea95074e 392non-nil, means to run FUN on all live and internal windows of
85cc1f11
MR
393FRAME.
394
ea95074e
MR
395Optional argument MINIBUF t means run FUN on FRAME's minibuffer
396window even if it isn't active. MINIBUF nil or omitted means run
397FUN on FRAME's minibuffer window only if it's active. In both
398cases the minibuffer window must be part of FRAME. MINIBUF
399neither nil nor t means never run FUN on the minibuffer window.
400
85cc1f11 401This function performs a pre-order, depth-first traversal of the
c7635a97 402window tree. If FUN changes the window tree, the result is
85cc1f11 403unpredictable."
ea95074e
MR
404 (setq frame (window-normalize-frame frame))
405 (walk-window-tree-1 fun (frame-root-window frame) any)
406 (when (memq minibuf '(nil t))
407 ;; Run FUN on FRAME's minibuffer window if requested.
408 (let ((minibuffer-window (minibuffer-window frame)))
409 (when (and (window-live-p minibuffer-window)
410 (eq (window-frame minibuffer-window) frame)
411 (or (eq minibuf t)
412 (minibuffer-window-active-p minibuffer-window)))
413 (funcall fun minibuffer-window)))))
85cc1f11 414
c7635a97
CY
415(defun walk-window-subtree (fun &optional window any)
416 "Run function FUN on the subtree of windows rooted at WINDOW.
417WINDOW defaults to the selected window. FUN must be a function
418with one argument - a window. By default, run FUN only on live
be7f5545 419windows of the subtree. If the optional argument ANY is non-nil,
c7635a97
CY
420run FUN on all live and internal windows of the subtree. If
421WINDOW is live, run FUN on WINDOW only.
85cc1f11
MR
422
423This function performs a pre-order, depth-first traversal of the
c7635a97 424subtree rooted at WINDOW. If FUN changes that tree, the result
be7f5545 425is unpredictable."
447f16b8 426 (setq window (window-normalize-window window))
c7635a97 427 (walk-window-tree-1 fun window any t))
85cc1f11 428
ea95074e 429(defun window-with-parameter (parameter &optional value frame any minibuf)
85cc1f11
MR
430 "Return first window on FRAME with PARAMETER non-nil.
431FRAME defaults to the selected frame. Optional argument VALUE
432non-nil means only return a window whose window-parameter value
382c953b 433for PARAMETER equals VALUE (comparison is done with `equal').
85cc1f11 434Optional argument ANY non-nil means consider internal windows
ea95074e
MR
435too.
436
437Optional argument MINIBUF t means consider FRAME's minibuffer
438window even if it isn't active. MINIBUF nil or omitted means
439consider FRAME's minibuffer window only if it's active. In both
440cases the minibuffer window must be part of FRAME. MINIBUF
441neither nil nor t means never consider the minibuffer window."
cb882333 442 (let (this-value)
85cc1f11
MR
443 (catch 'found
444 (walk-window-tree
445 (lambda (window)
446 (when (and (setq this-value (window-parameter window parameter))
447 (or (not value) (equal value this-value)))
448 (throw 'found window)))
ea95074e 449 frame any minibuf))))
85cc1f11
MR
450
451;;; Atomic windows.
452(defun window-atom-root (&optional window)
453 "Return root of atomic window WINDOW is a part of.
85c2386b 454WINDOW must be a valid window and defaults to the selected one.
382c953b 455Return nil if WINDOW is not part of an atomic window."
447f16b8 456 (setq window (window-normalize-window window))
85cc1f11
MR
457 (let (root)
458 (while (and window (window-parameter window 'window-atom))
459 (setq root window)
460 (setq window (window-parent window)))
461 root))
462
5386012d 463(defun window-make-atom (window)
85cc1f11
MR
464 "Make WINDOW an atomic window.
465WINDOW must be an internal window. Return WINDOW."
466 (if (not (window-child window))
467 (error "Window %s is not an internal window" window)
468 (walk-window-subtree
469 (lambda (window)
470 (set-window-parameter window 'window-atom t))
471 window t)
472 window))
473
caceae25
MR
474(defun display-buffer-in-atom-window (buffer alist)
475 "Display BUFFER in an atomic window.
476This function displays BUFFER in a new window that will be
477combined with an existing window to form an atomic window. If
478the existing window is already part of an atomic window, add the
479new window to that atomic window. Operations like `split-window'
480or `delete-window', when applied to a constituent of an atomic
481window, are applied atomically to the root of that atomic window.
482
483ALIST is an association list of symbols and values. The
484following symbols can be used.
485
486`window' specifies the existing window the new window shall be
487 combined with. Use `window-atom-root' to make the new window a
488 sibling of an atomic window's root. If an internal window is
489 specified here, all children of that window become part of the
490 atomic window too. If no window is specified, the new window
491 becomes a sibling of the selected window.
492
493`side' denotes the side of the existing window where the new
494 window shall be located. Valid values are `below', `right',
495 `above' and `left'. The default is `below'.
496
497The return value is the new window, nil when creating that window
498failed."
499 (let ((ignore-window-parameters t)
500 (window-combination-limit t)
501 (window (cdr (assq 'window alist)))
502 (side (cdr (assq 'side alist)))
503 new)
504 (setq window (window-normalize-window window))
505 ;; Split off new window
506 (when (setq new (split-window window nil side))
507 ;; Make sure we have a valid atomic window.
508 (window-make-atom (window-parent window))
509 ;; Display BUFFER in NEW and return NEW.
510 (window--display-buffer
511 buffer new 'window display-buffer-mark-dedicated))))
512
54f9154c
MR
513(defun window--atom-check-1 (window)
514 "Subroutine of `window--atom-check'."
85cc1f11
MR
515 (when window
516 (if (window-parameter window 'window-atom)
517 (let ((count 0))
518 (when (or (catch 'reset
519 (walk-window-subtree
520 (lambda (window)
521 (if (window-parameter window 'window-atom)
522 (setq count (1+ count))
523 (throw 'reset t)))
524 window t))
525 ;; count >= 1 must hold here. If there's no other
526 ;; window around dissolve this atomic window.
527 (= count 1))
528 ;; Dissolve atomic window.
529 (walk-window-subtree
530 (lambda (window)
531 (set-window-parameter window 'window-atom nil))
532 window t)))
533 ;; Check children.
534 (unless (window-buffer window)
54f9154c
MR
535 (window--atom-check-1 (window-left-child window))
536 (window--atom-check-1 (window-top-child window))))
85cc1f11 537 ;; Check right sibling
54f9154c 538 (window--atom-check-1 (window-right window))))
85cc1f11 539
54f9154c 540(defun window--atom-check (&optional frame)
85cc1f11
MR
541 "Check atomicity of all windows on FRAME.
542FRAME defaults to the selected frame. If an atomic window is
be7f5545
MR
543wrongly configured, reset the atomicity of all its windows on
544FRAME to nil. An atomic window is wrongly configured if it has
545no child windows or one of its child windows is not atomic."
54f9154c 546 (window--atom-check-1 (frame-root-window frame)))
85cc1f11
MR
547
548;; Side windows.
549(defvar window-sides '(left top right bottom)
550 "Window sides.")
551
552(defcustom window-sides-vertical nil
553 "If non-nil, left and right side windows are full height.
554Otherwise, top and bottom side windows are full width."
555 :type 'boolean
556 :group 'windows
557 :version "24.1")
558
559(defcustom window-sides-slots '(nil nil nil nil)
560 "Maximum number of side window slots.
561The value is a list of four elements specifying the number of
382c953b 562side window slots on (in this order) the left, top, right and
85cc1f11
MR
563bottom side of each frame. If an element is a number, this means
564to display at most that many side windows on the corresponding
565side. If an element is nil, this means there's no bound on the
566number of slots on that side."
2bed3f04 567 :version "24.1"
85cc1f11
MR
568 :risky t
569 :type
570 '(list
571 :value (nil nil nil nil)
572 (choice
573 :tag "Left"
574 :help-echo "Maximum slots of left side window."
575 :value nil
576 :format "%[Left%] %v\n"
577 (const :tag "Unlimited" :format "%t" nil)
578 (integer :tag "Number" :value 2 :size 5))
579 (choice
580 :tag "Top"
581 :help-echo "Maximum slots of top side window."
582 :value nil
583 :format "%[Top%] %v\n"
584 (const :tag "Unlimited" :format "%t" nil)
585 (integer :tag "Number" :value 3 :size 5))
586 (choice
587 :tag "Right"
588 :help-echo "Maximum slots of right side window."
589 :value nil
590 :format "%[Right%] %v\n"
591 (const :tag "Unlimited" :format "%t" nil)
592 (integer :tag "Number" :value 2 :size 5))
593 (choice
594 :tag "Bottom"
595 :help-echo "Maximum slots of bottom side window."
596 :value nil
597 :format "%[Bottom%] %v\n"
598 (const :tag "Unlimited" :format "%t" nil)
599 (integer :tag "Number" :value 3 :size 5)))
600 :group 'windows)
601
caceae25
MR
602(defun window--major-non-side-window (&optional frame)
603 "Return the major non-side window of frame FRAME.
604The optional argument FRAME must be a live frame and defaults to
605the selected one.
606
607If FRAME has at least one side window, the major non-side window
608is either an internal non-side window such that all other
609non-side windows on FRAME descend from it, or the single live
610non-side window of FRAME. If FRAME has no side windows, return
611its root window."
612 (let ((frame (window-normalize-frame frame))
613 major sibling)
614 ;; Set major to the _last_ window found by `walk-window-tree' that
615 ;; is not a side window but has a side window as its sibling.
616 (walk-window-tree
617 (lambda (window)
618 (and (not (window-parameter window 'window-side))
619 (or (and (setq sibling (window-prev-sibling window))
620 (window-parameter sibling 'window-side))
621 (and (setq sibling (window-next-sibling window))
622 (window-parameter sibling 'window-side)))
623 (setq major window)))
624 frame t)
625 (or major (frame-root-window frame))))
626
627(defun window--major-side-window (side)
628 "Return major side window on SIDE.
629SIDE must be one of the symbols `left', `top', `right' or
630`bottom'. Return nil if no such window exists."
631 (let ((root (frame-root-window))
632 window)
633 ;; (1) If a window on the opposite side exists, return that window's
634 ;; sibling.
635 ;; (2) If the new window shall span the entire side, return the
636 ;; frame's root window.
637 ;; (3) If a window on an orthogonal side exists, return that
638 ;; window's sibling.
639 ;; (4) Otherwise return the frame's root window.
640 (cond
641 ((or (and (eq side 'left)
642 (setq window (window-with-parameter 'window-side 'right nil t)))
643 (and (eq side 'top)
644 (setq window (window-with-parameter 'window-side 'bottom nil t))))
645 (window-prev-sibling window))
646 ((or (and (eq side 'right)
647 (setq window (window-with-parameter 'window-side 'left nil t)))
648 (and (eq side 'bottom)
649 (setq window (window-with-parameter 'window-side 'top nil t))))
650 (window-next-sibling window))
651 ((memq side '(left right))
652 (cond
653 (window-sides-vertical
654 root)
655 ((setq window (window-with-parameter 'window-side 'top nil t))
656 (window-next-sibling window))
657 ((setq window (window-with-parameter 'window-side 'bottom nil t))
658 (window-prev-sibling window))
659 (t root)))
660 ((memq side '(top bottom))
661 (cond
662 ((not window-sides-vertical)
663 root)
664 ((setq window (window-with-parameter 'window-side 'left nil t))
665 (window-next-sibling window))
666 ((setq window (window-with-parameter 'window-side 'right nil t))
667 (window-prev-sibling window))
668 (t root))))))
669
670(defun display-buffer-in-major-side-window (buffer side slot &optional alist)
671 "Display BUFFER in a new window on SIDE of the selected frame.
672SIDE must be one of `left', `top', `right' or `bottom'. SLOT
673specifies the slot to use. ALIST is an association list of
674symbols and values as passed to `display-buffer-in-side-window'.
675This function may be called only if no window on SIDE exists yet.
676The new window automatically becomes the \"major\" side window on
677SIDE. Return the new window, nil if its creation window failed."
678 (let* ((root (frame-root-window))
679 (left-or-right (memq side '(left right)))
680 (size (or (assq 'size alist)
681 (/ (window-total-size (frame-root-window) left-or-right)
682 ;; By default use a fourth of the size of the
683 ;; frame's root window. This has to be made
684 ;; customizable via ALIST.
685 4)))
686 (major (window--major-side-window side))
687 (selected-window (selected-window))
688 (on-side (cond
689 ((eq side 'top) 'above)
690 ((eq side 'bottom) 'below)
691 (t side)))
692 ;; The following two bindings will tell `split-window' to take
693 ;; the space for the new window from `major' and not make a new
694 ;; parent window unless needed.
695 (window-combination-resize 'side)
696 (window-combination-limit nil)
697 (new (split-window major (- size) on-side))
698 fun)
699 (when new
700 ;; Initialize `window-side' parameter of new window to SIDE.
701 (set-window-parameter new 'window-side side)
702 ;; Install `window-slot' parameter of new window.
703 (set-window-parameter new 'window-slot slot)
704 ;; Install `delete-window' parameter thus making sure that when
705 ;; the new window is deleted, a side window on the opposite side
706 ;; does not get resized.
707 (set-window-parameter new 'delete-window 'delete-side-window)
708 ;; Install BUFFER in new window and return NEW.
709 (window--display-buffer buffer new 'window 'side))))
710
711(defun delete-side-window (window)
712 "Delete side window WINDOW."
713 (let ((window-combination-resize
714 (window-parameter (window-parent window) 'window-side))
715 (ignore-window-parameters t))
716 (delete-window window)))
717
718(defun display-buffer-in-side-window (buffer alist)
719 "Display BUFFER in a window on side SIDE of the selected frame.
720ALIST is an association list of symbols and values. The
721following symbols can be used:
722
723`side' denotes the side of the existing window where the new
724 window shall be located. Valid values are `bottom', `right',
725 `top' and `left'. The default is `bottom'.
726
727`slot' if non-nil, specifies the window slot where to display
728 BUFFER. A value of zero or nil means use the middle slot on
729 the specified side. A negative value means use a slot
730 preceding (that is, above or on the left of) the middle slot.
731 A positive value means use a slot following (that is, below or
732 on the right of) the middle slot. The default is zero."
733 (let ((side (or (cdr (assq 'side alist)) 'bottom))
734 (slot (or (cdr (assq 'slot alist)) 0))
735 new)
736 (cond
737 ((not (memq side '(top bottom left right)))
738 (error "Invalid side %s specified" side))
739 ((not (numberp slot))
740 (error "Invalid slot %s specified" slot)))
741
742 (let* ((major (window-with-parameter 'window-side side nil t))
743 ;; `major' is the major window on SIDE, `windows' the list of
744 ;; life windows on SIDE.
745 (windows
746 (when major
747 (let (windows)
748 (walk-window-tree
749 (lambda (window)
750 (when (eq (window-parameter window 'window-side) side)
751 (setq windows (cons window windows)))))
752 (nreverse windows))))
753 (slots (when major (max 1 (window-child-count major))))
754 (max-slots
755 (nth (cond
756 ((eq side 'left) 0)
757 ((eq side 'top) 1)
758 ((eq side 'right) 2)
759 ((eq side 'bottom) 3))
760 window-sides-slots))
761 (selected-window (selected-window))
762 window this-window this-slot prev-window next-window
763 best-window best-slot abs-slot new-window)
764
765 (cond
766 ((and (numberp max-slots) (<= max-slots 0))
767 ;; No side-slots available on this side. Don't create an error,
768 ;; just return nil.
769 nil)
770 ((not windows)
771 ;; No major window exists on this side, make one.
772 (display-buffer-in-major-side-window buffer side slot alist))
773 (t
774 ;; Scan windows on SIDE.
775 (catch 'found
776 (dolist (window windows)
777 (setq this-slot (window-parameter window 'window-slot))
778 (cond
779 ;; The following should not happen and probably be checked
780 ;; by window--side-check.
781 ((not (numberp this-slot)))
782 ((= this-slot slot)
783 ;; A window with a matching slot has been found.
784 (setq this-window window)
785 (throw 'found t))
786 (t
787 ;; Check if this window has a better slot value wrt the
788 ;; slot of the window we want.
789 (setq abs-slot
790 (if (or (and (> this-slot 0) (> slot 0))
791 (and (< this-slot 0) (< slot 0)))
792 (abs (- slot this-slot))
793 (+ (abs slot) (abs this-slot))))
794 (unless (and best-slot (<= best-slot abs-slot))
795 (setq best-window window)
796 (setq best-slot abs-slot))
797 (cond
798 ((<= this-slot slot)
799 (setq prev-window window))
800 ((not next-window)
801 (setq next-window window)))))))
802
803 ;; `this-window' is the first window with the same SLOT.
804 ;; `prev-window' is the window with the largest slot < SLOT. A new
805 ;; window will be created after it.
806 ;; `next-window' is the window with the smallest slot > SLOT. A new
807 ;; window will be created before it.
808 ;; `best-window' is the window with the smallest absolute difference
809 ;; of its slot and SLOT.
810
811 ;; Note: We dedicate the window used softly to its buffer to
812 ;; avoid that "other" (non-side) buffer display functions steal
813 ;; it from us. This must eventually become customizable via
814 ;; ALIST (or, better, avoided in the "other" functions).
815 (or (and this-window
816 ;; Reuse `this-window'.
817 (window--display-buffer buffer this-window 'reuse 'side))
818 (and (or (not max-slots) (< slots max-slots))
819 (or (and next-window
820 ;; Make new window before `next-window'.
821 (let ((next-side
822 (if (memq side '(left right)) 'above 'left))
823 (window-combination-resize 'side))
824 (setq window (split-window next-window nil next-side))
825 ;; When the new window is deleted, its space
826 ;; is returned to other side windows.
827 (set-window-parameter
828 window 'delete-window 'delete-side-window)
829 window))
830 (and prev-window
831 ;; Make new window after `prev-window'.
832 (let ((prev-side
833 (if (memq side '(left right)) 'below 'right))
834 (window-combination-resize 'side))
835 (setq window (split-window prev-window nil prev-side))
836 ;; When the new window is deleted, its space
837 ;; is returned to other side windows.
838 (set-window-parameter
839 window 'delete-window 'delete-side-window)
840 window)))
841 (set-window-parameter window 'window-slot slot)
842 (window--display-buffer buffer window 'window 'side))
843 (and best-window
844 ;; Reuse `best-window'.
845 (progn
846 ;; Give best-window the new slot value.
847 (set-window-parameter best-window 'window-slot slot)
848 (window--display-buffer buffer best-window 'reuse 'side)))))))))
849
54f9154c 850(defun window--side-check (&optional frame)
caceae25
MR
851 "Check the side window configuration of FRAME.
852FRAME defaults to the selected frame.
853
854A valid side window configuration preserves the following two
855invariants:
856
857- If there exists a window whose window-side parameter is
858 non-nil, there must exist at least one live window whose
859 window-side parameter is nil.
860
861- If a window W has a non-nil window-side parameter (i) it must
862 have a parent window and that parent's window-side parameter
863 must be either nil or the same as for W, and (ii) any child
864 window of W must have the same window-side parameter as W.
865
866If the configuration is invalid, reset the window-side parameters
867of all windows on FRAME to nil."
868 (let (left top right bottom none side parent parent-side)
85cc1f11
MR
869 (when (or (catch 'reset
870 (walk-window-tree
871 (lambda (window)
872 (setq side (window-parameter window 'window-side))
873 (setq parent (window-parent window))
874 (setq parent-side
875 (and parent (window-parameter parent 'window-side)))
876 ;; The following `cond' seems a bit tedious, but I'd
877 ;; rather stick to using just the stack.
878 (cond
879 (parent-side
880 (when (not (eq parent-side side))
881 ;; A parent whose window-side is non-nil must
882 ;; have a child with the same window-side.
883 (throw 'reset t)))
caceae25
MR
884 ((not side)
885 (when (window-buffer window)
886 ;; Record that we have at least one non-side,
887 ;; live window.
85cc1f11 888 (setq none t)))
caceae25
MR
889 ((if (memq side '(left top))
890 (window-prev-sibling window)
891 (window-next-sibling window))
892 ;; Left and top major side windows must not have a
893 ;; previous sibling, right and bottom major side
894 ;; windows must not have a next sibling.
895 (throw 'reset t))
896 ;; Now check that there's no more than one major
897 ;; window for any of left, top, right and bottom.
85cc1f11 898 ((eq side 'left)
caceae25 899 (if left (throw 'reset t) (setq left t)))
85cc1f11 900 ((eq side 'top)
caceae25 901 (if top (throw 'reset t) (setq top t)))
85cc1f11 902 ((eq side 'right)
caceae25 903 (if right (throw 'reset t) (setq right t)))
85cc1f11 904 ((eq side 'bottom)
caceae25
MR
905 (if bottom (throw 'reset t) (setq bottom t)))
906 (t
907 (throw 'reset t))))
85cc1f11 908 frame t))
caceae25
MR
909 ;; If there's a side window, there must be at least one
910 ;; non-side window.
911 (and (or left top right bottom) (not none)))
85cc1f11
MR
912 (walk-window-tree
913 (lambda (window)
914 (set-window-parameter window 'window-side nil))
915 frame t))))
916
54f9154c 917(defun window--check (&optional frame)
85cc1f11
MR
918 "Check atomic and side windows on FRAME.
919FRAME defaults to the selected frame."
54f9154c
MR
920 (window--side-check frame)
921 (window--atom-check frame))
85cc1f11
MR
922
923;;; Window sizes.
924(defvar window-size-fixed nil
925 "Non-nil in a buffer means windows displaying the buffer are fixed-size.
926If the value is `height', then only the window's height is fixed.
927If the value is `width', then only the window's width is fixed.
928Any other non-nil value fixes both the width and the height.
929
930Emacs won't change the size of any window displaying that buffer,
382c953b 931unless it has no other choice (like when deleting a neighboring
85cc1f11
MR
932window).")
933(make-variable-buffer-local 'window-size-fixed)
934
842e3a93 935(defun window--size-ignore-p (window ignore)
a1511caf 936 "Return non-nil if IGNORE says to ignore size restrictions for WINDOW."
24300f5f 937 (if (window-valid-p ignore) (eq window ignore) ignore))
a1511caf
MR
938
939(defun window-min-size (&optional window horizontal ignore)
2116e93c 940 "Return the minimum size of WINDOW.
85c2386b
MR
941WINDOW must be a valid window and defaults to the selected one.
942Optional argument HORIZONTAL non-nil means return the minimum
943number of columns of WINDOW; otherwise return the minimum number
944of WINDOW's lines.
a1511caf 945
2116e93c 946Optional argument IGNORE, if non-nil, means ignore restrictions
a1511caf 947imposed by fixed size windows, `window-min-height' or
2116e93c 948`window-min-width' settings. If IGNORE equals `safe', live
a1511caf 949windows may get as small as `window-safe-min-height' lines and
2116e93c
EZ
950`window-safe-min-width' columns. If IGNORE is a window, ignore
951restrictions for that window only. Any other non-nil value
952means ignore all of the above restrictions for all windows."
c56cad4a 953 (window--min-size-1
447f16b8 954 (window-normalize-window window) horizontal ignore))
a1511caf 955
c56cad4a 956(defun window--min-size-1 (window horizontal ignore)
a1511caf
MR
957 "Internal function of `window-min-size'."
958 (let ((sub (window-child window)))
959 (if sub
960 (let ((value 0))
961 ;; WINDOW is an internal window.
3d8daefe 962 (if (window-combined-p sub horizontal)
a1511caf 963 ;; The minimum size of an iso-combination is the sum of
be7f5545 964 ;; the minimum sizes of its child windows.
a1511caf
MR
965 (while sub
966 (setq value (+ value
c56cad4a 967 (window--min-size-1 sub horizontal ignore)))
a1511caf
MR
968 (setq sub (window-right sub)))
969 ;; The minimum size of an ortho-combination is the maximum of
be7f5545 970 ;; the minimum sizes of its child windows.
a1511caf
MR
971 (while sub
972 (setq value (max value
c56cad4a 973 (window--min-size-1 sub horizontal ignore)))
a1511caf
MR
974 (setq sub (window-right sub))))
975 value)
976 (with-current-buffer (window-buffer window)
977 (cond
842e3a93 978 ((and (not (window--size-ignore-p window ignore))
a1511caf
MR
979 (window-size-fixed-p window horizontal))
980 ;; The minimum size of a fixed size window is its size.
981 (window-total-size window horizontal))
982 ((or (eq ignore 'safe) (eq ignore window))
983 ;; If IGNORE equals `safe' or WINDOW return the safe values.
984 (if horizontal window-safe-min-width window-safe-min-height))
985 (horizontal
986 ;; For the minimum width of a window take fringes and
987 ;; scroll-bars into account. This is questionable and should
988 ;; be removed as soon as we are able to split (and resize)
989 ;; windows such that the new (or resized) windows can get a
990 ;; size less than the user-specified `window-min-height' and
991 ;; `window-min-width'.
992 (let ((frame (window-frame window))
993 (fringes (window-fringes window))
994 (scroll-bars (window-scroll-bars window)))
995 (max
996 (+ window-safe-min-width
997 (ceiling (car fringes) (frame-char-width frame))
998 (ceiling (cadr fringes) (frame-char-width frame))
999 (cond
1000 ((memq (nth 2 scroll-bars) '(left right))
1001 (nth 1 scroll-bars))
1002 ((memq (frame-parameter frame 'vertical-scroll-bars)
1003 '(left right))
1004 (ceiling (or (frame-parameter frame 'scroll-bar-width) 14)
1005 (frame-char-width)))
1006 (t 0)))
842e3a93 1007 (if (and (not (window--size-ignore-p window ignore))
a1511caf
MR
1008 (numberp window-min-width))
1009 window-min-width
1010 0))))
1011 (t
1012 ;; For the minimum height of a window take any mode- or
1013 ;; header-line into account.
1014 (max (+ window-safe-min-height
1015 (if header-line-format 1 0)
1016 (if mode-line-format 1 0))
842e3a93 1017 (if (and (not (window--size-ignore-p window ignore))
a1511caf
MR
1018 (numberp window-min-height))
1019 window-min-height
1020 0))))))))
1021
1022(defun window-sizable (window delta &optional horizontal ignore)
1023 "Return DELTA if DELTA lines can be added to WINDOW.
85c2386b 1024WINDOW must be a valid window and defaults to the selected one.
a1511caf
MR
1025Optional argument HORIZONTAL non-nil means return DELTA if DELTA
1026columns can be added to WINDOW. A return value of zero means
1027that no lines (or columns) can be added to WINDOW.
1028
be7f5545
MR
1029This function looks only at WINDOW and, recursively, its child
1030windows. The function `window-resizable' looks at other windows
1031as well.
a1511caf
MR
1032
1033DELTA positive means WINDOW shall be enlarged by DELTA lines or
1034columns. If WINDOW cannot be enlarged by DELTA lines or columns
1035return the maximum value in the range 0..DELTA by which WINDOW
1036can be enlarged.
1037
1038DELTA negative means WINDOW shall be shrunk by -DELTA lines or
1039columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
1040return the minimum value in the range DELTA..0 by which WINDOW
1041can be shrunk.
1042
2116e93c 1043Optional argument IGNORE non-nil means ignore restrictions
a1511caf 1044imposed by fixed size windows, `window-min-height' or
2116e93c 1045`window-min-width' settings. If IGNORE equals `safe', live
a1511caf 1046windows may get as small as `window-safe-min-height' lines and
2116e93c
EZ
1047`window-safe-min-width' columns. If IGNORE is a window, ignore
1048restrictions for that window only. Any other non-nil value means
1049ignore all of the above restrictions for all windows."
447f16b8 1050 (setq window (window-normalize-window window))
a1511caf
MR
1051 (cond
1052 ((< delta 0)
1053 (max (- (window-min-size window horizontal ignore)
1054 (window-total-size window horizontal))
1055 delta))
842e3a93 1056 ((window--size-ignore-p window ignore)
a1511caf
MR
1057 delta)
1058 ((> delta 0)
1059 (if (window-size-fixed-p window horizontal)
1060 0
1061 delta))
1062 (t 0)))
1063
4b0d61e3 1064(defun window-sizable-p (window delta &optional horizontal ignore)
a1511caf 1065 "Return t if WINDOW can be resized by DELTA lines.
85c2386b 1066WINDOW must be a valid window and defaults to the selected one.
a1511caf
MR
1067For the meaning of the arguments of this function see the
1068doc-string of `window-sizable'."
447f16b8 1069 (setq window (window-normalize-window window))
a1511caf
MR
1070 (if (> delta 0)
1071 (>= (window-sizable window delta horizontal ignore) delta)
1072 (<= (window-sizable window delta horizontal ignore) delta)))
1073
5e92ca23 1074(defun window--size-fixed-1 (window horizontal)
a1511caf
MR
1075 "Internal function for `window-size-fixed-p'."
1076 (let ((sub (window-child window)))
1077 (catch 'fixed
1078 (if sub
1079 ;; WINDOW is an internal window.
3d8daefe 1080 (if (window-combined-p sub horizontal)
be7f5545
MR
1081 ;; An iso-combination is fixed size if all its child
1082 ;; windows are fixed-size.
a1511caf
MR
1083 (progn
1084 (while sub
5e92ca23 1085 (unless (window--size-fixed-1 sub horizontal)
be7f5545
MR
1086 ;; We found a non-fixed-size child window, so
1087 ;; WINDOW's size is not fixed.
a1511caf
MR
1088 (throw 'fixed nil))
1089 (setq sub (window-right sub)))
be7f5545 1090 ;; All child windows are fixed-size, so WINDOW's size is
a1511caf
MR
1091 ;; fixed.
1092 (throw 'fixed t))
1093 ;; An ortho-combination is fixed-size if at least one of its
be7f5545 1094 ;; child windows is fixed-size.
a1511caf 1095 (while sub
5e92ca23 1096 (when (window--size-fixed-1 sub horizontal)
be7f5545
MR
1097 ;; We found a fixed-size child window, so WINDOW's size
1098 ;; is fixed.
a1511caf
MR
1099 (throw 'fixed t))
1100 (setq sub (window-right sub))))
1101 ;; WINDOW is a live window.
1102 (with-current-buffer (window-buffer window)
1103 (if horizontal
1104 (memq window-size-fixed '(width t))
1105 (memq window-size-fixed '(height t))))))))
1106
1107(defun window-size-fixed-p (&optional window horizontal)
1108 "Return non-nil if WINDOW's height is fixed.
85c2386b
MR
1109WINDOW must be a valid window and defaults to the selected one.
1110Optional argument HORIZONTAL non-nil means return non-nil if
1111WINDOW's width is fixed.
a1511caf
MR
1112
1113If this function returns nil, this does not necessarily mean that
2cffd681
MR
1114WINDOW can be resized in the desired direction. The function
1115`window-resizable' can tell that."
5e92ca23 1116 (window--size-fixed-1
447f16b8 1117 (window-normalize-window window) horizontal))
a1511caf 1118
c56cad4a 1119(defun window--min-delta-1 (window delta &optional horizontal ignore trail noup)
a1511caf
MR
1120 "Internal function for `window-min-delta'."
1121 (if (not (window-parent window))
1122 ;; If we can't go up, return zero.
1123 0
1124 ;; Else try to find a non-fixed-size sibling of WINDOW.
1125 (let* ((parent (window-parent window))
1126 (sub (window-child parent)))
1127 (catch 'done
3d8daefe 1128 (if (window-combined-p sub horizontal)
a1511caf 1129 ;; In an iso-combination throw DELTA if we find at least one
be7f5545
MR
1130 ;; child window and that window is either not fixed-size or
1131 ;; we can ignore fixed-sizeness.
a1511caf
MR
1132 (let ((skip (eq trail 'after)))
1133 (while sub
1134 (cond
1135 ((eq sub window)
1136 (setq skip (eq trail 'before)))
1137 (skip)
842e3a93 1138 ((and (not (window--size-ignore-p window ignore))
a1511caf
MR
1139 (window-size-fixed-p sub horizontal)))
1140 (t
be7f5545 1141 ;; We found a non-fixed-size child window.
a1511caf
MR
1142 (throw 'done delta)))
1143 (setq sub (window-right sub))))
1144 ;; In an ortho-combination set DELTA to the minimum value by
be7f5545 1145 ;; which other child windows can shrink.
a1511caf
MR
1146 (while sub
1147 (unless (eq sub window)
1148 (setq delta
1149 (min delta
1150 (- (window-total-size sub horizontal)
1151 (window-min-size sub horizontal ignore)))))
1152 (setq sub (window-right sub))))
1153 (if noup
1154 delta
c56cad4a 1155 (window--min-delta-1 parent delta horizontal ignore trail))))))
a1511caf
MR
1156
1157(defun window-min-delta (&optional window horizontal ignore trail noup nodown)
1158 "Return number of lines by which WINDOW can be shrunk.
85c2386b
MR
1159WINDOW must be a valid window and defaults to the selected one.
1160Return zero if WINDOW cannot be shrunk.
a1511caf
MR
1161
1162Optional argument HORIZONTAL non-nil means return number of
1163columns by which WINDOW can be shrunk.
1164
2116e93c 1165Optional argument IGNORE non-nil means ignore restrictions
a1511caf 1166imposed by fixed size windows, `window-min-height' or
2116e93c
EZ
1167`window-min-width' settings. If IGNORE is a window, ignore
1168restrictions for that window only. If IGNORE equals `safe',
a1511caf 1169live windows may get as small as `window-safe-min-height' lines
2116e93c
EZ
1170and `window-safe-min-width' columns. Any other non-nil value
1171means ignore all of the above restrictions for all windows.
a1511caf 1172
2116e93c
EZ
1173Optional argument TRAIL restricts the windows that can be enlarged.
1174If its value is `before', only windows to the left of or above WINDOW
1175can be enlarged. If it is `after', only windows to the right of or
1176below WINDOW can be enlarged.
a1511caf
MR
1177
1178Optional argument NOUP non-nil means don't go up in the window
2116e93c 1179tree, but try to enlarge windows within WINDOW's combination only.
a1511caf
MR
1180
1181Optional argument NODOWN non-nil means don't check whether WINDOW
382c953b 1182itself (and its child windows) can be shrunk; check only whether
b3f4a882 1183at least one other window can be enlarged appropriately."
447f16b8 1184 (setq window (window-normalize-window window))
a1511caf
MR
1185 (let ((size (window-total-size window horizontal))
1186 (minimum (window-min-size window horizontal ignore)))
1187 (cond
1188 (nodown
1189 ;; If NODOWN is t, try to recover the entire size of WINDOW.
c56cad4a 1190 (window--min-delta-1 window size horizontal ignore trail noup))
a1511caf
MR
1191 ((= size minimum)
1192 ;; If NODOWN is nil and WINDOW's size is already at its minimum,
1193 ;; there's nothing to recover.
1194 0)
1195 (t
1196 ;; Otherwise, try to recover whatever WINDOW is larger than its
1197 ;; minimum size.
c56cad4a 1198 (window--min-delta-1
a1511caf
MR
1199 window (- size minimum) horizontal ignore trail noup)))))
1200
c56cad4a 1201(defun window--max-delta-1 (window delta &optional horizontal ignore trail noup)
a1511caf
MR
1202 "Internal function of `window-max-delta'."
1203 (if (not (window-parent window))
1204 ;; Can't go up. Return DELTA.
1205 delta
1206 (let* ((parent (window-parent window))
1207 (sub (window-child parent)))
1208 (catch 'fixed
3d8daefe 1209 (if (window-combined-p sub horizontal)
a1511caf 1210 ;; For an iso-combination calculate how much we can get from
be7f5545 1211 ;; other child windows.
a1511caf
MR
1212 (let ((skip (eq trail 'after)))
1213 (while sub
1214 (cond
1215 ((eq sub window)
1216 (setq skip (eq trail 'before)))
1217 (skip)
1218 (t
1219 (setq delta
1220 (+ delta
1221 (- (window-total-size sub horizontal)
1222 (window-min-size sub horizontal ignore))))))
1223 (setq sub (window-right sub))))
1224 ;; For an ortho-combination throw DELTA when at least one
be7f5545 1225 ;; child window is fixed-size.
a1511caf
MR
1226 (while sub
1227 (when (and (not (eq sub window))
842e3a93 1228 (not (window--size-ignore-p sub ignore))
a1511caf
MR
1229 (window-size-fixed-p sub horizontal))
1230 (throw 'fixed delta))
1231 (setq sub (window-right sub))))
1232 (if noup
1233 ;; When NOUP is nil, DELTA is all we can get.
1234 delta
1235 ;; Else try with parent of WINDOW, passing the DELTA we
1236 ;; recovered so far.
c56cad4a 1237 (window--max-delta-1 parent delta horizontal ignore trail))))))
a1511caf
MR
1238
1239(defun window-max-delta (&optional window horizontal ignore trail noup nodown)
2116e93c 1240 "Return maximum number of lines by which WINDOW can be enlarged.
85c2386b
MR
1241WINDOW must be a valid window and defaults to the selected one.
1242The return value is zero if WINDOW cannot be enlarged.
a1511caf
MR
1243
1244Optional argument HORIZONTAL non-nil means return maximum number
1245of columns by which WINDOW can be enlarged.
1246
2116e93c 1247Optional argument IGNORE non-nil means ignore restrictions
a1511caf 1248imposed by fixed size windows, `window-min-height' or
2116e93c
EZ
1249`window-min-width' settings. If IGNORE is a window, ignore
1250restrictions for that window only. If IGNORE equals `safe',
a1511caf 1251live windows may get as small as `window-safe-min-height' lines
2116e93c
EZ
1252and `window-safe-min-width' columns. Any other non-nil value means
1253ignore all of the above restrictions for all windows.
a1511caf 1254
2116e93c
EZ
1255Optional argument TRAIL restricts the windows that can be enlarged.
1256If its value is `before', only windows to the left of or above WINDOW
1257can be enlarged. If it is `after', only windows to the right of or
1258below WINDOW can be enlarged.
a1511caf
MR
1259
1260Optional argument NOUP non-nil means don't go up in the window
1261tree but try to obtain the entire space from windows within
1262WINDOW's combination.
1263
1264Optional argument NODOWN non-nil means do not check whether
382c953b 1265WINDOW itself (and its child windows) can be enlarged; check
be7f5545 1266only whether other windows can be shrunk appropriately."
447f16b8 1267 (setq window (window-normalize-window window))
842e3a93 1268 (if (and (not (window--size-ignore-p window ignore))
a1511caf
MR
1269 (not nodown) (window-size-fixed-p window horizontal))
1270 ;; With IGNORE and NOWDON nil return zero if WINDOW has fixed
1271 ;; size.
1272 0
1273 ;; WINDOW has no fixed size.
c56cad4a 1274 (window--max-delta-1 window 0 horizontal ignore trail noup)))
a1511caf
MR
1275
1276;; Make NOUP also inhibit the min-size check.
2cffd681 1277(defun window--resizable (window delta &optional horizontal ignore trail noup nodown)
a1511caf 1278 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
85c2386b 1279WINDOW must be a valid window and defaults to the selected one.
a1511caf
MR
1280Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
1281can be resized horizontally by DELTA columns. A return value of
1282zero means that WINDOW is not resizable.
1283
1284DELTA positive means WINDOW shall be enlarged by DELTA lines or
2cffd681 1285columns. If WINDOW cannot be enlarged by DELTA lines or columns,
a1511caf
MR
1286return the maximum value in the range 0..DELTA by which WINDOW
1287can be enlarged.
1288
1289DELTA negative means WINDOW shall be shrunk by -DELTA lines or
1290columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
1291return the minimum value in the range DELTA..0 that can be used
1292for shrinking WINDOW.
1293
2116e93c 1294Optional argument IGNORE non-nil means ignore restrictions
a1511caf 1295imposed by fixed size windows, `window-min-height' or
2116e93c
EZ
1296`window-min-width' settings. If IGNORE is a window, ignore
1297restrictions for that window only. If IGNORE equals `safe',
a1511caf 1298live windows may get as small as `window-safe-min-height' lines
2116e93c
EZ
1299and `window-safe-min-width' columns. Any other non-nil value
1300means ignore all of the above restrictions for all windows.
a1511caf
MR
1301
1302Optional argument TRAIL `before' means only windows to the left
1303of or below WINDOW can be shrunk. Optional argument TRAIL
1304`after' means only windows to the right of or above WINDOW can be
1305shrunk.
1306
1307Optional argument NOUP non-nil means don't go up in the window
2cffd681
MR
1308tree but check only whether space can be obtained from (or given
1309to) WINDOW's siblings.
a1511caf 1310
2cffd681
MR
1311Optional argument NODOWN non-nil means don't go down in the
1312window tree. This means do not check whether resizing would
1313violate size restrictions of WINDOW or its child windows."
447f16b8 1314 (setq window (window-normalize-window window))
a1511caf
MR
1315 (cond
1316 ((< delta 0)
1317 (max (- (window-min-delta window horizontal ignore trail noup nodown))
1318 delta))
1319 ((> delta 0)
1320 (min (window-max-delta window horizontal ignore trail noup nodown)
1321 delta))
1322 (t 0)))
1323
2cffd681 1324(defun window--resizable-p (window delta &optional horizontal ignore trail noup nodown)
a1511caf 1325 "Return t if WINDOW can be resized vertically by DELTA lines.
85c2386b 1326WINDOW must be a valid window and defaults to the selected one.
a1511caf 1327For the meaning of the arguments of this function see the
2cffd681 1328doc-string of `window--resizable'."
447f16b8 1329 (setq window (window-normalize-window window))
a1511caf 1330 (if (> delta 0)
2cffd681 1331 (>= (window--resizable window delta horizontal ignore trail noup nodown)
a1511caf 1332 delta)
2cffd681 1333 (<= (window--resizable window delta horizontal ignore trail noup nodown)
a1511caf
MR
1334 delta)))
1335
2cffd681
MR
1336(defun window-resizable (window delta &optional horizontal ignore)
1337 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
85c2386b 1338WINDOW must be a valid window and defaults to the selected one.
2cffd681
MR
1339Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
1340can be resized horizontally by DELTA columns. A return value of
1341zero means that WINDOW is not resizable.
1342
1343DELTA positive means WINDOW shall be enlarged by DELTA lines or
1344columns. If WINDOW cannot be enlarged by DELTA lines or columns
1345return the maximum value in the range 0..DELTA by which WINDOW
1346can be enlarged.
1347
1348DELTA negative means WINDOW shall be shrunk by -DELTA lines or
1349columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
1350return the minimum value in the range DELTA..0 that can be used
1351for shrinking WINDOW.
1352
2116e93c 1353Optional argument IGNORE non-nil means ignore restrictions
2cffd681 1354imposed by fixed size windows, `window-min-height' or
2116e93c
EZ
1355`window-min-width' settings. If IGNORE is a window, ignore
1356restrictions for that window only. If IGNORE equals `safe',
2cffd681 1357live windows may get as small as `window-safe-min-height' lines
2116e93c
EZ
1358and `window-safe-min-width' columns. Any other non-nil value
1359means ignore all of the above restrictions for all windows."
2cffd681
MR
1360 (setq window (window-normalize-window window))
1361 (window--resizable window delta horizontal ignore))
1362
105216ed 1363(defun window-total-size (&optional window horizontal)
2116e93c 1364 "Return the total height or width of WINDOW.
85c2386b 1365WINDOW must be a valid window and defaults to the selected one.
105216ed
CY
1366
1367If HORIZONTAL is omitted or nil, return the total height of
1368WINDOW, in lines, like `window-total-height'. Otherwise return
1369the total width, in columns, like `window-total-width'."
1370 (if horizontal
1371 (window-total-width window)
1372 (window-total-height window)))
3c448ab6 1373
f3d1777e
MR
1374;; Eventually we should make `window-height' obsolete.
1375(defalias 'window-height 'window-total-height)
1376
ccafbf06 1377;; See discussion in bug#4543.
4b0d61e3 1378(defun window-full-height-p (&optional window)
2116e93c 1379 "Return t if WINDOW is as high as its containing frame.
a1511caf
MR
1380More precisely, return t if and only if the total height of
1381WINDOW equals the total height of the root window of WINDOW's
85c2386b
MR
1382frame. WINDOW must be a valid window and defaults to the
1383selected one."
447f16b8 1384 (setq window (window-normalize-window window))
a1511caf
MR
1385 (= (window-total-size window)
1386 (window-total-size (frame-root-window window))))
1387
4b0d61e3 1388(defun window-full-width-p (&optional window)
2116e93c 1389 "Return t if WINDOW is as wide as its containing frame.
a1511caf
MR
1390More precisely, return t if and only if the total width of WINDOW
1391equals the total width of the root window of WINDOW's frame.
85c2386b 1392WINDOW must be a valid window and defaults to the selected one."
447f16b8 1393 (setq window (window-normalize-window window))
a1511caf
MR
1394 (= (window-total-size window t)
1395 (window-total-size (frame-root-window window) t)))
1396
105216ed
CY
1397(defun window-body-size (&optional window horizontal)
1398 "Return the height or width of WINDOW's text area.
85c2386b 1399WINDOW must be a live window and defaults to the selected one.
105216ed
CY
1400
1401If HORIZONTAL is omitted or nil, return the height of the text
1402area, like `window-body-height'. Otherwise, return the width of
1403the text area, like `window-body-width'."
1404 (if horizontal
1405 (window-body-width window)
1406 (window-body-height window)))
02c6f098 1407
f3d1777e
MR
1408;; Eventually we should make `window-height' obsolete.
1409(defalias 'window-width 'window-body-width)
1410
3c448ab6
MR
1411(defun window-current-scroll-bars (&optional window)
1412 "Return the current scroll bar settings for WINDOW.
387522b2 1413WINDOW must be a live window and defaults to the selected one.
3c448ab6
MR
1414
1415The return value is a cons cell (VERTICAL . HORIZONTAL) where
1416VERTICAL specifies the current location of the vertical scroll
1417bars (`left', `right', or nil), and HORIZONTAL specifies the
1418current location of the horizontal scroll bars (`top', `bottom',
1419or nil).
1420
1421Unlike `window-scroll-bars', this function reports the scroll bar
1422type actually used, once frame defaults and `scroll-bar-mode' are
1423taken into account."
447f16b8 1424 (setq window (window-normalize-window window t))
3c448ab6
MR
1425 (let ((vert (nth 2 (window-scroll-bars window)))
1426 (hor nil))
1427 (when (or (eq vert t) (eq hor t))
387522b2 1428 (let ((fcsb (frame-current-scroll-bars (window-frame window))))
3c448ab6
MR
1429 (if (eq vert t)
1430 (setq vert (car fcsb)))
1431 (if (eq hor t)
1432 (setq hor (cdr fcsb)))))
1433 (cons vert hor)))
1434
c7635a97
CY
1435(defun walk-windows (fun &optional minibuf all-frames)
1436 "Cycle through all live windows, calling FUN for each one.
1437FUN must specify a function with a window as its sole argument.
3c448ab6 1438The optional arguments MINIBUF and ALL-FRAMES specify the set of
387522b2 1439windows to include in the walk.
3c448ab6
MR
1440
1441MINIBUF t means include the minibuffer window even if the
1442minibuffer is not active. MINIBUF nil or omitted means include
1443the minibuffer window only if the minibuffer is active. Any
1444other value means do not include the minibuffer window even if
1445the minibuffer is active.
1446
387522b2
MR
1447ALL-FRAMES nil or omitted means consider all windows on the
1448selected frame, plus the minibuffer window if specified by the
1449MINIBUF argument. If the minibuffer counts, consider all windows
1450on all frames that share that minibuffer too. The following
1451non-nil values of ALL-FRAMES have special meanings:
1452
1453- t means consider all windows on all existing frames.
1454
1455- `visible' means consider all windows on all visible frames on
1456 the current terminal.
1457
1458- 0 (the number zero) means consider all windows on all visible
1459 and iconified frames on the current terminal.
1460
1461- A frame means consider all windows on that frame only.
1462
1463Anything else means consider all windows on the selected frame
1464and no others.
3c448ab6
MR
1465
1466This function changes neither the order of recently selected
1467windows nor the buffer list."
1468 ;; If we start from the minibuffer window, don't fail to come
1469 ;; back to it.
1470 (when (window-minibuffer-p (selected-window))
1471 (setq minibuf t))
1472 ;; Make sure to not mess up the order of recently selected
1473 ;; windows. Use `save-selected-window' and `select-window'
1474 ;; with second argument non-nil for this purpose.
1475 (save-selected-window
1476 (when (framep all-frames)
1477 (select-window (frame-first-window all-frames) 'norecord))
387522b2 1478 (dolist (walk-windows-window (window-list-1 nil minibuf all-frames))
c7635a97 1479 (funcall fun walk-windows-window))))
387522b2 1480
e07b9a6d
MR
1481(defun window-at-side-p (&optional window side)
1482 "Return t if WINDOW is at SIDE of its containing frame.
85c2386b
MR
1483WINDOW must be a valid window and defaults to the selected one.
1484SIDE can be any of the symbols `left', `top', `right' or
1485`bottom'. The default value nil is handled like `bottom'."
447f16b8 1486 (setq window (window-normalize-window window))
e07b9a6d
MR
1487 (let ((edge
1488 (cond
1489 ((eq side 'left) 0)
1490 ((eq side 'top) 1)
1491 ((eq side 'right) 2)
1492 ((memq side '(bottom nil)) 3))))
1493 (= (nth edge (window-edges window))
1494 (nth edge (window-edges (frame-root-window window))))))
1495
54f9154c 1496(defun window-at-side-list (&optional frame side)
e07b9a6d
MR
1497 "Return list of all windows on SIDE of FRAME.
1498FRAME must be a live frame and defaults to the selected frame.
1499SIDE can be any of the symbols `left', `top', `right' or
1500`bottom'. The default value nil is handled like `bottom'."
1501 (setq frame (window-normalize-frame frame))
1502 (let (windows)
1503 (walk-window-tree
1504 (lambda (window)
1505 (when (window-at-side-p window side)
1506 (setq windows (cons window windows))))
ea95074e 1507 frame nil 'nomini)
e07b9a6d
MR
1508 (nreverse windows)))
1509
5e92ca23 1510(defun window--in-direction-2 (window posn &optional horizontal)
387522b2
MR
1511 "Support function for `window-in-direction'."
1512 (if horizontal
1513 (let ((top (window-top-line window)))
1514 (if (> top posn)
1515 (- top posn)
1516 (- posn top (window-total-height window))))
1517 (let ((left (window-left-column window)))
1518 (if (> left posn)
1519 (- left posn)
1520 (- posn left (window-total-width window))))))
1521
ea95074e
MR
1522;; Predecessors to the below have been devised by Julian Assange in
1523;; change-windows-intuitively.el and Hovav Shacham in windmove.el.
1524;; Neither of these allow to selectively ignore specific windows
1525;; (windows whose `no-other-window' parameter is non-nil) as targets of
1526;; the movement.
387522b2
MR
1527(defun window-in-direction (direction &optional window ignore)
1528 "Return window in DIRECTION as seen from WINDOW.
ea95074e
MR
1529More precisely, return the nearest window in direction DIRECTION
1530as seen from the position of `window-point' in window WINDOW.
387522b2
MR
1531DIRECTION must be one of `above', `below', `left' or `right'.
1532WINDOW must be a live window and defaults to the selected one.
ea95074e
MR
1533
1534Do not return a window whose `no-other-window' parameter is
1535non-nil. If the nearest window's `no-other-window' parameter is
1536non-nil, try to find another window in the indicated direction.
1537If, however, the optional argument IGNORE is non-nil, return that
1538window even if its `no-other-window' parameter is non-nil.
1539
1540Return nil if no suitable window can be found."
447f16b8 1541 (setq window (window-normalize-window window t))
387522b2
MR
1542 (unless (memq direction '(above below left right))
1543 (error "Wrong direction %s" direction))
1544 (let* ((frame (window-frame window))
1545 (hor (memq direction '(left right)))
1546 (first (if hor
1547 (window-left-column window)
1548 (window-top-line window)))
1549 (last (+ first (if hor
1550 (window-total-width window)
1551 (window-total-height window))))
5481664a 1552 (posn-cons (nth 6 (posn-at-point (window-point window) window)))
387522b2
MR
1553 ;; The column / row value of `posn-at-point' can be nil for the
1554 ;; mini-window, guard against that.
1555 (posn (if hor
1556 (+ (or (cdr posn-cons) 1) (window-top-line window))
1557 (+ (or (car posn-cons) 1) (window-left-column window))))
1558 (best-edge
1559 (cond
1560 ((eq direction 'below) (frame-height frame))
1561 ((eq direction 'right) (frame-width frame))
1562 (t -1)))
1563 (best-edge-2 best-edge)
1564 (best-diff-2 (if hor (frame-height frame) (frame-width frame)))
1565 best best-2 best-diff-2-new)
1566 (walk-window-tree
1567 (lambda (w)
1568 (let* ((w-top (window-top-line w))
1569 (w-left (window-left-column w)))
1570 (cond
1571 ((or (eq window w)
1572 ;; Ignore ourselves.
1573 (and (window-parameter w 'no-other-window)
1574 ;; Ignore W unless IGNORE is non-nil.
1575 (not ignore))))
1576 (hor
1577 (cond
1578 ((and (<= w-top posn)
1579 (< posn (+ w-top (window-total-height w))))
1580 ;; W is to the left or right of WINDOW and covers POSN.
1581 (when (or (and (eq direction 'left)
1582 (<= w-left first) (> w-left best-edge))
1583 (and (eq direction 'right)
1584 (>= w-left last) (< w-left best-edge)))
1585 (setq best-edge w-left)
1586 (setq best w)))
1587 ((and (or (and (eq direction 'left)
1588 (<= (+ w-left (window-total-width w)) first))
1589 (and (eq direction 'right) (<= last w-left)))
1590 ;; W is to the left or right of WINDOW but does not
1591 ;; cover POSN.
1592 (setq best-diff-2-new
5e92ca23 1593 (window--in-direction-2 w posn hor))
387522b2
MR
1594 (or (< best-diff-2-new best-diff-2)
1595 (and (= best-diff-2-new best-diff-2)
1596 (if (eq direction 'left)
1597 (> w-left best-edge-2)
1598 (< w-left best-edge-2)))))
1599 (setq best-edge-2 w-left)
1600 (setq best-diff-2 best-diff-2-new)
1601 (setq best-2 w))))
1602 (t
1603 (cond
1604 ((and (<= w-left posn)
1605 (< posn (+ w-left (window-total-width w))))
1606 ;; W is above or below WINDOW and covers POSN.
1607 (when (or (and (eq direction 'above)
1608 (<= w-top first) (> w-top best-edge))
1609 (and (eq direction 'below)
1610 (>= w-top first) (< w-top best-edge)))
1611 (setq best-edge w-top)
1612 (setq best w)))
1613 ((and (or (and (eq direction 'above)
1614 (<= (+ w-top (window-total-height w)) first))
1615 (and (eq direction 'below) (<= last w-top)))
1616 ;; W is above or below WINDOW but does not cover POSN.
1617 (setq best-diff-2-new
5e92ca23 1618 (window--in-direction-2 w posn hor))
387522b2
MR
1619 (or (< best-diff-2-new best-diff-2)
1620 (and (= best-diff-2-new best-diff-2)
1621 (if (eq direction 'above)
1622 (> w-top best-edge-2)
1623 (< w-top best-edge-2)))))
1624 (setq best-edge-2 w-top)
1625 (setq best-diff-2 best-diff-2-new)
1626 (setq best-2 w)))))))
ea95074e 1627 frame)
387522b2 1628 (or best best-2)))
3c448ab6 1629
4c43d97b 1630(defun get-window-with-predicate (predicate &optional minibuf all-frames default)
387522b2
MR
1631 "Return a live window satisfying PREDICATE.
1632More precisely, cycle through all windows calling the function
1633PREDICATE on each one of them with the window as its sole
1634argument. Return the first window for which PREDICATE returns
4c43d97b 1635non-nil. Windows are scanned starting with the window following
c80e3b4a 1636the selected window. If no window satisfies PREDICATE, return
4c43d97b
MR
1637DEFAULT.
1638
1639MINIBUF t means include the minibuffer window even if the
1640minibuffer is not active. MINIBUF nil or omitted means include
1641the minibuffer window only if the minibuffer is active. Any
1642other value means do not include the minibuffer window even if
1643the minibuffer is active.
387522b2
MR
1644
1645ALL-FRAMES nil or omitted means consider all windows on the selected
1646frame, plus the minibuffer window if specified by the MINIBUF
1647argument. If the minibuffer counts, consider all windows on all
1648frames that share that minibuffer too. The following non-nil
1649values of ALL-FRAMES have special meanings:
3c448ab6 1650
387522b2
MR
1651- t means consider all windows on all existing frames.
1652
1653- `visible' means consider all windows on all visible frames on
1654 the current terminal.
1655
1656- 0 (the number zero) means consider all windows on all visible
1657 and iconified frames on the current terminal.
1658
1659- A frame means consider all windows on that frame only.
1660
1661Anything else means consider all windows on the selected frame
1662and no others."
3c448ab6 1663 (catch 'found
4c43d97b
MR
1664 (dolist (window (window-list-1
1665 (next-window nil minibuf all-frames)
1666 minibuf all-frames))
387522b2
MR
1667 (when (funcall predicate window)
1668 (throw 'found window)))
3c448ab6
MR
1669 default))
1670
1671(defalias 'some-window 'get-window-with-predicate)
1672
51a5f9d8 1673(defun get-lru-window (&optional all-frames dedicated not-selected)
190b47e6
MR
1674 "Return the least recently used window on frames specified by ALL-FRAMES.
1675Return a full-width window if possible. A minibuffer window is
1676never a candidate. A dedicated window is never a candidate
1677unless DEDICATED is non-nil, so if all windows are dedicated, the
1678value is nil. Avoid returning the selected window if possible.
51a5f9d8
MR
1679Optional argument NOT-SELECTED non-nil means never return the
1680selected window.
190b47e6
MR
1681
1682The following non-nil values of the optional argument ALL-FRAMES
1683have special meanings:
1684
1685- t means consider all windows on all existing frames.
1686
1687- `visible' means consider all windows on all visible frames on
1688 the current terminal.
1689
1690- 0 (the number zero) means consider all windows on all visible
1691 and iconified frames on the current terminal.
1692
1693- A frame means consider all windows on that frame only.
1694
1695Any other value of ALL-FRAMES means consider all windows on the
1696selected frame and no others."
1697 (let (best-window best-time second-best-window second-best-time time)
02cfc6d6 1698 (dolist (window (window-list-1 nil 'nomini all-frames))
51a5f9d8
MR
1699 (when (and (or dedicated (not (window-dedicated-p window)))
1700 (or (not not-selected) (not (eq window (selected-window)))))
190b47e6
MR
1701 (setq time (window-use-time window))
1702 (if (or (eq window (selected-window))
1703 (not (window-full-width-p window)))
1704 (when (or (not second-best-time) (< time second-best-time))
1705 (setq second-best-time time)
1706 (setq second-best-window window))
1707 (when (or (not best-time) (< time best-time))
1708 (setq best-time time)
1709 (setq best-window window)))))
1710 (or best-window second-best-window)))
1711
51a5f9d8 1712(defun get-mru-window (&optional all-frames dedicated not-selected)
387522b2 1713 "Return the most recently used window on frames specified by ALL-FRAMES.
51a5f9d8
MR
1714A minibuffer window is never a candidate. A dedicated window is
1715never a candidate unless DEDICATED is non-nil, so if all windows
1716are dedicated, the value is nil. Optional argument NOT-SELECTED
1717non-nil means never return the selected window.
387522b2
MR
1718
1719The following non-nil values of the optional argument ALL-FRAMES
1720have special meanings:
1721
1722- t means consider all windows on all existing frames.
1723
1724- `visible' means consider all windows on all visible frames on
1725 the current terminal.
1726
1727- 0 (the number zero) means consider all windows on all visible
1728 and iconified frames on the current terminal.
1729
1730- A frame means consider all windows on that frame only.
1731
1732Any other value of ALL-FRAMES means consider all windows on the
1733selected frame and no others."
1734 (let (best-window best-time time)
02cfc6d6 1735 (dolist (window (window-list-1 nil 'nomini all-frames))
387522b2 1736 (setq time (window-use-time window))
51a5f9d8
MR
1737 (when (and (or dedicated (not (window-dedicated-p window)))
1738 (or (not not-selected) (not (eq window (selected-window))))
1739 (or (not best-time) (> time best-time)))
387522b2
MR
1740 (setq best-time time)
1741 (setq best-window window)))
1742 best-window))
1743
51a5f9d8 1744(defun get-largest-window (&optional all-frames dedicated not-selected)
190b47e6
MR
1745 "Return the largest window on frames specified by ALL-FRAMES.
1746A minibuffer window is never a candidate. A dedicated window is
1747never a candidate unless DEDICATED is non-nil, so if all windows
51a5f9d8
MR
1748are dedicated, the value is nil. Optional argument NOT-SELECTED
1749non-nil means never return the selected window.
190b47e6
MR
1750
1751The following non-nil values of the optional argument ALL-FRAMES
1752have special meanings:
1753
1754- t means consider all windows on all existing frames.
1755
1756- `visible' means consider all windows on all visible frames on
1757 the current terminal.
1758
1759- 0 (the number zero) means consider all windows on all visible
1760 and iconified frames on the current terminal.
1761
1762- A frame means consider all windows on that frame only.
1763
1764Any other value of ALL-FRAMES means consider all windows on the
1765selected frame and no others."
1766 (let ((best-size 0)
1767 best-window size)
02cfc6d6 1768 (dolist (window (window-list-1 nil 'nomini all-frames))
51a5f9d8
MR
1769 (when (and (or dedicated (not (window-dedicated-p window)))
1770 (or (not not-selected) (not (eq window (selected-window)))))
190b47e6
MR
1771 (setq size (* (window-total-size window)
1772 (window-total-size window t)))
1773 (when (> size best-size)
1774 (setq best-size size)
1775 (setq best-window window))))
1776 best-window))
1777
3c448ab6
MR
1778(defun get-buffer-window-list (&optional buffer-or-name minibuf all-frames)
1779 "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
1780BUFFER-OR-NAME may be a buffer or the name of an existing buffer
4c43d97b
MR
1781and defaults to the current buffer. Windows are scanned starting
1782with the selected window.
190b47e6
MR
1783
1784MINIBUF t means include the minibuffer window even if the
1785minibuffer is not active. MINIBUF nil or omitted means include
1786the minibuffer window only if the minibuffer is active. Any
1787other value means do not include the minibuffer window even if
1788the minibuffer is active.
1789
1790ALL-FRAMES nil or omitted means consider all windows on the
1791selected frame, plus the minibuffer window if specified by the
1792MINIBUF argument. If the minibuffer counts, consider all windows
1793on all frames that share that minibuffer too. The following
1794non-nil values of ALL-FRAMES have special meanings:
1795
1796- t means consider all windows on all existing frames.
1797
1798- `visible' means consider all windows on all visible frames on
1799 the current terminal.
1800
1801- 0 (the number zero) means consider all windows on all visible
1802 and iconified frames on the current terminal.
1803
1804- A frame means consider all windows on that frame only.
1805
1806Anything else means consider all windows on the selected frame
1807and no others."
5386012d 1808 (let ((buffer (window-normalize-buffer buffer-or-name))
3c448ab6 1809 windows)
4c43d97b 1810 (dolist (window (window-list-1 (selected-window) minibuf all-frames))
190b47e6
MR
1811 (when (eq (window-buffer window) buffer)
1812 (setq windows (cons window windows))))
1813 (nreverse windows)))
3c448ab6
MR
1814
1815(defun minibuffer-window-active-p (window)
1816 "Return t if WINDOW is the currently active minibuffer window."
1817 (eq window (active-minibuffer-window)))
387522b2 1818
3c448ab6 1819(defun count-windows (&optional minibuf)
387522b2 1820 "Return the number of live windows on the selected frame.
3c448ab6
MR
1821The optional argument MINIBUF specifies whether the minibuffer
1822window shall be counted. See `walk-windows' for the precise
1823meaning of this argument."
387522b2 1824 (length (window-list-1 nil minibuf)))
9aab8e0d
MR
1825\f
1826;;; Resizing windows.
5386012d 1827(defun window--resize-reset (&optional frame horizontal)
9aab8e0d
MR
1828 "Reset resize values for all windows on FRAME.
1829FRAME defaults to the selected frame.
1830
1831This function stores the current value of `window-total-size' applied
1832with argument HORIZONTAL in the new total size of all windows on
1833FRAME. It also resets the new normal size of each of these
1834windows."
5386012d
MR
1835 (window--resize-reset-1
1836 (frame-root-window (window-normalize-frame frame)) horizontal))
9aab8e0d 1837
5386012d
MR
1838(defun window--resize-reset-1 (window horizontal)
1839 "Internal function of `window--resize-reset'."
9aab8e0d
MR
1840 ;; Register old size in the new total size.
1841 (set-window-new-total window (window-total-size window horizontal))
1842 ;; Reset new normal size.
1843 (set-window-new-normal window)
1844 (when (window-child window)
5386012d 1845 (window--resize-reset-1 (window-child window) horizontal))
9aab8e0d 1846 (when (window-right window)
5386012d 1847 (window--resize-reset-1 (window-right window) horizontal)))
9aab8e0d 1848
562dd5e9
MR
1849;; The following routine is used to manually resize the minibuffer
1850;; window and is currently used, for example, by ispell.el.
5386012d 1851(defun window--resize-mini-window (window delta)
562dd5e9 1852 "Resize minibuffer window WINDOW by DELTA lines.
382c953b 1853If WINDOW cannot be resized by DELTA lines make it as large (or
2116e93c 1854as small) as possible, but don't signal an error."
562dd5e9
MR
1855 (when (window-minibuffer-p window)
1856 (let* ((frame (window-frame window))
1857 (root (frame-root-window frame))
1858 (height (window-total-size window))
1859 (min-delta
1860 (- (window-total-size root)
1861 (window-min-size root))))
1862 ;; Sanitize DELTA.
1863 (cond
1864 ((<= (+ height delta) 0)
1865 (setq delta (- (- height 1))))
1866 ((> delta min-delta)
1867 (setq delta min-delta)))
1868
1869 ;; Resize now.
5386012d 1870 (window--resize-reset frame)
be7f5545
MR
1871 ;; Ideally we should be able to resize just the last child of root
1872 ;; here. See the comment in `resize-root-window-vertically' for
1873 ;; why we do not do that.
5386012d 1874 (window--resize-this-window root (- delta) nil nil t)
562dd5e9
MR
1875 (set-window-new-total window (+ height delta))
1876 ;; The following routine catches the case where we want to resize
1877 ;; a minibuffer-only frame.
1878 (resize-mini-window-internal window))))
1879
d615d6d2 1880(defun window-resize (window delta &optional horizontal ignore)
562dd5e9
MR
1881 "Resize WINDOW vertically by DELTA lines.
1882WINDOW can be an arbitrary window and defaults to the selected
1883one. An attempt to resize the root window of a frame will raise
1884an error though.
1885
1886DELTA a positive number means WINDOW shall be enlarged by DELTA
1887lines. DELTA negative means WINDOW shall be shrunk by -DELTA
1888lines.
1889
1890Optional argument HORIZONTAL non-nil means resize WINDOW
1891horizontally by DELTA columns. In this case a positive DELTA
1892means enlarge WINDOW by DELTA columns. DELTA negative means
1893WINDOW shall be shrunk by -DELTA columns.
1894
2116e93c 1895Optional argument IGNORE non-nil means ignore restrictions
562dd5e9 1896imposed by fixed size windows, `window-min-height' or
2116e93c
EZ
1897`window-min-width' settings. If IGNORE is a window, ignore
1898restrictions for that window only. If IGNORE equals `safe',
562dd5e9 1899live windows may get as small as `window-safe-min-height' lines
2116e93c
EZ
1900and `window-safe-min-width' columns. Any other non-nil value
1901means ignore all of the above restrictions for all windows.
562dd5e9
MR
1902
1903This function resizes other windows proportionally and never
1904deletes any windows. If you want to move only the low (right)
1905edge of WINDOW consider using `adjust-window-trailing-edge'
1906instead."
447f16b8 1907 (setq window (window-normalize-window window))
562dd5e9 1908 (let* ((frame (window-frame window))
feeb6f53 1909 (minibuffer-window (minibuffer-window frame))
562dd5e9
MR
1910 sibling)
1911 (cond
1912 ((eq window (frame-root-window frame))
1913 (error "Cannot resize the root window of a frame"))
1914 ((window-minibuffer-p window)
41cfe0cb
MR
1915 (if horizontal
1916 (error "Cannot resize minibuffer window horizontally")
1917 (window--resize-mini-window window delta)))
feeb6f53
MR
1918 ((and (not horizontal)
1919 (window-full-height-p window)
1920 (eq (window-frame minibuffer-window) frame)
1921 (or (not resize-mini-windows)
1922 (eq minibuffer-window (active-minibuffer-window))))
1923 ;; If WINDOW is full height and either `resize-mini-windows' is
1924 ;; nil or the minibuffer window is active, resize the minibuffer
1925 ;; window.
1926 (window--resize-mini-window minibuffer-window (- delta)))
2cffd681 1927 ((window--resizable-p window delta horizontal ignore)
5386012d
MR
1928 (window--resize-reset frame horizontal)
1929 (window--resize-this-window window delta horizontal ignore t)
a0c2d0ae 1930 (if (and (not window-combination-resize)
3d8daefe 1931 (window-combined-p window horizontal)
562dd5e9
MR
1932 (setq sibling (or (window-right window) (window-left window)))
1933 (window-sizable-p sibling (- delta) horizontal ignore))
a0c2d0ae 1934 ;; If window-combination-resize is nil, WINDOW is part of an
89d61221 1935 ;; iso-combination, and WINDOW's neighboring right or left
562dd5e9
MR
1936 ;; sibling can be resized as requested, resize that sibling.
1937 (let ((normal-delta
1938 (/ (float delta)
1939 (window-total-size (window-parent window) horizontal))))
5386012d 1940 (window--resize-this-window sibling (- delta) horizontal nil t)
562dd5e9
MR
1941 (set-window-new-normal
1942 window (+ (window-normal-size window horizontal)
1943 normal-delta))
1944 (set-window-new-normal
1945 sibling (- (window-normal-size sibling horizontal)
1946 normal-delta)))
1947 ;; Otherwise, resize all other windows in the same combination.
5386012d 1948 (window--resize-siblings window delta horizontal ignore))
d615d6d2 1949 (window-resize-apply frame horizontal))
562dd5e9
MR
1950 (t
1951 (error "Cannot resize window %s" window)))))
1952
4b0d61e3 1953(defun window--resize-child-windows-skip-p (window)
9aab8e0d
MR
1954 "Return non-nil if WINDOW shall be skipped by resizing routines."
1955 (memq (window-new-normal window) '(ignore stuck skip)))
1956
be7f5545
MR
1957(defun window--resize-child-windows-normal (parent horizontal window this-delta &optional trail other-delta)
1958 "Recursively set new normal height of child windows of window PARENT.
9aab8e0d 1959HORIZONTAL non-nil means set the new normal width of these
be7f5545 1960windows. WINDOW specifies a child window of PARENT that has been
382c953b 1961resized by THIS-DELTA lines (columns).
9aab8e0d 1962
2116e93c
EZ
1963Optional argument TRAIL either `before' or `after' means set values
1964only for windows before or after WINDOW. Optional argument
1965OTHER-DELTA, a number, specifies that this many lines (columns)
382c953b 1966have been obtained from (or returned to) an ancestor window of
9aab8e0d
MR
1967PARENT in order to resize WINDOW."
1968 (let* ((delta-normal
1969 (if (and (= (- this-delta) (window-total-size window horizontal))
1970 (zerop other-delta))
1971 ;; When WINDOW gets deleted and we can return its entire
1972 ;; space to its siblings, use WINDOW's normal size as the
1973 ;; normal delta.
1974 (- (window-normal-size window horizontal))
1975 ;; In any other case calculate the normal delta from the
1976 ;; relation of THIS-DELTA to the total size of PARENT.
1977 (/ (float this-delta) (window-total-size parent horizontal))))
1978 (sub (window-child parent))
1979 (parent-normal 0.0)
1980 (skip (eq trail 'after)))
1981
be7f5545
MR
1982 ;; Set parent-normal to the sum of the normal sizes of all child
1983 ;; windows of PARENT that shall be resized, excluding only WINDOW
9aab8e0d
MR
1984 ;; and any windows specified by the optional TRAIL argument.
1985 (while sub
1986 (cond
1987 ((eq sub window)
1988 (setq skip (eq trail 'before)))
1989 (skip)
1990 (t
1991 (setq parent-normal
1992 (+ parent-normal (window-normal-size sub horizontal)))))
1993 (setq sub (window-right sub)))
1994
be7f5545 1995 ;; Set the new normal size of all child windows of PARENT from what
9aab8e0d
MR
1996 ;; they should have contributed for recovering THIS-DELTA lines
1997 ;; (columns).
1998 (setq sub (window-child parent))
1999 (setq skip (eq trail 'after))
2000 (while sub
2001 (cond
2002 ((eq sub window)
2003 (setq skip (eq trail 'before)))
2004 (skip)
2005 (t
2006 (let ((old-normal (window-normal-size sub horizontal)))
2007 (set-window-new-normal
2008 sub (min 1.0 ; Don't get larger than 1.
2009 (max (- old-normal
2010 (* (/ old-normal parent-normal)
2011 delta-normal))
2012 ;; Don't drop below 0.
2013 0.0))))))
2014 (setq sub (window-right sub)))
2015
2016 (when (numberp other-delta)
2017 ;; Set the new normal size of windows from what they should have
2018 ;; contributed for recovering OTHER-DELTA lines (columns).
2019 (setq delta-normal (/ (float (window-total-size parent horizontal))
2020 (+ (window-total-size parent horizontal)
2021 other-delta)))
2022 (setq sub (window-child parent))
2023 (setq skip (eq trail 'after))
2024 (while sub
2025 (cond
2026 ((eq sub window)
2027 (setq skip (eq trail 'before)))
2028 (skip)
2029 (t
2030 (set-window-new-normal
2031 sub (min 1.0 ; Don't get larger than 1.
2032 (max (* (window-new-normal sub) delta-normal)
2033 ;; Don't drop below 0.
2034 0.0)))))
2035 (setq sub (window-right sub))))
2036
2037 ;; Set the new normal size of WINDOW to what is left by the sum of
2038 ;; the normal sizes of its siblings.
2039 (set-window-new-normal
2040 window
2041 (let ((sum 0))
2042 (setq sub (window-child parent))
2043 (while sub
2044 (cond
2045 ((eq sub window))
2046 ((not (numberp (window-new-normal sub)))
2047 (setq sum (+ sum (window-normal-size sub horizontal))))
2048 (t
2049 (setq sum (+ sum (window-new-normal sub)))))
2050 (setq sub (window-right sub)))
2051 ;; Don't get larger than 1 or smaller than 0.
2052 (min 1.0 (max (- 1.0 sum) 0.0))))))
2053
be7f5545
MR
2054(defun window--resize-child-windows (parent delta &optional horizontal window ignore trail edge)
2055 "Resize child windows of window PARENT vertically by DELTA lines.
9aab8e0d
MR
2056PARENT must be a vertically combined internal window.
2057
be7f5545 2058Optional argument HORIZONTAL non-nil means resize child windows of
9aab8e0d
MR
2059PARENT horizontally by DELTA columns. In this case PARENT must
2060be a horizontally combined internal window.
2061
2062WINDOW, if specified, must denote a child window of PARENT that
2063is resized by DELTA lines.
2064
2116e93c 2065Optional argument IGNORE non-nil means ignore restrictions
9aab8e0d 2066imposed by fixed size windows, `window-min-height' or
2116e93c 2067`window-min-width' settings. If IGNORE equals `safe', live
9aab8e0d 2068windows may get as small as `window-safe-min-height' lines and
2116e93c
EZ
2069`window-safe-min-width' columns. If IGNORE is a window, ignore
2070restrictions for that window only. Any other non-nil value means
2071ignore all of the above restrictions for all windows.
9aab8e0d
MR
2072
2073Optional arguments TRAIL and EDGE, when non-nil, restrict the set
2074of windows that shall be resized. If TRAIL equals `before',
2075resize only windows on the left or above EDGE. If TRAIL equals
2076`after', resize only windows on the right or below EDGE. Also,
2077preferably only resize windows adjacent to EDGE.
2078
2079Return the symbol `normalized' if new normal sizes have been
2080already set by this routine."
2081 (let* ((first (window-child parent))
9c52dd5a 2082 (last (window-last-child parent))
9aab8e0d 2083 (parent-total (+ (window-total-size parent horizontal) delta))
9c52dd5a 2084 sub best-window best-value)
9aab8e0d
MR
2085
2086 (if (and edge (memq trail '(before after))
2087 (progn
2088 (setq sub first)
2089 (while (and (window-right sub)
2090 (or (and (eq trail 'before)
be7f5545 2091 (not (window--resize-child-windows-skip-p
9aab8e0d
MR
2092 (window-right sub))))
2093 (and (eq trail 'after)
be7f5545 2094 (window--resize-child-windows-skip-p sub))))
9aab8e0d
MR
2095 (setq sub (window-right sub)))
2096 sub)
2097 (if horizontal
2098 (if (eq trail 'before)
2099 (= (+ (window-left-column sub)
2100 (window-total-size sub t))
2101 edge)
2102 (= (window-left-column sub) edge))
2103 (if (eq trail 'before)
2104 (= (+ (window-top-line sub)
2105 (window-total-size sub))
2106 edge)
2107 (= (window-top-line sub) edge)))
2108 (window-sizable-p sub delta horizontal ignore))
2109 ;; Resize only windows adjacent to EDGE.
2110 (progn
5386012d
MR
2111 (window--resize-this-window
2112 sub delta horizontal ignore t trail edge)
9aab8e0d
MR
2113 (if (and window (eq (window-parent sub) parent))
2114 (progn
2115 ;; Assign new normal sizes.
2116 (set-window-new-normal
2117 sub (/ (float (window-new-total sub)) parent-total))
2118 (set-window-new-normal
2119 window (- (window-normal-size window horizontal)
2120 (- (window-new-normal sub)
2121 (window-normal-size sub horizontal)))))
be7f5545 2122 (window--resize-child-windows-normal
5386012d
MR
2123 parent horizontal sub 0 trail delta))
2124 ;; Return 'normalized to notify `window--resize-siblings' that
9aab8e0d
MR
2125 ;; normal sizes have been already set.
2126 'normalized)
2127 ;; Resize all windows proportionally.
9c52dd5a 2128 (setq sub last)
9aab8e0d
MR
2129 (while sub
2130 (cond
be7f5545
MR
2131 ((or (window--resize-child-windows-skip-p sub)
2132 ;; Ignore windows to skip and fixed-size child windows -
2133 ;; in the latter case make it a window to skip.
9aab8e0d
MR
2134 (and (not ignore)
2135 (window-size-fixed-p sub horizontal)
2136 (set-window-new-normal sub 'ignore))))
2137 ((< delta 0)
2138 ;; When shrinking store the number of lines/cols we can get
2139 ;; from this window here together with the total/normal size
2140 ;; factor.
2141 (set-window-new-normal
2142 sub
2143 (cons
2144 ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
2145 (window-min-delta sub horizontal ignore trail t) ; t)
2146 (- (/ (float (window-total-size sub horizontal))
2147 parent-total)
2148 (window-normal-size sub horizontal)))))
2149 ((> delta 0)
2150 ;; When enlarging store the total/normal size factor only
2151 (set-window-new-normal
2152 sub
2153 (- (/ (float (window-total-size sub horizontal))
2154 parent-total)
2155 (window-normal-size sub horizontal)))))
2156
9c52dd5a 2157 (setq sub (window-left sub)))
9aab8e0d
MR
2158
2159 (cond
2160 ((< delta 0)
2161 ;; Shrink windows by delta.
2162 (setq best-window t)
2163 (while (and best-window (not (zerop delta)))
9c52dd5a 2164 (setq sub last)
9aab8e0d
MR
2165 (setq best-window nil)
2166 (setq best-value most-negative-fixnum)
2167 (while sub
2168 (when (and (consp (window-new-normal sub))
2169 (not (zerop (car (window-new-normal sub))))
2170 (> (cdr (window-new-normal sub)) best-value))
2171 (setq best-window sub)
2172 (setq best-value (cdr (window-new-normal sub))))
2173
9c52dd5a 2174 (setq sub (window-left sub)))
9aab8e0d
MR
2175
2176 (when best-window
2177 (setq delta (1+ delta)))
2178 (set-window-new-total best-window -1 t)
2179 (set-window-new-normal
2180 best-window
2181 (if (= (car (window-new-normal best-window)) 1)
2182 'skip ; We can't shrink best-window any further.
2183 (cons (1- (car (window-new-normal best-window)))
2184 (- (/ (float (window-new-total best-window))
2185 parent-total)
2186 (window-normal-size best-window horizontal)))))))
2187 ((> delta 0)
2188 ;; Enlarge windows by delta.
2189 (setq best-window t)
2190 (while (and best-window (not (zerop delta)))
9c52dd5a 2191 (setq sub last)
9aab8e0d
MR
2192 (setq best-window nil)
2193 (setq best-value most-positive-fixnum)
2194 (while sub
2195 (when (and (numberp (window-new-normal sub))
2196 (< (window-new-normal sub) best-value))
2197 (setq best-window sub)
2198 (setq best-value (window-new-normal sub)))
2199
9c52dd5a 2200 (setq sub (window-left sub)))
9aab8e0d
MR
2201
2202 (when best-window
2203 (setq delta (1- delta)))
2204 (set-window-new-total best-window 1 t)
2205 (set-window-new-normal
2206 best-window
2207 (- (/ (float (window-new-total best-window))
2208 parent-total)
2209 (window-normal-size best-window horizontal))))))
2210
2211 (when best-window
9c52dd5a 2212 (setq sub last)
9aab8e0d
MR
2213 (while sub
2214 (when (or (consp (window-new-normal sub))
2215 (numberp (window-new-normal sub)))
d615d6d2 2216 ;; Reset new normal size fields so `window-resize-apply'
9aab8e0d
MR
2217 ;; won't use them to apply new sizes.
2218 (set-window-new-normal sub))
2219
2220 (unless (eq (window-new-normal sub) 'ignore)
be7f5545 2221 ;; Resize this window's child windows (back-engineering
9aab8e0d
MR
2222 ;; delta from sub's old and new total sizes).
2223 (let ((delta (- (window-new-total sub)
2224 (window-total-size sub horizontal))))
2225 (unless (and (zerop delta) (not trail))
2226 ;; For the TRAIL non-nil case we have to resize SUB
2227 ;; recursively even if it's size does not change.
5386012d 2228 (window--resize-this-window
9aab8e0d 2229 sub delta horizontal ignore nil trail edge))))
9c52dd5a 2230 (setq sub (window-left sub)))))))
9aab8e0d 2231
5386012d 2232(defun window--resize-siblings (window delta &optional horizontal ignore trail edge)
9aab8e0d
MR
2233 "Resize other windows when WINDOW is resized vertically by DELTA lines.
2234Optional argument HORIZONTAL non-nil means resize other windows
2235when WINDOW is resized horizontally by DELTA columns. WINDOW
2236itself is not resized by this function.
2237
2116e93c 2238Optional argument IGNORE non-nil means ignore restrictions
9aab8e0d 2239imposed by fixed size windows, `window-min-height' or
2116e93c 2240`window-min-width' settings. If IGNORE equals `safe', live
9aab8e0d 2241windows may get as small as `window-safe-min-height' lines and
2116e93c
EZ
2242`window-safe-min-width' columns. If IGNORE is a window, ignore
2243restrictions for that window only. Any other non-nil value means
2244ignore all of the above restrictions for all windows.
9aab8e0d
MR
2245
2246Optional arguments TRAIL and EDGE, when non-nil, refine the set
2247of windows that shall be resized. If TRAIL equals `before',
2248resize only windows on the left or above EDGE. If TRAIL equals
2249`after', resize only windows on the right or below EDGE. Also,
2250preferably only resize windows adjacent to EDGE."
2251 (when (window-parent window)
2252 (let* ((parent (window-parent window))
2253 (sub (window-child parent)))
3d8daefe 2254 (if (window-combined-p sub horizontal)
9aab8e0d
MR
2255 ;; In an iso-combination try to extract DELTA from WINDOW's
2256 ;; siblings.
cb882333 2257 (let ((skip (eq trail 'after))
9aab8e0d
MR
2258 this-delta other-delta)
2259 ;; Decide which windows shall be left alone.
2260 (while sub
2261 (cond
2262 ((eq sub window)
2263 ;; Make sure WINDOW is left alone when
2264 ;; resizing its siblings.
2265 (set-window-new-normal sub 'ignore)
2266 (setq skip (eq trail 'before)))
2267 (skip
2268 ;; Make sure this sibling is left alone when
2269 ;; resizing its siblings.
2270 (set-window-new-normal sub 'ignore))
842e3a93 2271 ((or (window--size-ignore-p sub ignore)
9aab8e0d
MR
2272 (not (window-size-fixed-p sub horizontal)))
2273 ;; Set this-delta to t to signal that we found a sibling
2274 ;; of WINDOW whose size is not fixed.
2275 (setq this-delta t)))
2276
2277 (setq sub (window-right sub)))
2278
2279 ;; Set this-delta to what we can get from WINDOW's siblings.
2280 (if (= (- delta) (window-total-size window horizontal))
2281 ;; A deletion, presumably. We must handle this case
2cffd681 2282 ;; specially since `window--resizable' can't be used.
9aab8e0d
MR
2283 (if this-delta
2284 ;; There's at least one resizable sibling we can
2285 ;; give WINDOW's size to.
2286 (setq this-delta delta)
2287 ;; No resizable sibling exists.
2288 (setq this-delta 0))
2289 ;; Any other form of resizing.
2290 (setq this-delta
2cffd681 2291 (window--resizable window delta horizontal ignore trail t)))
9aab8e0d
MR
2292
2293 ;; Set other-delta to what we still have to get from
2294 ;; ancestor windows of parent.
2295 (setq other-delta (- delta this-delta))
2296 (unless (zerop other-delta)
2297 ;; Unless we got everything from WINDOW's siblings, PARENT
2298 ;; must be resized by other-delta lines or columns.
2299 (set-window-new-total parent other-delta 'add))
2300
2301 (if (zerop this-delta)
2302 ;; We haven't got anything from WINDOW's siblings but we
2303 ;; must update the normal sizes to respect other-delta.
be7f5545 2304 (window--resize-child-windows-normal
9aab8e0d
MR
2305 parent horizontal window this-delta trail other-delta)
2306 ;; We did get something from WINDOW's siblings which means
be7f5545
MR
2307 ;; we have to resize their child windows.
2308 (unless (eq (window--resize-child-windows
5386012d
MR
2309 parent (- this-delta) horizontal
2310 window ignore trail edge)
be7f5545 2311 ;; If `window--resize-child-windows' returns
5386012d
MR
2312 ;; 'normalized, this means it has set the
2313 ;; normal sizes already.
9aab8e0d
MR
2314 'normalized)
2315 ;; Set the normal sizes.
be7f5545 2316 (window--resize-child-windows-normal
9aab8e0d
MR
2317 parent horizontal window this-delta trail other-delta))
2318 ;; Set DELTA to what we still have to get from ancestor
2319 ;; windows.
2320 (setq delta other-delta)))
2321
2322 ;; In an ortho-combination all siblings of WINDOW must be
2323 ;; resized by DELTA.
2324 (set-window-new-total parent delta 'add)
2325 (while sub
2326 (unless (eq sub window)
5386012d 2327 (window--resize-this-window sub delta horizontal ignore t))
9aab8e0d
MR
2328 (setq sub (window-right sub))))
2329
2330 (unless (zerop delta)
2331 ;; "Go up."
5386012d
MR
2332 (window--resize-siblings
2333 parent delta horizontal ignore trail edge)))))
9aab8e0d 2334
5386012d 2335(defun window--resize-this-window (window delta &optional horizontal ignore add trail edge)
9aab8e0d
MR
2336 "Resize WINDOW vertically by DELTA lines.
2337Optional argument HORIZONTAL non-nil means resize WINDOW
2338horizontally by DELTA columns.
2339
2116e93c 2340Optional argument IGNORE non-nil means ignore restrictions
9aab8e0d 2341imposed by fixed size windows, `window-min-height' or
2116e93c 2342`window-min-width' settings. If IGNORE equals `safe', live
9aab8e0d 2343windows may get as small as `window-safe-min-height' lines and
2116e93c
EZ
2344`window-safe-min-width' columns. If IGNORE is a window, ignore
2345restrictions for that window only. Any other non-nil value
2346means ignore all of the above restrictions for all windows.
9aab8e0d
MR
2347
2348Optional argument ADD non-nil means add DELTA to the new total
2349size of WINDOW.
2350
2351Optional arguments TRAIL and EDGE, when non-nil, refine the set
2352of windows that shall be resized. If TRAIL equals `before',
2353resize only windows on the left or above EDGE. If TRAIL equals
2354`after', resize only windows on the right or below EDGE. Also,
2355preferably only resize windows adjacent to EDGE.
2356
be7f5545 2357This function recursively resizes WINDOW's child windows to fit the
2cffd681 2358new size. Make sure that WINDOW is `window--resizable' before
9aab8e0d
MR
2359calling this function. Note that this function does not resize
2360siblings of WINDOW or WINDOW's parent window. You have to
d615d6d2 2361eventually call `window-resize-apply' in order to make resizing
9aab8e0d
MR
2362actually take effect."
2363 (when add
2364 ;; Add DELTA to the new total size of WINDOW.
2365 (set-window-new-total window delta t))
387522b2 2366
9aab8e0d
MR
2367 (let ((sub (window-child window)))
2368 (cond
2369 ((not sub))
3d8daefe 2370 ((window-combined-p sub horizontal)
be7f5545 2371 ;; In an iso-combination resize child windows according to their
9aab8e0d 2372 ;; normal sizes.
be7f5545 2373 (window--resize-child-windows
5386012d 2374 window delta horizontal nil ignore trail edge))
be7f5545 2375 ;; In an ortho-combination resize each child window by DELTA.
9aab8e0d
MR
2376 (t
2377 (while sub
5386012d
MR
2378 (window--resize-this-window
2379 sub delta horizontal ignore t trail edge)
9aab8e0d
MR
2380 (setq sub (window-right sub)))))))
2381
5386012d 2382(defun window--resize-root-window (window delta horizontal ignore)
9aab8e0d
MR
2383 "Resize root window WINDOW vertically by DELTA lines.
2384HORIZONTAL non-nil means resize root window WINDOW horizontally
2385by DELTA columns.
2386
2387IGNORE non-nil means ignore any restrictions imposed by fixed
2388size windows, `window-min-height' or `window-min-width' settings.
2389
2390This function is only called by the frame resizing routines. It
2391resizes windows proportionally and never deletes any windows."
2392 (when (and (windowp window) (numberp delta)
2393 (window-sizable-p window delta horizontal ignore))
5386012d
MR
2394 (window--resize-reset (window-frame window) horizontal)
2395 (window--resize-this-window window delta horizontal ignore t)))
9aab8e0d 2396
5386012d 2397(defun window--resize-root-window-vertically (window delta)
9aab8e0d
MR
2398 "Resize root window WINDOW vertically by DELTA lines.
2399If DELTA is less than zero and we can't shrink WINDOW by DELTA
2400lines, shrink it as much as possible. If DELTA is greater than
be7f5545 2401zero, this function can resize fixed-size windows in order to
9aab8e0d
MR
2402recover the necessary lines.
2403
2404Return the number of lines that were recovered.
2405
2406This function is only called by the minibuffer window resizing
2407routines. It resizes windows proportionally and never deletes
2408any windows."
9c52dd5a
MR
2409 (let ((frame (window-frame window))
2410 ignore)
2411 (cond
2412 ((not (numberp delta))
2413 (setq delta 0))
2414 ((zerop delta))
2415 ((< delta 0)
2416 (setq delta (window-sizable window delta))
2417 (window--resize-reset frame)
2418 ;; When shrinking the root window, emulate an edge drag in order
2419 ;; to not resize other windows if we can avoid it (Bug#12419).
2420 (window--resize-this-window
2421 window delta nil ignore t 'before
2422 (+ (window-top-line window) (window-total-size window)))
2423 ;; Don't record new normal sizes to make sure that shrinking back
2424 ;; proportionally works as intended.
2425 (walk-window-tree
2426 (lambda (window) (set-window-new-normal window 'ignore)) frame t))
2427 ((> delta 0)
2428 (window--resize-reset frame)
2429 (unless (window-sizable window delta)
2430 (setq ignore t))
2431 ;; When growing the root window, resize proportionally. This
2432 ;; should give windows back their original sizes (hopefully).
2433 (window--resize-this-window window delta nil ignore t)))
2434 ;; Return the possibly adjusted DELTA.
2435 delta))
9aab8e0d 2436
562dd5e9
MR
2437(defun adjust-window-trailing-edge (window delta &optional horizontal)
2438 "Move WINDOW's bottom edge by DELTA lines.
2439Optional argument HORIZONTAL non-nil means move WINDOW's right
85c2386b
MR
2440edge by DELTA columns. WINDOW must be a valid window and
2441defaults to the selected one.
562dd5e9 2442
2116e93c 2443If DELTA is greater than zero, move the edge downwards or to the
562dd5e9
MR
2444right. If DELTA is less than zero, move the edge upwards or to
2445the left. If the edge can't be moved by DELTA lines or columns,
2446move it as far as possible in the desired direction."
447f16b8 2447 (setq window (window-normalize-window window))
41cfe0cb
MR
2448 (let* ((frame (window-frame window))
2449 (minibuffer-window (minibuffer-window frame))
2450 (right window)
2451 left this-delta min-delta max-delta)
562dd5e9 2452 ;; Find the edge we want to move.
3d8daefe 2453 (while (and (or (not (window-combined-p right horizontal))
562dd5e9
MR
2454 (not (window-right right)))
2455 (setq right (window-parent right))))
2456 (cond
41cfe0cb
MR
2457 ((and (not right) (not horizontal)
2458 ;; Resize the minibuffer window if it's on the same frame as
2459 ;; and immediately below WINDOW and it's either active or
2460 ;; `resize-mini-windows' is nil.
2461 (eq (window-frame minibuffer-window) frame)
2462 (= (nth 1 (window-edges minibuffer-window))
2463 (nth 3 (window-edges window)))
2464 (or (not resize-mini-windows)
2465 (eq minibuffer-window (active-minibuffer-window))))
2466 (window--resize-mini-window minibuffer-window (- delta)))
562dd5e9
MR
2467 ((or (not (setq left right)) (not (setq right (window-right right))))
2468 (if horizontal
2469 (error "No window on the right of this one")
2470 (error "No window below this one")))
2471 (t
2472 ;; Set LEFT to the first resizable window on the left. This step is
2473 ;; needed to handle fixed-size windows.
2474 (while (and left (window-size-fixed-p left horizontal))
2475 (setq left
2476 (or (window-left left)
2477 (progn
2478 (while (and (setq left (window-parent left))
3d8daefe 2479 (not (window-combined-p left horizontal))))
562dd5e9
MR
2480 (window-left left)))))
2481 (unless left
2482 (if horizontal
2483 (error "No resizable window on the left of this one")
2484 (error "No resizable window above this one")))
2485
2486 ;; Set RIGHT to the first resizable window on the right. This step
2487 ;; is needed to handle fixed-size windows.
2488 (while (and right (window-size-fixed-p right horizontal))
2489 (setq right
2490 (or (window-right right)
2491 (progn
2492 (while (and (setq right (window-parent right))
3d8daefe 2493 (not (window-combined-p right horizontal))))
562dd5e9
MR
2494 (window-right right)))))
2495 (unless right
2496 (if horizontal
2497 (error "No resizable window on the right of this one")
2498 (error "No resizable window below this one")))
2499
2500 ;; LEFT and RIGHT (which might be both internal windows) are now the
2501 ;; two windows we want to resize.
2502 (cond
2503 ((> delta 0)
c56cad4a
MR
2504 (setq max-delta (window--max-delta-1 left 0 horizontal nil 'after))
2505 (setq min-delta (window--min-delta-1 right (- delta) horizontal nil 'before))
562dd5e9
MR
2506 (when (or (< max-delta delta) (> min-delta (- delta)))
2507 ;; We can't get the whole DELTA - move as far as possible.
2508 (setq delta (min max-delta (- min-delta))))
2509 (unless (zerop delta)
2510 ;; Start resizing.
5386012d 2511 (window--resize-reset frame horizontal)
562dd5e9 2512 ;; Try to enlarge LEFT first.
2cffd681 2513 (setq this-delta (window--resizable left delta horizontal))
562dd5e9 2514 (unless (zerop this-delta)
5386012d 2515 (window--resize-this-window
562dd5e9
MR
2516 left this-delta horizontal nil t 'before
2517 (if horizontal
2518 (+ (window-left-column left) (window-total-size left t))
2519 (+ (window-top-line left) (window-total-size left)))))
2520 ;; Shrink windows on right of LEFT.
5386012d 2521 (window--resize-siblings
562dd5e9
MR
2522 left delta horizontal nil 'after
2523 (if horizontal
2524 (window-left-column right)
2525 (window-top-line right)))))
2526 ((< delta 0)
c56cad4a
MR
2527 (setq max-delta (window--max-delta-1 right 0 horizontal nil 'before))
2528 (setq min-delta (window--min-delta-1 left delta horizontal nil 'after))
562dd5e9
MR
2529 (when (or (< max-delta (- delta)) (> min-delta delta))
2530 ;; We can't get the whole DELTA - move as far as possible.
2531 (setq delta (max (- max-delta) min-delta)))
2532 (unless (zerop delta)
2533 ;; Start resizing.
5386012d 2534 (window--resize-reset frame horizontal)
562dd5e9 2535 ;; Try to enlarge RIGHT.
2cffd681 2536 (setq this-delta (window--resizable right (- delta) horizontal))
562dd5e9 2537 (unless (zerop this-delta)
5386012d 2538 (window--resize-this-window
562dd5e9
MR
2539 right this-delta horizontal nil t 'after
2540 (if horizontal
2541 (window-left-column right)
2542 (window-top-line right))))
2543 ;; Shrink windows on left of RIGHT.
5386012d 2544 (window--resize-siblings
562dd5e9
MR
2545 right (- delta) horizontal nil 'before
2546 (if horizontal
2547 (+ (window-left-column left) (window-total-size left t))
2548 (+ (window-top-line left) (window-total-size left)))))))
2549 (unless (zerop delta)
2550 ;; Don't report an error in the standard case.
d615d6d2 2551 (unless (window-resize-apply frame horizontal)
562dd5e9
MR
2552 ;; But do report an error if applying the changes fails.
2553 (error "Failed adjusting window %s" window)))))))
2554
2555(defun enlarge-window (delta &optional horizontal)
2116e93c 2556 "Make the selected window DELTA lines taller.
562dd5e9
MR
2557Interactively, if no argument is given, make the selected window
2558one line taller. If optional argument HORIZONTAL is non-nil,
2559make selected window wider by DELTA columns. If DELTA is
2560negative, shrink selected window by -DELTA lines or columns.
2561Return nil."
2562 (interactive "p")
feeb6f53
MR
2563 (let ((minibuffer-window (minibuffer-window)))
2564 (cond
2565 ((zerop delta))
2566 ((window-size-fixed-p nil horizontal)
2567 (error "Selected window has fixed size"))
2568 ((window-minibuffer-p)
2569 (if horizontal
2570 (error "Cannot resize minibuffer window horizontally")
2571 (window--resize-mini-window (selected-window) delta)))
2572 ((and (not horizontal)
2573 (window-full-height-p)
2574 (eq (window-frame minibuffer-window) (selected-frame))
2575 (not resize-mini-windows))
2576 ;; If the selected window is full height and `resize-mini-windows'
2577 ;; is nil, resize the minibuffer window.
2578 (window--resize-mini-window minibuffer-window (- delta)))
2579 ((window--resizable-p nil delta horizontal)
2580 (window-resize nil delta horizontal))
2581 (t
2582 (window-resize
2583 nil (if (> delta 0)
2584 (window-max-delta nil horizontal)
2585 (- (window-min-delta nil horizontal)))
2586 horizontal)))))
562dd5e9
MR
2587
2588(defun shrink-window (delta &optional horizontal)
2116e93c 2589 "Make the selected window DELTA lines smaller.
562dd5e9
MR
2590Interactively, if no argument is given, make the selected window
2591one line smaller. If optional argument HORIZONTAL is non-nil,
2592make selected window narrower by DELTA columns. If DELTA is
2593negative, enlarge selected window by -DELTA lines or columns.
f23d2c7d 2594Also see the `window-min-height' variable.
562dd5e9
MR
2595Return nil."
2596 (interactive "p")
feeb6f53
MR
2597 (let ((minibuffer-window (minibuffer-window)))
2598 (cond
2599 ((zerop delta))
2600 ((window-size-fixed-p nil horizontal)
2601 (error "Selected window has fixed size"))
2602 ((window-minibuffer-p)
2603 (if horizontal
2604 (error "Cannot resize minibuffer window horizontally")
2605 (window--resize-mini-window (selected-window) (- delta))))
2606 ((and (not horizontal)
2607 (window-full-height-p)
2608 (eq (window-frame minibuffer-window) (selected-frame))
2609 (not resize-mini-windows))
2610 ;; If the selected window is full height and `resize-mini-windows'
2611 ;; is nil, resize the minibuffer window.
2612 (window--resize-mini-window minibuffer-window delta))
2613 ((window--resizable-p nil (- delta) horizontal)
2614 (window-resize nil (- delta) horizontal))
2615 (t
2616 (window-resize
2617 nil (if (> delta 0)
2618 (- (window-min-delta nil horizontal))
2619 (window-max-delta nil horizontal))
2620 horizontal)))))
562dd5e9
MR
2621
2622(defun maximize-window (&optional window)
2623 "Maximize WINDOW.
2624Make WINDOW as large as possible without deleting any windows.
85c2386b 2625WINDOW must be a valid window and defaults to the selected one."
562dd5e9 2626 (interactive)
447f16b8 2627 (setq window (window-normalize-window window))
d615d6d2
MR
2628 (window-resize window (window-max-delta window))
2629 (window-resize window (window-max-delta window t) t))
562dd5e9
MR
2630
2631(defun minimize-window (&optional window)
2632 "Minimize WINDOW.
2633Make WINDOW as small as possible without deleting any windows.
85c2386b 2634WINDOW must be a valid window and defaults to the selected one."
562dd5e9 2635 (interactive)
447f16b8 2636 (setq window (window-normalize-window window))
d615d6d2
MR
2637 (window-resize window (- (window-min-delta window)))
2638 (window-resize window (- (window-min-delta window t)) t))
562dd5e9 2639\f
4b0d61e3 2640(defun frame-root-window-p (window)
9aab8e0d
MR
2641 "Return non-nil if WINDOW is the root window of its frame."
2642 (eq window (frame-root-window window)))
6198ccd0 2643
5e92ca23
MR
2644(defun window--subtree (window &optional next)
2645 "Return window subtree rooted at WINDOW.
2646Optional argument NEXT non-nil means include WINDOW's right
6198ccd0
MR
2647siblings in the return value.
2648
2649See the documentation of `window-tree' for a description of the
2650return value."
2651 (let (list)
2652 (while window
2653 (setq list
2654 (cons
2655 (cond
d68443dc 2656 ((window-top-child window)
6198ccd0 2657 (cons t (cons (window-edges window)
5e92ca23 2658 (window--subtree (window-top-child window) t))))
d68443dc 2659 ((window-left-child window)
6198ccd0 2660 (cons nil (cons (window-edges window)
5e92ca23 2661 (window--subtree (window-left-child window) t))))
6198ccd0
MR
2662 (t window))
2663 list))
d68443dc 2664 (setq window (when next (window-next-sibling window))))
6198ccd0
MR
2665 (nreverse list)))
2666
2667(defun window-tree (&optional frame)
2668 "Return the window tree of frame FRAME.
2669FRAME must be a live frame and defaults to the selected frame.
2670The return value is a list of the form (ROOT MINI), where ROOT
2671represents the window tree of the frame's root window, and MINI
2672is the frame's minibuffer window.
2673
2674If the root window is not split, ROOT is the root window itself.
2675Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
2676for a horizontal split, and t for a vertical split. EDGES gives
be7f5545
MR
2677the combined size and position of the child windows in the split,
2678and the rest of the elements are the child windows in the split.
2679Each of the child windows may again be a window or a list
382c953b 2680representing a window split, and so on. EDGES is a list (LEFT
6198ccd0 2681TOP RIGHT BOTTOM) as returned by `window-edges'."
5386012d 2682 (setq frame (window-normalize-frame frame))
5e92ca23 2683 (window--subtree (frame-root-window frame) t))
9aab8e0d 2684\f
9397e56f
MR
2685(defun other-window (count &optional all-frames)
2686 "Select another window in cyclic ordering of windows.
2687COUNT specifies the number of windows to skip, starting with the
2688selected window, before making the selection. If COUNT is
2689positive, skip COUNT windows forwards. If COUNT is negative,
2690skip -COUNT windows backwards. COUNT zero means do not skip any
2691window, so select the selected window. In an interactive call,
2692COUNT is the numeric prefix argument. Return nil.
2693
9a9e9ef0
MR
2694If the `other-window' parameter of the selected window is a
2695function and `ignore-window-parameters' is nil, call that
2696function with the arguments COUNT and ALL-FRAMES.
9397e56f
MR
2697
2698This function does not select a window whose `no-other-window'
2699window parameter is non-nil.
2700
2701This function uses `next-window' for finding the window to
2702select. The argument ALL-FRAMES has the same meaning as in
2703`next-window', but the MINIBUF argument of `next-window' is
2704always effectively nil."
2705 (interactive "p")
2706 (let* ((window (selected-window))
2707 (function (and (not ignore-window-parameters)
2708 (window-parameter window 'other-window)))
2709 old-window old-count)
2710 (if (functionp function)
2711 (funcall function count all-frames)
2712 ;; `next-window' and `previous-window' may return a window we are
2713 ;; not allowed to select. Hence we need an exit strategy in case
2714 ;; all windows are non-selectable.
2715 (catch 'exit
2716 (while (> count 0)
2717 (setq window (next-window window nil all-frames))
2718 (cond
2719 ((eq window old-window)
2720 (when (= count old-count)
2721 ;; Keep out of infinite loops. When COUNT has not changed
2722 ;; since we last looked at `window' we're probably in one.
2723 (throw 'exit nil)))
2724 ((window-parameter window 'no-other-window)
2725 (unless old-window
2726 ;; The first non-selectable window `next-window' got us:
2727 ;; Remember it and the current value of COUNT.
2728 (setq old-window window)
2729 (setq old-count count)))
2730 (t
2731 (setq count (1- count)))))
2732 (while (< count 0)
2733 (setq window (previous-window window nil all-frames))
2734 (cond
2735 ((eq window old-window)
2736 (when (= count old-count)
2737 ;; Keep out of infinite loops. When COUNT has not changed
2738 ;; since we last looked at `window' we're probably in one.
2739 (throw 'exit nil)))
2740 ((window-parameter window 'no-other-window)
2741 (unless old-window
2742 ;; The first non-selectable window `previous-window' got
2743 ;; us: Remember it and the current value of COUNT.
2744 (setq old-window window)
2745 (setq old-count count)))
2746 (t
2747 (setq count (1+ count)))))
2748
2749 (select-window window)
2750 ;; Always return nil.
2751 nil))))
2752
387522b2
MR
2753;; This should probably return non-nil when the selected window is part
2754;; of an atomic window whose root is the frame's root window.
2755(defun one-window-p (&optional nomini all-frames)
2756 "Return non-nil if the selected window is the only window.
2757Optional arg NOMINI non-nil means don't count the minibuffer
2758even if it is active. Otherwise, the minibuffer is counted
2759when it is active.
2760
2761Optional argument ALL-FRAMES specifies the set of frames to
2762consider, see also `next-window'. ALL-FRAMES nil or omitted
2763means consider windows on the selected frame only, plus the
2764minibuffer window if specified by the NOMINI argument. If the
2765minibuffer counts, consider all windows on all frames that share
2766that minibuffer too. The remaining non-nil values of ALL-FRAMES
2767with a special meaning are:
2768
2769- t means consider all windows on all existing frames.
2770
2771- `visible' means consider all windows on all visible frames on
2772 the current terminal.
2773
2774- 0 (the number zero) means consider all windows on all visible
2775 and iconified frames on the current terminal.
2776
2777- A frame means consider all windows on that frame only.
2778
2779Anything else means consider all windows on the selected frame
2780and no others."
2781 (let ((base-window (selected-window)))
2782 (if (and nomini (eq base-window (minibuffer-window)))
2783 (setq base-window (next-window base-window)))
2784 (eq base-window
2785 (next-window base-window (if nomini 'arg) all-frames))))
3c448ab6 2786\f
9aab8e0d 2787;;; Deleting windows.
1b36ed6a 2788(defun window-deletable-p (&optional window)
9aab8e0d 2789 "Return t if WINDOW can be safely deleted from its frame.
85c2386b
MR
2790WINDOW must be a valid window and defaults to the selected one.
2791Return `frame' if deleting WINDOW should also delete its frame."
447f16b8 2792 (setq window (window-normalize-window window))
8b0874b5 2793
9aab8e0d
MR
2794 (unless ignore-window-parameters
2795 ;; Handle atomicity.
2796 (when (window-parameter window 'window-atom)
2797 (setq window (window-atom-root window))))
8b0874b5 2798
caceae25 2799 (let ((frame (window-frame window)))
9aab8e0d
MR
2800 (cond
2801 ((frame-root-window-p window)
85e9c04b 2802 ;; WINDOW's frame can be deleted only if there are other frames
46b7967e
TN
2803 ;; on the same terminal, and it does not contain the active
2804 ;; minibuffer.
2805 (unless (or (eq frame (next-frame frame 0))
2806 (let ((minibuf (active-minibuffer-window)))
2807 (and minibuf (eq frame (window-frame minibuf)))))
85e9c04b 2808 'frame))
1b36ed6a 2809 ((or ignore-window-parameters
caceae25
MR
2810 (not (eq window (window--major-non-side-window frame))))
2811 ;; WINDOW can be deleted unless it is the major non-side window of
2812 ;; its frame.
1f3c99ca 2813 t))))
9aab8e0d 2814
be7f5545
MR
2815(defun window--in-subtree-p (window root)
2816 "Return t if WINDOW is either ROOT or a member of ROOT's subtree."
2817 (or (eq window root)
2818 (let ((parent (window-parent window)))
9aab8e0d
MR
2819 (catch 'done
2820 (while parent
be7f5545 2821 (if (eq parent root)
9aab8e0d
MR
2822 (throw 'done t)
2823 (setq parent (window-parent parent))))))))
2824
562dd5e9
MR
2825(defun delete-window (&optional window)
2826 "Delete WINDOW.
85c2386b
MR
2827WINDOW must be a valid window and defaults to the selected one.
2828Return nil.
562dd5e9
MR
2829
2830If the variable `ignore-window-parameters' is non-nil or the
2831`delete-window' parameter of WINDOW equals t, do not process any
2832parameters of WINDOW. Otherwise, if the `delete-window'
2833parameter of WINDOW specifies a function, call that function with
2834WINDOW as its sole argument and return the value returned by that
2835function.
2836
2837Otherwise, if WINDOW is part of an atomic window, call
2838`delete-window' with the root of the atomic window as its
85c2386b
MR
2839argument. Signal an error if WINDOW is either the only window on
2840its frame, the last non-side window, or part of an atomic window
2841that is its frame's root window."
562dd5e9 2842 (interactive)
447f16b8 2843 (setq window (window-normalize-window window))
562dd5e9
MR
2844 (let* ((frame (window-frame window))
2845 (function (window-parameter window 'delete-window))
2846 (parent (window-parent window))
2847 atom-root)
54f9154c 2848 (window--check frame)
562dd5e9
MR
2849 (catch 'done
2850 ;; Handle window parameters.
2851 (cond
2852 ;; Ignore window parameters if `ignore-window-parameters' tells
2853 ;; us so or `delete-window' equals t.
2854 ((or ignore-window-parameters (eq function t)))
2855 ((functionp function)
2856 ;; The `delete-window' parameter specifies the function to call.
2857 ;; If that function is `ignore' nothing is done. It's up to the
2858 ;; function called here to avoid infinite recursion.
2859 (throw 'done (funcall function window)))
2860 ((and (window-parameter window 'window-atom)
2861 (setq atom-root (window-atom-root window))
2862 (not (eq atom-root window)))
caceae25
MR
2863 (if (eq atom-root (frame-root-window frame))
2864 (error "Root of atomic window is root window of its frame")
2865 (throw 'done (delete-window atom-root))))
562dd5e9 2866 ((not parent)
caceae25
MR
2867 (error "Attempt to delete minibuffer or sole ordinary window"))
2868 ((eq window (window--major-non-side-window frame))
2869 (error "Attempt to delete last non-side window")))
562dd5e9 2870
d68443dc 2871 (let* ((horizontal (window-left-child parent))
562dd5e9
MR
2872 (size (window-total-size window horizontal))
2873 (frame-selected
be7f5545 2874 (window--in-subtree-p (frame-selected-window frame) window))
562dd5e9
MR
2875 ;; Emacs 23 preferably gives WINDOW's space to its left
2876 ;; sibling.
2877 (sibling (or (window-left window) (window-right window))))
5386012d 2878 (window--resize-reset frame horizontal)
562dd5e9 2879 (cond
a0c2d0ae
MR
2880 ((and (not window-combination-resize)
2881 sibling (window-sizable-p sibling size))
562dd5e9 2882 ;; Resize WINDOW's sibling.
5386012d 2883 (window--resize-this-window sibling size horizontal nil t)
562dd5e9
MR
2884 (set-window-new-normal
2885 sibling (+ (window-normal-size sibling horizontal)
2886 (window-normal-size window horizontal))))
2cffd681 2887 ((window--resizable-p window (- size) horizontal nil nil nil t)
562dd5e9 2888 ;; Can do without resizing fixed-size windows.
5386012d 2889 (window--resize-siblings window (- size) horizontal))
562dd5e9
MR
2890 (t
2891 ;; Can't do without resizing fixed-size windows.
5386012d 2892 (window--resize-siblings window (- size) horizontal t)))
562dd5e9
MR
2893 ;; Actually delete WINDOW.
2894 (delete-window-internal window)
2895 (when (and frame-selected
2896 (window-parameter
2897 (frame-selected-window frame) 'no-other-window))
2898 ;; `delete-window-internal' has selected a window that should
2899 ;; not be selected, fix this here.
2900 (other-window -1 frame))
2901 (run-window-configuration-change-hook frame)
54f9154c 2902 (window--check frame)
562dd5e9
MR
2903 ;; Always return nil.
2904 nil))))
2905
2906(defun delete-other-windows (&optional window)
2907 "Make WINDOW fill its frame.
85c2386b 2908WINDOW must be a valid window and defaults to the selected one.
562dd5e9
MR
2909Return nil.
2910
2911If the variable `ignore-window-parameters' is non-nil or the
2912`delete-other-windows' parameter of WINDOW equals t, do not
2913process any parameters of WINDOW. Otherwise, if the
2914`delete-other-windows' parameter of WINDOW specifies a function,
2915call that function with WINDOW as its sole argument and return
2916the value returned by that function.
2917
2918Otherwise, if WINDOW is part of an atomic window, call this
2919function with the root of the atomic window as its argument. If
2920WINDOW is a non-side window, make WINDOW the only non-side window
382c953b 2921on the frame. Side windows are not deleted. If WINDOW is a side
562dd5e9
MR
2922window signal an error."
2923 (interactive)
447f16b8 2924 (setq window (window-normalize-window window))
562dd5e9
MR
2925 (let* ((frame (window-frame window))
2926 (function (window-parameter window 'delete-other-windows))
2927 (window-side (window-parameter window 'window-side))
2928 atom-root side-main)
54f9154c 2929 (window--check frame)
562dd5e9
MR
2930 (catch 'done
2931 (cond
2932 ;; Ignore window parameters if `ignore-window-parameters' is t or
2933 ;; `delete-other-windows' is t.
2934 ((or ignore-window-parameters (eq function t)))
2935 ((functionp function)
2936 ;; The `delete-other-windows' parameter specifies the function
2937 ;; to call. If the function is `ignore' no windows are deleted.
2938 ;; It's up to the function called to avoid infinite recursion.
2939 (throw 'done (funcall function window)))
2940 ((and (window-parameter window 'window-atom)
2941 (setq atom-root (window-atom-root window))
2942 (not (eq atom-root window)))
caceae25
MR
2943 (if (eq atom-root (frame-root-window frame))
2944 (error "Root of atomic window is root window of its frame")
2945 (throw 'done (delete-other-windows atom-root))))
562dd5e9 2946 ((memq window-side window-sides)
caceae25
MR
2947 (error "Cannot make side window the only window"))
2948 ((and (window-minibuffer-p window)
2949 (not (eq window (frame-root-window window))))
2950 (error "Can't expand minibuffer to full frame")))
2951
2952 ;; If WINDOW is the major non-side window, do nothing.
2953 (if (window-with-parameter 'window-side)
2954 (setq side-main (window--major-non-side-window frame))
2955 (setq side-main (frame-root-window frame)))
562dd5e9
MR
2956 (unless (eq window side-main)
2957 (delete-other-windows-internal window side-main)
2958 (run-window-configuration-change-hook frame)
54f9154c 2959 (window--check frame))
562dd5e9
MR
2960 ;; Always return nil.
2961 nil)))
9397e56f
MR
2962
2963(defun delete-other-windows-vertically (&optional window)
2964 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
2965This may be a useful alternative binding for \\[delete-other-windows]
2966 if you often split windows horizontally."
2967 (interactive)
2968 (let* ((window (or window (selected-window)))
2969 (edges (window-edges window))
2970 (w window) delenda)
2971 (while (not (eq (setq w (next-window w 1)) window))
2972 (let ((e (window-edges w)))
2973 (when (and (= (car e) (car edges))
36cec983 2974 (= (nth 2 e) (nth 2 edges)))
9397e56f
MR
2975 (push w delenda))))
2976 (mapc 'delete-window delenda)))
2977
2978;;; Windows and buffers.
2979
2980;; `prev-buffers' and `next-buffers' are two reserved window slots used
2981;; for (1) determining which buffer to show in the window when its
2982;; buffer shall be buried or killed and (2) which buffer to show for
2983;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2984
2985;; `prev-buffers' consists of <buffer, window-start, window-point>
2986;; triples. The entries on this list are ordered by the time their
2987;; buffer has been removed from the window, the most recently removed
2988;; buffer's entry being first. The window-start and window-point
2989;; components are `window-start' and `window-point' at the time the
2990;; buffer was removed from the window which implies that the entry must
2991;; be added when `set-window-buffer' removes the buffer from the window.
2992
2993;; `next-buffers' is the list of buffers that have been replaced
2994;; recently by `switch-to-prev-buffer'. These buffers are the least
2995;; preferred candidates of `switch-to-prev-buffer' and the preferred
2996;; candidates of `switch-to-next-buffer' to switch to. This list is
2997;; reset to nil by any action changing the window's buffer with the
2998;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
2999;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
3000;; `switch-to-next-buffer' pops the last pushed buffer from it.
3001
3002;; Both `prev-buffers' and `next-buffers' may reference killed buffers
3003;; if such a buffer was killed while the window was hidden within a
3004;; window configuration. Such killed buffers get removed whenever
3005;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
3006
3007;; The following function is called by `set-window-buffer' _before_ it
3008;; replaces the buffer of the argument window with the new buffer.
3009(defun record-window-buffer (&optional window)
3010 "Record WINDOW's buffer.
3011WINDOW must be a live window and defaults to the selected one."
447f16b8 3012 (let* ((window (window-normalize-window window t))
9397e56f
MR
3013 (buffer (window-buffer window))
3014 (entry (assq buffer (window-prev-buffers window))))
3015 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
3016 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
3017 (set-window-next-buffers window nil)
3018
3019 (when entry
3020 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
3021 (set-window-prev-buffers
3022 window (assq-delete-all buffer (window-prev-buffers window))))
3023
3024 ;; Don't record insignificant buffers.
3025 (unless (eq (aref (buffer-name buffer) 0) ?\s)
3026 ;; Add an entry for buffer to WINDOW's previous buffers.
3027 (with-current-buffer buffer
3028 (let ((start (window-start window))
5481664a 3029 (point (window-point window)))
9397e56f
MR
3030 (setq entry
3031 (cons buffer
3032 (if entry
3033 ;; We have an entry, update marker positions.
3034 (list (set-marker (nth 1 entry) start)
3035 (set-marker (nth 2 entry) point))
3036 ;; Make new markers.
3037 (list (copy-marker start)
3038 (copy-marker point)))))
3039
3040 (set-window-prev-buffers
3041 window (cons entry (window-prev-buffers window))))))))
3042
3043(defun unrecord-window-buffer (&optional window buffer)
3044 "Unrecord BUFFER in WINDOW.
3045WINDOW must be a live window and defaults to the selected one.
3046BUFFER must be a live buffer and defaults to the buffer of
3047WINDOW."
447f16b8 3048 (let* ((window (window-normalize-window window t))
9397e56f
MR
3049 (buffer (or buffer (window-buffer window))))
3050 (set-window-prev-buffers
3051 window (assq-delete-all buffer (window-prev-buffers window)))
3052 (set-window-next-buffers
3053 window (delq buffer (window-next-buffers window)))))
3054
3055(defun set-window-buffer-start-and-point (window buffer &optional start point)
3056 "Set WINDOW's buffer to BUFFER.
85c2386b 3057WINDOW must be a live window and defaults to the selected one.
9397e56f
MR
3058Optional argument START non-nil means set WINDOW's start position
3059to START. Optional argument POINT non-nil means set WINDOW's
3060point to POINT. If WINDOW is selected this also sets BUFFER's
3061`point' to POINT. If WINDOW is selected and the buffer it showed
3062before was current this also makes BUFFER the current buffer."
85c2386b 3063 (setq window (window-normalize-window window t))
9397e56f
MR
3064 (let ((selected (eq window (selected-window)))
3065 (current (eq (window-buffer window) (current-buffer))))
3066 (set-window-buffer window buffer)
3067 (when (and selected current)
3068 (set-buffer buffer))
3069 (when start
cf4eacfd
MR
3070 ;; Don't force window-start here (even if POINT is nil).
3071 (set-window-start window start t))
9397e56f 3072 (when point
5481664a 3073 (set-window-point window point))))
9397e56f 3074
dcb6e7b3
MR
3075(defcustom switch-to-visible-buffer t
3076 "If non-nil, allow switching to an already visible buffer.
3077If this variable is non-nil, `switch-to-prev-buffer' and
3078`switch-to-next-buffer' may switch to an already visible buffer
3079provided the buffer was shown in the argument window before. If
3080this variable is nil, `switch-to-prev-buffer' and
3081`switch-to-next-buffer' always try to avoid switching to a buffer
3082that is already visible in another window on the same frame."
3083 :type 'boolean
3084 :version "24.1"
3085 :group 'windows)
3086
9397e56f
MR
3087(defun switch-to-prev-buffer (&optional window bury-or-kill)
3088 "In WINDOW switch to previous buffer.
3089WINDOW must be a live window and defaults to the selected one.
502e3f89
MR
3090Return the buffer switched to, nil if no suitable buffer could be
3091found.
9397e56f
MR
3092
3093Optional argument BURY-OR-KILL non-nil means the buffer currently
3094shown in WINDOW is about to be buried or killed and consequently
78dd6ab1
MR
3095shall not be switched to in future invocations of this command.
3096
3097As a special case, if BURY-OR-KILL equals `append', this means to
3098move the buffer to the end of WINDOW's previous buffers list so a
3099future invocation of `switch-to-prev-buffer' less likely switches
3100to it."
9397e56f 3101 (interactive)
447f16b8 3102 (let* ((window (window-normalize-window window t))
dcb6e7b3 3103 (frame (window-frame window))
9397e56f
MR
3104 (old-buffer (window-buffer window))
3105 ;; Save this since it's destroyed by `set-window-buffer'.
3106 (next-buffers (window-next-buffers window))
862382df 3107 (pred (frame-parameter frame 'buffer-predicate))
78dd6ab1
MR
3108 entry new-buffer killed-buffers visible)
3109 (when (window-minibuffer-p window)
3110 ;; Don't switch in minibuffer window.
3111 (unless (setq window (minibuffer-selected-window))
3112 (error "Window %s is a minibuffer window" window)))
3113
1b36ed6a 3114 (when (window-dedicated-p window)
78dd6ab1 3115 ;; Don't switch in dedicated window.
1b36ed6a
MR
3116 (error "Window %s is dedicated to buffer %s" window old-buffer))
3117
3118 (catch 'found
3119 ;; Scan WINDOW's previous buffers first, skipping entries of next
3120 ;; buffers.
3121 (dolist (entry (window-prev-buffers window))
78dd6ab1
MR
3122 (when (and (setq new-buffer (car entry))
3123 (or (buffer-live-p new-buffer)
1b36ed6a 3124 (not (setq killed-buffers
78dd6ab1
MR
3125 (cons new-buffer killed-buffers))))
3126 (not (eq new-buffer old-buffer))
3127 (or (null pred) (funcall pred new-buffer))
3128 ;; When BURY-OR-KILL is nil, avoid switching to a
3129 ;; buffer in WINDOW's next buffers list.
3130 (or bury-or-kill (not (memq new-buffer next-buffers))))
dcb6e7b3 3131 (if (and (not switch-to-visible-buffer)
78dd6ab1
MR
3132 (get-buffer-window new-buffer frame))
3133 ;; Try to avoid showing a buffer visible in some other
3134 ;; window.
3135 (setq visible new-buffer)
502e3f89
MR
3136 (set-window-buffer-start-and-point
3137 window new-buffer (nth 1 entry) (nth 2 entry))
3138 (throw 'found t))))
1b36ed6a
MR
3139 ;; Scan reverted buffer list of WINDOW's frame next, skipping
3140 ;; entries of next buffers. Note that when we bury or kill a
3141 ;; buffer we don't reverse the global buffer list to avoid showing
3142 ;; a buried buffer instead. Otherwise, we must reverse the global
3143 ;; buffer list in order to make sure that switching to the
3144 ;; previous/next buffer traverse it in opposite directions.
3145 (dolist (buffer (if bury-or-kill
dcb6e7b3
MR
3146 (buffer-list frame)
3147 (nreverse (buffer-list frame))))
1b36ed6a
MR
3148 (when (and (buffer-live-p buffer)
3149 (not (eq buffer old-buffer))
862382df 3150 (or (null pred) (funcall pred buffer))
78dd6ab1 3151 (not (eq (aref (buffer-name buffer) 0) ?\s))
1b36ed6a 3152 (or bury-or-kill (not (memq buffer next-buffers))))
dcb6e7b3 3153 (if (get-buffer-window buffer frame)
1b36ed6a 3154 ;; Try to avoid showing a buffer visible in some other window.
dcb6e7b3
MR
3155 (unless visible
3156 (setq visible buffer))
1b36ed6a
MR
3157 (setq new-buffer buffer)
3158 (set-window-buffer-start-and-point window new-buffer)
3159 (throw 'found t))))
3160 (unless bury-or-kill
3161 ;; Scan reverted next buffers last (must not use nreverse
3162 ;; here!).
3163 (dolist (buffer (reverse next-buffers))
3164 ;; Actually, buffer _must_ be live here since otherwise it
3165 ;; would have been caught in the scan of previous buffers.
3166 (when (and (or (buffer-live-p buffer)
9397e56f 3167 (not (setq killed-buffers
1b36ed6a 3168 (cons buffer killed-buffers))))
9397e56f 3169 (not (eq buffer old-buffer))
862382df 3170 (or (null pred) (funcall pred buffer))
1b36ed6a 3171 (setq entry (assq buffer (window-prev-buffers window))))
9397e56f 3172 (setq new-buffer buffer)
1b36ed6a
MR
3173 (set-window-buffer-start-and-point
3174 window new-buffer (nth 1 entry) (nth 2 entry))
9397e56f 3175 (throw 'found t))))
1b36ed6a
MR
3176
3177 ;; Show a buffer visible in another window.
3178 (when visible
3179 (setq new-buffer visible)
3180 (set-window-buffer-start-and-point window new-buffer)))
3181
3182 (if bury-or-kill
78dd6ab1
MR
3183 (let ((entry (and (eq bury-or-kill 'append)
3184 (assq old-buffer (window-prev-buffers window)))))
3185 ;; Remove `old-buffer' from WINDOW's previous and (restored list
3186 ;; of) next buffers.
1b36ed6a
MR
3187 (set-window-prev-buffers
3188 window (assq-delete-all old-buffer (window-prev-buffers window)))
78dd6ab1
MR
3189 (set-window-next-buffers window (delq old-buffer next-buffers))
3190 (when entry
3191 ;; Append old-buffer's entry to list of WINDOW's previous
3192 ;; buffers so it's less likely to get switched to soon but
3193 ;; `display-buffer-in-previous-window' can nevertheless find
3194 ;; it.
3195 (set-window-prev-buffers
3196 window (append (window-prev-buffers window) (list entry)))))
1b36ed6a
MR
3197 ;; Move `old-buffer' to head of WINDOW's restored list of next
3198 ;; buffers.
3199 (set-window-next-buffers
3200 window (cons old-buffer (delq old-buffer next-buffers))))
9397e56f
MR
3201
3202 ;; Remove killed buffers from WINDOW's previous and next buffers.
3203 (when killed-buffers
3204 (dolist (buffer killed-buffers)
3205 (set-window-prev-buffers
3206 window (assq-delete-all buffer (window-prev-buffers window)))
3207 (set-window-next-buffers
3208 window (delq buffer (window-next-buffers window)))))
3209
3210 ;; Return new-buffer.
3211 new-buffer))
3212
3213(defun switch-to-next-buffer (&optional window)
3214 "In WINDOW switch to next buffer.
502e3f89
MR
3215WINDOW must be a live window and defaults to the selected one.
3216Return the buffer switched to, nil if no suitable buffer could be
3217found."
9397e56f 3218 (interactive)
447f16b8 3219 (let* ((window (window-normalize-window window t))
dcb6e7b3 3220 (frame (window-frame window))
9397e56f
MR
3221 (old-buffer (window-buffer window))
3222 (next-buffers (window-next-buffers window))
862382df 3223 (pred (frame-parameter frame 'buffer-predicate))
78dd6ab1
MR
3224 new-buffer entry killed-buffers visible)
3225 (when (window-minibuffer-p window)
3226 ;; Don't switch in minibuffer window.
3227 (unless (setq window (minibuffer-selected-window))
3228 (error "Window %s is a minibuffer window" window)))
3229
9397e56f 3230 (when (window-dedicated-p window)
78dd6ab1 3231 ;; Don't switch in dedicated window.
9397e56f
MR
3232 (error "Window %s is dedicated to buffer %s" window old-buffer))
3233
3234 (catch 'found
3235 ;; Scan WINDOW's next buffers first.
3236 (dolist (buffer next-buffers)
3237 (when (and (or (buffer-live-p buffer)
3238 (not (setq killed-buffers
3239 (cons buffer killed-buffers))))
3240 (not (eq buffer old-buffer))
862382df 3241 (or (null pred) (funcall pred buffer))
9397e56f
MR
3242 (setq entry (assq buffer (window-prev-buffers window))))
3243 (setq new-buffer buffer)
3244 (set-window-buffer-start-and-point
3245 window new-buffer (nth 1 entry) (nth 2 entry))
3246 (throw 'found t)))
3247 ;; Scan the buffer list of WINDOW's frame next, skipping previous
3248 ;; buffers entries.
dcb6e7b3 3249 (dolist (buffer (buffer-list frame))
78dd6ab1
MR
3250 (when (and (buffer-live-p buffer)
3251 (not (eq buffer old-buffer))
862382df 3252 (or (null pred) (funcall pred buffer))
78dd6ab1 3253 (not (eq (aref (buffer-name buffer) 0) ?\s))
9397e56f 3254 (not (assq buffer (window-prev-buffers window))))
dcb6e7b3 3255 (if (get-buffer-window buffer frame)
9397e56f
MR
3256 ;; Try to avoid showing a buffer visible in some other window.
3257 (setq visible buffer)
3258 (setq new-buffer buffer)
3259 (set-window-buffer-start-and-point window new-buffer)
3260 (throw 'found t))))
3261 ;; Scan WINDOW's reverted previous buffers last (must not use
3262 ;; nreverse here!)
3263 (dolist (entry (reverse (window-prev-buffers window)))
78dd6ab1
MR
3264 (when (and (setq new-buffer (car entry))
3265 (or (buffer-live-p new-buffer)
9397e56f 3266 (not (setq killed-buffers
78dd6ab1
MR
3267 (cons new-buffer killed-buffers))))
3268 (not (eq new-buffer old-buffer))
3269 (or (null pred) (funcall pred new-buffer)))
dcb6e7b3 3270 (if (and (not switch-to-visible-buffer)
78dd6ab1 3271 (get-buffer-window new-buffer frame))
dcb6e7b3
MR
3272 ;; Try to avoid showing a buffer visible in some other window.
3273 (unless visible
78dd6ab1 3274 (setq visible new-buffer))
dcb6e7b3
MR
3275 (set-window-buffer-start-and-point
3276 window new-buffer (nth 1 entry) (nth 2 entry))
3277 (throw 'found t))))
9397e56f
MR
3278
3279 ;; Show a buffer visible in another window.
3280 (when visible
3281 (setq new-buffer visible)
3282 (set-window-buffer-start-and-point window new-buffer)))
3283
3284 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
3285 (set-window-next-buffers window (delq new-buffer next-buffers))
3286
3287 ;; Remove killed buffers from WINDOW's previous and next buffers.
3288 (when killed-buffers
3289 (dolist (buffer killed-buffers)
3290 (set-window-prev-buffers
3291 window (assq-delete-all buffer (window-prev-buffers window)))
3292 (set-window-next-buffers
3293 window (delq buffer (window-next-buffers window)))))
3294
3295 ;; Return new-buffer.
3296 new-buffer))
3297
3298(defun get-next-valid-buffer (list &optional buffer visible-ok frame)
3299 "Search LIST for a valid buffer to display in FRAME.
3300Return nil when all buffers in LIST are undesirable for display,
3301otherwise return the first suitable buffer in LIST.
3302
3303Buffers not visible in windows are preferred to visible buffers,
3304unless VISIBLE-OK is non-nil.
3305If the optional argument FRAME is nil, it defaults to the selected frame.
3306If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
3307 ;; This logic is more or less copied from other-buffer.
3308 (setq frame (or frame (selected-frame)))
3309 (let ((pred (frame-parameter frame 'buffer-predicate))
3310 found buf)
3311 (while (and (not found) list)
3312 (setq buf (car list))
3313 (if (and (not (eq buffer buf))
3314 (buffer-live-p buf)
3315 (or (null pred) (funcall pred buf))
3316 (not (eq (aref (buffer-name buf) 0) ?\s))
3317 (or visible-ok (null (get-buffer-window buf 'visible))))
3318 (setq found buf)
3319 (setq list (cdr list))))
3320 (car list)))
3321
3322(defun last-buffer (&optional buffer visible-ok frame)
3323 "Return the last buffer in FRAME's buffer list.
3324If BUFFER is the last buffer, return the preceding buffer
3325instead. Buffers not visible in windows are preferred to visible
3326buffers, unless optional argument VISIBLE-OK is non-nil.
3327Optional third argument FRAME nil or omitted means use the
3328selected frame's buffer list. If no such buffer exists, return
3329the buffer `*scratch*', creating it if necessary."
3330 (setq frame (or frame (selected-frame)))
3331 (or (get-next-valid-buffer (nreverse (buffer-list frame))
3332 buffer visible-ok frame)
3333 (get-buffer "*scratch*")
3334 (let ((scratch (get-buffer-create "*scratch*")))
3335 (set-buffer-major-mode scratch)
3336 scratch)))
3337
5a4cf282
MR
3338(defcustom frame-auto-hide-function #'iconify-frame
3339 "Function called to automatically hide frames.
3340The function is called with one argument - a frame.
3341
3342Functions affected by this option are those that bury a buffer
3343shown in a separate frame like `quit-window' and `bury-buffer'."
3344 :type '(choice (const :tag "Iconify" iconify-frame)
3345 (const :tag "Delete" delete-frame)
3346 (const :tag "Do nothing" ignore)
3347 function)
3348 :group 'windows
49677495
MR
3349 :group 'frames
3350 :version "24.1")
0e2070b5
MR
3351
3352(defun window--delete (&optional window dedicated-only kill)
3353 "Delete WINDOW if possible.
3354WINDOW must be a live window and defaults to the selected one.
3355Optional argument DEDICATED-ONLY non-nil means to delete WINDOW
3356only if it's dedicated to its buffer. Optional argument KILL
3357means the buffer shown in window will be killed. Return non-nil
c557cd6b 3358if WINDOW gets deleted or its frame is auto-hidden."
447f16b8 3359 (setq window (window-normalize-window window t))
0e2070b5 3360 (unless (and dedicated-only (not (window-dedicated-p window)))
cb882333 3361 (let ((deletable (window-deletable-p window)))
0e2070b5
MR
3362 (cond
3363 ((eq deletable 'frame)
3364 (let ((frame (window-frame window)))
c557cd6b
MR
3365 (cond
3366 (kill
3367 (delete-frame frame))
3368 ((functionp frame-auto-hide-function)
3369 (funcall frame-auto-hide-function frame))))
0e2070b5
MR
3370 'frame)
3371 (deletable
3372 (delete-window window)
3373 t)))))
3374
9397e56f
MR
3375(defun bury-buffer (&optional buffer-or-name)
3376 "Put BUFFER-OR-NAME at the end of the list of all buffers.
3377There it is the least likely candidate for `other-buffer' to
3378return; thus, the least likely buffer for \\[switch-to-buffer] to
3379select by default.
3380
3381You can specify a buffer name as BUFFER-OR-NAME, or an actual
3382buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
3383current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
3384remove the current buffer from the selected window if it is
3385displayed there."
3386 (interactive)
5386012d 3387 (let* ((buffer (window-normalize-buffer buffer-or-name)))
9397e56f
MR
3388 ;; If `buffer-or-name' is not on the selected frame we unrecord it
3389 ;; although it's not "here" (call it a feature).
e4ed06f1 3390 (bury-buffer-internal buffer)
9397e56f
MR
3391 ;; Handle case where `buffer-or-name' is nil and the current buffer
3392 ;; is shown in the selected window.
3393 (cond
3394 ((or buffer-or-name (not (eq buffer (window-buffer)))))
0e2070b5
MR
3395 ((window--delete nil t))
3396 (t
3397 ;; Switch to another buffer in window.
3398 (set-window-dedicated-p nil nil)
1885e5b8 3399 (switch-to-prev-buffer nil 'bury)))
1b36ed6a 3400
9397e56f
MR
3401 ;; Always return nil.
3402 nil))
3403
3404(defun unbury-buffer ()
3405 "Switch to the last buffer in the buffer list."
3406 (interactive)
3407 (switch-to-buffer (last-buffer)))
3408
3409(defun next-buffer ()
3410 "In selected window switch to next buffer."
3411 (interactive)
85c2386b
MR
3412 (cond
3413 ((window-minibuffer-p)
3414 (error "Cannot switch buffers in minibuffer window"))
3415 ((eq (window-dedicated-p) t)
3416 (error "Window is strongly dedicated to its buffer"))
3417 (t
3418 (switch-to-next-buffer))))
9397e56f
MR
3419
3420(defun previous-buffer ()
3421 "In selected window switch to previous buffer."
3422 (interactive)
85c2386b
MR
3423 (cond
3424 ((window-minibuffer-p)
3425 (error "Cannot switch buffers in minibuffer window"))
3426 ((eq (window-dedicated-p) t)
3427 (error "Window is strongly dedicated to its buffer"))
3428 (t
3429 (switch-to-prev-buffer))))
9397e56f
MR
3430
3431(defun delete-windows-on (&optional buffer-or-name frame)
3432 "Delete all windows showing BUFFER-OR-NAME.
3433BUFFER-OR-NAME may be a buffer or the name of an existing buffer
3434and defaults to the current buffer.
3435
3436The following non-nil values of the optional argument FRAME
3437have special meanings:
3438
3439- t means consider all windows on the selected frame only.
3440
3441- `visible' means consider all windows on all visible frames on
3442 the current terminal.
3443
3444- 0 (the number zero) means consider all windows on all visible
3445 and iconified frames on the current terminal.
3446
3447- A frame means consider all windows on that frame only.
3448
3449Any other value of FRAME means consider all windows on all
3450frames.
3451
3452When a window showing BUFFER-OR-NAME is dedicated and the only
3453window of its frame, that frame is deleted when there are other
3454frames left."
3455 (interactive "BDelete windows on (buffer):\nP")
5386012d 3456 (let ((buffer (window-normalize-buffer buffer-or-name))
9397e56f
MR
3457 ;; Handle the "inverted" meaning of the FRAME argument wrt other
3458 ;; `window-list-1' based function.
3459 (all-frames (cond ((not frame) t) ((eq frame t) nil) (t frame))))
3460 (dolist (window (window-list-1 nil nil all-frames))
3461 (if (eq (window-buffer window) buffer)
1b36ed6a 3462 (let ((deletable (window-deletable-p window)))
9397e56f 3463 (cond
1b36ed6a
MR
3464 ((and (eq deletable 'frame) (window-dedicated-p window))
3465 ;; Delete frame if and only if window is dedicated.
9397e56f 3466 (delete-frame (window-frame window)))
1b36ed6a
MR
3467 ((eq deletable t)
3468 ;; Delete window.
9397e56f
MR
3469 (delete-window window))
3470 (t
3471 ;; In window switch to previous buffer.
3472 (set-window-dedicated-p window nil)
3473 (switch-to-prev-buffer window 'bury))))
3474 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
3475 (unrecord-window-buffer window buffer)))))
3476
3477(defun replace-buffer-in-windows (&optional buffer-or-name)
3478 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
3479BUFFER-OR-NAME may be a buffer or the name of an existing buffer
3480and defaults to the current buffer.
3481
0e2070b5
MR
3482When a window showing BUFFER-OR-NAME is dedicated, that window is
3483deleted. If that window is the only window on its frame, the
3484frame is deleted too when there are other frames left. If there
3485are no other frames left, some other buffer is displayed in that
3486window.
9397e56f
MR
3487
3488This function removes the buffer denoted by BUFFER-OR-NAME from
3489all window-local buffer lists."
24901d61 3490 (interactive "bBuffer to replace: ")
5386012d 3491 (let ((buffer (window-normalize-buffer buffer-or-name)))
9397e56f
MR
3492 (dolist (window (window-list-1 nil nil t))
3493 (if (eq (window-buffer window) buffer)
0e2070b5
MR
3494 (unless (window--delete window t t)
3495 ;; Switch to another buffer in window.
3496 (set-window-dedicated-p window nil)
3497 (switch-to-prev-buffer window 'kill))
9397e56f
MR
3498 ;; Unrecord BUFFER in WINDOW.
3499 (unrecord-window-buffer window buffer)))))
3500
78dd6ab1
MR
3501(defun quit-restore-window (&optional window bury-or-kill)
3502 "Quit WINDOW and deal with its buffer.
cf4eacfd 3503WINDOW must be a live window and defaults to the selected one.
9397e56f
MR
3504
3505According to information stored in WINDOW's `quit-restore' window
382c953b
JB
3506parameter either (1) delete WINDOW and its frame, (2) delete
3507WINDOW, (3) restore the buffer previously displayed in WINDOW,
3508or (4) make WINDOW display some other buffer than the present
78dd6ab1
MR
3509one. If non-nil, reset `quit-restore' parameter to nil.
3510
3511Optional second argument BURY-OR-KILL tells how to proceed with
3512the buffer of WINDOW. The following values are handled:
3513
3514`nil' means to not handle the buffer in a particular way. This
3515 means that if WINDOW is not deleted by this function, invoking
3516 `switch-to-prev-buffer' will usually show the buffer again.
3517
3518`append' means that if WINDOW is not deleted, move its buffer to
3519 the end of WINDOW's previous buffers so it's less likely that a
3520 future invocation of `switch-to-prev-buffer' will switch to it.
3521 Also, move the buffer to the end of the frame's buffer list.
3522
3523`bury' means that if WINDOW is not deleted, remove its buffer
3524 from WINDOW'S list of previous buffers. Also, move the buffer
3525 to the end of the frame's buffer list. This value provides the
3526 most reliable remedy to not have `switch-to-prev-buffer' switch
3527 to this buffer again without killing the buffer.
3528
3529`kill' means to kill WINDOW's buffer."
447f16b8 3530 (setq window (window-normalize-window window t))
cf4eacfd
MR
3531 (let* ((buffer (window-buffer window))
3532 (quit-restore (window-parameter window 'quit-restore))
3533 (prev-buffer
3534 (let* ((prev-buffers (window-prev-buffers window))
3535 (prev-buffer (caar prev-buffers)))
3536 (and (or (not (eq prev-buffer buffer))
3537 (and (cdr prev-buffers)
3538 (not (eq (setq prev-buffer (cadr prev-buffers))
3539 buffer))))
3540 prev-buffer)))
78dd6ab1 3541 quad entry)
9397e56f 3542 (cond
cf4eacfd 3543 ((and (not prev-buffer)
0e2070b5
MR
3544 (memq (nth 1 quit-restore) '(window frame))
3545 (eq (nth 3 quit-restore) buffer)
3546 ;; Delete WINDOW if possible.
78dd6ab1 3547 (window--delete window nil (eq bury-or-kill 'kill)))
9397e56f
MR
3548 ;; If the previously selected window is still alive, select it.
3549 (when (window-live-p (nth 2 quit-restore))
3550 (select-window (nth 2 quit-restore))))
cf4eacfd
MR
3551 ((and (listp (setq quad (nth 1 quit-restore)))
3552 (buffer-live-p (car quad))
3553 (eq (nth 3 quit-restore) buffer))
3554 ;; Show another buffer stored in quit-restore parameter.
78dd6ab1
MR
3555 (when (and (integerp (nth 3 quad))
3556 (/= (nth 3 quad) (window-total-size window)))
cf4eacfd
MR
3557 ;; Try to resize WINDOW to its old height but don't signal an
3558 ;; error.
3559 (condition-case nil
3560 (window-resize window (- (nth 3 quad) (window-total-size window)))
3561 (error nil)))
78dd6ab1 3562 (set-window-dedicated-p window nil)
1885e5b8 3563 ;; Restore WINDOW's previous buffer, start and point position.
cf4eacfd
MR
3564 (set-window-buffer-start-and-point
3565 window (nth 0 quad) (nth 1 quad) (nth 2 quad))
78dd6ab1
MR
3566 ;; Deal with the buffer we just removed from WINDOW.
3567 (setq entry (and (eq bury-or-kill 'append)
3568 (assq buffer (window-prev-buffers window))))
3569 (when bury-or-kill
3570 ;; Remove buffer from WINDOW's previous and next buffers.
3571 (set-window-prev-buffers
3572 window (assq-delete-all buffer (window-prev-buffers window)))
3573 (set-window-next-buffers
3574 window (delq buffer (window-next-buffers window))))
3575 (when entry
3576 ;; Append old buffer's entry to list of WINDOW's previous
3577 ;; buffers so it's less likely to get switched to soon but
3578 ;; `display-buffer-in-previous-window' can nevertheless find it.
3579 (set-window-prev-buffers
3580 window (append (window-prev-buffers window) (list entry))))
9397e56f
MR
3581 ;; Reset the quit-restore parameter.
3582 (set-window-parameter window 'quit-restore nil)
cf4eacfd
MR
3583 ;; Select old window.
3584 (when (window-live-p (nth 2 quit-restore))
3585 (select-window (nth 2 quit-restore))))
9397e56f 3586 (t
cf4eacfd
MR
3587 ;; Show some other buffer in WINDOW and reset the quit-restore
3588 ;; parameter.
9397e56f 3589 (set-window-parameter window 'quit-restore nil)
b4d72fcf
MR
3590 ;; Make sure that WINDOW is no more dedicated.
3591 (set-window-dedicated-p window nil)
78dd6ab1
MR
3592 (switch-to-prev-buffer window bury-or-kill)))
3593
3594 ;; Deal with the buffer.
3595 (cond
3596 ((not (buffer-live-p buffer)))
3597 ((eq bury-or-kill 'kill)
3598 (kill-buffer buffer))
3599 (bury-or-kill
3600 (bury-buffer-internal buffer)))))
9397e56f 3601
78dd6ab1
MR
3602(defun quit-window (&optional kill window)
3603 "Quit WINDOW and bury its buffer.
3604WINDOW must be a live window and defaults to the selected one.
3605With prefix argument KILL non-nil, kill the buffer instead of
3606burying it.
3607
3608According to information stored in WINDOW's `quit-restore' window
3609parameter either (1) delete WINDOW and its frame, (2) delete
3610WINDOW, (3) restore the buffer previously displayed in WINDOW,
3611or (4) make WINDOW display some other buffer than the present
3612one. If non-nil, reset `quit-restore' parameter to nil."
3613 (interactive "P")
3614 (quit-restore-window window (if kill 'kill 'bury)))
366ca7f3
MR
3615
3616(defun quit-windows-on (&optional buffer-or-name kill frame)
3617 "Quit all windows showing BUFFER-OR-NAME.
3618BUFFER-OR-NAME may be a buffer or the name of an existing buffer
3619and defaults to the current buffer. Optional argument KILL
3620non-nil means to kill BUFFER-OR-NAME. KILL nil means to bury
3621BUFFER-OR-NAME. Optional argument FRAME is handled as by
3622`delete-windows-on'.
3623
3624This function calls `quit-window' on all candidate windows
3625showing BUFFER-OR-NAME."
3626 (interactive "BQuit windows on (buffer):\nP")
3627 (let ((buffer (window-normalize-buffer buffer-or-name))
3628 ;; Handle the "inverted" meaning of the FRAME argument wrt other
3629 ;; `window-list-1' based function.
3630 (all-frames (cond ((not frame) t) ((eq frame t) nil) (t frame))))
3631 (dolist (window (window-list-1 nil nil all-frames))
3632 (if (eq (window-buffer window) buffer)
3633 (quit-window kill window)
3634 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
3635 (unrecord-window-buffer window buffer)))))
562dd5e9
MR
3636\f
3637;;; Splitting windows.
4b0d61e3 3638(defun window-split-min-size (&optional horizontal)
562dd5e9
MR
3639 "Return minimum height of any window when splitting windows.
3640Optional argument HORIZONTAL non-nil means return minimum width."
3641 (if horizontal
3642 (max window-min-width window-safe-min-width)
3643 (max window-min-height window-safe-min-height)))
3644
3645(defun split-window (&optional window size side)
3646 "Make a new window adjacent to WINDOW.
85c2386b 3647WINDOW must be a valid window and defaults to the selected one.
562dd5e9
MR
3648Return the new window which is always a live window.
3649
3650Optional argument SIZE a positive number means make WINDOW SIZE
3651lines or columns tall. If SIZE is negative, make the new window
3652-SIZE lines or columns tall. If and only if SIZE is non-nil, its
3653absolute value can be less than `window-min-height' or
3654`window-min-width'; so this command can make a new window as
3655small as one line or two columns. SIZE defaults to half of
3656WINDOW's size. Interactively, SIZE is the prefix argument.
3657
3658Optional third argument SIDE nil (or `below') specifies that the
3659new window shall be located below WINDOW. SIDE `above' means the
3660new window shall be located above WINDOW. In both cases SIZE
382c953b 3661specifies the new number of lines for WINDOW (or the new window
562dd5e9
MR
3662if SIZE is negative) including space reserved for the mode and/or
3663header line.
3664
3665SIDE t (or `right') specifies that the new window shall be
3666located on the right side of WINDOW. SIDE `left' means the new
3667window shall be located on the left of WINDOW. In both cases
382c953b 3668SIZE specifies the new number of columns for WINDOW (or the new
562dd5e9
MR
3669window provided SIZE is negative) including space reserved for
3670fringes and the scrollbar or a divider column. Any other non-nil
3671value for SIDE is currently handled like t (or `right').
3672
3673If the variable `ignore-window-parameters' is non-nil or the
3674`split-window' parameter of WINDOW equals t, do not process any
3675parameters of WINDOW. Otherwise, if the `split-window' parameter
3676of WINDOW specifies a function, call that function with all three
3677arguments and return the value returned by that function.
3678
3679Otherwise, if WINDOW is part of an atomic window, \"split\" the
3680root of that atomic window. The new window does not become a
3681member of that atomic window.
3682
3683If WINDOW is live, properties of the new window like margins and
3684scrollbars are inherited from WINDOW. If WINDOW is an internal
3685window, these properties as well as the buffer displayed in the
3686new window are inherited from the window selected on WINDOW's
3687frame. The selected window is not changed by this function."
3688 (interactive "i")
447f16b8 3689 (setq window (window-normalize-window window))
130e3e11
MR
3690 (let* ((side (cond
3691 ((not side) 'below)
3692 ((memq side '(below above right left)) side)
3693 (t 'right)))
caceae25 3694 (horizontal (not (memq side '(below above))))
562dd5e9
MR
3695 (frame (window-frame window))
3696 (parent (window-parent window))
3697 (function (window-parameter window 'split-window))
3698 (window-side (window-parameter window 'window-side))
8e17c9ba
MR
3699 ;; Rebind the following two variables since in some cases we
3700 ;; have to override their value.
b6f67890 3701 (window-combination-limit window-combination-limit)
caceae25 3702 (window-combination-resize window-combination-resize)
562dd5e9
MR
3703 atom-root)
3704
54f9154c 3705 (window--check frame)
562dd5e9
MR
3706 (catch 'done
3707 (cond
3708 ;; Ignore window parameters if either `ignore-window-parameters'
3709 ;; is t or the `split-window' parameter equals t.
3710 ((or ignore-window-parameters (eq function t)))
3711 ((functionp function)
3712 ;; The `split-window' parameter specifies the function to call.
3713 ;; If that function is `ignore', do nothing.
3714 (throw 'done (funcall function window size side)))
be7f5545
MR
3715 ;; If WINDOW is part of an atomic window, split the root window
3716 ;; of that atomic window instead.
562dd5e9
MR
3717 ((and (window-parameter window 'window-atom)
3718 (setq atom-root (window-atom-root window))
3719 (not (eq atom-root window)))
caceae25
MR
3720 (throw 'done (split-window atom-root size side)))
3721 ;; If WINDOW is a side window or its first or last child is a
3722 ;; side window, throw an error unless `window-combination-resize'
3723 ;; equals 'side.
3724 ((and (not (eq window-combination-resize 'side))
3725 (or (window-parameter window 'window-side)
3726 (and (window-child window)
3727 (or (window-parameter
3728 (window-child window) 'window-side)
3729 (window-parameter
3730 (window-last-child window) 'window-side)))))
3731 (error "Cannot split side window or parent of side window"))
3732 ;; If `window-combination-resize' is 'side and window has a side
3733 ;; window sibling, bind `window-combination-limit' to t.
3734 ((and (not (eq window-combination-resize 'side))
3735 (or (and (window-prev-sibling window)
3736 (window-parameter
3737 (window-prev-sibling window) 'window-side))
3738 (and (window-next-sibling window)
3739 (window-parameter
3740 (window-next-sibling window) 'window-side))))
3741 (setq window-combination-limit t)))
3742
3743 ;; If `window-combination-resize' is t and SIZE is non-negative,
3744 ;; bind `window-combination-limit' to t.
3745 (when (and (eq window-combination-resize t) size (> size 0))
b6f67890 3746 (setq window-combination-limit t))
562dd5e9
MR
3747
3748 (let* ((parent-size
3749 ;; `parent-size' is the size of WINDOW's parent, provided
3750 ;; it has one.
3751 (when parent (window-total-size parent horizontal)))
3752 ;; `resize' non-nil means we are supposed to resize other
3753 ;; windows in WINDOW's combination.
3754 (resize
caceae25
MR
3755 (and window-combination-resize
3756 (or (window-parameter window 'window-side)
3757 (not (eq window-combination-resize 'side)))
8e17c9ba 3758 (not (eq window-combination-limit t))
562dd5e9 3759 ;; Resize makes sense in iso-combinations only.
3d8daefe 3760 (window-combined-p window horizontal)))
562dd5e9
MR
3761 ;; `old-size' is the current size of WINDOW.
3762 (old-size (window-total-size window horizontal))
3763 ;; `new-size' is the specified or calculated size of the
3764 ;; new window.
3765 (new-size
3766 (cond
3767 ((not size)
3768 (max (window-split-min-size horizontal)
3769 (if resize
3770 ;; When resizing try to give the new window the
3771 ;; average size of a window in its combination.
3772 (min (- parent-size
3773 (window-min-size parent horizontal))
3774 (/ parent-size
3d8daefe 3775 (1+ (window-combinations
562dd5e9
MR
3776 parent horizontal))))
3777 ;; Else try to give the new window half the size
3778 ;; of WINDOW (plus an eventual odd line).
3779 (+ (/ old-size 2) (% old-size 2)))))
3780 ((>= size 0)
3781 ;; SIZE non-negative specifies the new size of WINDOW.
3782
3783 ;; Note: Specifying a non-negative SIZE is practically
3784 ;; always done as workaround for making the new window
3785 ;; appear above or on the left of the new window (the
3786 ;; ispell window is a typical example of that). In all
3787 ;; these cases the SIDE argument should be set to 'above
3788 ;; or 'left in order to support the 'resize option.
3789 ;; Here we have to nest the windows instead, see above.
3790 (- old-size size))
3791 (t
3792 ;; SIZE negative specifies the size of the new window.
3793 (- size))))
3794 new-parent new-normal)
3795
3796 ;; Check SIZE.
3797 (cond
3798 ((not size)
3799 (cond
3800 (resize
3801 ;; SIZE unspecified, resizing.
3802 (when (and (not (window-sizable-p parent (- new-size) horizontal))
3803 ;; Try again with minimum split size.
3804 (setq new-size
3805 (max new-size (window-split-min-size horizontal)))
3806 (not (window-sizable-p parent (- new-size) horizontal)))
3807 (error "Window %s too small for splitting" parent)))
3808 ((> (+ new-size (window-min-size window horizontal)) old-size)
3809 ;; SIZE unspecified, no resizing.
3810 (error "Window %s too small for splitting" window))))
3811 ((and (>= size 0)
3812 (or (>= size old-size)
3813 (< new-size (if horizontal
3814 window-safe-min-width
3815 window-safe-min-width))))
3816 ;; SIZE specified as new size of old window. If the new size
3817 ;; is larger than the old size or the size of the new window
3818 ;; would be less than the safe minimum, signal an error.
3819 (error "Window %s too small for splitting" window))
3820 (resize
3821 ;; SIZE specified, resizing.
3822 (unless (window-sizable-p parent (- new-size) horizontal)
3823 ;; If we cannot resize the parent give up.
3824 (error "Window %s too small for splitting" parent)))
3825 ((or (< new-size
3826 (if horizontal window-safe-min-width window-safe-min-height))
3827 (< (- old-size new-size)
3828 (if horizontal window-safe-min-width window-safe-min-height)))
3829 ;; SIZE specification violates minimum size restrictions.
3830 (error "Window %s too small for splitting" window)))
3831
5386012d 3832 (window--resize-reset frame horizontal)
562dd5e9
MR
3833
3834 (setq new-parent
3835 ;; Make new-parent non-nil if we need a new parent window;
3836 ;; either because we want to nest or because WINDOW is not
3837 ;; iso-combined.
8e17c9ba 3838 (or (eq window-combination-limit t)
b6f67890 3839 (not (window-combined-p window horizontal))))
562dd5e9
MR
3840 (setq new-normal
3841 ;; Make new-normal the normal size of the new window.
3842 (cond
3843 (size (/ (float new-size) (if new-parent old-size parent-size)))
3844 (new-parent 0.5)
3d8daefe 3845 (resize (/ 1.0 (1+ (window-combinations parent horizontal))))
562dd5e9
MR
3846 (t (/ (window-normal-size window horizontal) 2.0))))
3847
3848 (if resize
3849 ;; Try to get space from OLD's siblings. We could go "up" and
3850 ;; try getting additional space from surrounding windows but
3851 ;; we won't be able to return space to those windows when we
3852 ;; delete the one we create here. Hence we do not go up.
3853 (progn
be7f5545 3854 (window--resize-child-windows parent (- new-size) horizontal)
562dd5e9
MR
3855 (let* ((normal (- 1.0 new-normal))
3856 (sub (window-child parent)))
3857 (while sub
3858 (set-window-new-normal
3859 sub (* (window-normal-size sub horizontal) normal))
3860 (setq sub (window-right sub)))))
3861 ;; Get entire space from WINDOW.
3862 (set-window-new-total window (- old-size new-size))
5386012d 3863 (window--resize-this-window window (- new-size) horizontal)
562dd5e9
MR
3864 (set-window-new-normal
3865 window (- (if new-parent 1.0 (window-normal-size window horizontal))
3866 new-normal)))
3867
3868 (let* ((new (split-window-internal window new-size side new-normal)))
caceae25
MR
3869 ;; Assign window-side parameters, if any.
3870 (when (eq window-combination-resize 'side)
3871 (let ((window-side
3872 (cond
3873 (window-side window-side)
3874 ((eq side 'above) 'top)
3875 ((eq side 'below) 'bottom)
3876 (t side))))
3877 ;; We made a new side window.
3878 (set-window-parameter new 'window-side window-side)
3879 (when (and new-parent (window-parameter window 'window-side))
3880 ;; We've been splitting a side root window. Give the
3881 ;; new parent the same window-side parameter.
3882 (set-window-parameter
3883 (window-parent new) 'window-side window-side))))
562dd5e9
MR
3884
3885 (run-window-configuration-change-hook frame)
54f9154c 3886 (window--check frame)
562dd5e9
MR
3887 ;; Always return the new window.
3888 new)))))
3889
3890;; I think this should be the default; I think people will prefer it--rms.
3891(defcustom split-window-keep-point t
2d197ffb
CY
3892 "If non-nil, \\[split-window-below] preserves point in the new window.
3893If nil, adjust point in the two windows to minimize redisplay.
3894This option applies only to `split-window-below' and functions
3895that call it. The low-level `split-window' function always keeps
3896the original point in both windows."
562dd5e9
MR
3897 :type 'boolean
3898 :group 'windows)
3899
2d197ffb
CY
3900(defun split-window-below (&optional size)
3901 "Split the selected window into two windows, one above the other.
3902The selected window is above. The newly split-off window is
3903below, and displays the same buffer. Return the new window.
3904
3905If optional argument SIZE is omitted or nil, both windows get the
3906same height, or close to it. If SIZE is positive, the upper
3907\(selected) window gets SIZE lines. If SIZE is negative, the
3908lower (new) window gets -SIZE lines.
3909
3910If the variable `split-window-keep-point' is non-nil, both
3911windows get the same value of point as the selected window.
3912Otherwise, the window starts are chosen so as to minimize the
3913amount of redisplay; this is convenient on slow terminals."
562dd5e9
MR
3914 (interactive "P")
3915 (let ((old-window (selected-window))
5481664a 3916 (old-point (window-point))
562dd5e9
MR
3917 (size (and size (prefix-numeric-value size)))
3918 moved-by-window-height moved new-window bottom)
3919 (when (and size (< size 0) (< (- size) window-min-height))
3920 ;; `split-window' would not signal an error here.
3921 (error "Size of new window too small"))
3922 (setq new-window (split-window nil size))
3923 (unless split-window-keep-point
3924 (with-current-buffer (window-buffer)
c491fa41
MR
3925 ;; Use `save-excursion' around vertical movements below
3926 ;; (Bug#10971). Note: When the selected window's buffer has a
3927 ;; header line, up to two lines of the buffer may not show up
3928 ;; in the resulting configuration.
3929 (save-excursion
3930 (goto-char (window-start))
3931 (setq moved (vertical-motion (window-height)))
3932 (set-window-start new-window (point))
3933 (when (> (point) (window-point new-window))
3934 (set-window-point new-window (point)))
3935 (when (= moved (window-height))
3936 (setq moved-by-window-height t)
3937 (vertical-motion -1))
3938 (setq bottom (point)))
3939 (and moved-by-window-height
3940 (<= bottom (point))
5481664a 3941 (set-window-point old-window (1- bottom)))
c491fa41
MR
3942 (and moved-by-window-height
3943 (<= (window-start new-window) old-point)
3944 (set-window-point new-window old-point)
3945 (select-window new-window))))
9397e56f
MR
3946 ;; Always copy quit-restore parameter in interactive use.
3947 (let ((quit-restore (window-parameter old-window 'quit-restore)))
3948 (when quit-restore
3949 (set-window-parameter new-window 'quit-restore quit-restore)))
3950 new-window))
562dd5e9 3951
2d197ffb 3952(defalias 'split-window-vertically 'split-window-below)
562dd5e9 3953
2d197ffb
CY
3954(defun split-window-right (&optional size)
3955 "Split the selected window into two side-by-side windows.
3956The selected window is on the left. The newly split-off window
3957is on the right, and displays the same buffer. Return the new
3958window.
562dd5e9 3959
2d197ffb
CY
3960If optional argument SIZE is omitted or nil, both windows get the
3961same width, or close to it. If SIZE is positive, the left-hand
3962\(selected) window gets SIZE columns. If SIZE is negative, the
3963right-hand (new) window gets -SIZE columns. Here, SIZE includes
3964the width of the window's scroll bar; if there are no scroll
3965bars, it includes the width of the divider column to the window's
3966right, if any."
562dd5e9
MR
3967 (interactive "P")
3968 (let ((old-window (selected-window))
3969 (size (and size (prefix-numeric-value size)))
3970 new-window)
3971 (when (and size (< size 0) (< (- size) window-min-width))
3972 ;; `split-window' would not signal an error here.
3973 (error "Size of new window too small"))
9397e56f
MR
3974 (setq new-window (split-window nil size t))
3975 ;; Always copy quit-restore parameter in interactive use.
3976 (let ((quit-restore (window-parameter old-window 'quit-restore)))
3977 (when quit-restore
3978 (set-window-parameter new-window 'quit-restore quit-restore)))
3979 new-window))
562dd5e9 3980
2d197ffb 3981(defalias 'split-window-horizontally 'split-window-right)
562dd5e9 3982\f
6198ccd0
MR
3983;;; Balancing windows.
3984
3985;; The following routine uses the recycled code from an old version of
be7f5545
MR
3986;; `window--resize-child-windows'. It's not very pretty, but coding it the way the
3987;; new `window--resize-child-windows' code does would hardly make it any shorter or
6198ccd0
MR
3988;; more readable (FWIW we'd need three loops - one to calculate the
3989;; minimum sizes per window, one to enlarge or shrink windows until the
3990;; new parent-size matches, and one where we shrink the largest/enlarge
3991;; the smallest window).
3992(defun balance-windows-2 (window horizontal)
3993 "Subroutine of `balance-windows-1'.
3d8daefe 3994WINDOW must be a vertical combination (horizontal if HORIZONTAL
85c2386b 3995is non-nil)."
6198ccd0
MR
3996 (let* ((first (window-child window))
3997 (sub first)
3998 (number-of-children 0)
3999 (parent-size (window-new-total window))
4000 (total-sum parent-size)
cb882333 4001 failed size sub-total sub-delta sub-amount rest)
6198ccd0
MR
4002 (while sub
4003 (setq number-of-children (1+ number-of-children))
4004 (when (window-size-fixed-p sub horizontal)
4005 (setq total-sum
4006 (- total-sum (window-total-size sub horizontal)))
4007 (set-window-new-normal sub 'ignore))
4008 (setq sub (window-right sub)))
3c448ab6 4009
6198ccd0
MR
4010 (setq failed t)
4011 (while (and failed (> number-of-children 0))
4012 (setq size (/ total-sum number-of-children))
4013 (setq failed nil)
4014 (setq sub first)
4015 (while (and sub (not failed))
be7f5545
MR
4016 ;; Ignore child windows that should be ignored or are stuck.
4017 (unless (window--resize-child-windows-skip-p sub)
6198ccd0
MR
4018 (setq sub-total (window-total-size sub horizontal))
4019 (setq sub-delta (- size sub-total))
4020 (setq sub-amount
4021 (window-sizable sub sub-delta horizontal))
be7f5545 4022 ;; Register the new total size for this child window.
6198ccd0
MR
4023 (set-window-new-total sub (+ sub-total sub-amount))
4024 (unless (= sub-amount sub-delta)
4025 (setq total-sum (- total-sum sub-total sub-amount))
4026 (setq number-of-children (1- number-of-children))
4027 ;; We failed and need a new round.
4028 (setq failed t)
4029 (set-window-new-normal sub 'skip)))
4030 (setq sub (window-right sub))))
3c448ab6 4031
6198ccd0
MR
4032 (setq rest (% total-sum number-of-children))
4033 ;; Fix rounding by trying to enlarge non-stuck windows by one line
4034 ;; (column) until `rest' is zero.
4035 (setq sub first)
4036 (while (and sub (> rest 0))
be7f5545 4037 (unless (window--resize-child-windows-skip-p window)
6198ccd0
MR
4038 (set-window-new-total sub 1 t)
4039 (setq rest (1- rest)))
4040 (setq sub (window-right sub)))
3c448ab6 4041
6198ccd0
MR
4042 ;; Fix rounding by trying to enlarge stuck windows by one line
4043 ;; (column) until `rest' equals zero.
4044 (setq sub first)
4045 (while (and sub (> rest 0))
4046 (unless (eq (window-new-normal sub) 'ignore)
4047 (set-window-new-total sub 1 t)
4048 (setq rest (1- rest)))
4049 (setq sub (window-right sub)))
4050
4051 (setq sub first)
4052 (while sub
4053 ;; Record new normal sizes.
4054 (set-window-new-normal
4055 sub (/ (if (eq (window-new-normal sub) 'ignore)
4056 (window-total-size sub horizontal)
4057 (window-new-total sub))
4058 (float parent-size)))
be7f5545 4059 ;; Recursively balance each window's child windows.
6198ccd0
MR
4060 (balance-windows-1 sub horizontal)
4061 (setq sub (window-right sub)))))
4062
4063(defun balance-windows-1 (window &optional horizontal)
4064 "Subroutine of `balance-windows'."
4065 (if (window-child window)
4066 (let ((sub (window-child window)))
3d8daefe 4067 (if (window-combined-p sub horizontal)
6198ccd0
MR
4068 (balance-windows-2 window horizontal)
4069 (let ((size (window-new-total window)))
4070 (while sub
9173deec 4071 (set-window-new-total sub size)
6198ccd0
MR
4072 (balance-windows-1 sub horizontal)
4073 (setq sub (window-right sub))))))))
4074
4075(defun balance-windows (&optional window-or-frame)
be7f5545 4076 "Balance the sizes of windows of WINDOW-OR-FRAME.
6198ccd0
MR
4077WINDOW-OR-FRAME is optional and defaults to the selected frame.
4078If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
4c36be58 4079windows of that frame. If WINDOW-OR-FRAME denotes a window,
be7f5545 4080recursively balance the sizes of all child windows of that
6198ccd0
MR
4081window."
4082 (interactive)
4083 (let* ((window
4084 (cond
4085 ((or (not window-or-frame)
4086 (frame-live-p window-or-frame))
4087 (frame-root-window window-or-frame))
4088 ((or (window-live-p window-or-frame)
4089 (window-child window-or-frame))
4090 window-or-frame)
4091 (t
4092 (error "Not a window or frame %s" window-or-frame))))
4093 (frame (window-frame window)))
4094 ;; Balance vertically.
5386012d 4095 (window--resize-reset (window-frame window))
6198ccd0 4096 (balance-windows-1 window)
d615d6d2 4097 (window-resize-apply frame)
6198ccd0 4098 ;; Balance horizontally.
5386012d 4099 (window--resize-reset (window-frame window) t)
6198ccd0 4100 (balance-windows-1 window t)
d615d6d2 4101 (window-resize-apply frame t)))
3c448ab6
MR
4102
4103(defun window-fixed-size-p (&optional window direction)
4104 "Return t if WINDOW cannot be resized in DIRECTION.
4105WINDOW defaults to the selected window. DIRECTION can be
4106nil (i.e. any), `height' or `width'."
4107 (with-current-buffer (window-buffer window)
4108 (when (and (boundp 'window-size-fixed) window-size-fixed)
4109 (not (and direction
4110 (member (cons direction window-size-fixed)
4111 '((height . width) (width . height))))))))
4112
4113;;; A different solution to balance-windows.
3c448ab6
MR
4114(defvar window-area-factor 1
4115 "Factor by which the window area should be over-estimated.
4116This is used by `balance-windows-area'.
4117Changing this globally has no effect.")
4118(make-variable-buffer-local 'window-area-factor)
4119
6198ccd0 4120(defun balance-windows-area-adjust (window delta horizontal)
d615d6d2 4121 "Wrapper around `window-resize' with error checking.
6198ccd0 4122Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
d615d6d2 4123 ;; `window-resize' may fail if delta is too large.
6198ccd0
MR
4124 (while (>= (abs delta) 1)
4125 (condition-case nil
4126 (progn
d615d6d2 4127 (window-resize window delta horizontal)
6198ccd0
MR
4128 (setq delta 0))
4129 (error
4130 ;;(message "adjust: %s" (error-message-string err))
4131 (setq delta (/ delta 2))))))
4132
3c448ab6
MR
4133(defun balance-windows-area ()
4134 "Make all visible windows the same area (approximately).
4135See also `window-area-factor' to change the relative size of
4136specific buffers."
4137 (interactive)
4138 (let* ((unchanged 0) (carry 0) (round 0)
4139 ;; Remove fixed-size windows.
4140 (wins (delq nil (mapcar (lambda (win)
4141 (if (not (window-fixed-size-p win)) win))
4142 (window-list nil 'nomini))))
4143 (changelog nil)
4144 next)
4145 ;; Resizing a window changes the size of surrounding windows in complex
4146 ;; ways, so it's difficult to balance them all. The introduction of
4147 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
4148 ;; very difficult to do. `balance-window' above takes an off-line
4149 ;; approach: get the whole window tree, then balance it, then try to
4150 ;; adjust the windows so they fit the result.
4151 ;; Here, instead, we take a "local optimization" approach, where we just
4152 ;; go through all the windows several times until nothing needs to be
4153 ;; changed. The main problem with this approach is that it's difficult
4154 ;; to make sure it terminates, so we use some heuristic to try and break
4155 ;; off infinite loops.
4156 ;; After a round without any change, we allow a second, to give a chance
4157 ;; to the carry to propagate a minor imbalance from the end back to
4158 ;; the beginning.
4159 (while (< unchanged 2)
4160 ;; (message "New round")
4161 (setq unchanged (1+ unchanged) round (1+ round))
4162 (dolist (win wins)
4163 (setq next win)
4164 (while (progn (setq next (next-window next))
4165 (window-fixed-size-p next)))
4166 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
4167 (let* ((horiz
4168 (< (car (window-edges win)) (car (window-edges next))))
4169 (areadiff (/ (- (* (window-height next) (window-width next)
4170 (buffer-local-value 'window-area-factor
4171 (window-buffer next)))
4172 (* (window-height win) (window-width win)
4173 (buffer-local-value 'window-area-factor
4174 (window-buffer win))))
4175 (max (buffer-local-value 'window-area-factor
4176 (window-buffer win))
4177 (buffer-local-value 'window-area-factor
4178 (window-buffer next)))))
4179 (edgesize (if horiz
4180 (+ (window-height win) (window-height next))
4181 (+ (window-width win) (window-width next))))
4182 (diff (/ areadiff edgesize)))
4183 (when (zerop diff)
4184 ;; Maybe diff is actually closer to 1 than to 0.
4185 (setq diff (/ (* 3 areadiff) (* 2 edgesize))))
4186 (when (and (zerop diff) (not (zerop areadiff)))
4187 (setq diff (/ (+ areadiff carry) edgesize))
4188 ;; Change things smoothly.
4189 (if (or (> diff 1) (< diff -1)) (setq diff (/ diff 2))))
4190 (if (zerop diff)
4191 ;; Make sure negligible differences don't accumulate to
4192 ;; become significant.
4193 (setq carry (+ carry areadiff))
6198ccd0 4194 ;; This used `adjust-window-trailing-edge' before and uses
d615d6d2 4195 ;; `window-resize' now. Error wrapping is still needed.
6198ccd0 4196 (balance-windows-area-adjust win diff horiz)
3c448ab6
MR
4197 ;; (sit-for 0.5)
4198 (let ((change (cons win (window-edges win))))
4199 ;; If the same change has been seen already for this window,
4200 ;; we're most likely in an endless loop, so don't count it as
4201 ;; a change.
4202 (unless (member change changelog)
4203 (push change changelog)
4204 (setq unchanged 0 carry 0)))))))
4205 ;; We've now basically balanced all the windows.
4206 ;; But there may be some minor off-by-one imbalance left over,
4207 ;; so let's do some fine tuning.
4208 ;; (bw-finetune wins)
4209 ;; (message "Done in %d rounds" round)
4210 ))
9d89fec7
MR
4211
4212;;; Window states, how to get them and how to put them in a window.
34a02f46 4213(defun window--state-get-1 (window &optional writable)
9d89fec7
MR
4214 "Helper function for `window-state-get'."
4215 (let* ((type
4216 (cond
d68443dc
MR
4217 ((window-top-child window) 'vc)
4218 ((window-left-child window) 'hc)
9d89fec7
MR
4219 (t 'leaf)))
4220 (buffer (window-buffer window))
4221 (selected (eq window (selected-window)))
4222 (head
4b0d61e3
SM
4223 `(,type
4224 ,@(unless (window-next-sibling window) `((last . t)))
4225 (total-height . ,(window-total-size window))
4226 (total-width . ,(window-total-size window t))
4227 (normal-height . ,(window-normal-size window))
4228 (normal-width . ,(window-normal-size window t))
b6f67890 4229 (combination-limit . ,(window-combination-limit window))
34a02f46
MR
4230 ,@(let ((parameters (window-parameters window))
4231 list)
4232 ;; Make copies of those window parameters whose
4233 ;; persistence property is `writable' if WRITABLE is
4234 ;; non-nil and non-nil if WRITABLE is nil.
4235 (dolist (par parameters)
4236 (let ((pers (cdr (assq (car par)
4237 window-persistent-parameters))))
4238 (when (and pers (or (not writable) (eq pers 'writable)))
4239 (setq list (cons (cons (car par) (cdr par)) list)))))
4240 ;; Add `clone-of' parameter if necessary.
4241 (let ((pers (cdr (assq 'clone-of
4242 window-persistent-parameters))))
4243 (when (and pers (or (not writable) (eq pers 'writable))
4244 (not (assq 'clone-of list)))
4245 (setq list (cons (cons 'clone-of window) list))))
4b0d61e3
SM
4246 (when list
4247 `((parameters . ,list))))
4248 ,@(when buffer
1edf595d 4249 ;; All buffer related things go in here.
5481664a 4250 (let ((point (window-point window))
1edf595d
MR
4251 (start (window-start window)))
4252 `((buffer
4253 ,(buffer-name buffer)
4254 (selected . ,selected)
4255 (hscroll . ,(window-hscroll window))
4256 (fringes . ,(window-fringes window))
4257 (margins . ,(window-margins window))
4258 (scroll-bars . ,(window-scroll-bars window))
4259 (vscroll . ,(window-vscroll window))
4260 (dedicated . ,(window-dedicated-p window))
de8c03dc
SM
4261 (point . ,(if writable point
4262 (copy-marker point
4263 (buffer-local-value
4264 'window-point-insertion-type
4265 buffer))))
1edf595d 4266 (start . ,(if writable start (copy-marker start)))))))))
9d89fec7
MR
4267 (tail
4268 (when (memq type '(vc hc))
4269 (let (list)
4270 (setq window (window-child window))
4271 (while window
34a02f46 4272 (setq list (cons (window--state-get-1 window writable) list))
9d89fec7
MR
4273 (setq window (window-right window)))
4274 (nreverse list)))))
4275 (append head tail)))
4276
34a02f46 4277(defun window-state-get (&optional window writable)
9d89fec7
MR
4278 "Return state of WINDOW as a Lisp object.
4279WINDOW can be any window and defaults to the root window of the
4280selected frame.
4281
34a02f46
MR
4282Optional argument WRITABLE non-nil means do not use markers for
4283sampling `window-point' and `window-start'. Together, WRITABLE
4284and the variable `window-persistent-parameters' specify which
4285window parameters are saved by this function. WRITABLE should be
4286non-nil when the return value shall be written to a file and read
4287back in another session. Otherwise, an application may run into
4288an `invalid-read-syntax' error while attempting to read back the
4289value from file.
9d89fec7
MR
4290
4291The return value can be used as argument for `window-state-put'
4292to put the state recorded here into an arbitrary window. The
4293value can be also stored on disk and read back in a new session."
4294 (setq window
4295 (if window
24300f5f 4296 (if (window-valid-p window)
9d89fec7
MR
4297 window
4298 (error "%s is not a live or internal window" window))
4299 (frame-root-window)))
4300 ;; The return value is a cons whose car specifies some constraints on
be7f5545
MR
4301 ;; the size of WINDOW. The cdr lists the states of the child windows
4302 ;; of WINDOW.
9d89fec7
MR
4303 (cons
4304 ;; Frame related things would go into a function, say `frame-state',
4305 ;; calling `window-state-get' to insert the frame's root window.
4b0d61e3
SM
4306 `((min-height . ,(window-min-size window))
4307 (min-width . ,(window-min-size window t))
4308 (min-height-ignore . ,(window-min-size window nil t))
4309 (min-width-ignore . ,(window-min-size window t t))
4310 (min-height-safe . ,(window-min-size window nil 'safe))
1edf595d 4311 (min-width-safe . ,(window-min-size window t 'safe)))
34a02f46 4312 (window--state-get-1 window writable)))
9d89fec7
MR
4313
4314(defvar window-state-put-list nil
4315 "Helper variable for `window-state-put'.")
4316
c56cad4a 4317(defun window--state-put-1 (state &optional window ignore totals)
9d89fec7
MR
4318 "Helper function for `window-state-put'."
4319 (let ((type (car state)))
4320 (setq state (cdr state))
4321 (cond
4322 ((eq type 'leaf)
4323 ;; For a leaf window just add unprocessed entries to
4324 ;; `window-state-put-list'.
c7635a97 4325 (push (cons window state) window-state-put-list))
9d89fec7
MR
4326 ((memq type '(vc hc))
4327 (let* ((horizontal (eq type 'hc))
4328 (total (window-total-size window horizontal))
4329 (first t)
4330 size new)
4331 (dolist (item state)
4332 ;; Find the next child window. WINDOW always points to the
4333 ;; real window that we want to fill with what we find here.
4334 (when (memq (car item) '(leaf vc hc))
4335 (if (assq 'last item)
c56cad4a 4336 ;; The last child window. Below `window--state-put-1'
9d89fec7
MR
4337 ;; will put into it whatever ITEM has in store.
4338 (setq new nil)
4339 ;; Not the last child window, prepare for splitting
4340 ;; WINDOW. SIZE is the new (and final) size of the old
4341 ;; window.
4342 (setq size
4343 (if totals
4344 ;; Use total size.
4345 (cdr (assq (if horizontal 'total-width 'total-height) item))
4346 ;; Use normalized size and round.
4347 (round (* total
4348 (cdr (assq
4349 (if horizontal 'normal-width 'normal-height)
4350 item))))))
4351
4352 ;; Use safe sizes, we try to resize later.
4353 (setq size (max size (if horizontal
4354 window-safe-min-height
4355 window-safe-min-width)))
4356
4357 (if (window-sizable-p window (- size) horizontal 'safe)
b6f67890
MR
4358 (let* ((window-combination-limit
4359 (assq 'combination-limit item)))
301b181a 4360 ;; We must inherit the combination limit, otherwise
b6f67890
MR
4361 ;; we might mess up handling of atomic and side
4362 ;; window.
9d89fec7
MR
4363 (setq new (split-window window size horizontal)))
4364 ;; Give up if we can't resize window down to safe sizes.
4365 (error "Cannot resize window %s" window))
4366
4367 (when first
4368 (setq first nil)
4369 ;; When creating the first child window add for parent
4370 ;; unprocessed entries to `window-state-put-list'.
4371 (setq window-state-put-list
4372 (cons (cons (window-parent window) state)
4373 window-state-put-list))))
4374
4375 ;; Now process the current window (either the one we've just
4376 ;; split or the last child of its parent).
c56cad4a 4377 (window--state-put-1 item window ignore totals)
9d89fec7
MR
4378 ;; Continue with the last window split off.
4379 (setq window new))))))))
4380
c56cad4a 4381(defun window--state-put-2 (ignore)
9d89fec7
MR
4382 "Helper function for `window-state-put'."
4383 (dolist (item window-state-put-list)
4384 (let ((window (car item))
b6f67890 4385 (combination-limit (cdr (assq 'combination-limit item)))
9d89fec7
MR
4386 (parameters (cdr (assq 'parameters item)))
4387 (state (cdr (assq 'buffer item))))
b6f67890
MR
4388 (when combination-limit
4389 (set-window-combination-limit window combination-limit))
34a02f46
MR
4390 ;; Reset window's parameters and assign saved ones (we might want
4391 ;; a `remove-window-parameters' function here).
4392 (dolist (parameter (window-parameters window))
4393 (set-window-parameter window (car parameter) nil))
9d89fec7
MR
4394 (when parameters
4395 (dolist (parameter parameters)
34a02f46 4396 (set-window-parameter window (car parameter) (cdr parameter))))
9d89fec7
MR
4397 ;; Process buffer related state.
4398 (when state
4399 ;; We don't want to raise an error here so we create a buffer if
4400 ;; there's none.
4401 (set-window-buffer window (get-buffer-create (car state)))
4402 (with-current-buffer (window-buffer window)
4403 (set-window-hscroll window (cdr (assq 'hscroll state)))
4404 (apply 'set-window-fringes
4405 (cons window (cdr (assq 'fringes state))))
4406 (let ((margins (cdr (assq 'margins state))))
4407 (set-window-margins window (car margins) (cdr margins)))
4408 (let ((scroll-bars (cdr (assq 'scroll-bars state))))
4409 (set-window-scroll-bars
4410 window (car scroll-bars) (nth 2 scroll-bars) (nth 3 scroll-bars)))
4411 (set-window-vscroll window (cdr (assq 'vscroll state)))
4412 ;; Adjust vertically.
4413 (if (memq window-size-fixed '(t height))
4414 ;; A fixed height window, try to restore the original size.
4415 (let ((delta (- (cdr (assq 'total-height item))
4416 (window-total-height window)))
4417 window-size-fixed)
2cffd681 4418 (when (window--resizable-p window delta)
d615d6d2 4419 (window-resize window delta)))
9d89fec7
MR
4420 ;; Else check whether the window is not high enough.
4421 (let* ((min-size (window-min-size window nil ignore))
4422 (delta (- min-size (window-total-size window))))
4423 (when (and (> delta 0)
2cffd681 4424 (window--resizable-p window delta nil ignore))
d615d6d2 4425 (window-resize window delta nil ignore))))
9d89fec7
MR
4426 ;; Adjust horizontally.
4427 (if (memq window-size-fixed '(t width))
4428 ;; A fixed width window, try to restore the original size.
4429 (let ((delta (- (cdr (assq 'total-width item))
4430 (window-total-width window)))
4431 window-size-fixed)
2cffd681 4432 (when (window--resizable-p window delta)
d615d6d2 4433 (window-resize window delta)))
9d89fec7
MR
4434 ;; Else check whether the window is not wide enough.
4435 (let* ((min-size (window-min-size window t ignore))
4436 (delta (- min-size (window-total-size window t))))
4437 (when (and (> delta 0)
2cffd681 4438 (window--resizable-p window delta t ignore))
d615d6d2 4439 (window-resize window delta t ignore))))
9d89fec7
MR
4440 ;; Set dedicated status.
4441 (set-window-dedicated-p window (cdr (assq 'dedicated state)))
4442 ;; Install positions (maybe we should do this after all windows
4443 ;; have been created and sized).
4444 (ignore-errors
4445 (set-window-start window (cdr (assq 'start state)))
fa8eafef 4446 (set-window-point window (cdr (assq 'point state))))
9d89fec7
MR
4447 ;; Select window if it's the selected one.
4448 (when (cdr (assq 'selected state))
4449 (select-window window)))))))
4450
4451(defun window-state-put (state &optional window ignore)
4452 "Put window state STATE into WINDOW.
4453STATE should be the state of a window returned by an earlier
4454invocation of `window-state-get'. Optional argument WINDOW must
4455specify a live window and defaults to the selected one.
4456
4457Optional argument IGNORE non-nil means ignore minimum window
4458sizes and fixed size restrictions. IGNORE equal `safe' means
be7f5545 4459windows can get as small as `window-safe-min-height' and
9d89fec7 4460`window-safe-min-width'."
447f16b8 4461 (setq window (window-normalize-window window t))
9d89fec7
MR
4462 (let* ((frame (window-frame window))
4463 (head (car state))
4464 ;; We check here (1) whether the total sizes of root window of
4465 ;; STATE and that of WINDOW are equal so we can avoid
4466 ;; calculating new sizes, and (2) if we do have to resize
4467 ;; whether we can do so without violating size restrictions.
4468 (totals
4469 (and (= (window-total-size window)
4470 (cdr (assq 'total-height state)))
4471 (= (window-total-size window t)
4472 (cdr (assq 'total-width state)))))
4473 (min-height (cdr (assq 'min-height head)))
cb882333 4474 (min-width (cdr (assq 'min-width head))))
9d89fec7
MR
4475 (if (and (not totals)
4476 (or (> min-height (window-total-size window))
4477 (> min-width (window-total-size window t)))
4478 (or (not ignore)
4479 (and (setq min-height
4480 (cdr (assq 'min-height-ignore head)))
4481 (setq min-width
4482 (cdr (assq 'min-width-ignore head)))
4483 (or (> min-height (window-total-size window))
4484 (> min-width (window-total-size window t)))
4485 (or (not (eq ignore 'safe))
4486 (and (setq min-height
4487 (cdr (assq 'min-height-safe head)))
4488 (setq min-width
4489 (cdr (assq 'min-width-safe head)))
4490 (or (> min-height
4491 (window-total-size window))
4492 (> min-width
4493 (window-total-size window t))))))))
4494 ;; The check above might not catch all errors due to rounding
4495 ;; issues - so IGNORE equal 'safe might not always produce the
4496 ;; minimum possible state. But such configurations hardly make
4497 ;; sense anyway.
a91adc7e 4498 (error "Window %s too small to accommodate state" window)
9d89fec7
MR
4499 (setq state (cdr state))
4500 (setq window-state-put-list nil)
4501 ;; Work on the windows of a temporary buffer to make sure that
4502 ;; splitting proceeds regardless of any buffer local values of
4503 ;; `window-size-fixed'. Release that buffer after the buffers of
c56cad4a 4504 ;; all live windows have been set by `window--state-put-2'.
9d89fec7
MR
4505 (with-temp-buffer
4506 (set-window-buffer window (current-buffer))
c56cad4a
MR
4507 (window--state-put-1 state window nil totals)
4508 (window--state-put-2 ignore))
54f9154c 4509 (window--check frame))))
9481c002 4510\f
f818cd2a
MR
4511(defun display-buffer-record-window (type window buffer)
4512 "Record information for window used by `display-buffer'.
cf4eacfd 4513TYPE specifies the type of the calling operation and must be one
382c953b
JB
4514of the symbols 'reuse (when WINDOW existed already and was
4515reused for displaying BUFFER), 'window (when WINDOW was created
4516on an already existing frame), or 'frame (when WINDOW was
4517created on a new frame). WINDOW is the window used for or created
cf4eacfd
MR
4518by the `display-buffer' routines. BUFFER is the buffer that
4519shall be displayed.
4520
4521This function installs or updates the quit-restore parameter of
4522WINDOW. The quit-restore parameter is a list of four elements:
4523The first element is one of the symbols 'window, 'frame, 'same or
4524'other. The second element is either one of the symbols 'window
4525or 'frame or a list whose elements are the buffer previously
4526shown in the window, that buffer's window start and window point,
4527and the window's height. The third element is the window
4528selected at the time the parameter was created. The fourth
4529element is BUFFER."
f818cd2a 4530 (cond
cf4eacfd
MR
4531 ((eq type 'reuse)
4532 (if (eq (window-buffer window) buffer)
4533 ;; WINDOW shows BUFFER already.
4534 (when (consp (window-parameter window 'quit-restore))
4535 ;; If WINDOW has a quit-restore parameter, reset its car.
4536 (setcar (window-parameter window 'quit-restore) 'same))
4537 ;; WINDOW shows another buffer.
9481c002 4538 (set-window-parameter
f818cd2a 4539 window 'quit-restore
cf4eacfd
MR
4540 (list 'other
4541 ;; A quadruple of WINDOW's buffer, start, point and height.
4542 (list (window-buffer window) (window-start window)
5481664a 4543 (window-point window) (window-total-size window))
cf4eacfd
MR
4544 (selected-window) buffer))))
4545 ((eq type 'window)
4546 ;; WINDOW has been created on an existing frame.
f818cd2a 4547 (set-window-parameter
cf4eacfd
MR
4548 window 'quit-restore
4549 (list 'window 'window (selected-window) buffer)))
4550 ((eq type 'frame)
4551 ;; WINDOW has been created on a new frame.
f818cd2a 4552 (set-window-parameter
cf4eacfd
MR
4553 window 'quit-restore
4554 (list 'frame 'frame (selected-window) buffer)))))
9481c002 4555
f818cd2a
MR
4556(defcustom display-buffer-function nil
4557 "If non-nil, function to call to handle `display-buffer'.
4558It will receive two args, the buffer and a flag which if non-nil
4559means that the currently selected window is not acceptable. It
4560should choose or create a window, display the specified buffer in
4561it, and return the window.
4562
e1c2c6f2
MR
4563The specified function should call `display-buffer-record-window'
4564with corresponding arguments to set up the quit-restore parameter
4565of the window used."
f818cd2a
MR
4566 :type '(choice
4567 (const nil)
4568 (function :tag "function"))
3c448ab6 4569 :group 'windows)
9481c002 4570
71ce58e7
CY
4571(make-obsolete-variable 'display-buffer-function
4572 'display-buffer-alist "24.3")
4573
d97af5a0
CY
4574;; Eventually, we want to turn this into a defvar; instead of
4575;; customizing this, the user should use a `pop-up-frame-parameters'
4576;; alist entry in `display-buffer-base-action'.
f818cd2a
MR
4577(defcustom pop-up-frame-alist nil
4578 "Alist of parameters for automatically generated new frames.
f818cd2a
MR
4579If non-nil, the value you specify here is used by the default
4580`pop-up-frame-function' for the creation of new frames.
9481c002 4581
f818cd2a
MR
4582Since `pop-up-frame-function' is used by `display-buffer' for
4583making new frames, any value specified here by default affects
4584the automatic generation of new frames via `display-buffer' and
4585all functions based on it. The behavior of `make-frame' is not
4586affected by this variable."
9481c002 4587 :type '(repeat (cons :format "%v"
f818cd2a
MR
4588 (symbol :tag "Parameter")
4589 (sexp :tag "Value")))
9481c002 4590 :group 'frames)
9481c002 4591
f818cd2a
MR
4592(defcustom pop-up-frame-function
4593 (lambda () (make-frame pop-up-frame-alist))
4594 "Function used by `display-buffer' for creating a new frame.
4595This function is called with no arguments and should return a new
4596frame. The default value calls `make-frame' with the argument
4597`pop-up-frame-alist'."
9481c002 4598 :type 'function
9481c002 4599 :group 'frames)
3c448ab6 4600
56f31926
MR
4601(defcustom special-display-buffer-names nil
4602 "List of names of buffers that should be displayed specially.
4603Displaying a buffer with `display-buffer' or `pop-to-buffer', if
4604its name is in this list, displays the buffer in a way specified
4605by `special-display-function'. `special-display-popup-frame'
4606\(the default for `special-display-function') usually displays
4607the buffer in a separate frame made with the parameters specified
4608by `special-display-frame-alist'. If `special-display-function'
4609has been set to some other function, that function is called with
4610the buffer as first, and nil as second argument.
4611
4612Alternatively, an element of this list can be specified as
4613\(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
382c953b 4614name and FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
56f31926
MR
4615`special-display-popup-frame' will interpret such pairs as frame
4616parameters when it creates a special frame, overriding the
4617corresponding values from `special-display-frame-alist'.
4618
4619As a special case, if FRAME-PARAMETERS contains (same-window . t)
4620`special-display-popup-frame' displays that buffer in the
4621selected window. If FRAME-PARAMETERS contains (same-frame . t),
4622it displays that buffer in a window on the selected frame.
4623
4624If `special-display-function' specifies some other function than
4625`special-display-popup-frame', that function is called with the
4626buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
4627argument.
4628
4629Finally, an element of this list can be also specified as
4630\(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
4631`special-display-popup-frame' will call FUNCTION with the buffer
4632named BUFFER-NAME as first argument, and OTHER-ARGS as the
0563dae9
MR
4633second.
4634
4635Any alternative function specified here is responsible for
4636setting up the quit-restore parameter of the window used.
56f31926
MR
4637
4638If this variable appears \"not to work\", because you added a
4639name to it but the corresponding buffer is displayed in the
4640selected window, look at the values of `same-window-buffer-names'
4641and `same-window-regexps'. Those variables take precedence over
4642this one.
4643
4644See also `special-display-regexps'."
4645 :type '(repeat
4646 (choice :tag "Buffer"
4647 :value ""
4648 (string :format "%v")
4649 (cons :tag "With parameters"
4650 :format "%v"
4651 :value ("" . nil)
4652 (string :format "%v")
4653 (repeat :tag "Parameters"
4654 (cons :format "%v"
4655 (symbol :tag "Parameter")
4656 (sexp :tag "Value"))))
4657 (list :tag "With function"
4658 :format "%v"
4659 :value ("" . nil)
4660 (string :format "%v")
4661 (function :tag "Function")
4662 (repeat :tag "Arguments" (sexp)))))
4663 :group 'windows
4664 :group 'frames)
77f1f99c 4665(make-obsolete-variable 'special-display-buffer-names 'display-buffer-alist "24.3")
ac549fa5
GM
4666(put 'special-display-buffer-names 'risky-local-variable t)
4667
56f31926
MR
4668(defcustom special-display-regexps nil
4669 "List of regexps saying which buffers should be displayed specially.
4670Displaying a buffer with `display-buffer' or `pop-to-buffer', if
4671any regexp in this list matches its name, displays it specially
4672using `special-display-function'. `special-display-popup-frame'
4673\(the default for `special-display-function') usually displays
4674the buffer in a separate frame made with the parameters specified
4675by `special-display-frame-alist'. If `special-display-function'
4676has been set to some other function, that function is called with
4677the buffer as first, and nil as second argument.
4678
4679Alternatively, an element of this list can be specified as
4680\(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
4681FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
4682`special-display-popup-frame' will then interpret these pairs as
4683frame parameters when creating a special frame for a buffer whose
4684name matches REGEXP, overriding the corresponding values from
4685`special-display-frame-alist'.
4686
4687As a special case, if FRAME-PARAMETERS contains (same-window . t)
4688`special-display-popup-frame' displays buffers matching REGEXP in
382c953b 4689the selected window. (same-frame . t) in FRAME-PARAMETERS means
56f31926
MR
4690to display such buffers in a window on the selected frame.
4691
4692If `special-display-function' specifies some other function than
4693`special-display-popup-frame', that function is called with the
4694buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
4695as second argument.
4696
4697Finally, an element of this list can be also specified as
4698\(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
4699will then call FUNCTION with the buffer whose name matched
0563dae9
MR
4700REGEXP as first, and OTHER-ARGS as second argument.
4701
4702Any alternative function specified here is responsible for
4703setting up the quit-restore parameter of the window used.
56f31926
MR
4704
4705If this variable appears \"not to work\", because you added a
4706name to it but the corresponding buffer is displayed in the
4707selected window, look at the values of `same-window-buffer-names'
4708and `same-window-regexps'. Those variables take precedence over
4709this one.
4710
4711See also `special-display-buffer-names'."
4712 :type '(repeat
4713 (choice :tag "Buffer"
4714 :value ""
4715 (regexp :format "%v")
4716 (cons :tag "With parameters"
4717 :format "%v"
4718 :value ("" . nil)
4719 (regexp :format "%v")
4720 (repeat :tag "Parameters"
4721 (cons :format "%v"
4722 (symbol :tag "Parameter")
4723 (sexp :tag "Value"))))
4724 (list :tag "With function"
4725 :format "%v"
4726 :value ("" . nil)
4727 (regexp :format "%v")
4728 (function :tag "Function")
4729 (repeat :tag "Arguments" (sexp)))))
4730 :group 'windows
4731 :group 'frames)
77f1f99c
CY
4732(make-obsolete-variable 'special-display-regexps 'display-buffer-alist "24.3")
4733(put 'special-display-regexps 'risky-local-variable t)
56f31926 4734
3c448ab6
MR
4735(defun special-display-p (buffer-name)
4736 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
56f31926
MR
4737More precisely, return t if `special-display-buffer-names' or
4738`special-display-regexps' contain a string entry equaling or
4739matching BUFFER-NAME. If `special-display-buffer-names' or
4740`special-display-regexps' contain a list entry whose car equals
4741or matches BUFFER-NAME, the return value is the cdr of that
4742entry."
f818cd2a 4743 (let (tmp)
98722073 4744 (cond
f818cd2a 4745 ((member buffer-name special-display-buffer-names)
98722073 4746 t)
f818cd2a 4747 ((setq tmp (assoc buffer-name special-display-buffer-names))
98722073
MR
4748 (cdr tmp))
4749 ((catch 'found
f818cd2a 4750 (dolist (regexp special-display-regexps)
98722073
MR
4751 (cond
4752 ((stringp regexp)
4753 (when (string-match-p regexp buffer-name)
4754 (throw 'found t)))
4755 ((and (consp regexp) (stringp (car regexp))
4756 (string-match-p (car regexp) buffer-name))
4757 (throw 'found (cdr regexp))))))))))
9481c002 4758
f818cd2a
MR
4759(defcustom special-display-frame-alist
4760 '((height . 14) (width . 80) (unsplittable . t))
4761 "Alist of parameters for special frames.
4762Special frames are used for buffers whose names are listed in
4763`special-display-buffer-names' and for buffers whose names match
4764one of the regular expressions in `special-display-regexps'.
9481c002 4765
f818cd2a 4766This variable can be set in your init file, like this:
9481c002 4767
f818cd2a
MR
4768 (setq special-display-frame-alist '((width . 80) (height . 20)))
4769
4770These supersede the values given in `default-frame-alist'."
4771 :type '(repeat (cons :format "%v"
4772 (symbol :tag "Parameter")
4773 (sexp :tag "Value")))
4774 :group 'frames)
77f1f99c 4775(make-obsolete-variable 'special-display-frame-alist 'display-buffer-alist "24.3")
f818cd2a
MR
4776
4777(defun special-display-popup-frame (buffer &optional args)
31cd32c9 4778 "Pop up a frame displaying BUFFER and return its window.
f818cd2a
MR
4779If BUFFER is already displayed in a visible or iconified frame,
4780raise that frame. Otherwise, display BUFFER in a new frame.
4781
4782Optional argument ARGS is a list specifying additional
4783information.
4784
4785If ARGS is an alist, use it as a list of frame parameters. If
382c953b
JB
4786these parameters contain (same-window . t), display BUFFER in
4787the selected window. If they contain (same-frame . t), display
f818cd2a
MR
4788BUFFER in a window of the selected frame.
4789
4790If ARGS is a list whose car is a symbol, use (car ARGS) as a
fdc2806d
CY
4791function to do the work. Pass it BUFFER as first argument, and
4792pass the elements of (cdr ARGS) as the remaining arguments."
f818cd2a
MR
4793 (if (and args (symbolp (car args)))
4794 (apply (car args) buffer (cdr args))
4795 (let ((window (get-buffer-window buffer 0)))
4796 (or
4797 ;; If we have a window already, make it visible.
4798 (when window
4799 (let ((frame (window-frame window)))
4800 (make-frame-visible frame)
4801 (raise-frame frame)
cf4eacfd 4802 (display-buffer-record-window 'reuse window buffer)
f818cd2a
MR
4803 window))
4804 ;; Reuse the current window if the user requested it.
4805 (when (cdr (assq 'same-window args))
4806 (condition-case nil
4807 (progn (switch-to-buffer buffer nil t) (selected-window))
4808 (error nil)))
4809 ;; Stay on the same frame if requested.
4810 (when (or (cdr (assq 'same-frame args)) (cdr (assq 'same-window args)))
4811 (let* ((pop-up-windows t)
4812 pop-up-frames
4813 special-display-buffer-names special-display-regexps)
4814 (display-buffer buffer)))
4815 ;; If no window yet, make one in a new frame.
e75852fd
MR
4816 (let* ((frame
4817 (with-current-buffer buffer
4818 (make-frame (append args special-display-frame-alist))))
4819 (window (frame-selected-window frame)))
4820 (display-buffer-record-window 'frame window buffer)
c5e28e39
MR
4821 (unless (eq buffer (window-buffer window))
4822 (set-window-buffer window buffer)
4823 (set-window-prev-buffers window nil))
e75852fd
MR
4824 (set-window-dedicated-p window t)
4825 window)))))
f818cd2a
MR
4826
4827(defcustom special-display-function 'special-display-popup-frame
4828 "Function to call for displaying special buffers.
4829This function is called with two arguments - the buffer and,
4830optionally, a list - and should return a window displaying that
4831buffer. The default value usually makes a separate frame for the
4832buffer using `special-display-frame-alist' to specify the frame
4833parameters. See the definition of `special-display-popup-frame'
4834for how to specify such a function.
4835
4836A buffer is special when its name is either listed in
4837`special-display-buffer-names' or matches a regexp in
4838`special-display-regexps'.
4839
e1c2c6f2
MR
4840The specified function should call `display-buffer-record-window'
4841with corresponding arguments to set up the quit-restore parameter
4842of the window used."
f818cd2a
MR
4843 :type 'function
4844 :group 'frames)
77f1f99c 4845(make-obsolete-variable 'special-display-function 'display-buffer-alist "24.3")
f818cd2a
MR
4846
4847(defcustom same-window-buffer-names nil
4848 "List of names of buffers that should appear in the \"same\" window.
4849`display-buffer' and `pop-to-buffer' show a buffer whose name is
4850on this list in the selected rather than some other window.
4851
4852An element of this list can be a cons cell instead of just a
4853string. In that case, the cell's car must be a string specifying
4854the buffer name. This is for compatibility with
4855`special-display-buffer-names'; the cdr of the cons cell is
4856ignored.
4857
4858See also `same-window-regexps'."
4859 :type '(repeat (string :format "%v"))
4860 :group 'windows)
4861
4862(defcustom same-window-regexps nil
4863 "List of regexps saying which buffers should appear in the \"same\" window.
4864`display-buffer' and `pop-to-buffer' show a buffer whose name
4865matches a regexp on this list in the selected rather than some
4866other window.
4867
4868An element of this list can be a cons cell instead of just a
4869string. In that case, the cell's car must be a regexp matching
4870the buffer name. This is for compatibility with
4871`special-display-regexps'; the cdr of the cons cell is ignored.
9481c002 4872
f818cd2a
MR
4873See also `same-window-buffer-names'."
4874 :type '(repeat (regexp :format "%v"))
4875 :group 'windows)
9481c002 4876
f818cd2a
MR
4877(defun same-window-p (buffer-name)
4878 "Return non-nil if a buffer named BUFFER-NAME would be shown in the \"same\" window.
4879This function returns non-nil if `display-buffer' or
4880`pop-to-buffer' would show a buffer named BUFFER-NAME in the
382c953b 4881selected rather than (as usual) some other window. See
f818cd2a
MR
4882`same-window-buffer-names' and `same-window-regexps'."
4883 (cond
4884 ((not (stringp buffer-name)))
4885 ;; The elements of `same-window-buffer-names' can be buffer
4886 ;; names or cons cells whose cars are buffer names.
4887 ((member buffer-name same-window-buffer-names))
4888 ((assoc buffer-name same-window-buffer-names))
4889 ((catch 'found
4890 (dolist (regexp same-window-regexps)
4891 ;; The elements of `same-window-regexps' can be regexps
4892 ;; or cons cells whose cars are regexps.
4893 (when (or (and (stringp regexp)
cb882333 4894 (string-match-p regexp buffer-name))
f818cd2a
MR
4895 (and (consp regexp) (stringp (car regexp))
4896 (string-match-p (car regexp) buffer-name)))
4897 (throw 'found t)))))))
3c448ab6 4898
d1067961 4899(defcustom pop-up-frames nil
3c448ab6 4900 "Whether `display-buffer' should make a separate frame.
d1f18ec0 4901If nil, never make a separate frame.
3c448ab6
MR
4902If the value is `graphic-only', make a separate frame
4903on graphic displays only.
4904Any other non-nil value means always make a separate frame."
4905 :type '(choice
4906 (const :tag "Never" nil)
4907 (const :tag "On graphic displays only" graphic-only)
4908 (const :tag "Always" t))
f818cd2a 4909 :group 'windows)
3c448ab6 4910
d1067961 4911(defcustom display-buffer-reuse-frames nil
f818cd2a 4912 "Non-nil means `display-buffer' should reuse frames.
3c448ab6
MR
4913If the buffer in question is already displayed in a frame, raise
4914that frame."
4915 :type 'boolean
d1067961 4916 :version "21.1"
f818cd2a 4917 :group 'windows)
24777832
CY
4918
4919(make-obsolete-variable
4920 'display-buffer-reuse-frames
4921 "use a `reusable-frames' alist entry in `display-buffer-alist'."
4922 "24.3")
3c448ab6 4923
4dc2a129
MR
4924(defcustom pop-up-windows t
4925 "Non-nil means `display-buffer' should make a new window."
3c448ab6
MR
4926 :type 'boolean
4927 :group 'windows)
4928
8b10a2d1 4929(defcustom split-window-preferred-function 'split-window-sensibly
f818cd2a 4930 "Function called by `display-buffer' routines to split a window.
8b10a2d1
MR
4931This function is called with a window as single argument and is
4932supposed to split that window and return the new window. If the
4933window can (or shall) not be split, it is supposed to return nil.
4934The default is to call the function `split-window-sensibly' which
4935tries to split the window in a way which seems most suitable.
4936You can customize the options `split-height-threshold' and/or
4937`split-width-threshold' in order to have `split-window-sensibly'
4938prefer either vertical or horizontal splitting.
4939
f818cd2a
MR
4940If you set this to any other function, bear in mind that the
4941`display-buffer' routines may call this function two times. The
4942argument of the first call is the largest window on its frame.
4943If that call fails to return a live window, the function is
4944called again with the least recently used window as argument. If
4945that call fails too, `display-buffer' will use an existing window
4946to display its buffer.
8b10a2d1
MR
4947
4948The window selected at the time `display-buffer' was invoked is
4949still selected when this function is called. Hence you can
4950compare the window argument with the value of `selected-window'
4951if you intend to split the selected window instead or if you do
4952not want to split the selected window."
4953 :type 'function
3c448ab6
MR
4954 :version "23.1"
4955 :group 'windows)
4956
8b10a2d1 4957(defcustom split-height-threshold 80
f818cd2a
MR
4958 "Minimum height for splitting windows sensibly.
4959If this is an integer, `split-window-sensibly' may split a window
8b10a2d1 4960vertically only if it has at least this many lines. If this is
f818cd2a
MR
4961nil, `split-window-sensibly' is not allowed to split a window
4962vertically. If, however, a window is the only window on its
4963frame, `split-window-sensibly' may split it vertically
4964disregarding the value of this variable."
8b10a2d1 4965 :type '(choice (const nil) (integer :tag "lines"))
3c448ab6
MR
4966 :version "23.1"
4967 :group 'windows)
4968
8b10a2d1 4969(defcustom split-width-threshold 160
f818cd2a
MR
4970 "Minimum width for splitting windows sensibly.
4971If this is an integer, `split-window-sensibly' may split a window
8b10a2d1 4972horizontally only if it has at least this many columns. If this
f818cd2a
MR
4973is nil, `split-window-sensibly' is not allowed to split a window
4974horizontally."
8b10a2d1 4975 :type '(choice (const nil) (integer :tag "columns"))
3c448ab6
MR
4976 :version "23.1"
4977 :group 'windows)
9481c002 4978
8b10a2d1
MR
4979(defun window-splittable-p (window &optional horizontal)
4980 "Return non-nil if `split-window-sensibly' may split WINDOW.
4981Optional argument HORIZONTAL nil or omitted means check whether
4982`split-window-sensibly' may split WINDOW vertically. HORIZONTAL
4983non-nil means check whether WINDOW may be split horizontally.
3c448ab6 4984
8b10a2d1 4985WINDOW may be split vertically when the following conditions
3c448ab6 4986hold:
3c448ab6
MR
4987- `window-size-fixed' is either nil or equals `width' for the
4988 buffer of WINDOW.
8b10a2d1 4989- `split-height-threshold' is an integer and WINDOW is at least as
3c448ab6 4990 high as `split-height-threshold'.
3c448ab6
MR
4991- When WINDOW is split evenly, the emanating windows are at least
4992 `window-min-height' lines tall and can accommodate at least one
4993 line plus - if WINDOW has one - a mode line.
4994
8b10a2d1 4995WINDOW may be split horizontally when the following conditions
3c448ab6 4996hold:
3c448ab6
MR
4997- `window-size-fixed' is either nil or equals `height' for the
4998 buffer of WINDOW.
8b10a2d1 4999- `split-width-threshold' is an integer and WINDOW is at least as
3c448ab6 5000 wide as `split-width-threshold'.
3c448ab6
MR
5001- When WINDOW is split evenly, the emanating windows are at least
5002 `window-min-width' or two (whichever is larger) columns wide."
5003 (when (window-live-p window)
5004 (with-current-buffer (window-buffer window)
5005 (if horizontal
5006 ;; A window can be split horizontally when its width is not
5007 ;; fixed, it is at least `split-width-threshold' columns wide
5008 ;; and at least twice as wide as `window-min-width' and 2 (the
5009 ;; latter value is hardcoded).
5010 (and (memq window-size-fixed '(nil height))
5011 ;; Testing `window-full-width-p' here hardly makes any
5012 ;; sense nowadays. This can be done more intuitively by
5013 ;; setting up `split-width-threshold' appropriately.
5014 (numberp split-width-threshold)
5015 (>= (window-width window)
5016 (max split-width-threshold
5017 (* 2 (max window-min-width 2)))))
5018 ;; A window can be split vertically when its height is not
5019 ;; fixed, it is at least `split-height-threshold' lines high,
5020 ;; and it is at least twice as high as `window-min-height' and 2
37269466 5021 ;; if it has a mode line or 1.
3c448ab6
MR
5022 (and (memq window-size-fixed '(nil width))
5023 (numberp split-height-threshold)
5024 (>= (window-height window)
5025 (max split-height-threshold
5026 (* 2 (max window-min-height
5027 (if mode-line-format 2 1))))))))))
5028
2dc2a609 5029(defun split-window-sensibly (&optional window)
8b10a2d1 5030 "Split WINDOW in a way suitable for `display-buffer'.
2dc2a609 5031WINDOW defaults to the currently selected window.
8b10a2d1
MR
5032If `split-height-threshold' specifies an integer, WINDOW is at
5033least `split-height-threshold' lines tall and can be split
5034vertically, split WINDOW into two windows one above the other and
5035return the lower window. Otherwise, if `split-width-threshold'
5036specifies an integer, WINDOW is at least `split-width-threshold'
5037columns wide and can be split horizontally, split WINDOW into two
5038windows side by side and return the window on the right. If this
5039can't be done either and WINDOW is the only window on its frame,
5040try to split WINDOW vertically disregarding any value specified
5041by `split-height-threshold'. If that succeeds, return the lower
5042window. Return nil otherwise.
5043
5044By default `display-buffer' routines call this function to split
5045the largest or least recently used window. To change the default
5046customize the option `split-window-preferred-function'.
5047
5048You can enforce this function to not split WINDOW horizontally,
382c953b 5049by setting (or binding) the variable `split-width-threshold' to
8b10a2d1
MR
5050nil. If, in addition, you set `split-height-threshold' to zero,
5051chances increase that this function does split WINDOW vertically.
5052
382c953b 5053In order to not split WINDOW vertically, set (or bind) the
8b10a2d1
MR
5054variable `split-height-threshold' to nil. Additionally, you can
5055set `split-width-threshold' to zero to make a horizontal split
5056more likely to occur.
5057
5058Have a look at the function `window-splittable-p' if you want to
5059know how `split-window-sensibly' determines whether WINDOW can be
5060split."
2dc2a609
TH
5061 (let ((window (or window (selected-window))))
5062 (or (and (window-splittable-p window)
5063 ;; Split window vertically.
5064 (with-selected-window window
5065 (split-window-below)))
5066 (and (window-splittable-p window t)
5067 ;; Split window horizontally.
5068 (with-selected-window window
5069 (split-window-right)))
5070 (and (eq window (frame-root-window (window-frame window)))
5071 (not (window-minibuffer-p window))
5072 ;; If WINDOW is the only window on its frame and is not the
5073 ;; minibuffer window, try to split it vertically disregarding
5074 ;; the value of `split-height-threshold'.
5075 (let ((split-height-threshold 0))
5076 (when (window-splittable-p window)
5077 (with-selected-window window
5078 (split-window-below))))))))
9481c002 5079
f818cd2a
MR
5080(defun window--try-to-split-window (window)
5081 "Try to split WINDOW.
5082Return value returned by `split-window-preferred-function' if it
5083represents a live window, nil otherwise."
5084 (and (window-live-p window)
5085 (not (frame-parameter (window-frame window) 'unsplittable))
8e17c9ba
MR
5086 (let* ((window-combination-limit
5087 ;; When `window-combination-limit' equals
5088 ;; `display-buffer' bind it to t so resizing steals
5089 ;; space preferably from the window that was split.
5090 (if (eq window-combination-limit 'display-buffer)
5091 t
5092 window-combination-limit))
5093 (new-window
5094 ;; Since `split-window-preferred-function' might
5095 ;; throw an error use `condition-case'.
5096 (condition-case nil
5097 (funcall split-window-preferred-function window)
5098 (error nil))))
f818cd2a
MR
5099 (and (window-live-p new-window) new-window))))
5100
5101(defun window--frame-usable-p (frame)
5102 "Return FRAME if it can be used to display a buffer."
5103 (when (frame-live-p frame)
5104 (let ((window (frame-root-window frame)))
5105 ;; `frame-root-window' may be an internal window which is considered
5106 ;; "dead" by `window-live-p'. Hence if `window' is not live we
5107 ;; implicitly know that `frame' has a visible window we can use.
5108 (unless (and (window-live-p window)
5109 (or (window-minibuffer-p window)
5110 ;; If the window is soft-dedicated, the frame is usable.
5111 ;; Actually, even if the window is really dedicated,
5112 ;; the frame is still usable by splitting it.
5113 ;; At least Emacs-22 allowed it, and it is desirable
5114 ;; when displaying same-frame windows.
5115 nil ; (eq t (window-dedicated-p window))
5116 ))
5117 frame))))
5118
5119(defcustom even-window-heights t
5120 "If non-nil `display-buffer' will try to even window heights.
5121Otherwise `display-buffer' will leave the window configuration
5122alone. Heights are evened only when `display-buffer' chooses a
5123window that appears above or below the selected window."
5124 :type 'boolean
5125 :group 'windows)
5126
5127(defun window--even-window-heights (window)
5128 "Even heights of WINDOW and selected window.
5129Do this only if these windows are vertically adjacent to each
5130other, `even-window-heights' is non-nil, and the selected window
5131is higher than WINDOW."
5132 (when (and even-window-heights
9aba119d
MR
5133 ;; Even iff WINDOW forms a vertical combination with the
5134 ;; selected window, and WINDOW's height exceeds that of the
5135 ;; selected window, see also bug#11880.
5136 (window-combined-p window)
5137 (= (window-child-count (window-parent window)) 2)
5138 (eq (window-parent) (window-parent window))
5139 (> (window-total-height) (window-total-height window)))
5140 ;; Don't throw an error if we can't even window heights for
5141 ;; whatever reason.
5142 (condition-case nil
5143 (enlarge-window
5144 (/ (- (window-total-height window) (window-total-height)) 2))
5145 (error nil))))
f818cd2a 5146
51a5f9d8 5147(defun window--display-buffer (buffer window type &optional dedicated)
f818cd2a 5148 "Display BUFFER in WINDOW and make its frame visible.
51a5f9d8
MR
5149TYPE must be one of the symbols `reuse', `window' or `frame' and
5150is passed unaltered to `display-buffer-record-window'. Set
5151`window-dedicated-p' to DEDICATED if non-nil. Return WINDOW if
5152BUFFER and WINDOW are live."
f818cd2a 5153 (when (and (buffer-live-p buffer) (window-live-p window))
caceae25 5154 (display-buffer-record-window type window buffer)
90749b53
CY
5155 (unless (eq buffer (window-buffer window))
5156 (set-window-dedicated-p window nil)
90749b53
CY
5157 (set-window-buffer window buffer)
5158 (when dedicated
5159 (set-window-dedicated-p window dedicated))
5160 (when (memq type '(window frame))
5161 (set-window-prev-buffers window nil)))
5162 window))
5163
5164(defun window--maybe-raise-frame (frame)
5165 (let ((visible (frame-visible-p frame)))
5166 (unless (or (not visible)
5167 ;; Assume the selected frame is already visible enough.
5168 (eq frame (selected-frame))
5169 ;; Assume the frame from which we invoked the
5170 ;; minibuffer is visible.
5171 (and (minibuffer-window-active-p (selected-window))
5172 (eq frame (window-frame (minibuffer-selected-window)))))
5173 (raise-frame frame))))
f818cd2a 5174
24510c22
SM
5175;; FIXME: Not implemented.
5176;; FIXME: By the way, there could be more levels of dedication:
5177;; - `barely' dedicated doesn't prevent reuse of the window, only records that
5178;; the window hasn't been used for something else yet.
5179;; - `softly' dedicated only allows reuse when asked explicitly.
5180;; - `strongly' never allows reuse.
f818cd2a
MR
5181(defvar display-buffer-mark-dedicated nil
5182 "If non-nil, `display-buffer' marks the windows it creates as dedicated.
5183The actual non-nil value of this variable will be copied to the
5184`window-dedicated-p' flag.")
5185
fa5660f9
CY
5186(defconst display-buffer--action-function-custom-type
5187 '(choice :tag "Function"
5188 (const :tag "--" ignore) ; default for insertion
fa5660f9 5189 (const display-buffer-reuse-window)
d9558cad 5190 (const display-buffer-pop-up-window)
fa5660f9
CY
5191 (const display-buffer-same-window)
5192 (const display-buffer-pop-up-frame)
5193 (const display-buffer-use-some-window)
5194 (function :tag "Other function"))
5195 "Custom type for `display-buffer' action functions.")
5196
5197(defconst display-buffer--action-custom-type
5198 `(cons :tag "Action"
5199 (choice :tag "Action functions"
5200 ,display-buffer--action-function-custom-type
5201 (repeat
5202 :tag "List of functions"
5203 ,display-buffer--action-function-custom-type))
5204 (alist :tag "Action arguments"
5205 :key-type symbol
5206 :value-type (sexp :tag "Value")))
5207 "Custom type for `display-buffer' actions.")
5208
cbb0f9ab
CY
5209(defvar display-buffer-overriding-action '(nil . nil)
5210 "Overriding action to perform to display a buffer.
5211It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
382c953b 5212function or a list of functions. Each function should accept two
cbb0f9ab
CY
5213arguments: a buffer to display and an alist similar to ALIST.
5214See `display-buffer' for details.")
5215(put 'display-buffer-overriding-action 'risky-local-variable t)
5216
fa5660f9 5217(defcustom display-buffer-alist nil
89894cd8
CY
5218 "Alist of conditional actions for `display-buffer'.
5219This is a list of elements (CONDITION . ACTION), where:
5220
5221 CONDITION is either a regexp matching buffer names, or a function
5222 that takes a buffer and returns a boolean.
5223
8319e0bf
CY
5224 ACTION is a cons cell (FUNCTION . ALIST), where FUNCTION is a
5225 function or a list of functions. Each such function should
382c953b 5226 accept two arguments: a buffer to display and an alist of the
fa5660f9
CY
5227 same form as ALIST. See `display-buffer' for details."
5228 :type `(alist :key-type
5229 (choice :tag "Condition"
5230 regexp
5231 (function :tag "Matcher function"))
5232 :value-type ,display-buffer--action-custom-type)
5233 :risky t
5234 :version "24.1"
5235 :group 'windows)
89894cd8 5236
cbb0f9ab
CY
5237(defcustom display-buffer-base-action '(nil . nil)
5238 "User-specified default action for `display-buffer'.
8319e0bf 5239It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
382c953b 5240function or a list of functions. Each function should accept two
fa5660f9
CY
5241arguments: a buffer to display and an alist similar to ALIST.
5242See `display-buffer' for details."
5243 :type display-buffer--action-custom-type
5244 :risky t
5245 :version "24.1"
5246 :group 'windows)
89894cd8 5247
cbb0f9ab 5248(defconst display-buffer-fallback-action
0a9f9ab5 5249 '((display-buffer--maybe-same-window ;FIXME: why isn't this redundant?
cbb0f9ab 5250 display-buffer-reuse-window
cbb0f9ab
CY
5251 display-buffer--maybe-pop-up-frame-or-window
5252 display-buffer-use-some-window
5253 ;; If all else fails, pop up a new frame.
5254 display-buffer-pop-up-frame))
5255 "Default fallback action for `display-buffer'.
5256This is the action used by `display-buffer' if no other actions
5257specified, e.g. by the user options `display-buffer-alist' or
5258`display-buffer-base-action'. See `display-buffer'.")
5259(put 'display-buffer-fallback-action 'risky-local-variable t)
f818cd2a
MR
5260
5261(defun display-buffer-assq-regexp (buffer-name alist)
5262 "Retrieve ALIST entry corresponding to BUFFER-NAME."
5263 (catch 'match
5264 (dolist (entry alist)
cb882333 5265 (let ((key (car entry)))
f818cd2a
MR
5266 (when (or (and (stringp key)
5267 (string-match-p key buffer-name))
5268 (and (symbolp key) (functionp key)
5269 (funcall key buffer-name alist)))
5270 (throw 'match (cdr entry)))))))
5271
8319e0bf
CY
5272(defvar display-buffer--same-window-action
5273 '(display-buffer-same-window
5274 (inhibit-same-window . nil))
5275 "A `display-buffer' action for displaying in the same window.")
5276(put 'display-buffer--same-window-action 'risky-local-variable t)
5277
5278(defvar display-buffer--other-frame-action
5279 '((display-buffer-reuse-window
8319e0bf
CY
5280 display-buffer-pop-up-frame)
5281 (reusable-frames . 0)
5282 (inhibit-same-window . t))
5283 "A `display-buffer' action for displaying in another frame.")
5284(put 'display-buffer--other-frame-action 'risky-local-variable t)
5285
d45ba96b 5286(defun display-buffer (buffer-or-name &optional action frame)
3199b96f 5287 "Display BUFFER-OR-NAME in some window, without selecting it.
89894cd8
CY
5288BUFFER-OR-NAME must be a buffer or the name of an existing
5289buffer. Return the window chosen for displaying BUFFER-OR-NAME,
5290or nil if no such window is found.
5291
5292Optional argument ACTION should have the form (FUNCTION . ALIST).
d4bd55e7
CY
5293FUNCTION is either a function or a list of functions.
5294ALIST is an arbitrary association list (alist).
5295
5296Each such FUNCTION should accept two arguments: the buffer to
5297display and an alist. Based on those arguments, it should either
5298display the buffer and return the window, or return nil if unable
5299to display the buffer.
89894cd8 5300
cbb0f9ab 5301The `display-buffer' function builds a function list and an alist
d4bd55e7
CY
5302by combining the functions and alists specified in
5303`display-buffer-overriding-action', `display-buffer-alist', the
5304ACTION argument, `display-buffer-base-action', and
5305`display-buffer-fallback-action' (in order). Then it calls each
5306function in the combined function list in turn, passing the
cbb0f9ab
CY
5307buffer as the first argument and the combined alist as the second
5308argument, until one of the functions returns non-nil.
8319e0bf
CY
5309
5310Available action functions include:
5311 `display-buffer-same-window'
8319e0bf
CY
5312 `display-buffer-reuse-window'
5313 `display-buffer-pop-up-frame'
5314 `display-buffer-pop-up-window'
5315 `display-buffer-use-some-window'
5316
5317Recognized alist entries include:
5318
5319 `inhibit-same-window' -- A non-nil value prevents the same
5320 window from being used for display.
5321
90749b53
CY
5322 `inhibit-switch-frame' -- A non-nil value prevents any other
5323 frame from being raised or selected,
5324 even if the window is displayed there.
5325
8319e0bf
CY
5326 `reusable-frames' -- Value specifies frame(s) to search for a
5327 window that already displays the buffer.
5328 See `display-buffer-reuse-window'.
2a7bdc1a 5329
d97af5a0
CY
5330 `pop-up-frame-parameters' -- Value specifies an alist of frame
5331 parameters to give a new frame, if
5332 one is created.
5333
2a7bdc1a
CY
5334The ACTION argument to `display-buffer' can also have a non-nil
5335and non-list value. This means to display the buffer in a window
5336other than the selected one, even if it is already displayed in
5337the selected window. If called interactively with a prefix
5338argument, ACTION is t.
89894cd8 5339
8319e0bf
CY
5340Optional argument FRAME, if non-nil, acts like an additional
5341ALIST entry (reusable-frames . FRAME), specifying the frame(s) to
5342search for a window that is already displaying the buffer. See
5343`display-buffer-reuse-window'."
c3313451
CY
5344 (interactive (list (read-buffer "Display buffer: " (other-buffer))
5345 (if current-prefix-arg t)))
d45ba96b
MR
5346 (let ((buffer (if (bufferp buffer-or-name)
5347 buffer-or-name
5348 (get-buffer buffer-or-name)))
89894cd8
CY
5349 ;; Handle the old form of the first argument.
5350 (inhibit-same-window (and action (not (listp action)))))
5351 (unless (listp action) (setq action nil))
5352 (if display-buffer-function
5353 ;; If `display-buffer-function' is defined, let it do the job.
5354 (funcall display-buffer-function buffer inhibit-same-window)
5355 ;; Otherwise, use the defined actions.
5356 (let* ((user-action
5357 (display-buffer-assq-regexp (buffer-name buffer)
5358 display-buffer-alist))
0a9f9ab5 5359 (special-action (display-buffer--special-action buffer))
89894cd8
CY
5360 ;; Extra actions from the arguments to this function:
5361 (extra-action
5362 (cons nil (append (if inhibit-same-window
5363 '((inhibit-same-window . t)))
5364 (if frame
8319e0bf 5365 `((reusable-frames . ,frame))))))
89894cd8
CY
5366 ;; Construct action function list and action alist.
5367 (actions (list display-buffer-overriding-action
0a9f9ab5 5368 user-action special-action action extra-action
cbb0f9ab
CY
5369 display-buffer-base-action
5370 display-buffer-fallback-action))
89894cd8
CY
5371 (functions (apply 'append
5372 (mapcar (lambda (x)
5373 (setq x (car x))
c3313451 5374 (if (functionp x) (list x) x))
89894cd8
CY
5375 actions)))
5376 (alist (apply 'append (mapcar 'cdr actions)))
5377 window)
5378 (unless (buffer-live-p buffer)
5379 (error "Invalid buffer"))
5380 (while (and functions (not window))
5381 (setq window (funcall (car functions) buffer alist)
5382 functions (cdr functions)))
5383 window))))
f818cd2a
MR
5384
5385(defun display-buffer-other-frame (buffer)
5386 "Display buffer BUFFER in another frame.
5387This uses the function `display-buffer' as a subroutine; see
5388its documentation for additional customization information."
5389 (interactive "BDisplay buffer in other frame: ")
8319e0bf 5390 (display-buffer buffer display-buffer--other-frame-action t))
f818cd2a 5391
89894cd8 5392;;; `display-buffer' action functions:
437014c8 5393
89894cd8 5394(defun display-buffer-same-window (buffer alist)
8319e0bf
CY
5395 "Display BUFFER in the selected window.
5396This fails if ALIST has a non-nil `inhibit-same-window' entry, or
5397if the selected window is a minibuffer window or is dedicated to
5398another buffer; in that case, return nil. Otherwise, return the
5399selected window."
89894cd8
CY
5400 (unless (or (cdr (assq 'inhibit-same-window alist))
5401 (window-minibuffer-p)
5402 (window-dedicated-p))
51a5f9d8 5403 (window--display-buffer buffer (selected-window) 'reuse)))
89894cd8 5404
0d3ff375 5405(defun display-buffer--maybe-same-window (buffer alist)
8319e0bf
CY
5406 "Conditionally display BUFFER in the selected window.
5407If `same-window-p' returns non-nil for BUFFER's name, call
5408`display-buffer-same-window' and return its value. Otherwise,
5409return nil."
89894cd8
CY
5410 (and (same-window-p (buffer-name buffer))
5411 (display-buffer-same-window buffer alist)))
5412
5413(defun display-buffer-reuse-window (buffer alist)
5414 "Return a window that is already displaying BUFFER.
8319e0bf
CY
5415Return nil if no usable window is found.
5416
5417If ALIST has a non-nil `inhibit-same-window' entry, the selected
5418window is not eligible for reuse.
5419
5420If ALIST contains a `reusable-frames' entry, its value determines
5421which frames to search for a reusable window:
5422 nil -- the selected frame (actually the last non-minibuffer frame)
5423 A frame -- just that frame
5424 `visible' -- all visible frames
5425 0 -- all frames on the current terminal
5426 t -- all frames.
5427
5428If ALIST contains no `reusable-frames' entry, search just the
5429selected frame if `display-buffer-reuse-frames' and
5430`pop-up-frames' are both nil; search all frames on the current
90749b53
CY
5431terminal if either of those variables is non-nil.
5432
5433If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
5434event that a window on another frame is chosen, avoid raising
5435that frame."
8319e0bf
CY
5436 (let* ((alist-entry (assq 'reusable-frames alist))
5437 (frames (cond (alist-entry (cdr alist-entry))
5438 ((if (eq pop-up-frames 'graphic-only)
5439 (display-graphic-p)
5440 pop-up-frames)
5441 0)
5442 (display-buffer-reuse-frames 0)
5443 (t (last-nonminibuffer-frame))))
5444 (window (if (and (eq buffer (window-buffer))
5445 (not (cdr (assq 'inhibit-same-window alist))))
5446 (selected-window)
5447 (car (delq (selected-window)
5448 (get-buffer-window-list buffer 'nomini
5449 frames))))))
90749b53
CY
5450 (when (window-live-p window)
5451 (prog1 (window--display-buffer buffer window 'reuse)
5452 (unless (cdr (assq 'inhibit-switch-frame alist))
5453 (window--maybe-raise-frame (window-frame window)))))))
89894cd8 5454
0a9f9ab5 5455(defun display-buffer--special-action (buffer)
4ad3bc2a
CY
5456 "Return special display action for BUFFER, if any.
5457If `special-display-p' returns non-nil for BUFFER, return an
5458appropriate display action involving `special-display-function'.
5459See `display-buffer' for the format of display actions."
8319e0bf
CY
5460 (and special-display-function
5461 ;; `special-display-p' returns either t or a list of frame
5462 ;; parameters to pass to `special-display-function'.
5463 (let ((pars (special-display-p (buffer-name buffer))))
5464 (when pars
0a9f9ab5
SM
5465 (list (list #'display-buffer-reuse-window
5466 `(lambda (buffer _alist)
5467 (funcall special-display-function
5468 buffer ',(if (listp pars) pars)))))))))
8319e0bf 5469
90749b53 5470(defun display-buffer-pop-up-frame (buffer alist)
89894cd8 5471 "Display BUFFER in a new frame.
8319e0bf 5472This works by calling `pop-up-frame-function'. If successful,
90749b53
CY
5473return the window used; otherwise return nil.
5474
5475If ALIST has a non-nil `inhibit-switch-frame' entry, avoid
d97af5a0
CY
5476raising the new frame.
5477
5478If ALIST has a non-nil `pop-up-frame-parameters' entry, the
5479corresponding value is an alist of frame parameters to give the
5480new frame."
5481 (let* ((params (cdr (assq 'pop-up-frame-parameters alist)))
5482 (pop-up-frame-alist (append params pop-up-frame-alist))
5483 (fun pop-up-frame-function)
5484 frame window)
89894cd8
CY
5485 (when (and fun
5486 (setq frame (funcall fun))
5487 (setq window (frame-selected-window frame)))
90749b53
CY
5488 (prog1 (window--display-buffer buffer window
5489 'frame display-buffer-mark-dedicated)
5490 (unless (cdr (assq 'inhibit-switch-frame alist))
5491 (window--maybe-raise-frame frame))))))
89894cd8 5492
90749b53 5493(defun display-buffer-pop-up-window (buffer alist)
89894cd8
CY
5494 "Display BUFFER by popping up a new window.
5495The new window is created on the selected frame, or in
5496`last-nonminibuffer-frame' if no windows can be created there.
90749b53
CY
5497If successful, return the new window; otherwise return nil.
5498
5499If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
5500event that the new window is created on another frame, avoid
5501raising the frame."
89894cd8
CY
5502 (let ((frame (or (window--frame-usable-p (selected-frame))
5503 (window--frame-usable-p (last-nonminibuffer-frame))))
5504 window)
5505 (when (and (or (not (frame-parameter frame 'unsplittable))
5506 ;; If the selected frame cannot be split, look at
5507 ;; `last-nonminibuffer-frame'.
5508 (and (eq frame (selected-frame))
5509 (setq frame (last-nonminibuffer-frame))
5510 (window--frame-usable-p frame)
5511 (not (frame-parameter frame 'unsplittable))))
5512 ;; Attempt to split largest or least recently used window.
5513 (setq window (or (window--try-to-split-window
5514 (get-largest-window frame t))
5515 (window--try-to-split-window
5516 (get-lru-window frame t)))))
90749b53
CY
5517 (prog1 (window--display-buffer buffer window
5518 'window display-buffer-mark-dedicated)
5519 (unless (cdr (assq 'inhibit-switch-frame alist))
5520 (window--maybe-raise-frame (window-frame window)))))))
89894cd8 5521
8319e0bf
CY
5522(defun display-buffer--maybe-pop-up-frame-or-window (buffer alist)
5523 "Try displaying BUFFER based on `pop-up-frames' or `pop-up-windows'.
5524
5525If `pop-up-frames' is non-nil (and not `graphic-only' on a
5526text-only terminal), try with `display-buffer-pop-up-frame'.
5527
5528If that cannot be done, and `pop-up-windows' is non-nil, try
5529again with `display-buffer-pop-up-window'."
5530 (or (and (if (eq pop-up-frames 'graphic-only)
5531 (display-graphic-p)
5532 pop-up-frames)
5533 (display-buffer-pop-up-frame buffer alist))
5534 (and pop-up-windows
5535 (display-buffer-pop-up-window buffer alist))))
89894cd8 5536
78dd6ab1
MR
5537(defun display-buffer-below-selected (buffer _alist)
5538 "Try displaying BUFFER in a window below the selected window.
5539This either splits the selected window or reuses the window below
5540the selected one."
5541 (let (window)
5542 (or (and (not (frame-parameter nil 'unsplittable))
5543 (setq window (window--try-to-split-window (selected-window)))
5544 (window--display-buffer
5545 buffer window 'window display-buffer-mark-dedicated))
5546 (and (setq window (window-in-direction 'below))
5547 (not (window-dedicated-p window))
5548 (window--display-buffer
5549 buffer window 'reuse display-buffer-mark-dedicated)))))
8e17c9ba
MR
5550
5551(defun display-buffer-at-bottom (buffer _alist)
5552 "Try displaying BUFFER in a window at the botom of the selected frame.
5553This either splits the window at the bottom of the frame or the
5554frame's root window, or reuses an existing window at the bottom
5555of the selected frame."
5556 (let (bottom-window window)
5557 (walk-window-tree (lambda (window) (setq bottom-window window)))
5558 (or (and (not (frame-parameter nil 'unsplittable))
5559 (setq window (window--try-to-split-window bottom-window))
5560 (window--display-buffer
5561 buffer window 'window display-buffer-mark-dedicated))
5562 (and (not (frame-parameter nil 'unsplittable))
5563 (setq window
5564 (condition-case nil
5565 (split-window (frame-root-window))
5566 (error nil)))
5567 (window--display-buffer
5568 buffer window 'window display-buffer-mark-dedicated))
5569 (and (setq window bottom-window)
5570 (not (window-dedicated-p window))
5571 (window--display-buffer
5572 buffer window 'reuse display-buffer-mark-dedicated)))))
78dd6ab1 5573
fa2bcf43
MR
5574(defun display-buffer-in-previous-window (buffer alist)
5575 "Display BUFFER in a window previously showing it.
5576If ALIST has a non-nil `inhibit-same-window' entry, the selected
5577window is not eligible for reuse.
5578
5579If ALIST contains a `reusable-frames' entry, its value determines
5580which frames to search for a reusable window:
5581 nil -- the selected frame (actually the last non-minibuffer frame)
5582 A frame -- just that frame
5583 `visible' -- all visible frames
5584 0 -- all frames on the current terminal
5585 t -- all frames.
5586
5587If ALIST contains no `reusable-frames' entry, search just the
5588selected frame if `display-buffer-reuse-frames' and
5589`pop-up-frames' are both nil; search all frames on the current
5590terminal if either of those variables is non-nil.
5591
5592If ALIST has a `previous-window' entry, the window specified by
5593that entry will override any other window found by the methods
5594above, even if that window never showed BUFFER before."
5595 (let* ((alist-entry (assq 'reusable-frames alist))
5596 (inhibit-same-window
5597 (cdr (assq 'inhibit-same-window alist)))
5598 (frames (cond
5599 (alist-entry (cdr alist-entry))
5600 ((if (eq pop-up-frames 'graphic-only)
5601 (display-graphic-p)
5602 pop-up-frames)
5603 0)
5604 (display-buffer-reuse-frames 0)
5605 (t (last-nonminibuffer-frame))))
5606 entry best-window second-best-window window)
5607 ;; Scan windows whether they have shown the buffer recently.
5608 (catch 'best
5609 (dolist (window (window-list-1 (frame-first-window) 'nomini frames))
5610 (when (and (assq buffer (window-prev-buffers window))
5611 (not (window-dedicated-p window)))
5612 (if (eq window (selected-window))
5613 (unless inhibit-same-window
5614 (setq second-best-window window))
5615 (setq best-window window)
5616 (throw 'best t)))))
5617 ;; When ALIST has a `previous-window' entry, that entry may override
5618 ;; anything we found so far.
5619 (when (and (setq window (cdr (assq 'previous-window alist)))
5620 (window-live-p window)
5621 (not (window-dedicated-p window)))
5622 (if (eq window (selected-window))
5623 (unless inhibit-same-window
5624 (setq second-best-window window))
5625 (setq best-window window)))
5626 ;; Return best or second best window found.
5627 (when (setq window (or best-window second-best-window))
5628 (window--display-buffer buffer window 'reuse))))
5629
89894cd8
CY
5630(defun display-buffer-use-some-window (buffer alist)
5631 "Display BUFFER in an existing window.
5632Search for a usable window, set that window to the buffer, and
90749b53
CY
5633return the window. If no suitable window is found, return nil.
5634
5635If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
5636event that a window in another frame is chosen, avoid raising
5637that frame."
89894cd8 5638 (let* ((not-this-window (cdr (assq 'inhibit-same-window alist)))
89894cd8
CY
5639 (frame (or (window--frame-usable-p (selected-frame))
5640 (window--frame-usable-p (last-nonminibuffer-frame))))
51a5f9d8
MR
5641 (window
5642 ;; Reuse an existing window.
5643 (or (get-lru-window frame nil not-this-window)
5644 (let ((window (get-buffer-window buffer 'visible)))
5645 (unless (and not-this-window
5646 (eq window (selected-window)))
5647 window))
5648 (get-largest-window 'visible nil not-this-window)
5649 (let ((window (get-buffer-window buffer 0)))
5650 (unless (and not-this-window
5651 (eq window (selected-window)))
5652 window))
5653 (get-largest-window 0 not-this-window))))
90749b53 5654 (when (window-live-p window)
9aba119d
MR
5655 (prog1
5656 (window--display-buffer buffer window 'reuse)
5657 (window--even-window-heights window)
90749b53
CY
5658 (unless (cdr (assq 'inhibit-switch-frame alist))
5659 (window--maybe-raise-frame (window-frame window)))))))
437014c8
CY
5660
5661;;; Display + selection commands:
c3313451
CY
5662(defun pop-to-buffer (buffer &optional action norecord)
5663 "Select buffer BUFFER in some window, preferably a different one.
5664BUFFER may be a buffer, a string (a buffer name), or nil. If it
5665is a string not naming an existent buffer, create a buffer with
5666that name. If BUFFER is nil, choose some other buffer. Return
5667the buffer.
5668
5669This uses `display-buffer' as a subroutine. The optional ACTION
5670argument is passed to `display-buffer' as its ACTION argument.
5671See `display-buffer' for more information. ACTION is t if called
5672interactively with a prefix argument, which means to pop to a
5673window other than the selected one even if the buffer is already
5674displayed in the selected window.
5675
5676If the window to show BUFFER is not on the selected
f818cd2a
MR
5677frame, raise that window's frame and give it input focus.
5678
f818cd2a
MR
5679Optional third arg NORECORD non-nil means do not put this buffer
5680at the front of the list of recently selected ones."
c3313451
CY
5681 (interactive (list (read-buffer "Pop to buffer: " (other-buffer))
5682 (if current-prefix-arg t)))
8319e0bf 5683 (setq buffer (window-normalize-buffer-to-switch-to buffer))
c3313451 5684 (set-buffer buffer)
cb882333 5685 (let* ((old-frame (selected-frame))
8319e0bf 5686 (window (display-buffer buffer action))
c3313451 5687 (frame (window-frame window)))
97adfb97
CY
5688 ;; If we chose another frame, make sure it gets input focus.
5689 (unless (eq frame old-frame)
c3313451 5690 (select-frame-set-input-focus frame norecord))
97adfb97
CY
5691 ;; Make sure new window is selected (Bug#8615), (Bug#6954).
5692 (select-window window norecord)
c3313451 5693 buffer))
f818cd2a 5694
72258fe5
CY
5695(defun pop-to-buffer-same-window (buffer &optional norecord)
5696 "Select buffer BUFFER in some window, preferably the same one.
5697This function behaves much like `switch-to-buffer', except it
5698displays with `special-display-function' if BUFFER has a match in
5699`special-display-buffer-names' or `special-display-regexps'.
5700
5701Unlike `pop-to-buffer', this function prefers using the selected
5702window over popping up a new window or frame.
5703
5704BUFFER may be a buffer, a string (a buffer name), or nil. If it
5705is a string not naming an existent buffer, create a buffer with
5706that name. If BUFFER is nil, choose some other buffer. Return
5707the buffer.
5708
5709NORECORD, if non-nil means do not put this buffer at the front of
5710the list of recently selected ones."
24510c22 5711 (pop-to-buffer buffer display-buffer--same-window-action norecord))
72258fe5 5712
f818cd2a
MR
5713(defun read-buffer-to-switch (prompt)
5714 "Read the name of a buffer to switch to, prompting with PROMPT.
e1dbe924 5715Return the name of the buffer as a string.
f818cd2a
MR
5716
5717This function is intended for the `switch-to-buffer' family of
5718commands since these need to omit the name of the current buffer
5719from the list of completions and default values."
5720 (let ((rbts-completion-table (internal-complete-buffer-except)))
5721 (minibuffer-with-setup-hook
5722 (lambda ()
5723 (setq minibuffer-completion-table rbts-completion-table)
5724 ;; Since rbts-completion-table is built dynamically, we
5725 ;; can't just add it to the default value of
5726 ;; icomplete-with-completion-tables, so we add it
5727 ;; here manually.
5728 (if (and (boundp 'icomplete-with-completion-tables)
5729 (listp icomplete-with-completion-tables))
5730 (set (make-local-variable 'icomplete-with-completion-tables)
5731 (cons rbts-completion-table
5732 icomplete-with-completion-tables))))
5733 (read-buffer prompt (other-buffer (current-buffer))
5734 (confirm-nonexistent-file-or-buffer)))))
5735
5736(defun window-normalize-buffer-to-switch-to (buffer-or-name)
5737 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
5738If BUFFER-OR-NAME is nil, return the buffer returned by
5739`other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
5740exists, return that buffer. If no such buffer exists, create a
5741buffer with the name BUFFER-OR-NAME and return that buffer."
5742 (if buffer-or-name
5743 (or (get-buffer buffer-or-name)
5744 (let ((buffer (get-buffer-create buffer-or-name)))
5745 (set-buffer-major-mode buffer)
5746 buffer))
5747 (other-buffer)))
5748
5749(defun switch-to-buffer (buffer-or-name &optional norecord force-same-window)
5750 "Switch to buffer BUFFER-OR-NAME in the selected window.
cee2e90d
CY
5751If the selected window cannot display the specified
5752buffer (e.g. if it is a minibuffer window or strongly dedicated
5753to another buffer), call `pop-to-buffer' to select the buffer in
5754another window.
5755
5756If called interactively, read the buffer name using the
f818cd2a
MR
5757minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5758determines whether to request confirmation before creating a new
5759buffer.
5760
cee2e90d
CY
5761BUFFER-OR-NAME may be a buffer, a string (a buffer name), or nil.
5762If BUFFER-OR-NAME is a string that does not identify an existing
5763buffer, create a buffer with that name. If BUFFER-OR-NAME is
5764nil, switch to the buffer returned by `other-buffer'.
5765
5766If optional argument NORECORD is non-nil, do not put the buffer
5767at the front of the buffer list, and do not make the window
5768displaying it the most recently selected one.
5769
5770If optional argument FORCE-SAME-WINDOW is non-nil, the buffer
5771must be displayed in the selected window; if that is impossible,
5772signal an error rather than calling `pop-to-buffer'.
f818cd2a
MR
5773
5774Return the buffer switched to."
5775 (interactive
acc825c5 5776 (list (read-buffer-to-switch "Switch to buffer: ") nil 'force-same-window))
f818cd2a 5777 (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name)))
24510c22
SM
5778 (cond
5779 ;; Don't call set-window-buffer if it's not needed since it
5780 ;; might signal an error (e.g. if the window is dedicated).
5781 ((eq buffer (window-buffer)))
5782 ((window-minibuffer-p)
5783 (if force-same-window
71873e2b 5784 (user-error "Cannot switch buffers in minibuffer window")
24510c22
SM
5785 (pop-to-buffer buffer norecord)))
5786 ((eq (window-dedicated-p) t)
5787 (if force-same-window
71873e2b 5788 (user-error "Cannot switch buffers in a dedicated window")
24510c22
SM
5789 (pop-to-buffer buffer norecord)))
5790 (t (set-window-buffer nil buffer)))
5791
5792 (unless norecord
5793 (select-window (selected-window)))
5794 (set-buffer buffer)))
f818cd2a
MR
5795
5796(defun switch-to-buffer-other-window (buffer-or-name &optional norecord)
5797 "Select the buffer specified by BUFFER-OR-NAME in another window.
382c953b 5798BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
f818cd2a
MR
5799nil. Return the buffer switched to.
5800
5801If called interactively, prompt for the buffer name using the
5802minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5803determines whether to request confirmation before creating a new
5804buffer.
5805
5806If BUFFER-OR-NAME is a string and does not identify an existing
5807buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5808nil, switch to the buffer returned by `other-buffer'.
5809
5810Optional second argument NORECORD non-nil means do not put this
5811buffer at the front of the list of recently selected ones.
5812
5813This uses the function `display-buffer' as a subroutine; see its
5814documentation for additional customization information."
5815 (interactive
5816 (list (read-buffer-to-switch "Switch to buffer in other window: ")))
8319e0bf
CY
5817 (let ((pop-up-windows t))
5818 (pop-to-buffer buffer-or-name t norecord)))
f818cd2a
MR
5819
5820(defun switch-to-buffer-other-frame (buffer-or-name &optional norecord)
5821 "Switch to buffer BUFFER-OR-NAME in another frame.
382c953b 5822BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
f818cd2a
MR
5823nil. Return the buffer switched to.
5824
5825If called interactively, prompt for the buffer name using the
5826minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5827determines whether to request confirmation before creating a new
5828buffer.
5829
5830If BUFFER-OR-NAME is a string and does not identify an existing
5831buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5832nil, switch to the buffer returned by `other-buffer'.
5833
5834Optional second arg NORECORD non-nil means do not put this
5835buffer at the front of the list of recently selected ones.
5836
5837This uses the function `display-buffer' as a subroutine; see its
5838documentation for additional customization information."
5839 (interactive
5840 (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
8319e0bf 5841 (pop-to-buffer buffer-or-name display-buffer--other-frame-action norecord))
3c448ab6
MR
5842\f
5843(defun set-window-text-height (window height)
9992ea0c 5844 "Set the height in lines of the text display area of WINDOW to HEIGHT.
85c2386b
MR
5845WINDOW must be a live window and defaults to the selected one.
5846HEIGHT doesn't include the mode line or header line, if any, or
5847any partial-height lines in the text display area.
3c448ab6
MR
5848
5849Note that the current implementation of this function cannot
5850always set the height exactly, but attempts to be conservative,
5851by allocating more lines than are actually needed in the case
5852where some error may be present."
447f16b8 5853 (setq window (window-normalize-window window t))
3c448ab6
MR
5854 (let ((delta (- height (window-text-height window))))
5855 (unless (zerop delta)
5856 ;; Setting window-min-height to a value like 1 can lead to very
5857 ;; bizarre displays because it also allows Emacs to make *other*
37269466
CY
5858 ;; windows one line tall, which means that there's no more space
5859 ;; for the mode line.
5860 (let ((window-min-height (min 2 height)))
d615d6d2 5861 (window-resize window delta)))))
3c448ab6 5862
6198ccd0
MR
5863(defun enlarge-window-horizontally (delta)
5864 "Make selected window DELTA columns wider.
3c448ab6
MR
5865Interactively, if no argument is given, make selected window one
5866column wider."
5867 (interactive "p")
6198ccd0 5868 (enlarge-window delta t))
3c448ab6 5869
6198ccd0
MR
5870(defun shrink-window-horizontally (delta)
5871 "Make selected window DELTA columns narrower.
3c448ab6
MR
5872Interactively, if no argument is given, make selected window one
5873column narrower."
5874 (interactive "p")
6198ccd0 5875 (shrink-window delta t))
3c448ab6
MR
5876
5877(defun count-screen-lines (&optional beg end count-final-newline window)
5878 "Return the number of screen lines in the region.
5879The number of screen lines may be different from the number of actual lines,
5880due to line breaking, display table, etc.
5881
5882Optional arguments BEG and END default to `point-min' and `point-max'
5883respectively.
5884
5885If region ends with a newline, ignore it unless optional third argument
5886COUNT-FINAL-NEWLINE is non-nil.
5887
5888The optional fourth argument WINDOW specifies the window used for obtaining
5889parameters such as width, horizontal scrolling, and so on. The default is
5890to use the selected window's parameters.
5891
5892Like `vertical-motion', `count-screen-lines' always uses the current buffer,
5893regardless of which buffer is displayed in WINDOW. This makes possible to use
5894`count-screen-lines' in any buffer, whether or not it is currently displayed
5895in some window."
5896 (unless beg
5897 (setq beg (point-min)))
5898 (unless end
5899 (setq end (point-max)))
5900 (if (= beg end)
5901 0
5902 (save-excursion
5903 (save-restriction
5904 (widen)
5905 (narrow-to-region (min beg end)
5906 (if (and (not count-final-newline)
5907 (= ?\n (char-before (max beg end))))
5908 (1- (max beg end))
5909 (max beg end)))
5910 (goto-char (point-min))
5911 (1+ (vertical-motion (buffer-size) window))))))
5912
6198ccd0 5913(defun window-buffer-height (window)
85c2386b
MR
5914 "Return the height (in screen lines) of the buffer that WINDOW is displaying.
5915WINDOW must be a live window and defaults to the selected one."
5916 (setq window (window-normalize-window window t))
6198ccd0
MR
5917 (with-current-buffer (window-buffer window)
5918 (max 1
5919 (count-screen-lines (point-min) (point-max)
5920 ;; If buffer ends with a newline, ignore it when
5921 ;; counting height unless point is after it.
5922 (eobp)
5923 window))))
5924
5925;;; Resizing buffers to fit their contents exactly.
c5e28e39 5926(defun fit-window-to-buffer (&optional window max-height min-height)
3c448ab6 5927 "Adjust height of WINDOW to display its buffer's contents exactly.
85c2386b 5928WINDOW must be a live window and defaults to the selected one.
6198ccd0
MR
5929
5930Optional argument MAX-HEIGHT specifies the maximum height of
5931WINDOW and defaults to the height of WINDOW's frame. Optional
5932argument MIN-HEIGHT specifies the minimum height of WINDOW and
382c953b 5933defaults to `window-min-height'. Both MAX-HEIGHT and MIN-HEIGHT
6198ccd0
MR
5934are specified in lines and include the mode line and header line,
5935if any.
5936
6198ccd0
MR
5937Return the number of lines by which WINDOW was enlarged or
5938shrunk. If an error occurs during resizing, return nil but don't
5939signal an error.
5940
5941Note that even if this function makes WINDOW large enough to show
5942_all_ lines of its buffer you might not see the first lines when
5943WINDOW was scrolled."
f7baca20 5944 (interactive)
447f16b8 5945 (setq window (window-normalize-window window t))
6198ccd0 5946 ;; Can't resize a full height or fixed-size window.
9173deec 5947 (unless (or (window-size-fixed-p window)
6198ccd0 5948 (window-full-height-p window))
6198ccd0 5949 (with-selected-window window
c5e28e39 5950 (let* ((height (window-total-size))
6198ccd0 5951 (min-height
c5e28e39
MR
5952 ;; Adjust MIN-HEIGHT.
5953 (if (numberp min-height)
5954 ;; Can't get smaller than `window-safe-min-height'.
5955 (max min-height window-safe-min-height)
5956 ;; Preserve header and mode line if present.
5957 (window-min-size nil nil t)))
6198ccd0 5958 (max-height
c5e28e39
MR
5959 ;; Adjust MAX-HEIGHT.
5960 (if (numberp max-height)
5961 ;; Can't get larger than height of frame.
5962 (min max-height
5963 (window-total-size (frame-root-window window)))
5964 ;, Don't delete other windows.
5965 (+ height (window-max-delta nil nil window))))
6198ccd0
MR
5966 ;; Make `desired-height' the height necessary to show
5967 ;; all of WINDOW's buffer, constrained by MIN-HEIGHT
5968 ;; and MAX-HEIGHT.
5969 (desired-height
5970 (max
5971 (min
5972 (+ (count-screen-lines)
5973 ;; For non-minibuffers count the mode line, if any.
5974 (if (and (not (window-minibuffer-p window))
5975 mode-line-format)
5976 1
5977 0)
5978 ;; Count the header line, if any.
5979 (if header-line-format 1 0))
5980 max-height)
5981 min-height))
5982 (desired-delta
5983 (- desired-height (window-total-size window)))
5984 (delta
5985 (if (> desired-delta 0)
5986 (min desired-delta
5987 (window-max-delta window nil window))
5988 (max desired-delta
5989 (- (window-min-delta window nil window))))))
6198ccd0
MR
5990 (condition-case nil
5991 (if (zerop delta)
c80e3b4a 5992 ;; Return zero if DELTA became zero in the process.
6198ccd0
MR
5993 0
5994 ;; Don't try to redisplay with the cursor at the end on its
5995 ;; own line--that would force a scroll and spoil things.
5996 (when (and (eobp) (bolp) (not (bobp)))
5997 ;; It's silly to put `point' at the end of the previous
5998 ;; line and so maybe force horizontal scrolling.
5999 (set-window-point window (line-beginning-position 0)))
d615d6d2
MR
6000 ;; Call `window-resize' with OVERRIDE argument equal WINDOW.
6001 (window-resize window delta nil window)
f7baca20
MR
6002 ;; Check if the last line is surely fully visible. If
6003 ;; not, enlarge the window.
6004 (let ((end (save-excursion
6005 (goto-char (point-max))
6006 (when (and (bolp) (not (bobp)))
6007 ;; Don't include final newline.
6008 (backward-char 1))
6009 (when truncate-lines
6010 ;; If line-wrapping is turned off, test the
6011 ;; beginning of the last line for
6012 ;; visibility instead of the end, as the
6013 ;; end of the line could be invisible by
6014 ;; virtue of extending past the edge of the
6015 ;; window.
6016 (forward-line 0))
6017 (point))))
6018 (set-window-vscroll window 0)
6198ccd0
MR
6019 ;; This loop might in some rare pathological cases raise
6020 ;; an error - another reason for the `condition-case'.
f7baca20 6021 (while (and (< desired-height max-height)
6198ccd0 6022 (= desired-height (window-total-size))
f7baca20 6023 (not (pos-visible-in-window-p end)))
d615d6d2 6024 (window-resize window 1 nil window)
6198ccd0
MR
6025 (setq desired-height (1+ desired-height)))))
6026 (error (setq delta nil)))
6027 delta))))
3c448ab6 6028
ef654460
MR
6029(defcustom fit-frame-to-buffer-bottom-margin 4
6030 "Bottom margin for `fit-frame-to-buffer'.
6031This is the number of lines `fit-frame-to-buffer' leaves free at the
6032bottom of the display in order to not obscure the system task bar."
6033 :type 'integer
6034 :version "24.2"
6035 :group 'windows)
6036
6037(defun fit-frame-to-buffer (&optional frame max-height min-height)
6038 "Adjust height of FRAME to display its buffer's contents exactly.
6039FRAME can be any live frame and defaults to the selected one.
6040
6041Optional argument MAX-HEIGHT specifies the maximum height of
6042FRAME and defaults to the height of the display below the current
6043top line of FRAME minus FIT-FRAME-TO-BUFFER-BOTTOM-MARGIN.
6044Optional argument MIN-HEIGHT specifies the minimum height of
6045FRAME."
6046 (interactive)
6047 (setq frame (window-normalize-frame frame))
6048 (let* ((root (frame-root-window frame))
6049 (frame-min-height
6050 (+ (- (frame-height frame) (window-total-size root))
6051 window-min-height))
6052 (frame-top (frame-parameter frame 'top))
6053 (top (if (consp frame-top)
6054 (funcall (car frame-top) (cadr frame-top))
6055 frame-top))
6056 (frame-max-height
6057 (- (/ (- (x-display-pixel-height frame) top)
6058 (frame-char-height frame))
6059 fit-frame-to-buffer-bottom-margin))
6060 (compensate 0)
6061 delta)
6062 (when (and (window-live-p root) (not (window-size-fixed-p root)))
6063 (with-selected-window root
6064 (cond
6065 ((not max-height)
6066 (setq max-height frame-max-height))
6067 ((numberp max-height)
6068 (setq max-height (min max-height frame-max-height)))
6069 (t
6070 (error "%s is an invalid maximum height" max-height)))
6071 (cond
6072 ((not min-height)
6073 (setq min-height frame-min-height))
6074 ((numberp min-height)
6075 (setq min-height (min min-height frame-min-height)))
6076 (t
6077 (error "%s is an invalid minimum height" min-height)))
6078 ;; When tool-bar-mode is enabled and we have just created a new
6079 ;; frame, reserve lines for toolbar resizing. This is needed
6080 ;; because for reasons unknown to me Emacs (1) reserves one line
6081 ;; for the toolbar when making the initial frame and toolbars
6082 ;; are enabled, and (2) later adds the remaining lines needed.
6083 ;; Our code runs IN BETWEEN (1) and (2). YMMV when you're on a
6084 ;; system that behaves differently.
6085 (let ((quit-restore (window-parameter root 'quit-restore))
6086 (lines (tool-bar-lines-needed frame)))
6087 (when (and quit-restore (eq (car quit-restore) 'frame)
6088 (not (zerop lines)))
6089 (setq compensate (1- lines))))
6090 (message "%s" compensate)
6091 (setq delta
6092 ;; Always count a final newline - we don't do any
6093 ;; post-processing, so let's play safe.
6094 (+ (count-screen-lines nil nil t)
6095 (- (window-body-size))
6096 compensate)))
6097 ;; Move away from final newline.
6098 (when (and (eobp) (bolp) (not (bobp)))
6099 (set-window-point root (line-beginning-position 0)))
6100 (set-window-start root (point-min))
6101 (set-window-vscroll root 0)
6102 (condition-case nil
6103 (set-frame-height
6104 frame
6105 (min (max (+ (frame-height frame) delta)
6106 min-height)
6107 max-height))
6108 (error (setq delta nil))))
6109 delta))
6110
39cffb44
MR
6111(defun window-safely-shrinkable-p (&optional window)
6112 "Return t if WINDOW can be shrunk without shrinking other windows.
6113WINDOW defaults to the selected window."
6114 (with-selected-window (or window (selected-window))
6115 (let ((edges (window-edges)))
39cffb44
MR
6116 (or (= (nth 2 edges) (nth 2 (window-edges (previous-window))))
6117 (= (nth 0 edges) (nth 0 (window-edges (next-window))))))))
39cffb44 6118
3c448ab6
MR
6119(defun shrink-window-if-larger-than-buffer (&optional window)
6120 "Shrink height of WINDOW if its buffer doesn't need so many lines.
6121More precisely, shrink WINDOW vertically to be as small as
6122possible, while still showing the full contents of its buffer.
85c2386b 6123WINDOW must be a live window and defaults to the selected one.
3c448ab6 6124
6198ccd0
MR
6125Do not shrink WINDOW to less than `window-min-height' lines. Do
6126nothing if the buffer contains more lines than the present window
6127height, or if some of the window's contents are scrolled out of
6128view, or if shrinking this window would also shrink another
6129window, or if the window is the only window of its frame.
3c448ab6
MR
6130
6131Return non-nil if the window was shrunk, nil otherwise."
6132 (interactive)
447f16b8 6133 (setq window (window-normalize-window window t))
6198ccd0
MR
6134 ;; Make sure that WINDOW is vertically combined and `point-min' is
6135 ;; visible (for whatever reason that's needed). The remaining issues
6136 ;; should be taken care of by `fit-window-to-buffer'.
3d8daefe 6137 (when (and (window-combined-p window)
6198ccd0
MR
6138 (pos-visible-in-window-p (point-min) window))
6139 (fit-window-to-buffer window (window-total-size window))))
6140\f
3c448ab6
MR
6141(defun kill-buffer-and-window ()
6142 "Kill the current buffer and delete the selected window."
6143 (interactive)
6144 (let ((window-to-delete (selected-window))
6145 (buffer-to-kill (current-buffer))
6198ccd0 6146 (delete-window-hook (lambda () (ignore-errors (delete-window)))))
3c448ab6
MR
6147 (unwind-protect
6148 (progn
6149 (add-hook 'kill-buffer-hook delete-window-hook t t)
6150 (if (kill-buffer (current-buffer))
6151 ;; If `delete-window' failed before, we rerun it to regenerate
6152 ;; the error so it can be seen in the echo area.
6153 (when (eq (selected-window) window-to-delete)
6154 (delete-window))))
6155 ;; If the buffer is not dead for some reason (probably because
6156 ;; of a `quit' signal), remove the hook again.
6198ccd0
MR
6157 (ignore-errors
6158 (with-current-buffer buffer-to-kill
6159 (remove-hook 'kill-buffer-hook delete-window-hook t))))))
3c448ab6 6160
74f806a1 6161\f
3c448ab6
MR
6162(defvar recenter-last-op nil
6163 "Indicates the last recenter operation performed.
0116abbd
JL
6164Possible values: `top', `middle', `bottom', integer or float numbers.")
6165
6166(defcustom recenter-positions '(middle top bottom)
6167 "Cycling order for `recenter-top-bottom'.
6168A list of elements with possible values `top', `middle', `bottom',
6169integer or float numbers that define the cycling order for
6170the command `recenter-top-bottom'.
6171
382c953b 6172Top and bottom destinations are `scroll-margin' lines from the true
0116abbd
JL
6173window top and bottom. Middle redraws the frame and centers point
6174vertically within the window. Integer number moves current line to
6175the specified absolute window-line. Float number between 0.0 and 1.0
6176means the percentage of the screen space from the top. The default
6177cycling order is middle -> top -> bottom."
6178 :type '(repeat (choice
6179 (const :tag "Top" top)
6180 (const :tag "Middle" middle)
6181 (const :tag "Bottom" bottom)
6182 (integer :tag "Line number")
6183 (float :tag "Percentage")))
6184 :version "23.2"
6185 :group 'windows)
3c448ab6
MR
6186
6187(defun recenter-top-bottom (&optional arg)
0116abbd
JL
6188 "Move current buffer line to the specified window line.
6189With no prefix argument, successive calls place point according
6190to the cycling order defined by `recenter-positions'.
3c448ab6
MR
6191
6192A prefix argument is handled like `recenter':
6193 With numeric prefix ARG, move current line to window-line ARG.
0116abbd 6194 With plain `C-u', move current line to window center."
3c448ab6
MR
6195 (interactive "P")
6196 (cond
0116abbd 6197 (arg (recenter arg)) ; Always respect ARG.
3c448ab6 6198 (t
0116abbd
JL
6199 (setq recenter-last-op
6200 (if (eq this-command last-command)
6201 (car (or (cdr (member recenter-last-op recenter-positions))
6202 recenter-positions))
6203 (car recenter-positions)))
3c448ab6
MR
6204 (let ((this-scroll-margin
6205 (min (max 0 scroll-margin)
6206 (truncate (/ (window-body-height) 4.0)))))
6207 (cond ((eq recenter-last-op 'middle)
0116abbd 6208 (recenter))
3c448ab6 6209 ((eq recenter-last-op 'top)
0116abbd
JL
6210 (recenter this-scroll-margin))
6211 ((eq recenter-last-op 'bottom)
6212 (recenter (- -1 this-scroll-margin)))
6213 ((integerp recenter-last-op)
6214 (recenter recenter-last-op))
6215 ((floatp recenter-last-op)
6216 (recenter (round (* recenter-last-op (window-height))))))))))
3c448ab6
MR
6217
6218(define-key global-map [?\C-l] 'recenter-top-bottom)
216349f8 6219
216349f8
SM
6220(defun move-to-window-line-top-bottom (&optional arg)
6221 "Position point relative to window.
6222
0f202d5d 6223With a prefix argument ARG, acts like `move-to-window-line'.
216349f8
SM
6224
6225With no argument, positions point at center of window.
0116abbd
JL
6226Successive calls position point at positions defined
6227by `recenter-positions'."
216349f8
SM
6228 (interactive "P")
6229 (cond
0116abbd 6230 (arg (move-to-window-line arg)) ; Always respect ARG.
216349f8 6231 (t
0116abbd
JL
6232 (setq recenter-last-op
6233 (if (eq this-command last-command)
6234 (car (or (cdr (member recenter-last-op recenter-positions))
6235 recenter-positions))
6236 (car recenter-positions)))
216349f8
SM
6237 (let ((this-scroll-margin
6238 (min (max 0 scroll-margin)
6239 (truncate (/ (window-body-height) 4.0)))))
0f202d5d 6240 (cond ((eq recenter-last-op 'middle)
0116abbd 6241 (call-interactively 'move-to-window-line))
0f202d5d 6242 ((eq recenter-last-op 'top)
0116abbd
JL
6243 (move-to-window-line this-scroll-margin))
6244 ((eq recenter-last-op 'bottom)
6245 (move-to-window-line (- -1 this-scroll-margin)))
6246 ((integerp recenter-last-op)
6247 (move-to-window-line recenter-last-op))
6248 ((floatp recenter-last-op)
6249 (move-to-window-line (round (* recenter-last-op (window-height))))))))))
216349f8
SM
6250
6251(define-key global-map [?\M-r] 'move-to-window-line-top-bottom)
3c448ab6 6252\f
74f806a1
JL
6253;;; Scrolling commands.
6254
0a9f9ab5
SM
6255;;; Scrolling commands which do not signal errors at top/bottom
6256;;; of buffer at first key-press (instead move to top/bottom
74f806a1
JL
6257;;; of buffer).
6258
6259(defcustom scroll-error-top-bottom nil
8350f087 6260 "Move point to top/bottom of buffer before signaling a scrolling error.
74f806a1
JL
6261A value of nil means just signal an error if no more scrolling possible.
6262A value of t means point moves to the beginning or the end of the buffer
6263\(depending on scrolling direction) when no more scrolling possible.
6264When point is already on that position, then signal an error."
6265 :type 'boolean
60efac0f 6266 :group 'windows
74f806a1
JL
6267 :version "24.1")
6268
6269(defun scroll-up-command (&optional arg)
6270 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
6271If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
6272scroll window further, move cursor to the bottom line.
6273When point is already on that position, then signal an error.
6274A near full screen is `next-screen-context-lines' less than a full screen.
6275Negative ARG means scroll downward.
6276If ARG is the atom `-', scroll downward by nearly full screen."
6277 (interactive "^P")
6278 (cond
6279 ((null scroll-error-top-bottom)
6280 (scroll-up arg))
6281 ((eq arg '-)
6282 (scroll-down-command nil))
6283 ((< (prefix-numeric-value arg) 0)
6284 (scroll-down-command (- (prefix-numeric-value arg))))
6285 ((eobp)
6286 (scroll-up arg)) ; signal error
6287 (t
6288 (condition-case nil
6289 (scroll-up arg)
6290 (end-of-buffer
6291 (if arg
6292 ;; When scrolling by ARG lines can't be done,
6293 ;; move by ARG lines instead.
6294 (forward-line arg)
6295 ;; When ARG is nil for full-screen scrolling,
6296 ;; move to the bottom of the buffer.
6297 (goto-char (point-max))))))))
6298
6299(put 'scroll-up-command 'scroll-command t)
6300
6301(defun scroll-down-command (&optional arg)
6302 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
6303If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
6304scroll window further, move cursor to the top line.
6305When point is already on that position, then signal an error.
6306A near full screen is `next-screen-context-lines' less than a full screen.
6307Negative ARG means scroll upward.
6308If ARG is the atom `-', scroll upward by nearly full screen."
6309 (interactive "^P")
6310 (cond
6311 ((null scroll-error-top-bottom)
6312 (scroll-down arg))
6313 ((eq arg '-)
6314 (scroll-up-command nil))
6315 ((< (prefix-numeric-value arg) 0)
6316 (scroll-up-command (- (prefix-numeric-value arg))))
6317 ((bobp)
6318 (scroll-down arg)) ; signal error
6319 (t
6320 (condition-case nil
6321 (scroll-down arg)
6322 (beginning-of-buffer
6323 (if arg
6324 ;; When scrolling by ARG lines can't be done,
6325 ;; move by ARG lines instead.
6326 (forward-line (- arg))
6327 ;; When ARG is nil for full-screen scrolling,
6328 ;; move to the top of the buffer.
6329 (goto-char (point-min))))))))
6330
6331(put 'scroll-down-command 'scroll-command t)
6332
6333;;; Scrolling commands which scroll a line instead of full screen.
6334
6335(defun scroll-up-line (&optional arg)
6336 "Scroll text of selected window upward ARG lines; or one line if no ARG.
6337If ARG is omitted or nil, scroll upward by one line.
6338This is different from `scroll-up-command' that scrolls a full screen."
6339 (interactive "p")
6340 (scroll-up (or arg 1)))
6341
6342(put 'scroll-up-line 'scroll-command t)
6343
6344(defun scroll-down-line (&optional arg)
6345 "Scroll text of selected window down ARG lines; or one line if no ARG.
6346If ARG is omitted or nil, scroll down by one line.
6347This is different from `scroll-down-command' that scrolls a full screen."
6348 (interactive "p")
6349 (scroll-down (or arg 1)))
6350
6351(put 'scroll-down-line 'scroll-command t)
6352
6353\f
011474aa 6354(defun scroll-other-window-down (&optional lines)
74f806a1
JL
6355 "Scroll the \"other window\" down.
6356For more details, see the documentation for `scroll-other-window'."
6357 (interactive "P")
6358 (scroll-other-window
6359 ;; Just invert the argument's meaning.
6360 ;; We can do that without knowing which window it will be.
6361 (if (eq lines '-) nil
6362 (if (null lines) '-
6363 (- (prefix-numeric-value lines))))))
6364
6365(defun beginning-of-buffer-other-window (arg)
6366 "Move point to the beginning of the buffer in the other window.
6367Leave mark at previous position.
6368With arg N, put point N/10 of the way from the true beginning."
6369 (interactive "P")
6370 (let ((orig-window (selected-window))
6371 (window (other-window-for-scrolling)))
6372 ;; We use unwind-protect rather than save-window-excursion
6373 ;; because the latter would preserve the things we want to change.
6374 (unwind-protect
6375 (progn
6376 (select-window window)
6377 ;; Set point and mark in that window's buffer.
6378 (with-no-warnings
6379 (beginning-of-buffer arg))
6380 ;; Set point accordingly.
6381 (recenter '(t)))
6382 (select-window orig-window))))
6383
6384(defun end-of-buffer-other-window (arg)
6385 "Move point to the end of the buffer in the other window.
6386Leave mark at previous position.
6387With arg N, put point N/10 of the way from the true end."
6388 (interactive "P")
6389 ;; See beginning-of-buffer-other-window for comments.
6390 (let ((orig-window (selected-window))
6391 (window (other-window-for-scrolling)))
6392 (unwind-protect
6393 (progn
6394 (select-window window)
6395 (with-no-warnings
6396 (end-of-buffer arg))
6397 (recenter '(t)))
6398 (select-window orig-window))))
74f806a1 6399\f
3c448ab6
MR
6400(defvar mouse-autoselect-window-timer nil
6401 "Timer used by delayed window autoselection.")
6402
6403(defvar mouse-autoselect-window-position nil
6404 "Last mouse position recorded by delayed window autoselection.")
6405
6406(defvar mouse-autoselect-window-window nil
6407 "Last window recorded by delayed window autoselection.")
6408
6409(defvar mouse-autoselect-window-state nil
6410 "When non-nil, special state of delayed window autoselection.
382c953b
JB
6411Possible values are `suspend' (suspend autoselection after a menu or
6412scrollbar interaction) and `select' (the next invocation of
6413`handle-select-window' shall select the window immediately).")
3c448ab6
MR
6414
6415(defun mouse-autoselect-window-cancel (&optional force)
6416 "Cancel delayed window autoselection.
6417Optional argument FORCE means cancel unconditionally."
6418 (unless (and (not force)
6419 ;; Don't cancel for select-window or select-frame events
6420 ;; or when the user drags a scroll bar.
6421 (or (memq this-command
6422 '(handle-select-window handle-switch-frame))
6423 (and (eq this-command 'scroll-bar-toolkit-scroll)
6424 (memq (nth 4 (event-end last-input-event))
6425 '(handle end-scroll)))))
6426 (setq mouse-autoselect-window-state nil)
6427 (when (timerp mouse-autoselect-window-timer)
6428 (cancel-timer mouse-autoselect-window-timer))
6429 (remove-hook 'pre-command-hook 'mouse-autoselect-window-cancel)))
6430
6431(defun mouse-autoselect-window-start (mouse-position &optional window suspend)
6432 "Start delayed window autoselection.
6433MOUSE-POSITION is the last position where the mouse was seen as returned
6434by `mouse-position'. Optional argument WINDOW non-nil denotes the
6435window where the mouse was seen. Optional argument SUSPEND non-nil
6436means suspend autoselection."
6437 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
6438 (setq mouse-autoselect-window-position mouse-position)
6439 (when window (setq mouse-autoselect-window-window window))
6440 (setq mouse-autoselect-window-state (when suspend 'suspend))
6441 ;; Install timer which runs `mouse-autoselect-window-select' after
6442 ;; `mouse-autoselect-window' seconds.
6443 (setq mouse-autoselect-window-timer
6444 (run-at-time
6445 (abs mouse-autoselect-window) nil 'mouse-autoselect-window-select)))
6446
6447(defun mouse-autoselect-window-select ()
6448 "Select window with delayed window autoselection.
6449If the mouse position has stabilized in a non-selected window, select
382c953b
JB
6450that window. The minibuffer window is selected only if the minibuffer
6451is active. This function is run by `mouse-autoselect-window-timer'."
6198ccd0
MR
6452 (ignore-errors
6453 (let* ((mouse-position (mouse-position))
6454 (window
6455 (ignore-errors
6456 (window-at (cadr mouse-position) (cddr mouse-position)
6457 (car mouse-position)))))
6458 (cond
6459 ((or (menu-or-popup-active-p)
6460 (and window
6461 (not (coordinates-in-window-p (cdr mouse-position) window))))
6462 ;; A menu / popup dialog is active or the mouse is on the scroll-bar
6463 ;; of WINDOW, temporarily suspend delayed autoselection.
6464 (mouse-autoselect-window-start mouse-position nil t))
6465 ((eq mouse-autoselect-window-state 'suspend)
6466 ;; Delayed autoselection was temporarily suspended, reenable it.
6467 (mouse-autoselect-window-start mouse-position))
6468 ((and window (not (eq window (selected-window)))
6469 (or (not (numberp mouse-autoselect-window))
6470 (and (> mouse-autoselect-window 0)
6471 ;; If `mouse-autoselect-window' is positive, select
6472 ;; window if the window is the same as before.
6473 (eq window mouse-autoselect-window-window))
6474 ;; Otherwise select window if the mouse is at the same
6475 ;; position as before. Observe that the first test after
6476 ;; starting autoselection usually fails since the value of
6477 ;; `mouse-autoselect-window-position' recorded there is the
6478 ;; position where the mouse has entered the new window and
6479 ;; not necessarily where the mouse has stopped moving.
6480 (equal mouse-position mouse-autoselect-window-position))
6481 ;; The minibuffer is a candidate window if it's active.
6482 (or (not (window-minibuffer-p window))
6483 (eq window (active-minibuffer-window))))
6484 ;; Mouse position has stabilized in non-selected window: Cancel
6485 ;; delayed autoselection and try to select that window.
6486 (mouse-autoselect-window-cancel t)
6487 ;; Select window where mouse appears unless the selected window is the
6488 ;; minibuffer. Use `unread-command-events' in order to execute pre-
6489 ;; and post-command hooks and trigger idle timers. To avoid delaying
6490 ;; autoselection again, set `mouse-autoselect-window-state'."
6491 (unless (window-minibuffer-p (selected-window))
6492 (setq mouse-autoselect-window-state 'select)
6493 (setq unread-command-events
6494 (cons (list 'select-window (list window))
6495 unread-command-events))))
6496 ((or (and window (eq window (selected-window)))
6497 (not (numberp mouse-autoselect-window))
6498 (equal mouse-position mouse-autoselect-window-position))
6499 ;; Mouse position has either stabilized in the selected window or at
6500 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
6501 (mouse-autoselect-window-cancel t))
6502 (t
6503 ;; Mouse position has not stabilized yet, resume delayed
6504 ;; autoselection.
6505 (mouse-autoselect-window-start mouse-position window))))))
3c448ab6
MR
6506
6507(defun handle-select-window (event)
6508 "Handle select-window events."
6509 (interactive "e")
6510 (let ((window (posn-window (event-start event))))
6511 (unless (or (not (window-live-p window))
6512 ;; Don't switch if we're currently in the minibuffer.
6513 ;; This tries to work around problems where the
6514 ;; minibuffer gets unselected unexpectedly, and where
6515 ;; you then have to move your mouse all the way down to
6516 ;; the minibuffer to select it.
6517 (window-minibuffer-p (selected-window))
6518 ;; Don't switch to minibuffer window unless it's active.
6519 (and (window-minibuffer-p window)
6520 (not (minibuffer-window-active-p window)))
6521 ;; Don't switch when autoselection shall be delayed.
6522 (and (numberp mouse-autoselect-window)
6523 (not (zerop mouse-autoselect-window))
6524 (not (eq mouse-autoselect-window-state 'select))
6525 (progn
6526 ;; Cancel any delayed autoselection.
6527 (mouse-autoselect-window-cancel t)
6528 ;; Start delayed autoselection from current mouse
6529 ;; position and window.
6530 (mouse-autoselect-window-start (mouse-position) window)
6531 ;; Executing a command cancels delayed autoselection.
6532 (add-hook
6533 'pre-command-hook 'mouse-autoselect-window-cancel))))
6534 (when mouse-autoselect-window
6535 ;; Reset state of delayed autoselection.
6536 (setq mouse-autoselect-window-state nil)
6537 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
6538 (run-hooks 'mouse-leave-buffer-hook))
b1bac16e
MR
6539 ;; Clear echo area.
6540 (message nil)
3c448ab6
MR
6541 (select-window window))))
6542
3c448ab6
MR
6543(defun truncated-partial-width-window-p (&optional window)
6544 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
85c2386b 6545WINDOW must be a live window and defaults to the selected one.
3c448ab6
MR
6546Return nil if WINDOW is not a partial-width window
6547 (regardless of the value of `truncate-lines').
6548Otherwise, consult the value of `truncate-partial-width-windows'
6549 for the buffer shown in WINDOW."
85c2386b 6550 (setq window (window-normalize-window window t))
3c448ab6
MR
6551 (unless (window-full-width-p window)
6552 (let ((t-p-w-w (buffer-local-value 'truncate-partial-width-windows
6553 (window-buffer window))))
6554 (if (integerp t-p-w-w)
6555 (< (window-width window) t-p-w-w)
6556 t-p-w-w))))
562dd5e9 6557\f
59ee0542
GM
6558;; Some of these are in tutorial--default-keys, so update that if you
6559;; change these.
562dd5e9
MR
6560(define-key ctl-x-map "0" 'delete-window)
6561(define-key ctl-x-map "1" 'delete-other-windows)
2d197ffb
CY
6562(define-key ctl-x-map "2" 'split-window-below)
6563(define-key ctl-x-map "3" 'split-window-right)
9397e56f 6564(define-key ctl-x-map "o" 'other-window)
562dd5e9 6565(define-key ctl-x-map "^" 'enlarge-window)
3c448ab6
MR
6566(define-key ctl-x-map "}" 'enlarge-window-horizontally)
6567(define-key ctl-x-map "{" 'shrink-window-horizontally)
6568(define-key ctl-x-map "-" 'shrink-window-if-larger-than-buffer)
6569(define-key ctl-x-map "+" 'balance-windows)
6570(define-key ctl-x-4-map "0" 'kill-buffer-and-window)
6571
3c448ab6 6572;;; window.el ends here