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