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