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