* lib-src/update-game-score.c (usage): Update usage line.
[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.
fbf5b3ce
MR
2261(defcustom frame-auto-delete 'automatic
2262 "If non-nil, quitting a window can delete it's frame.
2263If this variable is nil, functions that quit a window never
2264delete the associated frame. If this variable equals the symbol
2265`automatic', a frame is deleted only if it the window is
2266dedicated or was created by `display-buffer'. If this variable
2267is t, a frame can be always deleted, even if it was created by
2268`make-frame-command'. Other values should not be used.
2269
2270Note that a frame will be effectively deleted if and only if
2271another frame still exists.
2272
2273Functions quitting a window and consequently affected by this
2274variable are `switch-to-prev-buffer', `delete-windows-on',
2275`replace-buffer-in-windows' and `quit-restore-window'."
2276 :type '(choice
2277 (const :tag "Never" nil)
2278 (const :tag "Automatic" automatic)
2279 (const :tag "Always" t))
2280 :group 'windows
2281 :group 'frames)
2282
9aab8e0d
MR
2283(defun window-deletable-p (&optional window)
2284 "Return t if WINDOW can be safely deleted from its frame.
2285Return `frame' if deleting WINDOW should delete its frame
2286instead."
5386012d 2287 (setq window (window-normalize-any-window window))
9aab8e0d
MR
2288 (unless ignore-window-parameters
2289 ;; Handle atomicity.
2290 (when (window-parameter window 'window-atom)
2291 (setq window (window-atom-root window))))
2292 (let ((parent (window-parent window))
2293 (frame (window-frame window))
2294 (dedicated (and (window-buffer window) (window-dedicated-p window)))
2295 (quit-restore (window-parameter window 'quit-restore)))
2296 (cond
2297 ((frame-root-window-p window)
fbf5b3ce
MR
2298 (when (and (or (eq frame-auto-delete t)
2299 (and (eq frame-auto-delete 'automatic)
2300 (or dedicated
2301 (and (eq (car-safe quit-restore) 'new-frame)
2302 (eq (nth 1 quit-restore)
2303 (window-buffer window))))))
9aab8e0d
MR
2304 (other-visible-frames-p frame))
2305 ;; WINDOW is the root window of its frame. Return `frame' but
2306 ;; only if WINDOW is (1) either dedicated or quit-restore's car
2307 ;; is new-frame and the window still displays the same buffer
2308 ;; and (2) there are other frames left.
2309 'frame))
2310 ((and (not ignore-window-parameters)
2311 (eq (window-parameter window 'window-side) 'none)
2312 (or (not parent)
2313 (not (eq (window-parameter parent 'window-side) 'none))))
2314 ;; Can't delete last main window.
2315 nil)
2316 (t))))
2317
2318(defun window-or-subwindow-p (subwindow window)
2319 "Return t if SUBWINDOW is either WINDOW or a subwindow of WINDOW."
2320 (or (eq subwindow window)
2321 (let ((parent (window-parent subwindow)))
2322 (catch 'done
2323 (while parent
2324 (if (eq parent window)
2325 (throw 'done t)
2326 (setq parent (window-parent parent))))))))
2327
562dd5e9
MR
2328(defun delete-window (&optional window)
2329 "Delete WINDOW.
2330WINDOW can be an arbitrary window and defaults to the selected
2331one. Return nil.
2332
2333If the variable `ignore-window-parameters' is non-nil or the
2334`delete-window' parameter of WINDOW equals t, do not process any
2335parameters of WINDOW. Otherwise, if the `delete-window'
2336parameter of WINDOW specifies a function, call that function with
2337WINDOW as its sole argument and return the value returned by that
2338function.
2339
2340Otherwise, if WINDOW is part of an atomic window, call
2341`delete-window' with the root of the atomic window as its
2342argument. If WINDOW is the only window on its frame or the last
2343non-side window, signal an error."
2344 (interactive)
5386012d 2345 (setq window (window-normalize-any-window window))
562dd5e9
MR
2346 (let* ((frame (window-frame window))
2347 (function (window-parameter window 'delete-window))
2348 (parent (window-parent window))
2349 atom-root)
2350 (window-check frame)
2351 (catch 'done
2352 ;; Handle window parameters.
2353 (cond
2354 ;; Ignore window parameters if `ignore-window-parameters' tells
2355 ;; us so or `delete-window' equals t.
2356 ((or ignore-window-parameters (eq function t)))
2357 ((functionp function)
2358 ;; The `delete-window' parameter specifies the function to call.
2359 ;; If that function is `ignore' nothing is done. It's up to the
2360 ;; function called here to avoid infinite recursion.
2361 (throw 'done (funcall function window)))
2362 ((and (window-parameter window 'window-atom)
2363 (setq atom-root (window-atom-root window))
2364 (not (eq atom-root window)))
2365 (throw 'done (delete-window atom-root)))
2366 ((and (eq (window-parameter window 'window-side) 'none)
2367 (or (not parent)
2368 (not (eq (window-parameter parent 'window-side) 'none))))
2369 (error "Attempt to delete last non-side window"))
2370 ((not parent)
2371 (error "Attempt to delete minibuffer or sole ordinary window")))
2372
d68443dc 2373 (let* ((horizontal (window-left-child parent))
562dd5e9
MR
2374 (size (window-total-size window horizontal))
2375 (frame-selected
2376 (window-or-subwindow-p (frame-selected-window frame) window))
2377 ;; Emacs 23 preferably gives WINDOW's space to its left
2378 ;; sibling.
2379 (sibling (or (window-left window) (window-right window))))
5386012d 2380 (window--resize-reset frame horizontal)
562dd5e9
MR
2381 (cond
2382 ((and (not (window-splits window))
2383 sibling (window-sizable-p sibling size))
2384 ;; Resize WINDOW's sibling.
5386012d 2385 (window--resize-this-window sibling size horizontal nil t)
562dd5e9
MR
2386 (set-window-new-normal
2387 sibling (+ (window-normal-size sibling horizontal)
2388 (window-normal-size window horizontal))))
2389 ((window-resizable-p window (- size) horizontal nil nil nil t)
2390 ;; Can do without resizing fixed-size windows.
5386012d 2391 (window--resize-siblings window (- size) horizontal))
562dd5e9
MR
2392 (t
2393 ;; Can't do without resizing fixed-size windows.
5386012d 2394 (window--resize-siblings window (- size) horizontal t)))
562dd5e9
MR
2395 ;; Actually delete WINDOW.
2396 (delete-window-internal window)
2397 (when (and frame-selected
2398 (window-parameter
2399 (frame-selected-window frame) 'no-other-window))
2400 ;; `delete-window-internal' has selected a window that should
2401 ;; not be selected, fix this here.
2402 (other-window -1 frame))
2403 (run-window-configuration-change-hook frame)
2404 (window-check frame)
2405 ;; Always return nil.
2406 nil))))
2407
2408(defun delete-other-windows (&optional window)
2409 "Make WINDOW fill its frame.
2410WINDOW may be any window and defaults to the selected one.
2411Return nil.
2412
2413If the variable `ignore-window-parameters' is non-nil or the
2414`delete-other-windows' parameter of WINDOW equals t, do not
2415process any parameters of WINDOW. Otherwise, if the
2416`delete-other-windows' parameter of WINDOW specifies a function,
2417call that function with WINDOW as its sole argument and return
2418the value returned by that function.
2419
2420Otherwise, if WINDOW is part of an atomic window, call this
2421function with the root of the atomic window as its argument. If
2422WINDOW is a non-side window, make WINDOW the only non-side window
2423on the frame. Side windows are not deleted. If WINDOW is a side
2424window signal an error."
2425 (interactive)
5386012d 2426 (setq window (window-normalize-any-window window))
562dd5e9
MR
2427 (let* ((frame (window-frame window))
2428 (function (window-parameter window 'delete-other-windows))
2429 (window-side (window-parameter window 'window-side))
2430 atom-root side-main)
2431 (window-check frame)
2432 (catch 'done
2433 (cond
2434 ;; Ignore window parameters if `ignore-window-parameters' is t or
2435 ;; `delete-other-windows' is t.
2436 ((or ignore-window-parameters (eq function t)))
2437 ((functionp function)
2438 ;; The `delete-other-windows' parameter specifies the function
2439 ;; to call. If the function is `ignore' no windows are deleted.
2440 ;; It's up to the function called to avoid infinite recursion.
2441 (throw 'done (funcall function window)))
2442 ((and (window-parameter window 'window-atom)
2443 (setq atom-root (window-atom-root window))
2444 (not (eq atom-root window)))
2445 (throw 'done (delete-other-windows atom-root)))
2446 ((eq window-side 'none)
2447 ;; Set side-main to the major non-side window.
2448 (setq side-main (window-with-parameter 'window-side 'none nil t)))
2449 ((memq window-side window-sides)
2450 (error "Cannot make side window the only window")))
2451 ;; If WINDOW is the main non-side window, do nothing.
2452 (unless (eq window side-main)
2453 (delete-other-windows-internal window side-main)
2454 (run-window-configuration-change-hook frame)
2455 (window-check frame))
2456 ;; Always return nil.
2457 nil)))
9397e56f
MR
2458
2459(defun delete-other-windows-vertically (&optional window)
2460 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
2461This may be a useful alternative binding for \\[delete-other-windows]
2462 if you often split windows horizontally."
2463 (interactive)
2464 (let* ((window (or window (selected-window)))
2465 (edges (window-edges window))
2466 (w window) delenda)
2467 (while (not (eq (setq w (next-window w 1)) window))
2468 (let ((e (window-edges w)))
2469 (when (and (= (car e) (car edges))
2470 (= (caddr e) (caddr edges)))
2471 (push w delenda))))
2472 (mapc 'delete-window delenda)))
2473
2474;;; Windows and buffers.
2475
2476;; `prev-buffers' and `next-buffers' are two reserved window slots used
2477;; for (1) determining which buffer to show in the window when its
2478;; buffer shall be buried or killed and (2) which buffer to show for
2479;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2480
2481;; `prev-buffers' consists of <buffer, window-start, window-point>
2482;; triples. The entries on this list are ordered by the time their
2483;; buffer has been removed from the window, the most recently removed
2484;; buffer's entry being first. The window-start and window-point
2485;; components are `window-start' and `window-point' at the time the
2486;; buffer was removed from the window which implies that the entry must
2487;; be added when `set-window-buffer' removes the buffer from the window.
2488
2489;; `next-buffers' is the list of buffers that have been replaced
2490;; recently by `switch-to-prev-buffer'. These buffers are the least
2491;; preferred candidates of `switch-to-prev-buffer' and the preferred
2492;; candidates of `switch-to-next-buffer' to switch to. This list is
2493;; reset to nil by any action changing the window's buffer with the
2494;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
2495;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
2496;; `switch-to-next-buffer' pops the last pushed buffer from it.
2497
2498;; Both `prev-buffers' and `next-buffers' may reference killed buffers
2499;; if such a buffer was killed while the window was hidden within a
2500;; window configuration. Such killed buffers get removed whenever
2501;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
2502
2503;; The following function is called by `set-window-buffer' _before_ it
2504;; replaces the buffer of the argument window with the new buffer.
2505(defun record-window-buffer (&optional window)
2506 "Record WINDOW's buffer.
2507WINDOW must be a live window and defaults to the selected one."
5386012d 2508 (let* ((window (window-normalize-live-window window))
9397e56f
MR
2509 (buffer (window-buffer window))
2510 (entry (assq buffer (window-prev-buffers window))))
2511 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
2512 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2513 (set-window-next-buffers window nil)
2514
2515 (when entry
2516 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
2517 (set-window-prev-buffers
2518 window (assq-delete-all buffer (window-prev-buffers window))))
2519
2520 ;; Don't record insignificant buffers.
2521 (unless (eq (aref (buffer-name buffer) 0) ?\s)
2522 ;; Add an entry for buffer to WINDOW's previous buffers.
2523 (with-current-buffer buffer
2524 (let ((start (window-start window))
2525 (point (window-point window)))
2526 (setq entry
2527 (cons buffer
2528 (if entry
2529 ;; We have an entry, update marker positions.
2530 (list (set-marker (nth 1 entry) start)
2531 (set-marker (nth 2 entry) point))
2532 ;; Make new markers.
2533 (list (copy-marker start)
2534 (copy-marker point)))))
2535
2536 (set-window-prev-buffers
2537 window (cons entry (window-prev-buffers window))))))))
2538
2539(defun unrecord-window-buffer (&optional window buffer)
2540 "Unrecord BUFFER in WINDOW.
2541WINDOW must be a live window and defaults to the selected one.
2542BUFFER must be a live buffer and defaults to the buffer of
2543WINDOW."
5386012d 2544 (let* ((window (window-normalize-live-window window))
9397e56f
MR
2545 (buffer (or buffer (window-buffer window))))
2546 (set-window-prev-buffers
2547 window (assq-delete-all buffer (window-prev-buffers window)))
2548 (set-window-next-buffers
2549 window (delq buffer (window-next-buffers window)))))
2550
2551(defun set-window-buffer-start-and-point (window buffer &optional start point)
2552 "Set WINDOW's buffer to BUFFER.
2553Optional argument START non-nil means set WINDOW's start position
2554to START. Optional argument POINT non-nil means set WINDOW's
2555point to POINT. If WINDOW is selected this also sets BUFFER's
2556`point' to POINT. If WINDOW is selected and the buffer it showed
2557before was current this also makes BUFFER the current buffer."
2558 (let ((selected (eq window (selected-window)))
2559 (current (eq (window-buffer window) (current-buffer))))
2560 (set-window-buffer window buffer)
2561 (when (and selected current)
2562 (set-buffer buffer))
2563 (when start
2564 (set-window-start window start))
2565 (when point
2566 (if selected
2567 (with-current-buffer buffer
2568 (goto-char point))
2569 (set-window-point window point)))))
2570
2571(defun switch-to-prev-buffer (&optional window bury-or-kill)
2572 "In WINDOW switch to previous buffer.
2573WINDOW must be a live window and defaults to the selected one.
2574
2575Optional argument BURY-OR-KILL non-nil means the buffer currently
2576shown in WINDOW is about to be buried or killed and consequently
2577shall not be switched to in future invocations of this command."
2578 (interactive)
5386012d 2579 (let* ((window (window-normalize-live-window window))
9397e56f
MR
2580 (old-buffer (window-buffer window))
2581 ;; Save this since it's destroyed by `set-window-buffer'.
2582 (next-buffers (window-next-buffers window))
2583 entry new-buffer killed-buffers deletable visible)
2584 (cond
2585 ;; When BURY-OR-KILL is non-nil, there's no previous buffer for
2586 ;; this window, and we can delete the window (or the frame) do
2587 ;; that.
2588 ((and bury-or-kill
2589 (or (not (window-prev-buffers window))
2590 (and (eq (caar (window-prev-buffers window)) old-buffer)
2591 (not (cdr (car (window-prev-buffers window))))))
2592 (setq deletable (window-deletable-p window)))
2593 (if (eq deletable 'frame)
2594 (delete-frame (window-frame window))
2595 (delete-window window)))
2596 ((window-dedicated-p window)
2597 (error "Window %s is dedicated to buffer %s" window old-buffer)))
2598
2599 (unless deletable
2600 (catch 'found
2601 ;; Scan WINDOW's previous buffers first, skipping entries of next
2602 ;; buffers.
2603 (dolist (entry (window-prev-buffers window))
2604 (when (and (setq new-buffer (car entry))
2605 (or (buffer-live-p new-buffer)
2606 (not (setq killed-buffers
2607 (cons new-buffer killed-buffers))))
2608 (not (eq new-buffer old-buffer))
2609 (or bury-or-kill
2610 (not (memq new-buffer next-buffers))))
2611 (set-window-buffer-start-and-point
2612 window new-buffer (nth 1 entry) (nth 2 entry))
2613 (throw 'found t)))
2614 ;; Scan reverted buffer list of WINDOW's frame next, skipping
2615 ;; entries of next buffers. Note that when we bury or kill a
2616 ;; buffer we don't reverse the global buffer list to avoid showing
2617 ;; a buried buffer instead. Otherwise, we must reverse the global
2618 ;; buffer list in order to make sure that switching to the
2619 ;; previous/next buffer traverse it in opposite directions.
2620 (dolist (buffer (if bury-or-kill
2621 (buffer-list (window-frame window))
2622 (nreverse (buffer-list (window-frame window)))))
2623 (when (and (buffer-live-p buffer)
2624 (not (eq buffer old-buffer))
2625 (not (eq (aref (buffer-name buffer) 0) ?\s))
2626 (or bury-or-kill (not (memq buffer next-buffers))))
2627 (if (get-buffer-window buffer)
2628 ;; Try to avoid showing a buffer visible in some other window.
2629 (setq visible buffer)
2630 (setq new-buffer buffer)
2631 (set-window-buffer-start-and-point window new-buffer)
2632 (throw 'found t))))
2633 (unless bury-or-kill
2634 ;; Scan reverted next buffers last (must not use nreverse
2635 ;; here!).
2636 (dolist (buffer (reverse next-buffers))
2637 ;; Actually, buffer _must_ be live here since otherwise it
2638 ;; would have been caught in the scan of previous buffers.
2639 (when (and (or (buffer-live-p buffer)
2640 (not (setq killed-buffers
2641 (cons buffer killed-buffers))))
2642 (not (eq buffer old-buffer))
2643 (setq entry (assq buffer (window-prev-buffers window))))
2644 (setq new-buffer buffer)
2645 (set-window-buffer-start-and-point
2646 window new-buffer (nth 1 entry) (nth 2 entry))
2647 (throw 'found t))))
2648
2649 ;; Show a buffer visible in another window.
2650 (when visible
2651 (setq new-buffer visible)
2652 (set-window-buffer-start-and-point window new-buffer)))
2653
2654 (if bury-or-kill
2655 ;; Remove `old-buffer' from WINDOW's previous and (restored list
2656 ;; of) next buffers.
2657 (progn
2658 (set-window-prev-buffers
2659 window (assq-delete-all old-buffer (window-prev-buffers window)))
2660 (set-window-next-buffers window (delq old-buffer next-buffers)))
2661 ;; Move `old-buffer' to head of WINDOW's restored list of next
2662 ;; buffers.
2663 (set-window-next-buffers
2664 window (cons old-buffer (delq old-buffer next-buffers)))))
2665
2666 ;; Remove killed buffers from WINDOW's previous and next buffers.
2667 (when killed-buffers
2668 (dolist (buffer killed-buffers)
2669 (set-window-prev-buffers
2670 window (assq-delete-all buffer (window-prev-buffers window)))
2671 (set-window-next-buffers
2672 window (delq buffer (window-next-buffers window)))))
2673
2674 ;; Return new-buffer.
2675 new-buffer))
2676
2677(defun switch-to-next-buffer (&optional window)
2678 "In WINDOW switch to next buffer.
2679WINDOW must be a live window and defaults to the selected one."
2680 (interactive)
5386012d 2681 (let* ((window (window-normalize-live-window window))
9397e56f
MR
2682 (old-buffer (window-buffer window))
2683 (next-buffers (window-next-buffers window))
2684 new-buffer entry killed-buffers visible)
2685 (when (window-dedicated-p window)
2686 (error "Window %s is dedicated to buffer %s" window old-buffer))
2687
2688 (catch 'found
2689 ;; Scan WINDOW's next buffers first.
2690 (dolist (buffer next-buffers)
2691 (when (and (or (buffer-live-p buffer)
2692 (not (setq killed-buffers
2693 (cons buffer killed-buffers))))
2694 (not (eq buffer old-buffer))
2695 (setq entry (assq buffer (window-prev-buffers window))))
2696 (setq new-buffer buffer)
2697 (set-window-buffer-start-and-point
2698 window new-buffer (nth 1 entry) (nth 2 entry))
2699 (throw 'found t)))
2700 ;; Scan the buffer list of WINDOW's frame next, skipping previous
2701 ;; buffers entries.
2702 (dolist (buffer (buffer-list (window-frame window)))
2703 (when (and (buffer-live-p buffer) (not (eq buffer old-buffer))
2704 (not (eq (aref (buffer-name buffer) 0) ?\s))
2705 (not (assq buffer (window-prev-buffers window))))
2706 (if (get-buffer-window buffer)
2707 ;; Try to avoid showing a buffer visible in some other window.
2708 (setq visible buffer)
2709 (setq new-buffer buffer)
2710 (set-window-buffer-start-and-point window new-buffer)
2711 (throw 'found t))))
2712 ;; Scan WINDOW's reverted previous buffers last (must not use
2713 ;; nreverse here!)
2714 (dolist (entry (reverse (window-prev-buffers window)))
2715 (when (and (setq new-buffer (car entry))
2716 (or (buffer-live-p new-buffer)
2717 (not (setq killed-buffers
2718 (cons new-buffer killed-buffers))))
2719 (not (eq new-buffer old-buffer)))
2720 (set-window-buffer-start-and-point
2721 window new-buffer (nth 1 entry) (nth 2 entry))
2722 (throw 'found t)))
2723
2724 ;; Show a buffer visible in another window.
2725 (when visible
2726 (setq new-buffer visible)
2727 (set-window-buffer-start-and-point window new-buffer)))
2728
2729 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
2730 (set-window-next-buffers window (delq new-buffer next-buffers))
2731
2732 ;; Remove killed buffers from WINDOW's previous and next buffers.
2733 (when killed-buffers
2734 (dolist (buffer killed-buffers)
2735 (set-window-prev-buffers
2736 window (assq-delete-all buffer (window-prev-buffers window)))
2737 (set-window-next-buffers
2738 window (delq buffer (window-next-buffers window)))))
2739
2740 ;; Return new-buffer.
2741 new-buffer))
2742
2743(defun get-next-valid-buffer (list &optional buffer visible-ok frame)
2744 "Search LIST for a valid buffer to display in FRAME.
2745Return nil when all buffers in LIST are undesirable for display,
2746otherwise return the first suitable buffer in LIST.
2747
2748Buffers not visible in windows are preferred to visible buffers,
2749unless VISIBLE-OK is non-nil.
2750If the optional argument FRAME is nil, it defaults to the selected frame.
2751If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
2752 ;; This logic is more or less copied from other-buffer.
2753 (setq frame (or frame (selected-frame)))
2754 (let ((pred (frame-parameter frame 'buffer-predicate))
2755 found buf)
2756 (while (and (not found) list)
2757 (setq buf (car list))
2758 (if (and (not (eq buffer buf))
2759 (buffer-live-p buf)
2760 (or (null pred) (funcall pred buf))
2761 (not (eq (aref (buffer-name buf) 0) ?\s))
2762 (or visible-ok (null (get-buffer-window buf 'visible))))
2763 (setq found buf)
2764 (setq list (cdr list))))
2765 (car list)))
2766
2767(defun last-buffer (&optional buffer visible-ok frame)
2768 "Return the last buffer in FRAME's buffer list.
2769If BUFFER is the last buffer, return the preceding buffer
2770instead. Buffers not visible in windows are preferred to visible
2771buffers, unless optional argument VISIBLE-OK is non-nil.
2772Optional third argument FRAME nil or omitted means use the
2773selected frame's buffer list. If no such buffer exists, return
2774the buffer `*scratch*', creating it if necessary."
2775 (setq frame (or frame (selected-frame)))
2776 (or (get-next-valid-buffer (nreverse (buffer-list frame))
2777 buffer visible-ok frame)
2778 (get-buffer "*scratch*")
2779 (let ((scratch (get-buffer-create "*scratch*")))
2780 (set-buffer-major-mode scratch)
2781 scratch)))
2782
2783(defun bury-buffer (&optional buffer-or-name)
2784 "Put BUFFER-OR-NAME at the end of the list of all buffers.
2785There it is the least likely candidate for `other-buffer' to
2786return; thus, the least likely buffer for \\[switch-to-buffer] to
2787select by default.
2788
2789You can specify a buffer name as BUFFER-OR-NAME, or an actual
2790buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
2791current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
2792remove the current buffer from the selected window if it is
2793displayed there."
2794 (interactive)
5386012d 2795 (let* ((buffer (window-normalize-buffer buffer-or-name)))
9397e56f
MR
2796 ;; If `buffer-or-name' is not on the selected frame we unrecord it
2797 ;; although it's not "here" (call it a feature).
2798 (unrecord-buffer buffer)
2799 ;; Handle case where `buffer-or-name' is nil and the current buffer
2800 ;; is shown in the selected window.
2801 (cond
2802 ((or buffer-or-name (not (eq buffer (window-buffer)))))
2803 ((not (window-dedicated-p))
2804 (switch-to-prev-buffer nil 'bury))
0e61a35f
SM
2805 ((and (frame-root-window-p (selected-window))
2806 ;; Don't iconify if it's the only frame.
2807 (not (eq (next-frame nil 0) (selected-frame))))
9397e56f
MR
2808 (iconify-frame (window-frame (selected-window))))
2809 ((window-deletable-p)
2810 (delete-window)))
2811 ;; Always return nil.
2812 nil))
2813
2814(defun unbury-buffer ()
2815 "Switch to the last buffer in the buffer list."
2816 (interactive)
2817 (switch-to-buffer (last-buffer)))
2818
2819(defun next-buffer ()
2820 "In selected window switch to next buffer."
2821 (interactive)
e14b388a
CY
2822 (if (window-minibuffer-p)
2823 (error "Cannot switch buffers in minibuffer window"))
9397e56f
MR
2824 (switch-to-next-buffer))
2825
2826(defun previous-buffer ()
2827 "In selected window switch to previous buffer."
2828 (interactive)
e14b388a
CY
2829 (if (window-minibuffer-p)
2830 (error "Cannot switch buffers in minibuffer window"))
9397e56f
MR
2831 (switch-to-prev-buffer))
2832
2833(defun delete-windows-on (&optional buffer-or-name frame)
2834 "Delete all windows showing BUFFER-OR-NAME.
2835BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2836and defaults to the current buffer.
2837
2838The following non-nil values of the optional argument FRAME
2839have special meanings:
2840
2841- t means consider all windows on the selected frame only.
2842
2843- `visible' means consider all windows on all visible frames on
2844 the current terminal.
2845
2846- 0 (the number zero) means consider all windows on all visible
2847 and iconified frames on the current terminal.
2848
2849- A frame means consider all windows on that frame only.
2850
2851Any other value of FRAME means consider all windows on all
2852frames.
2853
2854When a window showing BUFFER-OR-NAME is dedicated and the only
2855window of its frame, that frame is deleted when there are other
2856frames left."
2857 (interactive "BDelete windows on (buffer):\nP")
5386012d 2858 (let ((buffer (window-normalize-buffer buffer-or-name))
9397e56f
MR
2859 ;; Handle the "inverted" meaning of the FRAME argument wrt other
2860 ;; `window-list-1' based function.
2861 (all-frames (cond ((not frame) t) ((eq frame t) nil) (t frame))))
2862 (dolist (window (window-list-1 nil nil all-frames))
2863 (if (eq (window-buffer window) buffer)
2864 (let ((deletable (window-deletable-p window)))
2865 (cond
2866 ((eq deletable 'frame)
2867 ;; Delete frame.
2868 (delete-frame (window-frame window)))
2869 (deletable
2870 ;; Delete window only.
2871 (delete-window window))
2872 (t
2873 ;; In window switch to previous buffer.
2874 (set-window-dedicated-p window nil)
2875 (switch-to-prev-buffer window 'bury))))
2876 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
2877 (unrecord-window-buffer window buffer)))))
2878
2879(defun replace-buffer-in-windows (&optional buffer-or-name)
2880 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
2881BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2882and defaults to the current buffer.
2883
2884When a window showing BUFFER-OR-NAME is either dedicated, or the
2885window has no previous buffer, that window is deleted. If that
2886window is the only window on its frame, the frame is deleted too
2887when there are other frames left. If there are no other frames
2888left, some other buffer is displayed in that window.
2889
2890This function removes the buffer denoted by BUFFER-OR-NAME from
2891all window-local buffer lists."
5386012d 2892 (let ((buffer (window-normalize-buffer buffer-or-name)))
9397e56f
MR
2893 (dolist (window (window-list-1 nil nil t))
2894 (if (eq (window-buffer window) buffer)
2895 (let ((deletable (window-deletable-p window)))
2896 (cond
2897 ((eq deletable 'frame)
2898 ;; Delete frame.
2899 (delete-frame (window-frame window)))
2900 ((and (window-dedicated-p window) deletable)
2901 ;; Delete window.
2902 (delete-window window))
2903 (t
2904 ;; Switch to another buffer in window.
2905 (set-window-dedicated-p window nil)
2906 (switch-to-prev-buffer window 'kill))))
2907 ;; Unrecord BUFFER in WINDOW.
2908 (unrecord-window-buffer window buffer)))))
2909
2910(defun quit-restore-window (&optional window kill)
2911 "Quit WINDOW in some way.
2912WINDOW must be a live window and defaults to the selected window.
2913Return nil.
2914
2915According to information stored in WINDOW's `quit-restore' window
2916parameter either \(1) delete WINDOW and its frame, \(2) delete
2917WINDOW, \(3) restore the buffer previously displayed in WINDOW,
2918or \(4) make WINDOW display some other buffer than the present
2919one. If non-nil, reset `quit-restore' parameter to nil.
2920
2921Optional argument KILL non-nil means in addition kill WINDOW's
2922buffer. If KILL is nil, put WINDOW's buffer at the end of the
2923buffer list. Interactively, KILL is the prefix argument."
2924 (interactive "i\nP")
5386012d 2925 (setq window (window-normalize-live-window window))
9397e56f
MR
2926 (let ((buffer (window-buffer window))
2927 (quit-restore (window-parameter window 'quit-restore))
2928 deletable resize)
2929 (cond
2930 ((and (or (and (memq (car-safe quit-restore) '(new-window new-frame))
2931 ;; Check that WINDOW's buffer is still the same.
2932 (eq (window-buffer window) (nth 1 quit-restore)))
2933 (window-dedicated-p window))
2934 (setq deletable (window-deletable-p window)))
2935 ;; WINDOW can be deleted.
2936 (unrecord-buffer buffer)
2937 (if (eq deletable 'frame)
2938 ;; WINDOW's frame can be deleted.
2939 (delete-frame (window-frame window))
2940 ;; Just delete WINDOW.
2941 (delete-window window))
2942 ;; If the previously selected window is still alive, select it.
2943 (when (window-live-p (nth 2 quit-restore))
2944 (select-window (nth 2 quit-restore))))
2945 ((and (buffer-live-p (nth 0 quit-restore))
2946 ;; The buffer currently shown in WINDOW must still be the
2947 ;; buffer shown when its `quit-restore' parameter was created
2948 ;; in the first place.
2949 (eq (window-buffer window) (nth 3 quit-restore)))
2950 (setq resize (with-current-buffer buffer temp-buffer-resize-mode))
2951 ;; Unrecord buffer.
2952 (unrecord-buffer buffer)
2953 (unrecord-window-buffer window buffer)
2954 ;; Display buffer stored in the quit-restore parameter.
2955 (set-window-dedicated-p window nil)
2956 (set-window-buffer window (nth 0 quit-restore))
2957 (set-window-start window (nth 1 quit-restore))
2958 (set-window-point window (nth 2 quit-restore))
2959 (when (and resize (/= (nth 4 quit-restore) (window-total-size window)))
d615d6d2 2960 (window-resize
9397e56f
MR
2961 window (- (nth 4 quit-restore) (window-total-size window))))
2962 ;; Reset the quit-restore parameter.
2963 (set-window-parameter window 'quit-restore nil)
2964 (when (window-live-p (nth 5 quit-restore))
2965 (select-window (nth 5 quit-restore))))
2966 (t
2967 ;; Otherwise, show another buffer in WINDOW and reset the
2968 ;; quit-restore parameter.
2969 (set-window-parameter window 'quit-restore nil)
2970 (unrecord-buffer buffer)
2971 (switch-to-prev-buffer window 'bury-or-kill)))
2972
2973 ;; Kill WINDOW's old-buffer if requested
2974 (when kill (kill-buffer buffer))
2975 nil))
562dd5e9
MR
2976\f
2977;;; Splitting windows.
2978(defsubst window-split-min-size (&optional horizontal)
2979 "Return minimum height of any window when splitting windows.
2980Optional argument HORIZONTAL non-nil means return minimum width."
2981 (if horizontal
2982 (max window-min-width window-safe-min-width)
2983 (max window-min-height window-safe-min-height)))
2984
2985(defun split-window (&optional window size side)
2986 "Make a new window adjacent to WINDOW.
2987WINDOW can be any window and defaults to the selected one.
2988Return the new window which is always a live window.
2989
2990Optional argument SIZE a positive number means make WINDOW SIZE
2991lines or columns tall. If SIZE is negative, make the new window
2992-SIZE lines or columns tall. If and only if SIZE is non-nil, its
2993absolute value can be less than `window-min-height' or
2994`window-min-width'; so this command can make a new window as
2995small as one line or two columns. SIZE defaults to half of
2996WINDOW's size. Interactively, SIZE is the prefix argument.
2997
2998Optional third argument SIDE nil (or `below') specifies that the
2999new window shall be located below WINDOW. SIDE `above' means the
3000new window shall be located above WINDOW. In both cases SIZE
3001specifies the new number of lines for WINDOW \(or the new window
3002if SIZE is negative) including space reserved for the mode and/or
3003header line.
3004
3005SIDE t (or `right') specifies that the new window shall be
3006located on the right side of WINDOW. SIDE `left' means the new
3007window shall be located on the left of WINDOW. In both cases
3008SIZE specifies the new number of columns for WINDOW \(or the new
3009window provided SIZE is negative) including space reserved for
3010fringes and the scrollbar or a divider column. Any other non-nil
3011value for SIDE is currently handled like t (or `right').
3012
3013If the variable `ignore-window-parameters' is non-nil or the
3014`split-window' parameter of WINDOW equals t, do not process any
3015parameters of WINDOW. Otherwise, if the `split-window' parameter
3016of WINDOW specifies a function, call that function with all three
3017arguments and return the value returned by that function.
3018
3019Otherwise, if WINDOW is part of an atomic window, \"split\" the
3020root of that atomic window. The new window does not become a
3021member of that atomic window.
3022
3023If WINDOW is live, properties of the new window like margins and
3024scrollbars are inherited from WINDOW. If WINDOW is an internal
3025window, these properties as well as the buffer displayed in the
3026new window are inherited from the window selected on WINDOW's
3027frame. The selected window is not changed by this function."
3028 (interactive "i")
5386012d 3029 (setq window (window-normalize-any-window window))
130e3e11
MR
3030 (let* ((side (cond
3031 ((not side) 'below)
3032 ((memq side '(below above right left)) side)
3033 (t 'right)))
3034 (horizontal (not (memq side '(nil below above))))
562dd5e9
MR
3035 (frame (window-frame window))
3036 (parent (window-parent window))
3037 (function (window-parameter window 'split-window))
3038 (window-side (window-parameter window 'window-side))
3039 ;; Rebind `window-nest' since in some cases we may have to
3040 ;; override its value.
3041 (window-nest window-nest)
3042 atom-root)
3043
3044 (window-check frame)
3045 (catch 'done
3046 (cond
3047 ;; Ignore window parameters if either `ignore-window-parameters'
3048 ;; is t or the `split-window' parameter equals t.
3049 ((or ignore-window-parameters (eq function t)))
3050 ((functionp function)
3051 ;; The `split-window' parameter specifies the function to call.
3052 ;; If that function is `ignore', do nothing.
3053 (throw 'done (funcall function window size side)))
3054 ;; If WINDOW is a subwindow of an atomic window, split the root
3055 ;; window of that atomic window instead.
3056 ((and (window-parameter window 'window-atom)
3057 (setq atom-root (window-atom-root window))
3058 (not (eq atom-root window)))
3059 (throw 'done (split-window atom-root size side))))
3060
3061 (when (and window-side
3062 (or (not parent)
3063 (not (window-parameter parent 'window-side))))
3064 ;; WINDOW is a side root window. To make sure that a new parent
3065 ;; window gets created set `window-nest' to t.
3066 (setq window-nest t))
3067
3068 (when (and window-splits size (> size 0))
3069 ;; If `window-splits' is non-nil and SIZE is a non-negative
3070 ;; integer, we cannot reasonably resize other windows. Rather
3071 ;; bind `window-nest' to t to make sure that subsequent window
3072 ;; deletions are handled correctly.
3073 (setq window-nest t))
3074
3075 (let* ((parent-size
3076 ;; `parent-size' is the size of WINDOW's parent, provided
3077 ;; it has one.
3078 (when parent (window-total-size parent horizontal)))
3079 ;; `resize' non-nil means we are supposed to resize other
3080 ;; windows in WINDOW's combination.
3081 (resize
3082 (and window-splits (not window-nest)
3083 ;; Resize makes sense in iso-combinations only.
3084 (window-iso-combined-p window horizontal)))
3085 ;; `old-size' is the current size of WINDOW.
3086 (old-size (window-total-size window horizontal))
3087 ;; `new-size' is the specified or calculated size of the
3088 ;; new window.
3089 (new-size
3090 (cond
3091 ((not size)
3092 (max (window-split-min-size horizontal)
3093 (if resize
3094 ;; When resizing try to give the new window the
3095 ;; average size of a window in its combination.
3096 (min (- parent-size
3097 (window-min-size parent horizontal))
3098 (/ parent-size
3099 (1+ (window-iso-combinations
3100 parent horizontal))))
3101 ;; Else try to give the new window half the size
3102 ;; of WINDOW (plus an eventual odd line).
3103 (+ (/ old-size 2) (% old-size 2)))))
3104 ((>= size 0)
3105 ;; SIZE non-negative specifies the new size of WINDOW.
3106
3107 ;; Note: Specifying a non-negative SIZE is practically
3108 ;; always done as workaround for making the new window
3109 ;; appear above or on the left of the new window (the
3110 ;; ispell window is a typical example of that). In all
3111 ;; these cases the SIDE argument should be set to 'above
3112 ;; or 'left in order to support the 'resize option.
3113 ;; Here we have to nest the windows instead, see above.
3114 (- old-size size))
3115 (t
3116 ;; SIZE negative specifies the size of the new window.
3117 (- size))))
3118 new-parent new-normal)
3119
3120 ;; Check SIZE.
3121 (cond
3122 ((not size)
3123 (cond
3124 (resize
3125 ;; SIZE unspecified, resizing.
3126 (when (and (not (window-sizable-p parent (- new-size) horizontal))
3127 ;; Try again with minimum split size.
3128 (setq new-size
3129 (max new-size (window-split-min-size horizontal)))
3130 (not (window-sizable-p parent (- new-size) horizontal)))
3131 (error "Window %s too small for splitting" parent)))
3132 ((> (+ new-size (window-min-size window horizontal)) old-size)
3133 ;; SIZE unspecified, no resizing.
3134 (error "Window %s too small for splitting" window))))
3135 ((and (>= size 0)
3136 (or (>= size old-size)
3137 (< new-size (if horizontal
3138 window-safe-min-width
3139 window-safe-min-width))))
3140 ;; SIZE specified as new size of old window. If the new size
3141 ;; is larger than the old size or the size of the new window
3142 ;; would be less than the safe minimum, signal an error.
3143 (error "Window %s too small for splitting" window))
3144 (resize
3145 ;; SIZE specified, resizing.
3146 (unless (window-sizable-p parent (- new-size) horizontal)
3147 ;; If we cannot resize the parent give up.
3148 (error "Window %s too small for splitting" parent)))
3149 ((or (< new-size
3150 (if horizontal window-safe-min-width window-safe-min-height))
3151 (< (- old-size new-size)
3152 (if horizontal window-safe-min-width window-safe-min-height)))
3153 ;; SIZE specification violates minimum size restrictions.
3154 (error "Window %s too small for splitting" window)))
3155
5386012d 3156 (window--resize-reset frame horizontal)
562dd5e9
MR
3157
3158 (setq new-parent
3159 ;; Make new-parent non-nil if we need a new parent window;
3160 ;; either because we want to nest or because WINDOW is not
3161 ;; iso-combined.
3162 (or window-nest (not (window-iso-combined-p window horizontal))))
3163 (setq new-normal
3164 ;; Make new-normal the normal size of the new window.
3165 (cond
3166 (size (/ (float new-size) (if new-parent old-size parent-size)))
3167 (new-parent 0.5)
3168 (resize (/ 1.0 (1+ (window-iso-combinations parent horizontal))))
3169 (t (/ (window-normal-size window horizontal) 2.0))))
3170
3171 (if resize
3172 ;; Try to get space from OLD's siblings. We could go "up" and
3173 ;; try getting additional space from surrounding windows but
3174 ;; we won't be able to return space to those windows when we
3175 ;; delete the one we create here. Hence we do not go up.
3176 (progn
5386012d 3177 (window--resize-subwindows parent (- new-size) horizontal)
562dd5e9
MR
3178 (let* ((normal (- 1.0 new-normal))
3179 (sub (window-child parent)))
3180 (while sub
3181 (set-window-new-normal
3182 sub (* (window-normal-size sub horizontal) normal))
3183 (setq sub (window-right sub)))))
3184 ;; Get entire space from WINDOW.
3185 (set-window-new-total window (- old-size new-size))
5386012d 3186 (window--resize-this-window window (- new-size) horizontal)
562dd5e9
MR
3187 (set-window-new-normal
3188 window (- (if new-parent 1.0 (window-normal-size window horizontal))
3189 new-normal)))
3190
3191 (let* ((new (split-window-internal window new-size side new-normal)))
3192 ;; Inherit window-side parameters, if any.
3193 (when (and window-side new-parent)
3194 (set-window-parameter (window-parent new) 'window-side window-side)
3195 (set-window-parameter new 'window-side window-side))
3196
3197 (run-window-configuration-change-hook frame)
3198 (window-check frame)
3199 ;; Always return the new window.
3200 new)))))
3201
3202;; I think this should be the default; I think people will prefer it--rms.
3203(defcustom split-window-keep-point t
3204 "If non-nil, \\[split-window-above-each-other] keeps the original point \
3205in both children.
3206This is often more convenient for editing.
3207If nil, adjust point in each of the two windows to minimize redisplay.
3208This is convenient on slow terminals, but point can move strangely.
3209
3210This option applies only to `split-window-above-each-other' and
3211functions that call it. `split-window' always keeps the original
3212point in both children."
3213 :type 'boolean
3214 :group 'windows)
3215
3216(defun split-window-above-each-other (&optional size)
3217 "Split selected window into two windows, one above the other.
3218The upper window gets SIZE lines and the lower one gets the rest.
3219SIZE negative means the lower window gets -SIZE lines and the
3220upper one the rest. With no argument, split windows equally or
3221close to it. Both windows display the same buffer, now current.
3222
3223If the variable `split-window-keep-point' is non-nil, both new
3224windows will get the same value of point as the selected window.
3225This is often more convenient for editing. The upper window is
3226the selected window.
3227
3228Otherwise, we choose window starts so as to minimize the amount of
3229redisplay; this is convenient on slow terminals. The new selected
3230window is the one that the current value of point appears in. The
3231value of point can change if the text around point is hidden by the
3232new mode line.
3233
3234Regardless of the value of `split-window-keep-point', the upper
3235window is the original one and the return value is the new, lower
3236window."
3237 (interactive "P")
3238 (let ((old-window (selected-window))
3239 (old-point (point))
3240 (size (and size (prefix-numeric-value size)))
3241 moved-by-window-height moved new-window bottom)
3242 (when (and size (< size 0) (< (- size) window-min-height))
3243 ;; `split-window' would not signal an error here.
3244 (error "Size of new window too small"))
3245 (setq new-window (split-window nil size))
3246 (unless split-window-keep-point
3247 (with-current-buffer (window-buffer)
3248 (goto-char (window-start))
3249 (setq moved (vertical-motion (window-height)))
3250 (set-window-start new-window (point))
3251 (when (> (point) (window-point new-window))
3252 (set-window-point new-window (point)))
3253 (when (= moved (window-height))
3254 (setq moved-by-window-height t)
3255 (vertical-motion -1))
3256 (setq bottom (point)))
3257 (and moved-by-window-height
3258 (<= bottom (point))
3259 (set-window-point old-window (1- bottom)))
3260 (and moved-by-window-height
3261 (<= (window-start new-window) old-point)
3262 (set-window-point new-window old-point)
3263 (select-window new-window)))
9397e56f
MR
3264 ;; Always copy quit-restore parameter in interactive use.
3265 (let ((quit-restore (window-parameter old-window 'quit-restore)))
3266 (when quit-restore
3267 (set-window-parameter new-window 'quit-restore quit-restore)))
3268 new-window))
562dd5e9
MR
3269
3270(defalias 'split-window-vertically 'split-window-above-each-other)
3271
562dd5e9
MR
3272(defun split-window-side-by-side (&optional size)
3273 "Split selected window into two windows side by side.
3274The selected window becomes the left one and gets SIZE columns.
3275SIZE negative means the right window gets -SIZE lines.
3276
3277SIZE includes the width of the window's scroll bar; if there are
3278no scroll bars, it includes the width of the divider column to
3279the window's right, if any. SIZE omitted or nil means split
3280window equally.
3281
3282The selected window remains selected. Return the new window."
3283 (interactive "P")
3284 (let ((old-window (selected-window))
3285 (size (and size (prefix-numeric-value size)))
3286 new-window)
3287 (when (and size (< size 0) (< (- size) window-min-width))
3288 ;; `split-window' would not signal an error here.
3289 (error "Size of new window too small"))
9397e56f
MR
3290 (setq new-window (split-window nil size t))
3291 ;; Always copy quit-restore parameter in interactive use.
3292 (let ((quit-restore (window-parameter old-window 'quit-restore)))
3293 (when quit-restore
3294 (set-window-parameter new-window 'quit-restore quit-restore)))
3295 new-window))
562dd5e9
MR
3296
3297(defalias 'split-window-horizontally 'split-window-side-by-side)
3298\f
6198ccd0
MR
3299;;; Balancing windows.
3300
3301;; The following routine uses the recycled code from an old version of
5386012d
MR
3302;; `window--resize-subwindows'. It's not very pretty, but coding it the way the
3303;; new `window--resize-subwindows' code does would hardly make it any shorter or
6198ccd0
MR
3304;; more readable (FWIW we'd need three loops - one to calculate the
3305;; minimum sizes per window, one to enlarge or shrink windows until the
3306;; new parent-size matches, and one where we shrink the largest/enlarge
3307;; the smallest window).
3308(defun balance-windows-2 (window horizontal)
3309 "Subroutine of `balance-windows-1'.
3310WINDOW must be an iso-combination."
3311 (let* ((first (window-child window))
3312 (sub first)
3313 (number-of-children 0)
3314 (parent-size (window-new-total window))
3315 (total-sum parent-size)
3316 found failed size sub-total sub-delta sub-amount rest)
3317 (while sub
3318 (setq number-of-children (1+ number-of-children))
3319 (when (window-size-fixed-p sub horizontal)
3320 (setq total-sum
3321 (- total-sum (window-total-size sub horizontal)))
3322 (set-window-new-normal sub 'ignore))
3323 (setq sub (window-right sub)))
3c448ab6 3324
6198ccd0
MR
3325 (setq failed t)
3326 (while (and failed (> number-of-children 0))
3327 (setq size (/ total-sum number-of-children))
3328 (setq failed nil)
3329 (setq sub first)
3330 (while (and sub (not failed))
3331 ;; Ignore subwindows that should be ignored or are stuck.
5386012d 3332 (unless (window--resize-subwindows-skip-p sub)
6198ccd0
MR
3333 (setq found t)
3334 (setq sub-total (window-total-size sub horizontal))
3335 (setq sub-delta (- size sub-total))
3336 (setq sub-amount
3337 (window-sizable sub sub-delta horizontal))
3338 ;; Register the new total size for this subwindow.
3339 (set-window-new-total sub (+ sub-total sub-amount))
3340 (unless (= sub-amount sub-delta)
3341 (setq total-sum (- total-sum sub-total sub-amount))
3342 (setq number-of-children (1- number-of-children))
3343 ;; We failed and need a new round.
3344 (setq failed t)
3345 (set-window-new-normal sub 'skip)))
3346 (setq sub (window-right sub))))
3c448ab6 3347
6198ccd0
MR
3348 (setq rest (% total-sum number-of-children))
3349 ;; Fix rounding by trying to enlarge non-stuck windows by one line
3350 ;; (column) until `rest' is zero.
3351 (setq sub first)
3352 (while (and sub (> rest 0))
5386012d 3353 (unless (window--resize-subwindows-skip-p window)
6198ccd0
MR
3354 (set-window-new-total sub 1 t)
3355 (setq rest (1- rest)))
3356 (setq sub (window-right sub)))
3c448ab6 3357
6198ccd0
MR
3358 ;; Fix rounding by trying to enlarge stuck windows by one line
3359 ;; (column) until `rest' equals zero.
3360 (setq sub first)
3361 (while (and sub (> rest 0))
3362 (unless (eq (window-new-normal sub) 'ignore)
3363 (set-window-new-total sub 1 t)
3364 (setq rest (1- rest)))
3365 (setq sub (window-right sub)))
3366
3367 (setq sub first)
3368 (while sub
3369 ;; Record new normal sizes.
3370 (set-window-new-normal
3371 sub (/ (if (eq (window-new-normal sub) 'ignore)
3372 (window-total-size sub horizontal)
3373 (window-new-total sub))
3374 (float parent-size)))
3375 ;; Recursively balance each subwindow's subwindows.
3376 (balance-windows-1 sub horizontal)
3377 (setq sub (window-right sub)))))
3378
3379(defun balance-windows-1 (window &optional horizontal)
3380 "Subroutine of `balance-windows'."
3381 (if (window-child window)
3382 (let ((sub (window-child window)))
3383 (if (window-iso-combined-p sub horizontal)
3384 (balance-windows-2 window horizontal)
3385 (let ((size (window-new-total window)))
3386 (while sub
9173deec 3387 (set-window-new-total sub size)
6198ccd0
MR
3388 (balance-windows-1 sub horizontal)
3389 (setq sub (window-right sub))))))))
3390
3391(defun balance-windows (&optional window-or-frame)
3392 "Balance the sizes of subwindows of WINDOW-OR-FRAME.
3393WINDOW-OR-FRAME is optional and defaults to the selected frame.
3394If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
3395subwindows of that frame's root window. If WINDOW-OR-FRAME
3396denots a window, balance the sizes of all subwindows of that
3397window."
3398 (interactive)
3399 (let* ((window
3400 (cond
3401 ((or (not window-or-frame)
3402 (frame-live-p window-or-frame))
3403 (frame-root-window window-or-frame))
3404 ((or (window-live-p window-or-frame)
3405 (window-child window-or-frame))
3406 window-or-frame)
3407 (t
3408 (error "Not a window or frame %s" window-or-frame))))
3409 (frame (window-frame window)))
3410 ;; Balance vertically.
5386012d 3411 (window--resize-reset (window-frame window))
6198ccd0 3412 (balance-windows-1 window)
d615d6d2 3413 (window-resize-apply frame)
6198ccd0 3414 ;; Balance horizontally.
5386012d 3415 (window--resize-reset (window-frame window) t)
6198ccd0 3416 (balance-windows-1 window t)
d615d6d2 3417 (window-resize-apply frame t)))
3c448ab6
MR
3418
3419(defun window-fixed-size-p (&optional window direction)
3420 "Return t if WINDOW cannot be resized in DIRECTION.
3421WINDOW defaults to the selected window. DIRECTION can be
3422nil (i.e. any), `height' or `width'."
3423 (with-current-buffer (window-buffer window)
3424 (when (and (boundp 'window-size-fixed) window-size-fixed)
3425 (not (and direction
3426 (member (cons direction window-size-fixed)
3427 '((height . width) (width . height))))))))
3428
3429;;; A different solution to balance-windows.
3c448ab6
MR
3430(defvar window-area-factor 1
3431 "Factor by which the window area should be over-estimated.
3432This is used by `balance-windows-area'.
3433Changing this globally has no effect.")
3434(make-variable-buffer-local 'window-area-factor)
3435
6198ccd0 3436(defun balance-windows-area-adjust (window delta horizontal)
d615d6d2 3437 "Wrapper around `window-resize' with error checking.
6198ccd0 3438Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
d615d6d2 3439 ;; `window-resize' may fail if delta is too large.
6198ccd0
MR
3440 (while (>= (abs delta) 1)
3441 (condition-case nil
3442 (progn
d615d6d2 3443 (window-resize window delta horizontal)
6198ccd0
MR
3444 (setq delta 0))
3445 (error
3446 ;;(message "adjust: %s" (error-message-string err))
3447 (setq delta (/ delta 2))))))
3448
3c448ab6
MR
3449(defun balance-windows-area ()
3450 "Make all visible windows the same area (approximately).
3451See also `window-area-factor' to change the relative size of
3452specific buffers."
3453 (interactive)
3454 (let* ((unchanged 0) (carry 0) (round 0)
3455 ;; Remove fixed-size windows.
3456 (wins (delq nil (mapcar (lambda (win)
3457 (if (not (window-fixed-size-p win)) win))
3458 (window-list nil 'nomini))))
3459 (changelog nil)
3460 next)
3461 ;; Resizing a window changes the size of surrounding windows in complex
3462 ;; ways, so it's difficult to balance them all. The introduction of
3463 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
3464 ;; very difficult to do. `balance-window' above takes an off-line
3465 ;; approach: get the whole window tree, then balance it, then try to
3466 ;; adjust the windows so they fit the result.
3467 ;; Here, instead, we take a "local optimization" approach, where we just
3468 ;; go through all the windows several times until nothing needs to be
3469 ;; changed. The main problem with this approach is that it's difficult
3470 ;; to make sure it terminates, so we use some heuristic to try and break
3471 ;; off infinite loops.
3472 ;; After a round without any change, we allow a second, to give a chance
3473 ;; to the carry to propagate a minor imbalance from the end back to
3474 ;; the beginning.
3475 (while (< unchanged 2)
3476 ;; (message "New round")
3477 (setq unchanged (1+ unchanged) round (1+ round))
3478 (dolist (win wins)
3479 (setq next win)
3480 (while (progn (setq next (next-window next))
3481 (window-fixed-size-p next)))
3482 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
3483 (let* ((horiz
3484 (< (car (window-edges win)) (car (window-edges next))))
3485 (areadiff (/ (- (* (window-height next) (window-width next)
3486 (buffer-local-value 'window-area-factor
3487 (window-buffer next)))
3488 (* (window-height win) (window-width win)
3489 (buffer-local-value 'window-area-factor
3490 (window-buffer win))))
3491 (max (buffer-local-value 'window-area-factor
3492 (window-buffer win))
3493 (buffer-local-value 'window-area-factor
3494 (window-buffer next)))))
3495 (edgesize (if horiz
3496 (+ (window-height win) (window-height next))
3497 (+ (window-width win) (window-width next))))
3498 (diff (/ areadiff edgesize)))
3499 (when (zerop diff)
3500 ;; Maybe diff is actually closer to 1 than to 0.
3501 (setq diff (/ (* 3 areadiff) (* 2 edgesize))))
3502 (when (and (zerop diff) (not (zerop areadiff)))
3503 (setq diff (/ (+ areadiff carry) edgesize))
3504 ;; Change things smoothly.
3505 (if (or (> diff 1) (< diff -1)) (setq diff (/ diff 2))))
3506 (if (zerop diff)
3507 ;; Make sure negligible differences don't accumulate to
3508 ;; become significant.
3509 (setq carry (+ carry areadiff))
6198ccd0 3510 ;; This used `adjust-window-trailing-edge' before and uses
d615d6d2 3511 ;; `window-resize' now. Error wrapping is still needed.
6198ccd0 3512 (balance-windows-area-adjust win diff horiz)
3c448ab6
MR
3513 ;; (sit-for 0.5)
3514 (let ((change (cons win (window-edges win))))
3515 ;; If the same change has been seen already for this window,
3516 ;; we're most likely in an endless loop, so don't count it as
3517 ;; a change.
3518 (unless (member change changelog)
3519 (push change changelog)
3520 (setq unchanged 0 carry 0)))))))
3521 ;; We've now basically balanced all the windows.
3522 ;; But there may be some minor off-by-one imbalance left over,
3523 ;; so let's do some fine tuning.
3524 ;; (bw-finetune wins)
3525 ;; (message "Done in %d rounds" round)
3526 ))
9d89fec7
MR
3527
3528;;; Window states, how to get them and how to put them in a window.
3529(defsubst window-list-no-nils (&rest args)
3530 "Like LIST but do not add nil elements of ARGS."
3531 (delq nil (apply 'list args)))
3532
3533(defvar window-state-ignored-parameters '(quit-restore)
3534 "List of window parameters ignored by `window-state-get'.")
3535
3536(defun window-state-get-1 (window &optional markers)
3537 "Helper function for `window-state-get'."
3538 (let* ((type
3539 (cond
d68443dc
MR
3540 ((window-top-child window) 'vc)
3541 ((window-left-child window) 'hc)
9d89fec7
MR
3542 (t 'leaf)))
3543 (buffer (window-buffer window))
3544 (selected (eq window (selected-window)))
3545 (head
3546 (window-list-no-nils
3547 type
d68443dc 3548 (unless (window-next-sibling window) (cons 'last t))
9d89fec7
MR
3549 (cons 'total-height (window-total-size window))
3550 (cons 'total-width (window-total-size window t))
3551 (cons 'normal-height (window-normal-size window))
3552 (cons 'normal-width (window-normal-size window t))
3553 (cons 'splits (window-splits window))
3554 (cons 'nest (window-nest window))
3555 (let (list)
3556 (dolist (parameter (window-parameters window))
3557 (unless (memq (car parameter)
3558 window-state-ignored-parameters)
3559 (setq list (cons parameter list))))
28545e04
MR
3560 (unless (window-parameter window 'clone-of)
3561 ;; Make a clone-of parameter.
3562 (setq list (cons (cons 'clone-of window) list)))
9d89fec7
MR
3563 (when list
3564 (cons 'parameters list)))
3565 (when buffer
3566 ;; All buffer related things go in here - make the buffer
3567 ;; current when retrieving `point' and `mark'.
3568 (with-current-buffer (window-buffer window)
3569 (let ((point (if selected (point) (window-point window)))
3570 (start (window-start window))
3571 (mark (mark)))
3572 (window-list-no-nils
3573 'buffer (buffer-name buffer)
3574 (cons 'selected selected)
3575 (when window-size-fixed (cons 'size-fixed window-size-fixed))
3576 (cons 'hscroll (window-hscroll window))
3577 (cons 'fringes (window-fringes window))
3578 (cons 'margins (window-margins window))
3579 (cons 'scroll-bars (window-scroll-bars window))
3580 (cons 'vscroll (window-vscroll window))
3581 (cons 'dedicated (window-dedicated-p window))
3582 (cons 'point (if markers (copy-marker point) point))
3583 (cons 'start (if markers (copy-marker start) start))
3584 (when mark
3585 (cons 'mark (if markers (copy-marker mark) mark)))))))))
3586 (tail
3587 (when (memq type '(vc hc))
3588 (let (list)
3589 (setq window (window-child window))
3590 (while window
3591 (setq list (cons (window-state-get-1 window markers) list))
3592 (setq window (window-right window)))
3593 (nreverse list)))))
3594 (append head tail)))
3595
3596(defun window-state-get (&optional window markers)
3597 "Return state of WINDOW as a Lisp object.
3598WINDOW can be any window and defaults to the root window of the
3599selected frame.
3600
3601Optional argument MARKERS non-nil means use markers for sampling
3602positions like `window-point' or `window-start'. MARKERS should
3603be non-nil only if the value is used for putting the state back
3604in the same session (note that markers slow down processing).
3605
3606The return value can be used as argument for `window-state-put'
3607to put the state recorded here into an arbitrary window. The
3608value can be also stored on disk and read back in a new session."
3609 (setq window
3610 (if window
3611 (if (window-any-p window)
3612 window
3613 (error "%s is not a live or internal window" window))
3614 (frame-root-window)))
3615 ;; The return value is a cons whose car specifies some constraints on
3616 ;; the size of WINDOW. The cdr lists the states of the subwindows of
3617 ;; WINDOW.
3618 (cons
3619 ;; Frame related things would go into a function, say `frame-state',
3620 ;; calling `window-state-get' to insert the frame's root window.
3621 (window-list-no-nils
3622 (cons 'min-height (window-min-size window))
3623 (cons 'min-width (window-min-size window t))
3624 (cons 'min-height-ignore (window-min-size window nil t))
3625 (cons 'min-width-ignore (window-min-size window t t))
3626 (cons 'min-height-safe (window-min-size window nil 'safe))
3627 (cons 'min-width-safe (window-min-size window t 'safe))
3628 ;; These are probably not needed.
3629 (when (window-size-fixed-p window) (cons 'fixed-height t))
3630 (when (window-size-fixed-p window t) (cons 'fixed-width t)))
3631 (window-state-get-1 window markers)))
3632
3633(defvar window-state-put-list nil
3634 "Helper variable for `window-state-put'.")
3635
3636(defun window-state-put-1 (state &optional window ignore totals)
3637 "Helper function for `window-state-put'."
3638 (let ((type (car state)))
3639 (setq state (cdr state))
3640 (cond
3641 ((eq type 'leaf)
3642 ;; For a leaf window just add unprocessed entries to
3643 ;; `window-state-put-list'.
3644 (setq window-state-put-list
3645 (cons (cons window state) window-state-put-list)))
3646 ((memq type '(vc hc))
3647 (let* ((horizontal (eq type 'hc))
3648 (total (window-total-size window horizontal))
3649 (first t)
3650 size new)
3651 (dolist (item state)
3652 ;; Find the next child window. WINDOW always points to the
3653 ;; real window that we want to fill with what we find here.
3654 (when (memq (car item) '(leaf vc hc))
3655 (if (assq 'last item)
3656 ;; The last child window. Below `window-state-put-1'
3657 ;; will put into it whatever ITEM has in store.
3658 (setq new nil)
3659 ;; Not the last child window, prepare for splitting
3660 ;; WINDOW. SIZE is the new (and final) size of the old
3661 ;; window.
3662 (setq size
3663 (if totals
3664 ;; Use total size.
3665 (cdr (assq (if horizontal 'total-width 'total-height) item))
3666 ;; Use normalized size and round.
3667 (round (* total
3668 (cdr (assq
3669 (if horizontal 'normal-width 'normal-height)
3670 item))))))
3671
3672 ;; Use safe sizes, we try to resize later.
3673 (setq size (max size (if horizontal
3674 window-safe-min-height
3675 window-safe-min-width)))
3676
3677 (if (window-sizable-p window (- size) horizontal 'safe)
3678 (let* ((window-nest (assq 'nest item)))
3679 ;; We must inherit the nesting, otherwise we might mess
3680 ;; up handling of atomic and side window.
3681 (setq new (split-window window size horizontal)))
3682 ;; Give up if we can't resize window down to safe sizes.
3683 (error "Cannot resize window %s" window))
3684
3685 (when first
3686 (setq first nil)
3687 ;; When creating the first child window add for parent
3688 ;; unprocessed entries to `window-state-put-list'.
3689 (setq window-state-put-list
3690 (cons (cons (window-parent window) state)
3691 window-state-put-list))))
3692
3693 ;; Now process the current window (either the one we've just
3694 ;; split or the last child of its parent).
3695 (window-state-put-1 item window ignore totals)
3696 ;; Continue with the last window split off.
3697 (setq window new))))))))
3698
3699(defun window-state-put-2 (ignore)
3700 "Helper function for `window-state-put'."
3701 (dolist (item window-state-put-list)
3702 (let ((window (car item))
9d89fec7
MR
3703 (splits (cdr (assq 'splits item)))
3704 (nest (cdr (assq 'nest item)))
3705 (parameters (cdr (assq 'parameters item)))
3706 (state (cdr (assq 'buffer item))))
9d89fec7
MR
3707 (when splits (set-window-splits window splits))
3708 (when nest (set-window-nest window nest))
3709 ;; Process parameters.
3710 (when parameters
3711 (dolist (parameter parameters)
3712 (set-window-parameter window (car parameter) (cdr parameter))))
3713 ;; Process buffer related state.
3714 (when state
3715 ;; We don't want to raise an error here so we create a buffer if
3716 ;; there's none.
3717 (set-window-buffer window (get-buffer-create (car state)))
3718 (with-current-buffer (window-buffer window)
3719 (set-window-hscroll window (cdr (assq 'hscroll state)))
3720 (apply 'set-window-fringes
3721 (cons window (cdr (assq 'fringes state))))
3722 (let ((margins (cdr (assq 'margins state))))
3723 (set-window-margins window (car margins) (cdr margins)))
3724 (let ((scroll-bars (cdr (assq 'scroll-bars state))))
3725 (set-window-scroll-bars
3726 window (car scroll-bars) (nth 2 scroll-bars) (nth 3 scroll-bars)))
3727 (set-window-vscroll window (cdr (assq 'vscroll state)))
3728 ;; Adjust vertically.
3729 (if (memq window-size-fixed '(t height))
3730 ;; A fixed height window, try to restore the original size.
3731 (let ((delta (- (cdr (assq 'total-height item))
3732 (window-total-height window)))
3733 window-size-fixed)
3734 (when (window-resizable-p window delta)
d615d6d2 3735 (window-resize window delta)))
9d89fec7
MR
3736 ;; Else check whether the window is not high enough.
3737 (let* ((min-size (window-min-size window nil ignore))
3738 (delta (- min-size (window-total-size window))))
3739 (when (and (> delta 0)
3740 (window-resizable-p window delta nil ignore))
d615d6d2 3741 (window-resize window delta nil ignore))))
9d89fec7
MR
3742 ;; Adjust horizontally.
3743 (if (memq window-size-fixed '(t width))
3744 ;; A fixed width window, try to restore the original size.
3745 (let ((delta (- (cdr (assq 'total-width item))
3746 (window-total-width window)))
3747 window-size-fixed)
3748 (when (window-resizable-p window delta)
d615d6d2 3749 (window-resize window delta)))
9d89fec7
MR
3750 ;; Else check whether the window is not wide enough.
3751 (let* ((min-size (window-min-size window t ignore))
3752 (delta (- min-size (window-total-size window t))))
3753 (when (and (> delta 0)
3754 (window-resizable-p window delta t ignore))
d615d6d2 3755 (window-resize window delta t ignore))))
9d89fec7
MR
3756 ;; Set dedicated status.
3757 (set-window-dedicated-p window (cdr (assq 'dedicated state)))
3758 ;; Install positions (maybe we should do this after all windows
3759 ;; have been created and sized).
3760 (ignore-errors
3761 (set-window-start window (cdr (assq 'start state)))
3762 (set-window-point window (cdr (assq 'point state)))
3763 ;; I'm not sure whether we should set the mark here, but maybe
3764 ;; it can be used.
3765 (let ((mark (cdr (assq 'mark state))))
3766 (when mark (set-mark mark))))
3767 ;; Select window if it's the selected one.
3768 (when (cdr (assq 'selected state))
3769 (select-window window)))))))
3770
3771(defun window-state-put (state &optional window ignore)
3772 "Put window state STATE into WINDOW.
3773STATE should be the state of a window returned by an earlier
3774invocation of `window-state-get'. Optional argument WINDOW must
3775specify a live window and defaults to the selected one.
3776
3777Optional argument IGNORE non-nil means ignore minimum window
3778sizes and fixed size restrictions. IGNORE equal `safe' means
3779subwindows can get as small as `window-safe-min-height' and
3780`window-safe-min-width'."
5386012d 3781 (setq window (window-normalize-live-window window))
9d89fec7
MR
3782 (let* ((frame (window-frame window))
3783 (head (car state))
3784 ;; We check here (1) whether the total sizes of root window of
3785 ;; STATE and that of WINDOW are equal so we can avoid
3786 ;; calculating new sizes, and (2) if we do have to resize
3787 ;; whether we can do so without violating size restrictions.
3788 (totals
3789 (and (= (window-total-size window)
3790 (cdr (assq 'total-height state)))
3791 (= (window-total-size window t)
3792 (cdr (assq 'total-width state)))))
3793 (min-height (cdr (assq 'min-height head)))
3794 (min-width (cdr (assq 'min-width head)))
3795 window-splits selected)
3796 (if (and (not totals)
3797 (or (> min-height (window-total-size window))
3798 (> min-width (window-total-size window t)))
3799 (or (not ignore)
3800 (and (setq min-height
3801 (cdr (assq 'min-height-ignore head)))
3802 (setq min-width
3803 (cdr (assq 'min-width-ignore head)))
3804 (or (> min-height (window-total-size window))
3805 (> min-width (window-total-size window t)))
3806 (or (not (eq ignore 'safe))
3807 (and (setq min-height
3808 (cdr (assq 'min-height-safe head)))
3809 (setq min-width
3810 (cdr (assq 'min-width-safe head)))
3811 (or (> min-height
3812 (window-total-size window))
3813 (> min-width
3814 (window-total-size window t))))))))
3815 ;; The check above might not catch all errors due to rounding
3816 ;; issues - so IGNORE equal 'safe might not always produce the
3817 ;; minimum possible state. But such configurations hardly make
3818 ;; sense anyway.
3819 (error "Window %s too small to accomodate state" window)
3820 (setq state (cdr state))
3821 (setq window-state-put-list nil)
3822 ;; Work on the windows of a temporary buffer to make sure that
3823 ;; splitting proceeds regardless of any buffer local values of
3824 ;; `window-size-fixed'. Release that buffer after the buffers of
3825 ;; all live windows have been set by `window-state-put-2'.
3826 (with-temp-buffer
3827 (set-window-buffer window (current-buffer))
3828 (window-state-put-1 state window nil totals)
3829 (window-state-put-2 ignore))
3830 (window-check frame))))
9481c002 3831\f
9b9c9e3a 3832;;; Displaying buffers.
9481c002
MR
3833(defconst display-buffer-default-specifiers
3834 '((reuse-window nil same visible)
3835 (pop-up-window (largest . nil) (lru . nil))
be3fb2b8
MR
3836 (pop-up-window-min-height . 40)
3837 (pop-up-window-min-width . 80)
3838 (reuse-window other nil nil)
9481c002 3839 (reuse-window nil other visible)
be3fb2b8 3840 (reuse-window nil nil t)
9481c002
MR
3841 (reuse-window-even-sizes . t))
3842 "Buffer display default specifiers.
3843The value specified here is used when no other specifiers have
3844been specified by the user or the application. Consult the
3845documentation of `display-buffer-alist' for a description of
3846buffer display specifiers.")
3847
3848(defconst display-buffer-macro-specifiers
3849 '((same-window
3850 ;; Use the same window.
3851 (reuse-window same nil nil))
3852 (same-frame
3853 ;; Avoid other frames.
3854 (reuse-window nil same nil)
3855 (pop-up-window (largest . nil) (lru . nil))
3856 (reuse-window nil other nil))
25aef8b8
MR
3857 ;; (other-window
3858 ;; ;; Avoid selected window.
3859 ;; (reuse-window other same visible)
3860 ;; (pop-up-window (largest . nil) (lru . nil))
3861 ;; (reuse-window other other visible))
9481c002
MR
3862 (same-frame-other-window
3863 ;; Avoid other frames and selected window.
3864 (reuse-window other same nil)
3865 (pop-up-window (largest . nil) (lru . nil))
3866 (reuse-window other other nil))
3867 (other-frame
3868 ;; Avoid selected frame.
3869 (reuse-window nil same other)
3870 (pop-up-frame)
3871 (reuse-window nil other other))
3872 (default
3873 ;; The default specifiers.
3874 display-buffer-default-specifiers))
3875 "Buffer display macro specifiers.")
3876
3877(defcustom display-buffer-alist
3878 '((((regexp . ".*"))
327c8fb1
MR
3879 ;; Reuse window showing same buffer on same frame.
3880 reuse-window (reuse-window nil same nil)
25aef8b8 3881 ;; Pop up window.
9481c002 3882 pop-up-window
25aef8b8 3883 ;; Split largest or lru window.
9481c002 3884 (pop-up-window (largest . nil) (lru . nil))
25aef8b8
MR
3885 (pop-up-window-min-height . 40) ; split-height-threshold / 2
3886 (pop-up-window-min-width . 80) ; split-width-threshold / 2
3887 ;; Reuse any but selected window on same frame.
3888 reuse-window (reuse-window other nil nil)
9481c002
MR
3889 (reuse-window-even-sizes . t)))
3890 "List associating buffer identifiers with display specifiers.
3891The car of each element of this list is built from a set of cons
3892cells called buffer identifiers. `display-buffer' shows a buffer
3893according to the display specifiers in the element's cdr
3894\(elements are true lists) if at least one of the identifiers
3895matches the first or third argument of `display-buffer'. Such a
3896match occurs in one of the following three cases:
3897
3898- The car of the buffer identifier is the symbol `name' and its
3899 cdr is a string equalling the name of the buffer specified by
3900 the first \(BUFFER-OR-NAME) argument of `display-buffer'.
3901
3902- The car is the symbol `regexp' and the cdr is a regular
3903 expression matching the name of the buffer specified by the
3904 first \(BUFFER-OR-NAME) argument of `display-buffer'.
3905
3906- The car is the symbol `label' and the cdr is a symbol equalling
3907 the third \(LABEL) argument of `display-buffer'.
3908
3909Display specifiers are either symbols, cons cells, or lists.
3910Five specifiers have been reserved to indicate the basic method
3911for displaying the buffer: `reuse-window', `pop-up-window',
5386012d 3912`pop-up-frame', `use-side-window', and `function'.
9481c002
MR
3913
3914A list whose car is the symbol `reuse-window' indicates that an
3915existing window shall be reused for displaying the buffer. The
3916second element of this list specifies the window to use and can
3917be one of the following symbols:
3918
3919 nil stands for any window.
3920
3921 `same' stands for the selected window.
3922
3923 `other' stands for any but the selected window.
3924
3925The third element specifies whether the buffer shown in a window
3926that shall be reused must be the same buffer that shall be
3927displayed or another buffer and can be one of the following:
3928
3929 nil means to not care about the window's buffer.
3930
3931 `same' means the window must show the buffer already.
3932
3933 `other' means the window must not show the buffer yet.
3934
3935The fourth element specifies the set of frames to search for a
3936suitable window and can be one of the following:
3937
3938 nil to reuse a window on the selected frame.
3939
3940 `visible' to search visible frames on the current terminal.
3941
3942 `other' stands for any visible frame but the selected one.
3943
3944 0 \(the number zero) to search visible and iconified frames on
3945 the current terminal.
3946
3947 t to search arbitrary frames including invisible ones.
3948
3949If more than one window fits the constraints imposed by these
3950elements, the least recently used candidate is chosen. A side
3951window is never reused unless it already shows the buffer.
3952
3953The following two specifiers are useful when the method equals
3954`reuse-window':
3955
3956- A cons cell whose car is the symbol `reuse-window-even-sizes'
3957 and whose cdr is non-nil means to even out the sizes of a
3958 reused window and the selected window provided they (1) appear
3959 adjacent to each other and (2) the selected window is larger
3960 than the window chosen. If the cdr is nil, this means that the
3961 window sizes are left alone.
3962
3963- A cons cell whose car is the symbol `reuse-window-dedicated'
3964 and whose cdr is non-nil means that a window can be reused even
3965 if it's weakly dedicated to its buffer. If the cdr is t, a
3966 strongly dedicated window can be reused to show the buffer.
3967 Any other non-nil value means only weakly dedicated windows can
3968 be reused. If the cdr is nil, dedicated windows are not
3969 reused.
3970
3971 This specifier should be used in emergency cases only since
3972 windows are usually made dedicated in order to prevent
3973 `display-buffer' from reusing them.
3974
3975A list whose car is the symbol `pop-up-window' and whose cdr is
3976built from cons cells representing window/side tuples indicates
3977that a new window shall be made for displaying the buffer on the
3978selected frame.
3979
3980Window/side tuples are cons cells. The car of such a tuple
3981identifies the window that shall be split. Possible values are
3982`largest', `lru', `selected', and `root' to split the largest,
3983least recently used, selected or root window of the selected
3984frame.
3985
3986If the frame has side windows, these values do allow to split
3987only the selected frame's main window or one of its subwindows.
3988Setting the car to one of `left', `top', `right' and `bottom'
3989splits the corresponding side window, provided such a window
3990exists.
3991
3992The cdr of each pair specifies on which side of the window to
3993split the new window shall appear and can be one of `below',
3994`right', `above', or `left' with the obvious meanings. If the
3995cdr is nil, the window is split in a fashion suitable for its
3996current dimensions. If the cdr specifies a function, that
3997function is called with one argument - the window to split. The
3998function is supposed to split that window and return the new
3999window.
4000
4001`display-buffer' scans these tuples until it can either produce a
4002suitable window or fails. The default value for
4003`display-buffer-alist' contains the tuples \(largest . nil) and
4004\(lru . nil) in order to split the largest window first and, if
4005that fails, the least recently used one.
4006
4007The following specifiers are useful if the method specifier is
4008`pop-up-window'.
4009
4010- A cons cell whose car is the symbol `pop-up-window-min-height'
4011 specifiies the minimum height of the new window. If the cdr is
4012 an integer number, it specifies the minimum number of lines of
4013 the window. A floating point number gives the minimum fraction
4014 of the window height with respect to the height of the frame's
4015 root window. A new window is created only if it can be made at
4016 least as high as specified by the number. If the cdr is nil,
4017 this means to use the value of `window-min-height'.
4018
4019- A cons cell whose car is the symbol `pop-up-window-min-width'
4020 specifies the minimum width of the new window. If the cdr is
4021 an integer number, it specifies the minimum number of columns
4022 of the window. A floating point number gives the minimum
4023 fraction of the window width with respect to the width of the
4024 frame's root window. A new window is created only if it can be
4025 made at least as wide as specified by the number. If the cdr
4026 is nil, this means to use the value of `window-min-width'.
4027
4028- A cons cell whose car is `pop-up-window-set-height' with
4029 the following interpretations for the cdr:
4030
4031 - nil means leave the height of the new window alone.
4032
4033 - A number specifies the desired height of the new window. An
4034 integer number specifies the number of lines of the window.
4035 A floating point number gives the fraction of the window
4036 height with respect to the height of the frame's root window.
4037
4038 - If the cdr specifies a function, that function is called with
4039 one argument - the new window. The function is supposed to
4040 adjust the height of the window; its return value is ignored.
4041 Suitable functions are `shrink-window-if-larger-than-buffer'
4042 and `fit-window-to-buffer'.
4043
4044- A cons cell whose car equals `pop-up-window-set-width' with
4045 the following interpretations for the cdr:
4046
4047 - nil means leave the width of the new window alone.
4048
4049 - A number specifies the desired width of the new window. An
4050 integer number specifies the number of columns of the window.
4051 A floating point number gives the fraction of the window
4052 width with respect to the width of the frame's root window.
4053
4054 - If the cdr specifies a function, that function is called with
4055 one argument - the new window. The function is supposed to
4056 adjust the width of the window; its return value is ignored.
4057
4058 Observe that specifying `pop-up-window-set-height' or
4059 `pop-up-window-set-width' may override restrictions given by
4060 the `pop-up-window-min-height' and `pop-up-window-min-width'
4061 specifiers.
4062
4063- A cons cell whose car is `pop-up-window-split-unsplittable' and
4064 whose cdr is non-nil allows to make a new window on an
4065 unsplittable frame. If the cdr is nil, unsplittable frames are
4066 not split. This specifier should be used in special cases only
4067 since frames are usually made unsplittable in order to prevent
4068 `display-buffer' from splitting them.
4069
4070A list whose car is the symbol `pop-up-frame' specifies that a
4071new frame shall be made for displaying the buffer. The second
4072element, if non-nil, allows popping up a new frame on graphic
4073displays only.
4074
4075The following specifiers are useful if the method specifier is
4076`pop-up-frame'.
4077
4078- A list whose car is the symbol `pop-up-frame-function' together
4079 with a valid function as cdr specifies the function for
4080 creating a new frame. If the cdr is nil, the default function
4081 `make-frame' is called. The function is called with the
4082 parameters and values provided by the specifier described next.
4083
4084- A list whose car is the symbol `pop-up-frame-alist' followed by
4085 an arbitrary number of frame parameter/value tuples, each given
4086 as a cons cell, specifies the parameters passed to the pop-up
4087 frame function.
4088
4089A list of three elements whose car is the symbol
4090`use-side-window' specifies that the buffer shall be displayed in
4091a side window of the selected frame. The second element denotes
4092the side of the frame where the window appears or shall be made.
4093The third element denotes the slot used by the window. If a side
4094window with the specified slot exists already, that window is
4095reused. If no such window exists it is created.
4096
4097The following specifiers are useful in connection with the
4098`use-side-window' method specifier: `reuse-window-dedicated',
4099`pop-up-window-min-height', `pop-up-window-min-width',
4100`pop-up-window-set-height' and `pop-up-window-set-width'.
4101
5386012d 4102A list whose car is the symbol `function' specifies that the
9481c002
MR
4103function specified in the second element of the list is
4104responsible for displaying the buffer. `display-buffer' calls
4105this function with the buffer as first argument and the remaining
28545e04 4106elements of the list as the second.
9481c002
MR
4107
4108The function should choose or create a window, display the buffer
4109in it, and return the window. It is also responsible for giving
4110the variable `display-buffer-window' and the `quit-restore'
4111parameter of the window used a meaningful value.
4112
4113Within the body of this function avoid calling `display-buffer'
4114with the same buffer as argument since this may lead to endless
4115recursion.
4116
4117Instead of supplying basic method specifiers, it's sometimes more
4118convenient to use macro specifiers. They provide some commonly
4119used display methods but do not support the fine control provided
4120by the basic method specifiers. Macro specifiers are symbols.
4121The following macro specifiers are provided:
4122
4123 `same-window' to display the buffer in the selected window.
4124
4125 `same-frame' to display the buffer on the selected frame.
4126
4127 `other-window' to display the buffer in any window but the
4128 selected one.
4129
4130 `same-frame-other-window' as `other-window' but stay on the
4131 selected frame.
4132
4133 `other-frame' to display the buffer on another visible
4134 frame.
4135
4136 `default' to use the default value of `display-buffer-alist'.
4137
4138One specifier is useful with any method specifier: A list whose
4139car is the symbol `dedicate' and whose cdr is non-nil will
4140dedicate the window to its buffer. The following values are
4141supported:
4142
4143- nil to not dedicate the window to the buffer.
4144
4145- `weak' to weakly dedicate the window to the buffer.
4146
4147- t to strongly dedicate the window to the buffer.
4148
9be74fbb
MR
4149A cons cell whose car is `other-window-means-other-frame' and
4150whose cdr is non-nil means that you want calls of
4151`display-buffer' with the second argument t or the symbol
4152`other-window' to display the buffer in another frame. This
4153means, for example, that you prefer functions like
4154`find-file-other-window' or `switch-to-buffer-other-window' to
4155make a new frame instead of a new window on the selected frame.
4156
9481c002
MR
4157Usually, applications are free to override the specifiers of
4158`display-buffer-alist' by passing their own specifiers as second
4159argument of `display-buffer'. For every `display-buffer-alist'
4160entry you can, however, add a cons cell whose car is the symbol
4161`override' and whose cdr is non-nil, to explicitly override any
4162value supplied by the application.
4163
4164Overriding specifiers supplied by the calling application is, in
4165general, not advisable. It permits, for example, to change the
4166semantics of a function like `display-buffer-other-window' by
4167using the location specifiers `same-window' or `other-frame'."
4168 :risky t
4169 :type
4170 '(repeat
4171 :offset 9
4172 ;; Associations of buffer identifiers and display specifiers.
4173 (list
4174 :format "%v"
4175 ;; Buffer identifiers.
4176 (repeat
4177 :tag "Buffer identifiers"
4178 (choice
4179 :tag "Identifier"
4180 :format "%[%t%] %v" :size 15
4181 (cons
4182 :tag "Name"
4183 :format "%v"
4184 :help-echo "A buffer name."
4185 (const :format "" name)
4186 (string :format "Name: %v\n" :size 32))
4187 (cons
4188 :tag "Regexp"
4189 :format "%v"
4190 :help-echo "A regular expression matching buffer names."
4191 (const :format "" regexp)
4192 (string :format "Regexp: %v\n" :size 32))
4193 (cons
4194 :tag "Label"
4195 :format "%v"
4196 :help-echo "A symbol equalling the buffer display label."
d615d6d2 4197 (const :format "" label)
9481c002
MR
4198 (symbol :format "Label: %v\n" :size 32))))
4199
4200 ;; Display specifiers.
4201 (repeat
4202 :offset 9
4203 :tag "Display specifiers"
4204 :inline t
4205 (list
4206 :inline t
4207 :format "%v"
4208 (choice
4209 :tag "Method"
4210 :value (reuse-window
4211 (reuse-window nil same nil)
4212 (reuse-window-even-sizes . t))
4213 :inline t
4214 :help-echo "Method for displaying the buffer."
4215 :format "%[Method%] %v" :size 15
4216
4217 ;; Reuse window specifiers.
4218 (list
4219 :tag "Reuse window"
4220 :value (reuse-window
4221 (reuse-window nil same nil)
4222 (reuse-window-even-sizes . t))
4223 :format "%t\n%v"
4224 :inline t
4225 ;; For customization purposes only.
4226 (const :format "" reuse-window)
4227 (set
4228 :format "%v"
4229 :inline t
4230 ;; The window to reuse.
4231 (list
4232 :format "%v\n"
4233 (const :format "" reuse-window)
4234 ;; The window type.
4235 (choice
4236 :tag "Window"
4237 :help-echo "Window to reuse."
4238 :value nil
4239 :format "%[Window%] %v" :size 15
5f45cca5
MR
4240 (const :tag "Any window" :format "%t" nil)
4241 (const :tag "Same window" :format "%t" same)
4242 (const :tag "Other window" :format "%t" other))
9481c002
MR
4243 ;; The window's buffer.
4244 (choice
4245 :tag "Buffer"
4246 :help-echo "Buffer shown by reused window."
4247 :value t
4248 :format " %[Buffer%] %v" :size 15
4249 (const :tag "Any buffer" :format "%t" nil)
4250 (const :tag "Same buffer" :format "%t" same)
4251 (const :tag "Other buffer" :format "%t" other))
4252 ;; The window's frame.
4253 (choice
5f45cca5 4254 :help-echo "Frames to search for a window to reuse."
9481c002
MR
4255 :tag "Frame"
4256 :value nil
4257 :format " %[Frame%] %v" :size 15
5f45cca5 4258 (const :tag "Same frame only" :format "%t" nil)
9481c002 4259 (const :tag "Visible frames" :format "%t" visible)
5f45cca5
MR
4260 (const :tag "Any other visible frame" :format "%t" other)
4261 (const :tag "Visible and iconified frames" :format "%t" 0)
4262 (const :tag "All frames" :format "%t" t)))
9481c002
MR
4263 ;; Whether window sizes should be evened out.
4264 (cons
4265 :format "%v\n"
4266 :tag "Even window sizes"
4267 (const :format "" reuse-window-even-sizes)
4268 (choice
4269 :tag "Even window sizes"
4270 :help-echo "Whether to even sizes of selected and reused window."
4271 :value t
4272 :format "%[Even window sizes%] %v" :size 15
4273 (const :tag "Off" :format "%t" nil)
4274 (const :tag "Even window sizes" :format "%t" t)))
4275 ;; Whether to reuse a dedicated window
4276 (cons
4277 :format "%v\n"
4278 (const :format "" reuse-window-dedicated)
4279 (choice
4280 :tag "Reuse dedicated window" :value nil
4281 :help-echo "Reuse a window even if it is dedicated to its buffer."
4282 :format "%[Reuse dedicated window%] %v" :size 15
4283 (const :tag "Off" :format "%t" nil)
4284 (const :tag "Reuse weakly dedicated windows" :format "%t" weak)
4285 (const :tag "Reuse any dedicated window" :format "%t" t)))))
4286
4287 ;; Pop-up window specifiers.
4288 (list
4289 :tag "Pop-up window"
4290 :value (pop-up-window (pop-up-window (largest . nil) (lru . nil)))
4291 :format "%t\n%v"
4292 :inline t
4293 (const :format "" pop-up-window)
4294 (set
4295 :format "%v"
4296 :inline t
4297 ;; Pop-up window list.
4298 (list
4299 :format "%v"
4300 :value (pop-up-window (largest . nil) (lru . nil))
4301 (const :format "" pop-up-window)
4302 (repeat
4303 :tag "Window / Side tuples"
4304 :inline t
4305 (cons
4306 :format "%v\n"
4307 (choice
4308 :tag "Window"
4309 :help-echo "The window to split."
4310 :value largest
4311 :format "%[Window%] %v"
4312 (const :tag "Largest" :format "%t" largest)
4313 (const :tag "Least recently used" :format "%t" lru)
4314 (const :tag "Selected" :format "%t" selected)
4315 (const :tag "Root" :format "%t" root)
4316 (const :tag "Left" :format "%t" left)
4317 (const :tag "Top" :format "%t" top)
4318 (const :tag "Right" :format "%t" right)
4319 (const :tag "Bottom" :format "%t" bottom))
4320 (choice
4321 :tag "Side"
4322 :help-echo "The position of the new window with respect to the window to split."
4323 :value nil
4324 :format " %[Side%] %v"
4325 (const :tag "Dynamic" :format "%t" nil)
4326 (const :tag "Below" :format "%t" below)
4327 (const :tag "Right" :format "%t" right)
4328 (const :tag "Above" :format "%t" above)
4329 (const :tag "Left" :format "%t" left)
4330 (function
4331 :tag "Function" :format "%v" :size 25)))))
4332 ;; Minimum height of pop-up windows.
4333 (cons
4334 :format "%v\n"
4335 (const :format "" pop-up-window-min-height)
4336 (choice
4337 :help-echo "Minimum height of popped-up window."
4338 :format "%[Minimum height%] %v"
4339 (const :tag "Default" :format "%t" :value nil)
4340 (integer :tag "Number of lines" :value 12 :size 5)
4341 (float :tag "Fraction of frame height" :value .25 :size 5)))
4342 ;; Minimum width of pop-up windows.
4343 (cons
4344 :format "%v\n"
4345 (const :format "" pop-up-window-min-width)
4346 (choice
4347 :help-echo "Minimum width of popped-up window."
4348 :format "%[Minimum width%] %v"
4349 (const :tag "Default" :format "%t" :value nil)
4350 (integer :tag "Number of columns" :value 12 :size 5)
4351 (float :tag "Fraction of frame width" :value .25 :size 5)))
4352 ;; Desired height of pop-up windows.
4353 (cons
4354 :format "%v\n"
4355 (const :format "" pop-up-window-set-height)
4356 (choice
4357 :help-echo "Desired height of popped-up window."
4358 :format "%[Desired height%] %v"
4359 (const :tag "Default" :format "%t" :value nil)
4360 (integer :tag "Number of lines" :value 12 :size 5)
4361 (float :tag "Fraction of frame height" :value .25 :size 5)
4362 (function :tag "Function" :size 25)))
4363 ;; Desired width of pop-up windows.
4364 (cons
4365 :format "%v\n"
4366 (const :format "" pop-up-window-set-width)
4367 (choice
4368 :help-echo "Desired width of popped-up window."
4369 :format "%[Desired width%] %v"
4370 (const :tag "Default" :format "%t" :value nil)
4371 (integer :tag "Number of column" :value 12 :size 5)
4372 (float :tag "Fraction of frame width" :value .25 :size 5)
4373 (function :tag "Function" :size 25)))
4374 ;; Split unsplittable frames.
4375 (cons
4376 :format "%v\n"
4377 (const :format "" pop-up-window-unsplittable)
4378 (choice
4379 :help-echo "Allow popping up a window on \"unsplittable\" frames."
4380 :format "%[Split unsplittable frame%] %v"
4381 (const :tag "Off" :format "%t" nil)
4382 (const :tag "Allow" :format "%t" t)))))
4383
4384 ;; Pop-up frame specifiers.
4385 (list
4386 :tag "Pop-up frame"
4387 :value (pop-up-frame
8998d1b3 4388 (pop-up-frame))
9481c002
MR
4389 :format "%t\n%v"
4390 :inline t
4391 (const :format "" pop-up-frame)
4392 (set
4393 :format "%v"
4394 :inline t
4395 ;; Pop-up frame.
4396 (list
4397 :tag "Pop-up a new frame"
4398 :value (pop-up-frame)
4399 :format "%v"
4400 (const :format "" pop-up-frame)
4401 (choice
4402 :tag "Pop-up a new frame"
4403 :help-echo "Whether to pop-up a new frame on a display."
4404 :format "%[Display%] %v\n" :size 15
4405 (const :tag "On any display" :format "%t" nil)
4406 (const :tag "On graphic displays only" :format "%t" t)))
4407 ;; Pop-up frame function.
4408 (cons
4409 :format "%v\n"
4410 (const :format "" pop-up-frame-function)
4411 (choice
4412 :tag "Pop-up frame function"
4413 :value nil
4414 :help-echo "Function to use to pop-up a new frame."
4415 :format "%[Function%] %v" :size 15
4416 (const :tag "Default" :format "%t" nil)
4417 (function
4418 :value make-frame
4419 :format "%t: %v"
4420 :size 25)))
4421 ;; Pop-up frame alist.
4422 (list
4423 :format "%v"
4424 (const :format "" pop-up-frame-alist)
4425 (repeat
4426 :tag "Parameter / Value tuples"
4427 :inline t
4428 (cons
4429 :format "%v\n"
4430 (symbol
4431 :tag "Parameter"
4432 :format "Parameter: %v"
4433 :size 16)
4434 (sexp
4435 :tag "Value"
4436 :format " Value: %v"
4437 :size 8))))))
4438
4439 ;; Use side-window specifiers.
4440 (list
4441 :tag "Use side-window"
4442 :value (use-side-window (use-side-window bottom 0))
4443 :format "%t\n%v"
4444 :inline t
4445 ;; For customization purposes only.
4446 (const :format "" use-side-window)
4447 (set
4448 :format "%v"
4449 :inline t
4450 ;; Side and slot.
4451 (list
4452 :format "%v\n"
4453 :value (use-side-window bottom 0)
4454 (const :format "" use-side-window)
4455 ;; The side.
4456 (choice
4457 :tag "Side"
4458 :help-echo "Side of frame."
4459 :value bottom
4460 :format "%[Side%] %v" :size 15
4461 (const :tag "Left" :format "%t" left)
4462 (const :tag "Top" :format "%t" top)
4463 (const :tag "Right" :format "%t" right)
4464 (const :tag "Bottom" :format "%t" bottom))
4465 ;; The slot
4466 (number
4467 :tag "Slot"
4468 :help-echo "The slot (an arbitrary number, where 0 stands for the center slot)."
4469 :value 0
4470 :format " Slot: %v" :size 8))
4471 ;; Whether to reuse a dedicated side window
4472 (cons
4473 :format "%v\n"
4474 (const :format "" reuse-window-dedicated)
4475 (choice
4476 :tag "Reuse dedicated side window" :value nil
4477 :help-echo "Reuse a side window even if it is dedicated to its buffer."
4478 :format "%[Reuse dedicated side window%] %v" :size 15
4479 (const :tag "Off" :format "%t" nil)
4480 (const :tag "Reuse weakly dedicated side windows" :format "%t" weak)
4481 (const :tag "Reuse any dedicated side window" :format "%t" t)))
4482 ;; Minimum height of pop-up side windows.
4483 (cons
4484 :format "%v\n"
4485 (const :format "" pop-up-window-min-height)
4486 (choice
4487 :help-echo "Minimum height of popped-up side window."
4488 :format "%[Minimum height%] %v"
4489 (const :tag "Default" :format "%t" :value nil)
4490 (integer :tag "Number of lines" :value 12 :size 5)
4491 (float :tag "Fraction of frame height" :value .25 :size 5)))
4492 ;; Minimum width of pop-up windows.
4493 (cons
4494 :format "%v\n"
4495 (const :format "" pop-up-window-min-width)
4496 (choice
4497 :help-echo "Minimum width of popped-up side window."
4498 :format "%[Minimum width%] %v"
4499 (const :tag "Default" :format "%t" :value nil)
4500 (integer :tag "Number of columns" :value 12 :size 5)
4501 (float :tag "Fraction of frame width" :value .25 :size 5)))
4502 ;; Desired height of pop-up windows.
4503 (cons
4504 :format "%v\n"
4505 (const :format "" pop-up-window-set-height)
4506 (choice
4507 :help-echo "Desired height of popped-up side window."
4508 :format "%[Desired height%] %v"
4509 (const :tag "Default" :format "%t" :value nil)
4510 (integer :tag "Number of lines" :value 12 :size 5)
4511 (float :tag "Fraction of frame height" :value .25 :size 5)
4512 (function :tag "Function" :size 25)))
4513 ;; Desired width of pop-up windows.
4514 (cons
4515 :format "%v\n"
4516 (const :format "" pop-up-window-set-width)
4517 (choice
4518 :help-echo "Desired width of popped-up side window."
4519 :format "%[Desired width%] %v"
4520 (const :tag "Default" :format "%t" :value nil)
4521 (integer :tag "Number of column" :value 12 :size 5)
4522 (float :tag "Fraction of frame width" :value .25 :size 5)
4523 (function :tag "Function" :size 25)))))
4524
4525 ;; Function with argument specifiers.
4526 (list
4527 :tag "Function with arguments"
5386012d 4528 :value (function (function 'ignore))
9481c002
MR
4529 :format "%t\n%v"
4530 :inline t
4531 ;; For customization purposes only.
5386012d 4532 (const :format "" function)
9481c002
MR
4533 (set
4534 :format "%v"
4535 :inline t
4536 (list
4537 :format "%v"
5386012d
MR
4538 :value (function 'ignore)
4539 (const :format "" function)
9481c002
MR
4540 (function :tag "Function" :format "%t: %v\n" :size 25)
4541 (list
4542 :format "%v"
4543 (repeat
4544 :tag "Arguments"
4545 :inline t
4546 (sexp
4547 :format "%v\n"
4548 :size 16))))))
4549
4550 ;; Macro specifiers.
4551 (list
355f2e07
MR
4552 :tag "Same window"
4553 :format "%t%v"
4554 :inline t
4555 (const :format "\n" same-window))
4556 (list
4557 :tag "Same frame"
9481c002
MR
4558 :format "%t%v"
4559 :inline t
4560 (const :format "\n" same-frame))
4561 (list
4562 :tag "Other window"
4563 :format "%t%v"
4564 :inline t
4565 (const :format "\n" other-window))
4566 (list
4567 :tag "Same frame other window"
4568 :format "%t%v"
4569 :inline t
4570 (const :format "\n" same-frame-other-window))
4571 (list
355f2e07 4572 :tag "Other frame"
9481c002
MR
4573 :format "%t%v"
4574 :inline t
4575 (const :format "\n" other-frame))
4576 (list
4577 :tag "Default"
4578 :format "%t%v"
4579 :inline t
4580 (const :format "\n" default)))))
4581
4582 (set
4583 :format "%v"
4584 :inline t
4585 ;; Dedicate window to buffer.
4586 (cons
4587 :format "%v"
4588 (const :format "" dedicate)
4589 (choice
4590 :help-echo "Mark window as dedicated to its buffer."
4591 :format "%[Dedicate window to buffer%] %v\n" :size 15
4592 (const :tag "Off" :format "%t" nil)
4593 (const :tag "Weak" :format "%t" weak)
4594 (const :tag "Strong" :format "%t" t)))
4595 ;; No other window.
4596 (cons
4597 :format "%v"
4598 (const :format "" no-other-window)
4599 (choice
4600 :help-echo "Whether `other-window' shall ignore the window."
4601 :format "%[No other window%] %v\n" :size 15
4602 (const :tag "Off" :format "%t" nil)
4603 (const :tag "Ignore" :format "%t" t)))
25aef8b8
MR
4604 ;; Other window means other frame.
4605 (cons
4606 :format "%v"
4607 (const :format "" other-window-means-other-frame)
4608 (choice
4609 :help-echo "Whether other window means same or other frame."
5f45cca5
MR
4610 :format "%[Other window means other frame%] %v\n" :size 15
4611 (const :tag "Off" :format "%t" nil)
4612 (const :tag "On" :format "%t" t)))
9481c002
MR
4613 ;; Overriding.
4614 (cons
4615 :format "%v\n"
4616 (const :format "" override)
4617 (choice
4618 :help-echo "Override application supplied specifiers."
4619 :format "%[Override%] %v"
4620 (const :tag "Off" :format "%t" nil)
4621 (const :tag "Override" :format "%t" t))))))
4622 :group 'windows
4623 :group 'frames)
4624
3c448ab6 4625(defcustom display-buffer-function nil
9481c002
MR
4626 "If non-nil, function to call to display a buffer.
4627`display-buffer' calls this function with two arguments, the
4628buffer to display and a list of buffer display specifiers, see
4629`display-buffer-alist'.
4630
4631The function is supposed to choose or create a window, display
4632the specified buffer in it, and return the window. It is also
4633responsible for giving the variable `display-buffer-window' and
4634the `quit-restore' parameter of the window used a meaningful
4635value.
4636
4637The function specified here overrides all specifiers of the
4638variable `display-buffer-alist' any specifiers passed to
4639`display-buffer'.
4640
4641If you call `display-buffer' within the body of the function,
4642bind the value of `display-buffer-function' to nil around that
4643call to avoid that the function recursively calls itself."
3c448ab6
MR
4644 :type '(choice
4645 (const nil)
9481c002
MR
4646 (function :tag "Function"))
4647 :group 'windows)
4648
4649;; The following is a global variable which is used externally (by
4650;; help.el) to (1) know which window was used for displaying a buffer
4651;; and (2) whether the window was new or reused.
4652(defvar display-buffer-window nil
4653 "Window used by `display-buffer' and related information.
4654After `display-buffer' displays a buffer in some window this
4655variable is a cons cell whose car denotes the window used to
4656display the buffer. The cdr is supposed to be one of the symbols
4657`reuse-buffer-window', `reuse-other-window', `new-window' or
4658`new-frame'.
4659
4660If the buffer display location specifier is one of 'same-window,
4661'same-frame, or 'other-frame, the `display-buffer' routines
4662assign the value of this variable. If the location specifier is
4663a function, that function becomes responsible for assigning a
4664meaningful value to this variable. See the functions
4665`display-buffer-reuse-window', `display-buffer-pop-up-window' and
4666`display-buffer-pop-up-frame' for how this can be done.")
4667
4668(defun display-buffer-even-window-sizes (window specifiers)
4669 "Even sizes of WINDOW and selected window according to SPECIFIERS.
4670SPECIFIERS must be a list of buffer display specifiers, see the
4671documentation of `display-buffer-alist' for a description.
4672
4673Sizes are evened out if and only if WINDOW and the selected
4674window appear next to each other and the selected window is
4675larger than WINDOW."
4676 (cond
4677 ((or (not (cdr (assq 'reuse-window-even-sizes specifiers)))
4678 ;; Don't resize minibuffer windows.
4679 (window-minibuffer-p)
4680 ;; WINDOW must be adjacent to the selected one.
d68443dc
MR
4681 (not (or (eq window (window-prev-sibling))
4682 (eq window (window-next-sibling))))))
9481c002
MR
4683 ((and (window-iso-combined-p window)
4684 ;; Resize iff the selected window is higher than WINDOW.
4685 (> (window-total-height) (window-total-height window)))
4686 ;; Don't throw an error if we can't even window heights for
4687 ;; whatever reason. In any case, enlarging the selected window
4688 ;; might fail anyway if there are other windows above or below
4689 ;; WINDOW and the selected one. But for a simple two windows
4690 ;; configuration the present behavior is good enough so why care?
4691 (ignore-errors
d615d6d2 4692 (window-resize
9481c002
MR
4693 window (/ (- (window-total-height) (window-total-height window))
4694 2))))
4695 ((and (window-iso-combined-p window t)
4696 ;; Resize iff the selected window is wider than WINDOW.
4697 (> (window-total-width) (window-total-width window)))
4698 ;; Don't throw an error if we can't even window widths, see
4699 ;; comment above.
4700 (ignore-errors
d615d6d2 4701 (window-resize
9481c002
MR
4702 window (/ (- (window-total-width) (window-total-width window))
4703 2) t)))))
4704
4705(defun display-buffer-set-height (window specifiers)
4706 "Adjust height of WINDOW according to SPECIFIERS.
4707SPECIFIERS must be a list of buffer display specifiers, see the
4708documentation of `display-buffer-alist' for a description."
4709 (let ((set-height (cdr (assq 'pop-up-window-set-height specifiers))))
4710 (cond
4711 ((numberp set-height)
4712 (let* ((height (if (integerp set-height)
4713 set-height
4714 (round
4715 (* (window-total-size (frame-root-window window))
4716 set-height))))
4717 (delta (- height (window-total-size window))))
4718 (when (and (window-resizable-p window delta nil 'safe)
4719 (window-iso-combined-p window))
d615d6d2 4720 (window-resize window delta nil 'safe))))
9481c002
MR
4721 ((functionp set-height)
4722 (ignore-errors (funcall set-height window))))))
4723
4724(defun display-buffer-set-width (window specifiers)
4725 "Adjust width of WINDOW according to SPECIFIERS.
4726SPECIFIERS must be a list of buffer display specifiers, see the
4727documentation of `display-buffer-alist' for a description."
4728 (let ((set-width (cdr (assq 'pop-up-window-set-width specifiers))))
4729 (cond
4730 ((numberp set-width)
4731 (let* ((width (if (integerp set-width)
4732 set-width
4733 (round
4734 (* (window-total-size (frame-root-window window) t)
4735 set-width))))
4736 (delta (- width (window-total-size window t))))
4737 (when (and (window-resizable-p window delta t 'safe)
4738 (window-iso-combined-p window t))
d615d6d2 4739 (window-resize window delta t 'safe))))
9481c002
MR
4740 ((functionp set-width)
4741 (ignore-errors (funcall set-width window))))))
4742
9481c002
MR
4743(defun display-buffer-in-window (buffer window specifiers)
4744 "Display BUFFER in WINDOW and raise its frame if needed.
4745WINDOW must be a live window and defaults to the selected one.
4746Return WINDOW.
4747
4748SPECIFIERS must be a list of buffer display specifiers, see the
4749documentation of `display-buffer-alist' for a description."
5386012d
MR
4750 (setq buffer (window-normalize-buffer buffer))
4751 (setq window (window-normalize-live-window window))
9481c002
MR
4752 (let* ((old-frame (selected-frame))
4753 (new-frame (window-frame window))
4754 (dedicated (cdr (assq 'dedicated specifiers)))
4755 (no-other-window (cdr (assq 'no-other-window specifiers))))
4756 ;; Show BUFFER in WINDOW.
355f2e07
MR
4757 (unless (eq buffer (window-buffer window))
4758 ;; If we show another buffer in WINDOW, undedicate it first.
4759 (set-window-dedicated-p window nil))
9481c002
MR
4760 (set-window-buffer window buffer)
4761 (when dedicated
4762 (set-window-dedicated-p window dedicated))
4763 (when no-other-window
4764 (set-window-parameter window 'no-other-window t))
327c8fb1
MR
4765 (unless (or (eq old-frame new-frame)
4766 (not (frame-visible-p new-frame))
4767 ;; Assume the selected frame is already visible enough.
4768 (eq new-frame (selected-frame))
4769 ;; Assume the frame from which we invoked the minibuffer
4770 ;; is visible.
4771 (and (minibuffer-window-active-p (selected-window))
4772 (eq new-frame
4773 (window-frame (minibuffer-selected-window)))))
4774 (raise-frame new-frame))
9481c002
MR
4775 ;; Return window.
4776 window))
4777
4778(defun display-buffer-reuse-window (buffer method &optional specifiers)
4779 "Display BUFFER in an existing window.
4780METHOD must be a list in the form of the cdr of a `reuse-window'
4781buffer display specifier, see `display-buffer-alist' for an
4782explanation. The first element must specifiy the window to use,
4783and can be either nil, `same', `other', or a live window. The
4784second element must specify the window's buffer and can be either
4785nil, `same', `other', or a live buffer. The third element is the
4786frame to use - either nil, 0, `visible', `other', t, or a live
4787frame.
4788
4789Optional argument SPECIFIERS must be a list of valid display
4790specifiers. Return the window chosen to display BUFFER, nil if
4791none was found."
4792 (let* ((method-window (nth 0 method))
4793 (method-buffer (nth 1 method))
4794 (method-frame (nth 2 method))
d615d6d2 4795 (reuse-dedicated (cdr (assq 'reuse-window-dedicated specifiers)))
9481c002
MR
4796 windows other-frame dedicated time best-window best-time)
4797 (when (eq method-frame 'other)
4798 ;; `other' is not handled by `window-list-1'.
4799 (setq other-frame t)
4800 (setq method-frame t))
4801 (dolist (window (window-list-1 nil 'nomini method-frame))
4802 (let ((window-buffer (window-buffer window)))
4803 (when (and (not (window-minibuffer-p window))
4804 ;; Don't reuse a side window.
4805 (or (not (eq (window-parameter window 'window-side) 'side))
4806 (eq window-buffer buffer))
4807 (or (not method-window)
4808 (and (eq method-window 'same)
4809 (eq window (selected-window)))
4810 (and (eq method-window 'other)
4811 (not (eq window (selected-window))))
4812 ;; Special case for applications that specifiy
4813 ;; the window explicitly.
4814 (eq method-window window))
4815 (or (not method-buffer)
4816 (and (eq method-buffer 'same)
4817 (eq window-buffer buffer))
4818 (and (eq method-buffer 'other)
4819 (not (eq window-buffer buffer)))
4820 ;; Special case for applications that specifiy
4821 ;; the window's buffer explicitly.
4822 (eq method-buffer window-buffer))
4823 (or (not other-frame)
4824 (not (eq (window-frame window) (selected-frame))))
4825 ;; Handle dedicatedness.
4826 (or (eq window-buffer buffer)
4827 ;; The window does not show the same buffer.
4828 (not (setq dedicated (window-dedicated-p window)))
4829 ;; If the window is weakly dedicated to its
4830 ;; buffer, reuse-dedicated must be non-nil.
4831 (and (not (eq dedicated t)) reuse-dedicated)
4832 ;; If the window is strongly dedicated to its
4833 ;; buffer, reuse-dedicated must be t.
4834 (eq reuse-dedicated t)))
4835 (setq windows (cons window windows)))))
4836
4837 (if (eq method-buffer 'same)
4838 ;; When reusing a window on the same buffer use the lru one.
4839 (dolist (window windows)
4840 (setq time (window-use-time window))
4841 (when (or (not best-window) (< time best-time))
4842 (setq best-window window)
4843 (setq best-time time)))
4844 ;; Otherwise, sort windows according to their use-time.
4845 (setq windows
4846 (sort windows
4847 #'(lambda (window-1 window-2)
4848 (<= (window-use-time window-1)
4849 (window-use-time window-2)))))
4850 (setq best-window
4851 ;; Try to get a full-width window (this is silly and can
4852 ;; get us to another frame but let's ignore these issues
4853 ;; for the moment).
4854 (catch 'found
4855 (dolist (window windows)
4856 (when (window-full-width-p window)
4857 (throw 'found window)))
4858 ;; If there's no full-width window return the lru window.
4859 (car windows))))
4860
4861 (when best-window
4862 (display-buffer-even-window-sizes best-window specifiers)
4863 ;; Never change the quit-restore parameter of a window here.
4864 (if (eq (window-buffer best-window) buffer)
4865 (setq display-buffer-window
4866 (cons best-window 'reuse-buffer-window))
4867 (setq display-buffer-window
4868 (cons best-window 'reuse-other-window))
4869 (unless (window-parameter best-window 'quit-restore)
4870 ;; Don't overwrite an existing quit-restore entry.
4871 (set-window-parameter
4872 best-window 'quit-restore
4873 (list (window-buffer best-window) (window-start best-window)
4874 (window-point best-window) buffer
4875 (window-total-size best-window) (selected-window)))))
4876
4877 (display-buffer-in-window buffer best-window specifiers))))
4878
4879(defconst display-buffer-split-specifiers '(largest lru selected root left top right bottom)
4880 "List of symbols identifying window that shall be split.")
4881
4882(defconst display-buffer-side-specifiers '(below right above left nil)
4883 "List of symbols identifying side of split-off window.")
4884
4885(defun display-buffer-split-window-1 (window side min-size)
4886 "Subroutine of `display-buffer-split-window'."
4887 (let* ((horizontal (memq side '(left right)))
4888 (parent (window-parent window))
4889 (resize (and window-splits (window-iso-combined-p window horizontal)))
4890 (old-size
4891 ;; We either resize WINDOW or its parent.
4892 (window-total-size (if resize parent window) horizontal))
4893 new-size)
4894 ;; We don't call split-window-vertically/-horizontally any more
4895 ;; here. If for some reason it's needed we can always do so
4896 ;; (provided we give it an optional SIDE argument).
4897 (cond
4898 (resize
4899 ;; When we resize a combination, the new window must be at least
4900 ;; MIN-SIZE large after the split.
4901 (setq new-size
4902 (max min-size
4903 (min (- old-size (window-min-size parent horizontal))
4904 (/ old-size
4905 ;; Try to make the size of the new window
4906 ;; proportional to the number of iso-arranged
4907 ;; windows in the combination.
4908 (1+ (window-iso-combinations parent horizontal))))))
4909 (when (window-sizable-p parent (- new-size) horizontal)
4910 (split-window window (- new-size) side)))
4911 ((window-live-p window)
4912 (setq new-size (/ old-size 2))
4913 ;; When WINDOW is live, the old _and_ the new window must be at
4914 ;; least MIN-SIZE large after the split.
4915 (when (and (>= new-size min-size)
4916 (window-sizable-p window (- new-size) horizontal))
4917 ;; Do an even split to make Stepan happy.
4918 (split-window window nil side)))
4919 (t
4920 ;; When WINDOW is internal, the new window must be at least
4921 ;; MIN-SIZE large after the split.
4922 (setq new-size
4923 (max min-size
4924 (/ old-size
4925 ;; Try to make the size of the new window
4926 ;; proportional to the number of iso-arranged
4927 ;; subwindows of WINDOW.
4928 (1+ (window-iso-combinations window horizontal)))))
4929 (when (window-sizable-p window (- new-size) horizontal)
4930 (split-window window (- new-size) side))))))
4931
4932(defun display-buffer-split-window (window &optional side specifiers)
4933 "Split WINDOW in a way suitable for `display-buffer'.
4934Optional argument SIDE must be a side specifier \(one of the
4935symbols below, right, above, left, or nil). SPECIFIERS must be a
4936list of buffer display specifiers, see the documentation of
4937`display-buffer-alist' for a description.
4938
4939Return the new window, nil if it could not be created."
4940 (let ((min-height (cdr (assq 'pop-up-window-min-height specifiers)))
4941 (min-width (cdr (assq 'pop-up-window-min-width specifiers)))
4942 size)
4943 ;; Normalize min-height and min-width, we might need both.
4944 (setq min-height
4945 ;; If min-height is specified, it can be as small as
4946 ;; `window-safe-min-height'.
4947 (cond
4948 ((and (integerp min-height)
4949 (>= min-height window-safe-min-height))
4950 min-height)
4951 ((and (floatp min-height)
4952 (<= min-height 1)
4953 (let* ((root-height (window-total-height
4954 (frame-root-window
4955 (window-frame window))))
4956 (height (round (* min-height root-height))))
4957 (when (>= height window-safe-min-height)
4958 height))))
4959 (t window-min-height)))
4960 (setq min-width
4961 ;; If min-width is specified, it can be as small as
4962 ;; `window-safe-min-width'.
4963 (cond
4964 ((and (integerp min-width)
4965 (>= min-width window-safe-min-width))
4966 min-width)
4967 ((and (floatp min-width)
4968 (<= min-width 1)
4969 (let* ((root-width (window-total-width
4970 (frame-root-window
4971 (window-frame window))))
4972 (width (round (* min-width root-width))))
4973 (when (>= width window-safe-min-width)
4974 width))))
4975 (t window-min-width)))
4976
4977 (or (and (memq side '(nil above below))
4978 (display-buffer-split-window-1
4979 window (or side 'below) min-height))
4980 ;; If SIDE is nil and vertical splitting failed, we try again
4981 ;; splitting horizontally this time.
4982 (and (memq side '(nil left right))
4983 (display-buffer-split-window-1
4984 window (or side 'right) min-width))
4985 ;; If WINDOW is live and the root window of its frame, try once
4986 ;; more splitting vertically, disregarding the min-height
4987 ;; specifier this time and using `window-min-height' instead.
4988 (and (memq side '(nil above below))
4989 (<= window-min-height min-height)
4990 (window-live-p window)
4991 (eq window (frame-root-window window))
4992 (display-buffer-split-window-1
4993 window (or side 'below) window-min-height)))))
4994
4995(defun display-buffer-split-atom-window (window &optional side nest specifiers)
4996 "Make WINDOW part of an atomic window."
4997 (let ((ignore-window-parameters t)
4998 (window-nest t)
4999 (selected-window (selected-window))
5000 root new new-parent)
5001
5002 ;; We are in an atomic window.
5003 (when (and (window-parameter window 'window-atom) (not nest))
5004 ;; Split the root window.
5005 (setq window (window-atom-root window)))
5006
5007 (when (setq new (display-buffer-split-window window side specifiers))
5008 (setq new-parent (window-parent window))
5009 ;; WINDOW is or becomes atomic.
5010 (unless (window-parameter window 'window-atom)
5011 (walk-window-subtree
5012 (lambda (window)
5013 (set-window-parameter window 'window-atom t))
5014 window t))
5015 ;; New window and any new parent get their window-atom parameter
5016 ;; set too.
5017 (set-window-parameter new 'window-atom t)
5018 (set-window-parameter new-parent 'window-atom t)
5019 new)))
5020
5021(defun display-buffer-pop-up-window (buffer methods &optional specifiers)
5022 "Display BUFFER in a new window.
5023Return the window displaying BUFFER, nil if popping up the window
5024failed. METHODS must be a list of window/side tuples like those
5025forming the cdr of the `pop-up-window' buffer display specifier.
5026As a special case, the car of such a tuple can be also a live
5027window.
5028
5029Optional argument SPECIFIERS must be a list of buffer display
5030specifiers, see the doc-string of `display-buffer-alist' for a
5031description."
5032 (let* ((frame (display-buffer-frame))
5033 (selected-window (frame-selected-window frame))
02cfc6d6 5034 cand window side atomic)
9481c002
MR
5035 (unless (and (cdr (assq 'unsplittable (frame-parameters frame)))
5036 ;; Don't split an unsplittable frame unless
5037 ;; SPECIFIERS allow it.
5038 (not (cdr (assq 'split-unsplittable-frame specifiers))))
5039 (catch 'done
5040 (dolist (method methods)
02cfc6d6 5041 (setq cand (car method))
9481c002 5042 (setq side (cdr method))
02cfc6d6
MR
5043 (setq window
5044 (cond
5045 ((eq cand 'largest)
9173deec 5046 ;; The largest window.
02cfc6d6
MR
5047 (get-largest-window frame t))
5048 ((eq cand 'lru)
5049 ;; The least recently used window.
5050 (get-lru-window frame t))
5051 ((eq cand 'selected)
5052 ;; The selected window.
5053 (frame-selected-window frame))
5054 ((eq cand 'root)
5055 ;; If there are side windows, split the main window
5056 ;; else the frame's root window.
5057 (or (window-with-parameter 'window-side 'none nil t)
5058 (frame-root-window frame)))
5059 ((memq cand window-sides)
5060 ;; This should gets us the "root" side window if there
5061 ;; exists more than one window on that side.
5062 (window-with-parameter 'window-side cand nil t))
5063 ((windowp cand)
5064 ;; A window, directly specified.
5065 cand)))
5066
5067 (when (and (window-live-p window)
5068 ;; The window must be on the correct frame,
5069 (eq (window-frame window) frame)
5070 ;; and must be neither a minibuffer window
5071 (not (window-minibuffer-p window))
5072 ;; nor a side window.
5073 (not (eq (window-parameter window 'window-side) 'side)))
5074 (setq window
5075 (cond
5076 ((memq side display-buffer-side-specifiers)
5077 (if (and (window-buffer window)
5078 (setq atomic (cdr (assq 'atomic specifiers))))
5079 (display-buffer-split-atom-window
5080 window side (eq atomic 'nest) specifiers)
5081 (display-buffer-split-window window side specifiers)))
5082 ((functionp side)
5083 (ignore-errors
5084 ;; Don't pass any specifiers to this function.
5085 (funcall side window)))))
5086
5087 (when window
5088 ;; Adjust sizes if asked for.
5089 (display-buffer-set-height window specifiers)
5090 (display-buffer-set-width window specifiers)
5091 (set-window-parameter
5092 window 'quit-restore (list 'new-window buffer selected-window))
5093 (setq display-buffer-window (cons window 'new-window))
5094 (display-buffer-in-window buffer window specifiers)
5095 (set-window-prev-buffers window nil)
5096 (throw 'done window))))))))
9481c002
MR
5097
5098(defun display-buffer-pop-up-frame (buffer &optional graphic-only specifiers)
5099 "Make a new frame for displaying BUFFER.
5100Return the window displaying BUFFER if creating the new frame was
5101successful, nil otherwise. Optional argument GRAPHIC-ONLY
5102non-nil means to make a new frame on graphic displays only.
5103
5104SPECIFIERS must be a list of buffer display specifiers, see the
5105documentation of `display-buffer-alist' for a description."
9c2755e9
MR
5106 (unless (or (and graphic-only (not (display-graphic-p)))
5107 noninteractive)
9481c002
MR
5108 (let* ((selected-window (selected-window))
5109 (function (or (cdr (assq 'pop-up-frame-function specifiers))
5110 'make-frame))
5111 (parameters
5112 (when (symbolp function)
5113 (cdr (assq 'pop-up-frame-alist specifiers))))
5114 (frame
5115 (if (symbolp function)
5116 (funcall function parameters)
5117 (funcall function))))
5118 (when frame
5119 (let ((window (frame-selected-window frame)))
5120 (set-window-parameter
5121 window 'quit-restore (list 'new-frame buffer selected-window))
5122 (setq display-buffer-window (cons window 'new-frame))
5123 (display-buffer-in-window buffer window specifiers))))))
5124
5125(defun display-buffer-pop-up-side-window (buffer side slot &optional specifiers)
5126 "Display BUFFER in a new window on SIDE of the selected frame.
5127SLOT specifies the slot to use. SPECIFIERS must be a list of
5128buffer display specifiers.
5129
5130Return the window displaying BUFFER, nil if popping up the window
5131failed."
5132 (let* ((root (frame-root-window))
5133 (main (window-with-parameter 'window-side 'none nil t))
5134 (left-or-right (memq side '(left right)))
5135 (main-or-root
5136 (if (and main
5137 (or (and left-or-right (not window-sides-vertical))
5138 (and (not left-or-right) window-sides-vertical)))
5139 main
5140 root))
5141 (selected-window (selected-window))
5142 (on-side (cond
5143 ((eq side 'top) 'above)
5144 ((eq side 'bottom) 'below)
5145 (t side)))
5146 (window
5147 (display-buffer-split-window main-or-root on-side specifiers))
5148 fun)
5149 (when window
5150 (unless main
5151 (walk-window-subtree
5152 (lambda (window)
5153 ;; Make all main-or-root subwindows main windows.
5154 (set-window-parameter window 'window-side 'none))
5155 main-or-root t))
5156 ;; Make sure that parent's window-side is nil.
5157 (set-window-parameter (window-parent window) 'window-side nil)
5158 ;; Initialize side.
5159 (set-window-parameter window 'window-side side)
5160 ;; Adjust sizes if asked for.
5161 (display-buffer-set-height window specifiers)
5162 (display-buffer-set-width window specifiers)
5163 ;; Set window parameters.
5164 (set-window-parameter
5165 window 'quit-restore (list 'new-window buffer selected-window))
5166 (setq display-buffer-window (cons window 'new-window))
5167 (set-window-parameter window 'window-slot slot)
5168 (display-buffer-in-window buffer window specifiers)
5169 (set-window-prev-buffers window nil)
5170 window)))
5171
5172(defun display-buffer-in-side-window (buffer side &optional slot specifiers)
5173 "Display BUFFER in a window on SIDE of the selected frame.
5174SLOT, if non-nil, specifies the window slot where to display the
5175BUFFER. SLOT zero or nil means use the central slot on SIDE.
5176SLOT negative means use a slot preceding the central window.
5177SLOT positive means use a slot following the central window.
5178
5179SPECIFIERS must be a list of buffer display specifiers."
5180 (unless (memq side window-sides)
5181 (error "Invalid side %s specified" side))
5182 (let* ((major (window-with-parameter 'window-side side nil t))
5183 ;; `major' is the major window on SIDE, `windows' the life
5184 ;; windows on SIDE.
5185 (windows (when major (windows-with-parameter 'window-side side)))
5f45cca5 5186 (reuse-dedicated (cdr (assq 'reuse-window-dedicated specifiers)))
9481c002
MR
5187 (slots (when major (window-child-count major)))
5188 (max-slots
5189 (nth (cond
5190 ((eq side 'left) 0)
5191 ((eq side 'top) 1)
5192 ((eq side 'right) 2)
5193 ((eq side 'bottom) 3))
5194 window-sides-slots))
5195 (selected-window (selected-window))
5196 window this-window this-slot prev-window next-window
5f45cca5 5197 best-window best-slot abs-slot dedicated)
9481c002
MR
5198
5199 (unless (numberp slot)
5200 (setq slot 0))
5201 (if (not windows)
5202 ;; No suitable side window exists, make one.
5203 (display-buffer-pop-up-side-window buffer side slot specifiers)
5204 ;; Scan windows on SIDE.
5205 (catch 'found
5206 (dolist (window windows)
5207 (setq this-slot (window-parameter window 'window-slot))
5208 (cond
5209 ((not (numberp this-slot)))
5210 ((and (= this-slot slot)
5211 ;; Dedicatedness check.
5f45cca5
MR
5212 (or (not (setq dedicated (window-dedicated-p window)))
5213 ;; If the window is weakly dedicated to its
5214 ;; buffer, reuse-dedicated must be non-nil.
5215 (and (not (eq dedicated t)) reuse-dedicated)
5216 ;; If the window is strongly dedicated to its
5217 ;; buffer, reuse-dedicated must be t.
5218 (eq reuse-dedicated t)))
9481c002
MR
5219 ;; Window with matching SLOT, use it.
5220 (setq this-window window)
5221 (throw 'found t))
5222 (t
5223 (setq abs-slot (abs (- (abs slot) (abs this-slot))))
5224 (unless (and best-slot (<= best-slot abs-slot))
5225 (setq best-window window)
5226 (setq best-slot abs-slot))
5227 (cond
5228 ((<= this-slot slot)
5229 (setq prev-window window))
5230 ((not next-window)
5231 (setq next-window window)))))))
5232
5233 ;; `this-window' is the first window with the same SLOT.
5234 ;; `prev-window' is the window with the largest slot < SLOT. A new
5235 ;; window will be created after it.
5236 ;; `next-window' is the window with the smallest slot > SLOT. A new
5237 ;; window will be created before it.
5238 ;; `best-window' is the window with the smallest absolute difference
5239 ;; of its slot and SLOT.
5240 (or (and this-window
5241 ;; Reuse this window.
5242 (prog1
5243 (setq window this-window)
5244 (if (eq (window-buffer window) buffer)
5245 (setq display-buffer-window
5246 (cons window 'reuse-buffer-window))
5247 (setq display-buffer-window
5248 (cons window 'reuse-other-window))
5249 (unless (window-parameter window 'quit-restore)
5250 ;; Don't overwrite an existing quit-restore entry.
5251 (set-window-parameter
5252 window 'quit-restore
5253 (list (window-buffer window) (window-start window)
5254 (window-point window) buffer
5255 (window-total-size window) (selected-window)))))))
5256 (and (or (not max-slots) (< slots max-slots))
5257 (or (and next-window
5258 ;; Make new window before next-window.
5259 (let ((next-side
5260 (if (memq side '(left right)) 'above 'left)))
5261 (setq window (display-buffer-split-window
5262 next-window next-side specifiers))))
5263 (and prev-window
5264 ;; Make new window after prev-window.
5265 (let ((prev-side
5266 (if (memq side '(left right)) 'below 'right)))
5267 (setq window (display-buffer-split-window
5268 prev-window prev-side specifiers)))))
5269 (progn
5270 (display-buffer-set-height window specifiers)
5271 (display-buffer-set-width window specifiers)
5272 (set-window-parameter
5273 window 'quit-restore
5274 (list 'new-window buffer selected-window))
5275 (setq display-buffer-window (cons window 'new-window))
5276 window))
5277 (and best-window
5278 (setq window best-window)
5279 ;; Reuse best window (the window nearest to SLOT).
5280 (if (eq (window-buffer window) buffer)
5281 (setq display-buffer-window
5282 (cons window 'reuse-buffer-window))
5283 (setq display-buffer-window
5284 (cons window 'reuse-other-window))
5285
5286 (unless (window-parameter window 'quit-restore)
5287 ;; Don't overwrite an existing quit-restore entry.
5288 (set-window-parameter
5289 window 'quit-restore
5290 (list (window-buffer window) (window-start window)
5291 (window-point window) buffer
5292 (window-total-size window) (selected-window)))))
5293 window))
5294
5295 (when window
5296 (unless (window-parameter window 'window-slot)
5297 ;; Don't change exisiting slot value.
5298 (set-window-parameter window 'window-slot slot))
5299 (display-buffer-in-window buffer window specifiers)))))
5300
5386012d 5301(defun window-normalize-buffer-to-display (buffer-or-name)
fbf5b3ce
MR
5302 "Normalize BUFFER-OR-NAME argument for buffer display functions.
5303If BUFFER-OR-NAME is nil, return the curent buffer. Else, if a
5304buffer specified by BUFFER-OR-NAME exists, return that buffer.
5305If no such buffer exists, create a buffer with the name
5306BUFFER-OR-NAME and return that buffer."
5307 (if buffer-or-name
5308 (or (get-buffer buffer-or-name)
5309 (let ((buffer (get-buffer-create buffer-or-name)))
5310 (set-buffer-major-mode buffer)
5311 buffer))
5312 (current-buffer)))
5313
25aef8b8
MR
5314(defun display-buffer-other-window-means-other-frame (buffer-or-name &optional label)
5315 "Return non-nil if BUFFER shall be preferably displayed in another frame.
5316BUFFER must be a live buffer or the name of a live buffer.
5317
5318Return nil if BUFFER shall be preferably displayed in another
5319window on the selected frame. Return non-nil if BUFFER shall be
5320preferably displayed in a window on any but the selected frame.
5321
5322Optional argument LABEL is like the same argument of
5323`display-buffer'.
5324
5325The calculation of the return value is exclusively based on the
5326user preferences expressed in `display-buffer-alist'."
5386012d 5327 (let* ((buffer (window-normalize-buffer buffer-or-name))
fbf5b3ce 5328 (list (display-buffer-normalize-alist (buffer-name buffer) label))
25aef8b8
MR
5329 (value (assq 'other-window-means-other-frame
5330 (or (car list) (cdr list)))))
5331 (when value (cdr value))))
5332
355f2e07
MR
5333(defun display-buffer-normalize-arguments (buffer-name specifiers label other-frame)
5334 "Normalize second and third argument of `display-buffer'.
fbf5b3ce 5335BUFFER-NAME is the name of the buffer that shall be displayed,
355f2e07
MR
5336SPECIFIERS is the second argument of `display-buffer'. LABEL is
5337the same argument of `display-buffer'. OTHER-FRAME non-nil means
5338use other-frame for other-window."
5339 (let (normalized entry specifier pars)
5340 (setq specifier
5341 (cond
5342 ((not specifiers)
5343 nil)
5344 ((listp specifiers)
5345 ;; If SPECIFIERS is a list, we assume it is a list of specifiers.
5346 (dolist (specifier specifiers)
5347 (cond
5348 ((consp specifier)
5349 (setq normalized (cons specifier normalized)))
5350 ((eq specifier 'other-window)
5351 ;; `other-window' must be treated separately.
5352 (let ((entry (assq (if other-frame
5353 'other-frame
5354 'same-frame-other-window)
5355 display-buffer-macro-specifiers)))
5356 (dolist (item (cdr entry))
5357 (setq normalized (cons item normalized)))))
5358 ((symbolp specifier)
5359 ;; Might be a macro specifier, try to expand it (the cdr is a
5360 ;; list and we have to reverse it later, so do it one at a
5361 ;; time).
5362 (let ((entry (assq specifier display-buffer-macro-specifiers)))
5363 (dolist (item (cdr entry))
5364 (setq normalized (cons item normalized)))))))
5365 ;; Reverse list.
5366 (nreverse normalized))
5367 ((setq entry (assq specifiers display-buffer-macro-specifiers))
5368 ;; A macro specifier.
5369 (cdr entry))
5370 ((or other-frame (with-no-warnings pop-up-frames))
5371 ;; `special-display-p' group.
5372 (if (and (with-no-warnings special-display-function)
5373 ;; `special-display-p' returns either t or a list
5374 ;; of frame parameters to pass to
5375 ;; `special-display-function'.
5376 (setq pars (with-no-warnings
5377 (special-display-p buffer-name))))
5386012d 5378 (list (list 'function
355f2e07
MR
5379 (with-no-warnings special-display-function)
5380 (when (listp pars) pars)))
5381 ;; Pop up another frame.
5382 (cddr (assq 'other-frame display-buffer-macro-specifiers))))
5383 (t
5384 ;; In any other case pop up a new window.
5385 (cdr (assq 'same-frame-other-window
5386 display-buffer-macro-specifiers)))))
5387
5388 ;; Handle the old meaning of the LABEL argument of `display-buffer'.
9481c002 5389 (cond
355f2e07
MR
5390 ((or (memq label '(visible 0 t)) (frame-live-p label))
5391 ;; LABEL must be one of visible (and visible frame), 0 (any
5392 ;; visible or iconfied frame), t (any frame), or a live frame.
5393 (cons `(reuse-window nil same ,label) specifier))
5394 ((or other-frame
5395 (with-no-warnings pop-up-frames)
5396 (with-no-warnings display-buffer-reuse-frames))
5397 (cons '(reuse-window nil same 0) specifier))
9b9c9e3a 5398 (t
355f2e07 5399 specifier))))
9481c002 5400
fbf5b3ce 5401(defun display-buffer-normalize-options (buffer-or-name)
9481c002
MR
5402 "Subroutine of `display-buffer-normalize-specifiers'.
5403BUFFER-OR-NAME is the buffer to display. This routine provides a
5404compatibility layer for the now obsolete Emacs 23 buffer display
5405options."
327c8fb1 5406 (with-no-warnings
5386012d 5407 (let* ((buffer (window-normalize-buffer buffer-or-name))
327c8fb1
MR
5408 (buffer-name (buffer-name buffer))
5409 (use-pop-up-frames
5410 (or (and (eq pop-up-frames 'graphic-only)
5411 (display-graphic-p))
5412 pop-up-frames))
5413 specifiers)
d1067961
MR
5414 ;; `even-window-heights', unless nil or unset.
5415 (unless (memq even-window-heights '(nil unset))
5416 (setq specifiers
5417 (cons (cons 'reuse-window-even-sizes t) specifiers)))
5418
9481c002 5419 ;; `display-buffer-mark-dedicated'
d1067961 5420 (when display-buffer-mark-dedicated
9481c002
MR
5421 (setq specifiers
5422 (cons (cons 'dedicate display-buffer-mark-dedicated)
5423 specifiers)))
5424
5425 ;; `pop-up-window' group. Anything is added here iff
5426 ;; `pop-up-windows' is neither nil nor unset.
5427 (let ((pop-up-window (not (memq pop-up-windows '(nil unset))))
5428 (fun (unless (eq split-window-preferred-function
5429 'split-window-sensibly)
5430 split-window-preferred-function))
5431 (min-height (if (numberp split-height-threshold)
5432 (/ split-height-threshold 2)
5433 1.0))
5434 (min-width (if (numberp split-width-threshold)
5435 (/ split-width-threshold 2)
5436 1.0)))
be3fb2b8
MR
5437 ;; Create an entry only if a default value was changed.
5438 (when (or pop-up-window
5439 (not (equal split-height-threshold 80))
5440 (not (equal split-width-threshold 160)))
5441 ;; `reuse-window' (needed as fallback when popping up the new
5442 ;; window fails).
9481c002 5443 (setq specifiers
be3fb2b8 5444 (cons (list 'reuse-window 'other nil nil)
9481c002
MR
5445 specifiers))
5446 ;; `split-width-threshold'
5447 (setq specifiers
5448 (cons (cons 'pop-up-window-min-width min-width)
5449 specifiers))
be3fb2b8
MR
5450 ;; `split-height-threshold'
5451 (setq specifiers
5452 (cons (cons 'pop-up-window-min-height min-height)
5453 specifiers))
9481c002
MR
5454 ;; `pop-up-window'
5455 (setq specifiers
5456 (cons (list 'pop-up-window
5457 (cons 'largest fun) (cons 'lru fun))
5458 specifiers))))
5459
327c8fb1
MR
5460 ;; `pop-up-frame' group.
5461 (when use-pop-up-frames
9481c002
MR
5462 ;; `pop-up-frame-function'. If `pop-up-frame-function' uses the
5463 ;; now obsolete `pop-up-frame-alist' it will continue to do so.
5464 (setq specifiers
5465 (cons (cons 'pop-up-frame-function pop-up-frame-function)
5466 specifiers))
5467 ;; `pop-up-frame'
5468 (setq specifiers
327c8fb1
MR
5469 (cons (list 'pop-up-frame t) specifiers)))
5470
5471 ;; `pop-up-windows' and `use-pop-up-frames' both nil means means
5472 ;; we are supposed to reuse any window on the same frame (unless
5473 ;; we find one showing the same buffer already).
5474 (unless (or pop-up-windows use-pop-up-frames)
5475 ;; `reuse-window' showing any buffer on same frame.
5476 (setq specifiers
5477 (cons (list 'reuse-window nil nil nil)
5478 specifiers)))
9481c002 5479
9a028c23
MR
5480 ;; `special-display-p' group.
5481 (when special-display-function
5482 ;; `special-display-p' returns either t or a list of frame
5483 ;; parameters to pass to `special-display-function'.
5484 (let ((pars (special-display-p buffer-name)))
5485 (when pars
5486 (setq specifiers
5386012d 5487 (cons (list 'function special-display-function
9a028c23
MR
5488 (when (listp pars) pars))
5489 specifiers)))))
5490
9e9de014
MR
5491 ;; `pop-up-frames', `display-buffer-reuse-frames' means search for
5492 ;; a window showing the buffer on some visible or iconfied frame.
5493 ;; `last-nonminibuffer-frame' set and not the same frame means
5494 ;; search that frame.
bd168c06
MR
5495 (let ((frames (or (and (or use-pop-up-frames
5496 display-buffer-reuse-frames
5497 (not (last-nonminibuffer-frame)))
327c8fb1 5498 ;; All visible or iconfied frames.
bd168c06 5499 0)
9e9de014 5500 ;; Same frame.
bd168c06 5501 (last-nonminibuffer-frame))))
327c8fb1
MR
5502 (when frames
5503 (setq specifiers
5504 (cons (list 'reuse-window 'other 'same frames)
5505 specifiers))))
5506
d1067961
MR
5507 ;; `same-window-p' group.
5508 (when (same-window-p buffer-name)
5509 ;; Try to reuse the same (selected) window.
5510 (setq specifiers
5511 (cons (list 'reuse-window 'same nil nil)
5512 specifiers)))
9481c002 5513
d1067961 5514 ;; Prepend "reuse window on same frame if showing the buffer
327c8fb1
MR
5515 ;; already" specifier. It will be overriden by the application
5516 ;; supplied 'other-window specifier.
d1067961
MR
5517 (setq specifiers (cons (list 'reuse-window nil 'same nil)
5518 specifiers))
9481c002
MR
5519
5520 specifiers)))
5521
fbf5b3ce
MR
5522(defun display-buffer-normalize-alist-1 (specifiers label)
5523 "Subroutine of `display-buffer-normalize-alist'.
5524SPECIFIERS is a list of buffer display specfiers. LABEL is the
5525same argument of `display-buffer'."
5526 (let (normalized entry)
5527 (cond
5528 ((not specifiers)
5529 nil)
5530 ((listp specifiers)
5531 ;; If SPECIFIERS is a list, we assume it is a list of specifiers.
5532 (dolist (specifier specifiers)
5533 (cond
5534 ((consp specifier)
5535 (setq normalized (cons specifier normalized)))
5536 ((symbolp specifier)
5537 ;; Might be a macro specifier, try to expand it (the cdr is a
5538 ;; list and we have to reverse it later, so do it one at a
5539 ;; time).
5540 (let ((entry (assq specifier display-buffer-macro-specifiers)))
5541 (dolist (item (cdr entry))
5542 (setq normalized (cons item normalized)))))))
5543 ;; Reverse list.
5544 (nreverse normalized))
5545 ((setq entry (assq specifiers display-buffer-macro-specifiers))
5546 ;; A macro specifier.
5547 (cdr entry)))))
5548
5549(defun display-buffer-normalize-alist (buffer-name label)
5550 "Normalize `display-buffer-alist'.
5551BUFFER-NAME must be the name of the buffer that shall be displayed.
5552LABEL the corresponding argument of `display-buffer'."
9481c002
MR
5553 (let (list-1 list-2)
5554 (dolist (entry display-buffer-alist)
5555 (when (and (listp entry)
5556 (catch 'match
5557 (dolist (id (car entry))
5558 (when (consp id)
5559 (let ((type (car id))
5560 (value (cdr id)))
5561 (when (or (and (eq type 'name) (stringp value)
5562 (equal value buffer-name))
5563 (and (eq type 'regexp) (stringp value)
5564 (string-match-p value buffer-name))
5565 (and (eq type 'label) (eq value label)))
5566 (throw 'match t)))))))
fbf5b3ce 5567 (let* ((specifiers (cdr entry))
25aef8b8 5568 (normalized
fbf5b3ce 5569 (display-buffer-normalize-alist-1 specifiers label)))
5f45cca5 5570 (if (cdr (assq 'override specifiers))
9481c002
MR
5571 (setq list-1
5572 (if list-1
5573 (append list-1 normalized)
5574 normalized))
5575 (setq list-2
5576 (if list-2
5577 (append list-2 normalized)
5578 normalized))))))
5579
25aef8b8
MR
5580 (cons list-1 list-2)))
5581
fbf5b3ce
MR
5582(defvar display-buffer-normalize-options-inhibit nil
5583 "If non-nil, `display-buffer' doesn't process obsolete options.")
5584
25aef8b8
MR
5585(defun display-buffer-normalize-specifiers (buffer-name specifiers label)
5586 "Return normalized specifiers for a buffer matching BUFFER-NAME or LABEL.
5587BUFFER-NAME must be a string specifying a valid buffer name.
5588SPECIFIERS and LABEL are the homonymous arguments of
5589`display-buffer'.
5590
5591The method for displaying the buffer specified by BUFFER-NAME or
5592LABEL is established by appending the following four lists of
5593specifiers:
5594
5595- The specifiers in `display-buffer-alist' whose buffer
5596 identifier matches BUFFER-NAME or LABEL and whose 'override
5597 component is set.
5598
5599- SPECIFIERS.
5600
5601- The specifiers in `display-buffer-alist' whose buffer
5602 identifier matches BUFFER-NAME or LABEL and whose 'override
5603 component is not set.
5604
5605- `display-buffer-default-specifiers'."
fbf5b3ce 5606 (let* ((list (display-buffer-normalize-alist buffer-name label))
5f45cca5
MR
5607 (other-frame (cdr (assq 'other-window-means-other-frame
5608 (or (car list) (cdr list))))))
9481c002
MR
5609 (append
5610 ;; Overriding user specifiers.
25aef8b8 5611 (car list)
9481c002 5612 ;; Application specifiers.
355f2e07 5613 (display-buffer-normalize-arguments
fbf5b3ce 5614 buffer-name specifiers label other-frame)
9481c002 5615 ;; Emacs 23 compatibility specifiers.
fbf5b3ce
MR
5616 (unless display-buffer-normalize-options-inhibit
5617 (display-buffer-normalize-options buffer-name))
9481c002 5618 ;; Non-overriding user specifiers.
25aef8b8 5619 (cdr list)
9481c002
MR
5620 ;; Default specifiers.
5621 display-buffer-default-specifiers)))
5622
5623;; Minibuffer-only frames should be documented better. They really
5624;; deserve a separate section in the manual. Also
5625;; `last-nonminibuffer-frame' is nowhere documented in the manual.
5626(defun display-buffer-frame (&optional frame)
5627 "Return FRAME if it is live and not a minibuffer-only frame.
5628Return the value of `last-nonminibuffer-frame' otherwise."
5386012d 5629 (setq frame (window-normalize-frame frame))
9481c002
MR
5630 (if (and (frame-live-p frame)
5631 ;; A not very nice way to get that information.
5632 (not (window-minibuffer-p (frame-root-window frame))))
5633 frame
5634 (last-nonminibuffer-frame)))
5635
5636(defun display-buffer (&optional buffer-or-name specifiers label)
5637 "Make the buffer specified by BUFFER-OR-NAME appear in some window.
5638Optional argument BUFFER-OR-NAME may be a buffer, a string \(a
5639buffer name), or nil. If BUFFER-OR-NAME is a string not naming
5640an existent buffer, create a buffer with that name. If
5641BUFFER-OR-NAME is nil or omitted, display the current buffer.
5642Interactively, prompt for the buffer name using the minibuffer.
5643
5644Return the window chosen to display the buffer or nil if no such
5645window is found. Do not change the selected window unless the
5646buffer is shown on a different frame than the selected one.
5647
5648Optional argument SPECIFIERS must be a list of buffer display
5649specifiers, see the documentation of `display-buffer-alist' for a
5650description.
5651
5652For convenience, SPECIFIERS may also consist of a single buffer
5653display location specifier or t, where the latter means to
5654display the buffer in any but the selected window. If SPECIFIERS
5655is nil or omitted, this means to exclusively use the specifiers
5656provided by `display-buffer-alist'. If the value of the latter
5657is nil too, all specifiers are provided by the constant
5658`display-buffer-default-specifiers'.
5659
5660As a special case, the `reuse-window' specifier allows to specify
5661as second element an arbitrary window, as third element an
5662arbitrary buffer, and as fourth element an arbitrary frame. As
5663first element of a window/side pair of the `pop-up-window'
5664specifier you can specifiy an arbitrary window.
5665
5666The optional third argument LABEL, if non-nil, must be a symbol
5667specifiying the buffer display label. Applications should set
5668this when the buffer shall be displayed in some special way but
5669BUFFER-OR-NAME does not identify the buffer as special. Typical
5670buffers that fit into this category are those whose names are
5671derived from the name of the file they are visiting. A user can
5672override SPECIFIERS by adding an entry to `display-buffer-alist'
5673whose car contains LABEL and whose cdr specifies the preferred
5674alternative display method.
5675
355f2e07
MR
5676The following values of LABEL have a special meaning and allow to
5677specify the set of frames to investigate when the buffer already
5678appears in a window:
5679
5680`visible' - the set of visible frames.
5681
56820 - the set of visible or iconified frames.
5683
5684t - the set of all frames.
5685
5686A live frame - the set containing that frame as its only element.
5687
5688If the buffer is already displayed in a window on a frame in the
5689specified set, return that window.
5690
9481c002
MR
5691The method to display the buffer is derived by combining the
5692values of `display-buffer-alist' and SPECIFIERS. Highest
5693priority is given to overriding elements of
5694`display-buffer-alist'. Next come the elements specified by
5695SPECIFIERS, followed by the non-overriding elements of
5696`display-buffer-alist'.
5697
5698The result must be a list of valid buffer display specifiers. If
5699`display-buffer-function' is non-nil, call it with the buffer and
5700this list as arguments."
5701 (interactive "BDisplay buffer:\nP")
5386012d 5702 (let* ((buffer (window-normalize-buffer-to-display buffer-or-name))
9481c002 5703 (buffer-name (buffer-name buffer))
02cfc6d6 5704 (normalized
9481c002
MR
5705 ;; Normalize specifiers.
5706 (display-buffer-normalize-specifiers buffer-name specifiers label))
5707 ;; Don't use a minibuffer frame.
5708 (frame (display-buffer-frame))
5709 ;; `window' is the window we use for showing `buffer'.
5710 window specifier method)
5711 ;; Reset this.
5712 (setq display-buffer-window nil)
5713 (if display-buffer-function
5714 ;; Let `display-buffer-function' do the job.
5715 (funcall display-buffer-function buffer specifiers)
5716 ;; Retrieve the next location specifier while there a specifiers
5717 ;; left and we don't have a valid window.
02cfc6d6
MR
5718 (while (and normalized (not (window-live-p window)))
5719 (setq specifier (car normalized))
5720 (setq normalized (cdr normalized))
9481c002
MR
5721 (setq method (car specifier))
5722 (setq window
5723 (cond
5724 ((eq method 'reuse-window)
5725 (display-buffer-reuse-window
02cfc6d6 5726 buffer (cdr specifier) normalized))
9481c002
MR
5727 ((eq method 'pop-up-window)
5728 (display-buffer-pop-up-window
02cfc6d6 5729 buffer (cdr specifier) normalized))
9481c002
MR
5730 ((eq method 'pop-up-frame)
5731 (display-buffer-pop-up-frame
02cfc6d6 5732 buffer (cdr specifier) normalized))
9481c002
MR
5733 ((eq method 'use-side-window)
5734 (display-buffer-in-side-window
02cfc6d6 5735 buffer (nth 1 specifier) (nth 2 specifier) normalized))
5386012d 5736 ((eq method 'function)
0bf4ba9a 5737 (funcall (nth 1 specifier) buffer (nth 2 specifier))))))
9481c002
MR
5738
5739 ;; If we don't have a window yet, try a fallback method. All
5740 ;; specifiers have been used up by now.
5741 (or (and (window-live-p window) window)
5742 ;; Try reusing a window showing BUFFER on any visible or
5743 ;; iconfied frame.
355f2e07 5744 (display-buffer-reuse-window buffer `(nil ,buffer 0))
9481c002
MR
5745 ;; Try reusing a window not showing BUFFER on any visible or
5746 ;; iconified frame.
5747 (display-buffer-reuse-window buffer '(nil other 0))
355f2e07
MR
5748 ;; Eli says it's better to never try making a new frame.
5749 ;; (display-buffer-pop-up-frame buffer)
baa1c9ab 5750 ;; Try using a weakly dedicated window.
9481c002
MR
5751 (display-buffer-reuse-window
5752 buffer '(nil nil t) '((reuse-window-dedicated . weak)))
baa1c9ab 5753 ;; Try using a strongly dedicated window.
9481c002
MR
5754 (display-buffer-reuse-window
5755 buffer '(nil nil t) '((reuse-window-dedicated . t)))))))
5756
9173deec 5757(defsubst display-buffer-same-window (&optional buffer-or-name label)
9481c002
MR
5758 "Display buffer specified by BUFFER-OR-NAME in the selected window.
5759Another window will be used only if the buffer can't be shown in
5760the selected window, usually because it is dedicated to another
5761buffer. Optional argument BUFFER-OR-NAME and LABEL are as for
5762`display-buffer'."
5763 (interactive "BDisplay buffer in same window:\nP")
5764 (display-buffer buffer-or-name 'same-window label))
5765
9173deec 5766(defsubst display-buffer-same-frame (&optional buffer-or-name label)
9481c002
MR
5767 "Display buffer specified by BUFFER-OR-NAME in a window on the same frame.
5768Another frame will be used only if there is no other choice.
5769Optional argument BUFFER-OR-NAME and LABEL are as for
5770`display-buffer'."
5771 (interactive "BDisplay buffer on same frame:\nP")
5772 (display-buffer buffer-or-name 'same-frame label))
5773
9173deec 5774(defsubst display-buffer-other-window (&optional buffer-or-name label)
9481c002
MR
5775 "Display buffer specified by BUFFER-OR-NAME in another window.
5776The selected window will be used only if there is no other
5777choice. Windows on the selected frame are preferred to windows
5778on other frames. Optional argument BUFFER-OR-NAME and LABEL are as
5779for `display-buffer'."
5780 (interactive "BDisplay buffer in another window:\nP")
5781 (display-buffer buffer-or-name 'other-window label))
5782
9173deec 5783(defun display-buffer-same-frame-other-window (&optional buffer-or-name label)
9481c002
MR
5784 "Display buffer specified by BUFFER-OR-NAME in another window on the same frame.
5785The selected window or another frame will be used only if there
5786is no other choice. Optional argument BUFFER-OR-NAME and LABEL are
5787as for `display-buffer'."
5788 (interactive "BDisplay buffer in another window on same frame:\nP")
5789 (display-buffer buffer-or-name 'same-frame-other-window label))
5790
5791(defun display-buffer-other-frame (&optional buffer-or-name label)
5792 "Display buffer specified by BUFFER-OR-NAME on another frame.
5793The selected frame will be used only if there is no other choice.
5794Optional argument BUFFER-OR-NAME and LABEL are as for
5795`display-buffer'.
5796
5797If this command uses another frame, it will also select that frame."
5798 (interactive "BDisplay buffer in other frame: ")
5799 (display-buffer buffer-or-name 'other-frame label))
5800
5801(defun pop-to-buffer (&optional buffer-or-name specifiers norecord label)
5802 "Display buffer specified by BUFFER-OR-NAME and select the window used.
5803Optional argument BUFFER-OR-NAME may be a buffer, a string \(a
d4eaeab1
GM
5804buffer name), or nil. If BUFFER-OR-NAME is a string naming a buffer
5805that does not exist, create a buffer with that name. If
9481c002
MR
5806BUFFER-OR-NAME is nil or omitted, display the current buffer.
5807Interactively, prompt for the buffer name using the minibuffer.
5808
d4eaeab1
GM
5809Optional second argument SPECIFIERS can be: a list of buffer
5810display specifiers (see `display-buffer-alist'); a single
5811location specifier; t, which means to display the buffer in any
5812but the selected window; or nil, which means to exclusively apply
5813the specifiers customized by the user. See `display-buffer' for
5814more details.
9481c002 5815
d4eaeab1
GM
5816Optional argument NORECORD non-nil means do not put the displayed
5817buffer at the front of the buffer list, and do not make the window
5818displaying it the most recently selected one.
9481c002
MR
5819
5820The optional argument LABEL, if non-nil, is a symbol specifying the
5821display purpose. Applications should set this when the buffer
d4eaeab1 5822should be displayed in a special way but BUFFER-OR-NAME does not
9481c002
MR
5823identify the buffer as special. Buffers that typically fit into
5824this category are those whose names have been derived from the
5825name of the file they are visiting.
5826
d4eaeab1 5827Returns the displayed buffer, or nil if displaying the buffer failed.
9481c002
MR
5828
5829This uses the function `display-buffer' as a subroutine; see the
5830documentations of `display-buffer' and `display-buffer-alist' for
5831additional information."
5832 (interactive "BPop to buffer:\nP")
5386012d 5833 (let ((buffer (window-normalize-buffer-to-display buffer-or-name))
327c8fb1
MR
5834 (old-window (selected-window))
5835 (old-frame (selected-frame))
5836 new-window new-frame)
9481c002 5837 (set-buffer buffer)
327c8fb1
MR
5838 (setq new-window (display-buffer buffer specifiers label))
5839 (unless (eq new-window old-window)
5840 ;; `display-buffer' has chosen another window, select it.
5841 (select-window new-window norecord)
5842 (setq new-frame (window-frame new-window))
5843 (unless (eq new-frame old-frame)
5844 ;; `display-buffer' has chosen another frame, make sure it gets
5845 ;; input focus and is risen.
5846 (select-frame-set-input-focus new-frame)))
5847
5848 buffer))
9481c002
MR
5849
5850(defsubst pop-to-buffer-same-window (&optional buffer-or-name norecord label)
5851 "Pop to buffer specified by BUFFER-OR-NAME in the selected window.
5852Another window will be used only if the buffer can't be shown in
5853the selected window, usually because it is dedicated to another
5854buffer. Optional arguments BUFFER-OR-NAME, NORECORD and LABEL are
5855as for `pop-to-buffer'."
5856 (interactive "BPop to buffer in selected window:\nP")
5857 (pop-to-buffer buffer-or-name 'same-window norecord label))
5858
9173deec 5859(defsubst pop-to-buffer-same-frame (&optional buffer-or-name norecord label)
9481c002
MR
5860 "Pop to buffer specified by BUFFER-OR-NAME in a window on the selected frame.
5861Another frame will be used only if there is no other choice.
5862Optional arguments BUFFER-OR-NAME, NORECORD and LABEL are as for
5863`pop-to-buffer'."
5864 (interactive "BPop to buffer on same frame:\nP")
5865 (pop-to-buffer buffer-or-name 'same-frame norecord label))
5866
5867(defsubst pop-to-buffer-other-window (&optional buffer-or-name norecord label)
5868 "Pop to buffer specified by BUFFER-OR-NAME in another window.
5869The selected window will be used only if there is no other
5870choice. Windows on the selected frame are preferred to windows
5871on other frames. Optional arguments BUFFER-OR-NAME, NORECORD and
5872LABEL are as for `pop-to-buffer'."
5873 (interactive "BPop to buffer in another window:\nP")
5874 (pop-to-buffer buffer-or-name 'other-window norecord))
5875
9173deec 5876(defsubst pop-to-buffer-same-frame-other-window (&optional buffer-or-name norecord label)
9481c002
MR
5877 "Pop to buffer specified by BUFFER-OR-NAME in another window on the selected frame.
5878The selected window or another frame will be used only if there
5879is no other choice. Optional arguments BUFFER-OR-NAME, NORECORD
5880and LABEL are as for `pop-to-buffer'."
5881 (interactive "BPop to buffer in another window on same frame:\nP")
5882 (pop-to-buffer buffer-or-name 'same-frame-other-window norecord label))
5883
5884(defsubst pop-to-buffer-other-frame (&optional buffer-or-name norecord label)
5885 "Pop to buffer specified by BUFFER-OR-NAME on another frame.
5886The selected frame will be used only if there's no other choice.
5887Optional arguments BUFFER-OR-NAME, NORECORD and LABEL are as for
5888`pop-to-buffer'."
5889 (interactive "BPop to buffer on another frame:\nP")
5890 (pop-to-buffer buffer-or-name 'other-frame norecord label))
5891
5892(defun read-buffer-to-switch (prompt)
5893 "Read the name of a buffer to switch to, prompting with PROMPT.
5894Return the neame of the buffer as a string.
5895
5896This function is intended for the `switch-to-buffer' family of
5897commands since these need to omit the name of the current buffer
5898from the list of completions and default values."
5899 (let ((rbts-completion-table (internal-complete-buffer-except)))
5900 (minibuffer-with-setup-hook
5901 (lambda ()
5902 (setq minibuffer-completion-table rbts-completion-table)
5903 ;; Since rbts-completion-table is built dynamically, we
5904 ;; can't just add it to the default value of
5905 ;; icomplete-with-completion-tables, so we add it
5906 ;; here manually.
5907 (if (and (boundp 'icomplete-with-completion-tables)
5908 (listp icomplete-with-completion-tables))
5909 (set (make-local-variable 'icomplete-with-completion-tables)
5910 (cons rbts-completion-table
5911 icomplete-with-completion-tables))))
5912 (read-buffer prompt (other-buffer (current-buffer))
5913 (confirm-nonexistent-file-or-buffer)))))
5914
5386012d 5915(defun window-normalize-buffer-to-switch-to (buffer-or-name)
9481c002
MR
5916 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
5917If BUFFER-OR-NAME is nil, return the buffer returned by
5918`other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
5919exists, return that buffer. If no such buffer exists, create a
5920buffer with the name BUFFER-OR-NAME and return that buffer."
5921 (if buffer-or-name
5922 (or (get-buffer buffer-or-name)
5923 (let ((buffer (get-buffer-create buffer-or-name)))
5924 (set-buffer-major-mode buffer)
5925 buffer))
5926 (other-buffer)))
5927
5928(defun switch-to-buffer (buffer-or-name &optional norecord)
5929 "Switch to buffer BUFFER-OR-NAME in the selected window.
5930If called interactively, prompt for the buffer name using the
5931minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5932determines whether to request confirmation before creating a new
5933buffer.
5934
5935BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
5936nil. If BUFFER-OR-NAME is a string that does not identify an
5937existing buffer, create a buffer with that name. If
5938BUFFER-OR-NAME is nil, switch to the buffer returned by
5939`other-buffer'.
5940
5941Optional argument NORECORD non-nil means do not put the buffer
5942specified by BUFFER-OR-NAME at the front of the buffer list and
5943do not make the window displaying it the most recently selected
5944one. Return the buffer switched to.
5945
5946This function is intended for interactive use only. Lisp
5947functions should call `pop-to-buffer-same-window' instead."
5948 (interactive
5949 (list (read-buffer-to-switch "Switch to buffer: ")))
5386012d 5950 (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name)))
0e61a35f
SM
5951 (cond
5952 ;; Don't call set-window-buffer if it's not needed since it
5953 ;; might signal an error (e.g. if the window is dedicated).
5954 ((eq buffer (window-buffer)) nil)
5955 ((window-minibuffer-p)
5956 (error "Cannot switch buffers in minibuffer window"))
5957 ((eq (window-dedicated-p) t)
5958 (error "Cannot switch buffers in a dedicated window"))
5959 (t (set-window-buffer nil buffer)))
5960 (unless norecord
5961 (select-window (selected-window)))
5962 (set-buffer buffer)))
9481c002
MR
5963
5964(defun switch-to-buffer-same-frame (buffer-or-name &optional norecord)
5965 "Switch to buffer BUFFER-OR-NAME in a window on the selected frame.
5966Another frame will be used only if there is no other choice.
981d5c09
MR
5967Arguments BUFFER-OR-NAME and NORECORD have the same meaning as
5968for `switch-to-buffer'.
9481c002
MR
5969
5970This function is intended for interactive use only. Lisp
5971functions should call `pop-to-buffer-same-frame' instead."
5972 (interactive
5973 (list (read-buffer-to-switch "Switch to buffer in other window: ")))
5386012d 5974 (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name)))
9481c002
MR
5975 (pop-to-buffer buffer 'same-frame norecord)))
5976
5977(defun switch-to-buffer-other-window (buffer-or-name &optional norecord)
5978 "Switch to buffer BUFFER-OR-NAME in another window.
5979The selected window will be used only if there is no other
5980choice. Windows on the selected frame are preferred to windows
981d5c09
MR
5981on other frames. Arguments BUFFER-OR-NAME and NORECORD have the
5982same meaning as for `switch-to-buffer'.
9481c002
MR
5983
5984This function is intended for interactive use only. Lisp
5985functions should call `pop-to-buffer-other-window' instead."
5986 (interactive
5987 (list (read-buffer-to-switch "Switch to buffer in other window: ")))
5386012d 5988 (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name)))
9481c002
MR
5989 (pop-to-buffer buffer 'other-window norecord)))
5990
5991(defun switch-to-buffer-other-window-same-frame (buffer-or-name &optional norecord)
5992 "Switch to buffer BUFFER-OR-NAME in another window on the selected frame.
5993The selected window or another frame will be used only if there
981d5c09
MR
5994is no other choice. Arguments BUFFER-OR-NAME and NORECORD have
5995the same meaning as for `switch-to-buffer'.
9481c002
MR
5996
5997This function is intended for interactive use only. Lisp
5998functions should call `pop-to-buffer-other-window-same-frame'
5999instead."
6000 (interactive
6001 (list (read-buffer-to-switch "Switch to buffer in other window: ")))
5386012d 6002 (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name)))
9481c002
MR
6003 (pop-to-buffer buffer 'same-frame-other-window norecord)))
6004
6005(defun switch-to-buffer-other-frame (buffer-or-name &optional norecord)
6006 "Switch to buffer BUFFER-OR-NAME on another frame.
6007The same frame will be used only if there is no other choice.
981d5c09
MR
6008Arguments BUFFER-OR-NAME and NORECORD have the same meaning
6009as for `switch-to-buffer'.
9481c002
MR
6010
6011This function is intended for interactive use only. Lisp
6012functions should call `pop-to-buffer-other-frame' instead."
6013 (interactive
6014 (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
5386012d 6015 (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name)))
9481c002
MR
6016 (pop-to-buffer buffer 'other-frame norecord)))
6017
6018;;; Obsolete definitions of `display-buffer' below.
6019(defcustom same-window-buffer-names nil
6020 "List of names of buffers that should appear in the \"same\" window.
6021`display-buffer' and `pop-to-buffer' show a buffer whose name is
6022on this list in the selected rather than some other window.
6023
6024An element of this list can be a cons cell instead of just a
6025string. In that case, the cell's car must be a string specifying
6026the buffer name. This is for compatibility with
6027`special-display-buffer-names'; the cdr of the cons cell is
6028ignored.
6029
6030See also `same-window-regexps'."
6031 :type '(repeat (string :format "%v"))
6032 :group 'windows)
0bf4ba9a
MR
6033;; (make-obsolete-variable
6034 ;; 'same-window-buffer-names
6035 ;; "use 2nd arg of `display-buffer' instead." "24.1")
9481c002
MR
6036
6037(defcustom same-window-regexps nil
6038 "List of regexps saying which buffers should appear in the \"same\" window.
6039`display-buffer' and `pop-to-buffer' show a buffer whose name
6040matches a regexp on this list in the selected rather than some
6041other window.
6042
6043An element of this list can be a cons cell instead of just a
6044string. In that case, the cell's car must be a regexp matching
6045the buffer name. This is for compatibility with
6046`special-display-regexps'; the cdr of the cons cell is ignored.
6047
6048See also `same-window-buffer-names'."
6049 :type '(repeat (regexp :format "%v"))
3c448ab6 6050 :group 'windows)
0bf4ba9a
MR
6051;; (make-obsolete-variable
6052 ;; 'same-window-regexps
6053 ;; "use 2nd arg of `display-buffer' instead." "24.1")
9481c002
MR
6054
6055(defun same-window-p (buffer-name)
6056 "Return non-nil if a buffer named BUFFER-NAME would be shown in the \"same\" window.
6057This function returns non-nil if `display-buffer' or
6058`pop-to-buffer' would show a buffer named BUFFER-NAME in the
6059selected rather than \(as usual\) some other window. See
6060`same-window-buffer-names' and `same-window-regexps'."
dbad4f69
MR
6061 (let ((buffer-names (with-no-warnings same-window-buffer-names))
6062 (regexps (with-no-warnings same-window-regexps)))
9481c002
MR
6063 (cond
6064 ((not (stringp buffer-name)))
6065 ;; The elements of `same-window-buffer-names' can be buffer
6066 ;; names or cons cells whose cars are buffer names.
6067 ((member buffer-name buffer-names))
6068 ((assoc buffer-name buffer-names))
6069 ((catch 'found
6070 (dolist (regexp regexps)
6071 ;; The elements of `same-window-regexps' can be regexps
6072 ;; or cons cells whose cars are regexps.
6073 (when (or (and (stringp regexp)
6074 (string-match regexp buffer-name))
6075 (and (consp regexp) (stringp (car regexp))
6076 (string-match-p (car regexp) buffer-name)))
6077 (throw 'found t))))))))
0bf4ba9a
MR
6078;; (make-obsolete
6079 ;; 'same-window-p "pass argument to buffer display function instead." "24.1")
9481c002
MR
6080
6081(defcustom special-display-frame-alist
6082 '((height . 14) (width . 80) (unsplittable . t))
6083 "Alist of parameters for special frames.
6084Special frames are used for buffers whose names are listed in
6085`special-display-buffer-names' and for buffers whose names match
6086one of the regular expressions in `special-display-regexps'.
6087
6088This variable can be set in your init file, like this:
6089
6090 (setq special-display-frame-alist '((width . 80) (height . 20)))
6091
6092These supersede the values given in `default-frame-alist'."
6093 :type '(repeat (cons :format "%v"
6094 (symbol :tag "Parameter")
6095 (sexp :tag "Value")))
6096 :group 'frames)
0bf4ba9a
MR
6097;; (make-obsolete-variable
6098 ;; 'special-display-frame-alist
6099 ;; "use 2nd arg of `display-buffer' instead." "24.1")
9481c002
MR
6100
6101(defun special-display-popup-frame (buffer &optional args)
6102 "Display BUFFER in a special frame and return the window chosen.
6103If BUFFER is already displayed in a visible or iconified frame,
6104raise that frame. Otherwise, display BUFFER in a way as
6105specified by optional argument ARGS.
6106
6107If ARGS is an alist, use it as a list of frame parameters. If
6108these parameters contain \(same-window . t), display BUFFER in
6109the selected window. If they contain \(same-frame . t), display
6110BUFFER in a window on the selected frame.
6111
6112If ARGS is a list whose car is a symbol, use (car ARGS) as a
6113function to do the work. Pass it BUFFER as first argument,
322b7dab 6114and (cdr ARGS) as the rest of the arguments."
9481c002
MR
6115 (if (and args (symbolp (car args)))
6116 (apply (car args) buffer (cdr args))
6117 (let ((window (get-buffer-window buffer 0)))
6118 (or
6119 ;; If we have a window already, make it visible.
6120 (when window
6121 (let ((frame (window-frame window)))
6122 (make-frame-visible frame)
6123 (raise-frame frame)
6124 window))
6125 ;; Reuse the current window if the user requested it.
6126 (when (cdr (assq 'same-window args))
6127 (display-buffer-reuse-window
be3fb2b8 6128 buffer '(same nil nil) '((reuse-dedicated . weak))))
9481c002
MR
6129 ;; Stay on the same frame if requested.
6130 (when (or (cdr (assq 'same-frame args))
6131 (cdr (assq 'same-window args)))
6132 (or (display-buffer-pop-up-window
6133 buffer '((largest . nil) (lru . nil)))
6134 (display-buffer-reuse-window
6135 buffer '(nil nil nil))))
6136 ;; If no window yet, make one in a new frame.
6137 (let ((frame
6138 (with-current-buffer buffer
6139 (make-frame
6140 (append args (with-no-warnings
6141 special-display-frame-alist))))))
6142 (set-window-buffer (frame-selected-window frame) buffer)
6143 (set-window-dedicated-p (frame-selected-window frame) t)
6144 (frame-selected-window frame))))))
0bf4ba9a
MR
6145;; (make-obsolete
6146 ;; 'special-display-popup-frame
6147 ;; "use 2nd arg of `display-buffer' instead." "24.1")
9481c002
MR
6148
6149(defcustom special-display-function 'special-display-popup-frame
6150 "Function to call for displaying special buffers.
6151This function is called with two arguments - the buffer and,
6152optionally, a list - and should return a window displaying that
6153buffer. The default value usually makes a separate frame for the
6154buffer using `special-display-frame-alist' to specify the frame
6155parameters. See the definition of `special-display-popup-frame'
6156for how to specify such a function.
6157
6158A buffer is special when its name is either listed in
6159`special-display-buffer-names' or matches a regexp in
6160`special-display-regexps'."
6161 :type 'function
6162 :group 'windows
6163 :group 'frames)
0bf4ba9a
MR
6164;; (make-obsolete-variable
6165 ;; 'special-display-function
6166 ;; "use 2nd arg of `display-buffer' instead." "24.1")
3c448ab6 6167
56f31926
MR
6168(defcustom special-display-buffer-names nil
6169 "List of names of buffers that should be displayed specially.
6170Displaying a buffer with `display-buffer' or `pop-to-buffer', if
6171its name is in this list, displays the buffer in a way specified
6172by `special-display-function'. `special-display-popup-frame'
6173\(the default for `special-display-function') usually displays
6174the buffer in a separate frame made with the parameters specified
6175by `special-display-frame-alist'. If `special-display-function'
6176has been set to some other function, that function is called with
6177the buffer as first, and nil as second argument.
6178
6179Alternatively, an element of this list can be specified as
6180\(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
6181name and FRAME-PARAMETERS an alist of \(PARAMETER . VALUE) pairs.
6182`special-display-popup-frame' will interpret such pairs as frame
6183parameters when it creates a special frame, overriding the
6184corresponding values from `special-display-frame-alist'.
6185
6186As a special case, if FRAME-PARAMETERS contains (same-window . t)
6187`special-display-popup-frame' displays that buffer in the
6188selected window. If FRAME-PARAMETERS contains (same-frame . t),
6189it displays that buffer in a window on the selected frame.
6190
6191If `special-display-function' specifies some other function than
6192`special-display-popup-frame', that function is called with the
6193buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
6194argument.
6195
6196Finally, an element of this list can be also specified as
6197\(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
6198`special-display-popup-frame' will call FUNCTION with the buffer
6199named BUFFER-NAME as first argument, and OTHER-ARGS as the
6200second. If `special-display-function' specifies some other
6201function, that function is called with the buffer named
6202BUFFER-NAME as first, and the element's cdr as second argument.
6203
6204If this variable appears \"not to work\", because you added a
6205name to it but the corresponding buffer is displayed in the
6206selected window, look at the values of `same-window-buffer-names'
6207and `same-window-regexps'. Those variables take precedence over
6208this one.
6209
6210See also `special-display-regexps'."
6211 :type '(repeat
6212 (choice :tag "Buffer"
6213 :value ""
6214 (string :format "%v")
6215 (cons :tag "With parameters"
6216 :format "%v"
6217 :value ("" . nil)
6218 (string :format "%v")
6219 (repeat :tag "Parameters"
6220 (cons :format "%v"
6221 (symbol :tag "Parameter")
6222 (sexp :tag "Value"))))
6223 (list :tag "With function"
6224 :format "%v"
6225 :value ("" . nil)
6226 (string :format "%v")
6227 (function :tag "Function")
6228 (repeat :tag "Arguments" (sexp)))))
6229 :group 'windows
6230 :group 'frames)
0bf4ba9a
MR
6231;; (make-obsolete-variable
6232 ;; 'special-display-buffer-names
6233 ;; "use 2nd arg of `display-buffer' instead." "24.1")
56f31926 6234
ac549fa5
GM
6235;;;###autoload
6236(put 'special-display-buffer-names 'risky-local-variable t)
6237
56f31926
MR
6238(defcustom special-display-regexps nil
6239 "List of regexps saying which buffers should be displayed specially.
6240Displaying a buffer with `display-buffer' or `pop-to-buffer', if
6241any regexp in this list matches its name, displays it specially
6242using `special-display-function'. `special-display-popup-frame'
6243\(the default for `special-display-function') usually displays
6244the buffer in a separate frame made with the parameters specified
6245by `special-display-frame-alist'. If `special-display-function'
6246has been set to some other function, that function is called with
6247the buffer as first, and nil as second argument.
6248
6249Alternatively, an element of this list can be specified as
6250\(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
6251FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
6252`special-display-popup-frame' will then interpret these pairs as
6253frame parameters when creating a special frame for a buffer whose
6254name matches REGEXP, overriding the corresponding values from
6255`special-display-frame-alist'.
6256
6257As a special case, if FRAME-PARAMETERS contains (same-window . t)
6258`special-display-popup-frame' displays buffers matching REGEXP in
6259the selected window. \(same-frame . t) in FRAME-PARAMETERS means
6260to display such buffers in a window on the selected frame.
6261
6262If `special-display-function' specifies some other function than
6263`special-display-popup-frame', that function is called with the
6264buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
6265as second argument.
6266
6267Finally, an element of this list can be also specified as
6268\(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
6269will then call FUNCTION with the buffer whose name matched
6270REGEXP as first, and OTHER-ARGS as second argument. If
6271`special-display-function' specifies some other function, that
6272function is called with the buffer whose name matched REGEXP
6273as first, and the element's cdr as second argument.
6274
6275If this variable appears \"not to work\", because you added a
6276name to it but the corresponding buffer is displayed in the
6277selected window, look at the values of `same-window-buffer-names'
6278and `same-window-regexps'. Those variables take precedence over
6279this one.
6280
6281See also `special-display-buffer-names'."
6282 :type '(repeat
6283 (choice :tag "Buffer"
6284 :value ""
6285 (regexp :format "%v")
6286 (cons :tag "With parameters"
6287 :format "%v"
6288 :value ("" . nil)
6289 (regexp :format "%v")
6290 (repeat :tag "Parameters"
6291 (cons :format "%v"
6292 (symbol :tag "Parameter")
6293 (sexp :tag "Value"))))
6294 (list :tag "With function"
6295 :format "%v"
6296 :value ("" . nil)
6297 (regexp :format "%v")
6298 (function :tag "Function")
6299 (repeat :tag "Arguments" (sexp)))))
6300 :group 'windows
6301 :group 'frames)
0bf4ba9a
MR
6302;; (make-obsolete-variable
6303 ;; 'special-display-regexps
6304 ;; "use 2nd arg of `display-buffer' instead." "24.1")
56f31926 6305
3c448ab6
MR
6306(defun special-display-p (buffer-name)
6307 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
56f31926
MR
6308More precisely, return t if `special-display-buffer-names' or
6309`special-display-regexps' contain a string entry equaling or
6310matching BUFFER-NAME. If `special-display-buffer-names' or
6311`special-display-regexps' contain a list entry whose car equals
6312or matches BUFFER-NAME, the return value is the cdr of that
6313entry."
9481c002
MR
6314 (let ((buffer-names (with-no-warnings special-display-buffer-names))
6315 (regexps (with-no-warnings special-display-regexps))
6316 tmp)
98722073
MR
6317 (cond
6318 ((not (stringp buffer-name)))
9481c002 6319 ((member buffer-name buffer-names)
98722073 6320 t)
9481c002 6321 ((setq tmp (assoc buffer-name buffer-names))
98722073
MR
6322 (cdr tmp))
6323 ((catch 'found
9481c002 6324 (dolist (regexp regexps)
98722073
MR
6325 (cond
6326 ((stringp regexp)
6327 (when (string-match-p regexp buffer-name)
6328 (throw 'found t)))
6329 ((and (consp regexp) (stringp (car regexp))
6330 (string-match-p (car regexp) buffer-name))
6331 (throw 'found (cdr regexp))))))))))
0bf4ba9a
MR
6332;; (make-obsolete
6333 ;; 'special-display-p
6334 ;; "pass argument to buffer display function instead." "24.1")
9481c002
MR
6335
6336(defcustom pop-up-frame-alist nil
6337 "Alist of parameters for automatically generated new frames.
6338You can set this in your init file; for example,
6339
6340 (setq pop-up-frame-alist '((width . 80) (height . 20)))
6341
6342If non-nil, the value you specify here is used by the default
6343`pop-up-frame-function' for the creation of new frames.
6344
6345Since `pop-up-frame-function' is used by `display-buffer' for
6346making new frames, any value specified here by default affects
6347the automatic generation of new frames via `display-buffer' and
6348all functions based on it. The behavior of `make-frame' is not
6349affected by this variable."
6350 :type '(repeat (cons :format "%v"
6351 (symbol :tag "Parameter")
6352 (sexp :tag "Value")))
6353 :group 'frames)
0bf4ba9a
MR
6354;; (make-obsolete-variable
6355 ;; 'pop-up-frame-alist
6356 ;; "use 2nd arg of `display-buffer' instead." "24.1")
9481c002
MR
6357
6358(defcustom pop-up-frame-function
6359 (lambda () (make-frame pop-up-frame-alist))
6360 "Function used by `display-buffer' for creating a new frame.
6361This function is called with no arguments and should return a new
6362frame. The default value calls `make-frame' with the argument
6363`pop-up-frame-alist'."
3c448ab6
MR
6364 :type 'function
6365 :group 'frames)
0bf4ba9a
MR
6366;; (make-obsolete-variable
6367 ;; 'pop-up-frame-function
6368 ;; "use 2nd arg of `display-buffer' instead." "24.1")
3c448ab6 6369
d1067961 6370(defcustom pop-up-frames nil
3c448ab6 6371 "Whether `display-buffer' should make a separate frame.
d1f18ec0 6372If nil, never make a separate frame.
3c448ab6
MR
6373If the value is `graphic-only', make a separate frame
6374on graphic displays only.
6375Any other non-nil value means always make a separate frame."
6376 :type '(choice
6377 (const :tag "Never" nil)
6378 (const :tag "On graphic displays only" graphic-only)
6379 (const :tag "Always" t))
9481c002
MR
6380 :group 'windows
6381 :group 'frames)
0bf4ba9a
MR
6382;; (make-obsolete-variable
6383 ;; 'pop-up-frames
6384 ;; "use 2nd arg of `display-buffer' instead." "24.1")
3c448ab6 6385
d1067961 6386(defcustom display-buffer-reuse-frames nil
9481c002 6387 "Set and non-nil means `display-buffer' should reuse frames.
3c448ab6
MR
6388If the buffer in question is already displayed in a frame, raise
6389that frame."
6390 :type 'boolean
d1067961 6391 :version "21.1"
9481c002
MR
6392 :group 'windows
6393 :group 'frames)
0bf4ba9a
MR
6394;; (make-obsolete-variable
6395 ;; 'display-buffer-reuse-frames
6396 ;; "use 2nd arg of `display-buffer' instead." "24.1")
3c448ab6 6397
9481c002
MR
6398(defcustom pop-up-windows 'unset ; t
6399 "Set and non-nil means `display-buffer' should make a new window."
3c448ab6 6400 :type 'boolean
9481c002 6401 :version "24.1"
3c448ab6 6402 :group 'windows)
0bf4ba9a
MR
6403;; (make-obsolete-variable
6404 ;; 'pop-up-windows
6405 ;; "use 2nd arg of `display-buffer' instead." "24.1")
3c448ab6 6406
8b10a2d1 6407(defcustom split-window-preferred-function 'split-window-sensibly
9481c002 6408 "Function called by `display-buffer' to split a window.
8b10a2d1
MR
6409This function is called with a window as single argument and is
6410supposed to split that window and return the new window. If the
6411window can (or shall) not be split, it is supposed to return nil.
9481c002 6412
8b10a2d1
MR
6413The default is to call the function `split-window-sensibly' which
6414tries to split the window in a way which seems most suitable.
6415You can customize the options `split-height-threshold' and/or
6416`split-width-threshold' in order to have `split-window-sensibly'
6417prefer either vertical or horizontal splitting.
6418
9481c002
MR
6419If you set this to any other function, bear in mind that
6420`display-buffer' may call that function repeatedly; the option
6421`pop-up-windows' controls which windows may become the argument
6422of this function.
8b10a2d1
MR
6423
6424The window selected at the time `display-buffer' was invoked is
6425still selected when this function is called. Hence you can
6426compare the window argument with the value of `selected-window'
6427if you intend to split the selected window instead or if you do
6428not want to split the selected window."
6429 :type 'function
3c448ab6
MR
6430 :version "23.1"
6431 :group 'windows)
0bf4ba9a
MR
6432;; (make-obsolete-variable
6433 ;; 'split-window-preferred-function
6434 ;; "use 2nd arg of `display-buffer' instead." "24.1")
3c448ab6 6435
8b10a2d1 6436(defcustom split-height-threshold 80
9481c002
MR
6437 "Minimum height for splitting a window to display a buffer.
6438If this is an integer, `display-buffer' can split a window
8b10a2d1 6439vertically only if it has at least this many lines. If this is
9481c002
MR
6440nil, `display-buffer' does not split windows vertically. If a
6441window is the only window on its frame, `display-buffer' may
6442split it vertically disregarding the value of this variable."
8b10a2d1 6443 :type '(choice (const nil) (integer :tag "lines"))
3c448ab6
MR
6444 :version "23.1"
6445 :group 'windows)
0bf4ba9a
MR
6446;; (make-obsolete-variable
6447 ;; 'split-height-threshold
6448 ;; "use 2nd arg of `display-buffer' instead." "24.1")
3c448ab6 6449
8b10a2d1 6450(defcustom split-width-threshold 160
9481c002
MR
6451 "Minimum width for splitting a window to display a buffer.
6452If this is an integer, `display-buffer' can split a window
8b10a2d1 6453horizontally only if it has at least this many columns. If this
9481c002 6454is nil, `display-buffer' cannot split windows horizontally."
8b10a2d1 6455 :type '(choice (const nil) (integer :tag "columns"))
3c448ab6
MR
6456 :version "23.1"
6457 :group 'windows)
0bf4ba9a
MR
6458;; (make-obsolete-variable
6459 ;; 'split-width-threshold
6460 ;; "use 2nd arg of `display-buffer' instead." "24.1")
9481c002 6461
d1067961
MR
6462(defcustom even-window-heights 'unset ; t
6463 "If set and non-nil `display-buffer' will try to even window heights.
9481c002
MR
6464Otherwise `display-buffer' will leave the window configuration
6465alone. Heights are evened only when `display-buffer' reuses a
6466window that appears above or below the selected window."
6467 :type 'boolean
d1067961 6468 :version "24.1"
9481c002 6469 :group 'windows)
0bf4ba9a
MR
6470;; (make-obsolete-variable
6471 ;; 'even-window-heights
6472 ;; "use 2nd arg of `display-buffer' instead." "24.1")
9481c002 6473
d1067961
MR
6474(defvar display-buffer-mark-dedicated nil
6475 "Non-nil means `display-buffer' marks the windows it creates as dedicated.
9481c002
MR
6476The actual non-nil value of this variable will be copied to the
6477`window-dedicated-p' flag.")
0bf4ba9a
MR
6478;; (make-obsolete-variable
6479 ;; 'display-buffer-mark-dedicated
6480 ;; "use 2nd arg of `display-buffer' instead." "24.1")
3c448ab6 6481
8b10a2d1
MR
6482(defun window-splittable-p (window &optional horizontal)
6483 "Return non-nil if `split-window-sensibly' may split WINDOW.
6484Optional argument HORIZONTAL nil or omitted means check whether
6485`split-window-sensibly' may split WINDOW vertically. HORIZONTAL
6486non-nil means check whether WINDOW may be split horizontally.
3c448ab6 6487
8b10a2d1 6488WINDOW may be split vertically when the following conditions
3c448ab6 6489hold:
3c448ab6
MR
6490- `window-size-fixed' is either nil or equals `width' for the
6491 buffer of WINDOW.
8b10a2d1 6492- `split-height-threshold' is an integer and WINDOW is at least as
3c448ab6 6493 high as `split-height-threshold'.
3c448ab6
MR
6494- When WINDOW is split evenly, the emanating windows are at least
6495 `window-min-height' lines tall and can accommodate at least one
6496 line plus - if WINDOW has one - a mode line.
6497
8b10a2d1 6498WINDOW may be split horizontally when the following conditions
3c448ab6 6499hold:
3c448ab6
MR
6500- `window-size-fixed' is either nil or equals `height' for the
6501 buffer of WINDOW.
8b10a2d1 6502- `split-width-threshold' is an integer and WINDOW is at least as
3c448ab6 6503 wide as `split-width-threshold'.
3c448ab6
MR
6504- When WINDOW is split evenly, the emanating windows are at least
6505 `window-min-width' or two (whichever is larger) columns wide."
6506 (when (window-live-p window)
6507 (with-current-buffer (window-buffer window)
6508 (if horizontal
6509 ;; A window can be split horizontally when its width is not
6510 ;; fixed, it is at least `split-width-threshold' columns wide
6511 ;; and at least twice as wide as `window-min-width' and 2 (the
6512 ;; latter value is hardcoded).
6513 (and (memq window-size-fixed '(nil height))
6514 ;; Testing `window-full-width-p' here hardly makes any
6515 ;; sense nowadays. This can be done more intuitively by
6516 ;; setting up `split-width-threshold' appropriately.
6517 (numberp split-width-threshold)
6518 (>= (window-width window)
6519 (max split-width-threshold
6520 (* 2 (max window-min-width 2)))))
6521 ;; A window can be split vertically when its height is not
6522 ;; fixed, it is at least `split-height-threshold' lines high,
6523 ;; and it is at least twice as high as `window-min-height' and 2
6524 ;; if it has a modeline or 1.
6525 (and (memq window-size-fixed '(nil width))
6526 (numberp split-height-threshold)
6527 (>= (window-height window)
6528 (max split-height-threshold
6529 (* 2 (max window-min-height
6530 (if mode-line-format 2 1))))))))))
0bf4ba9a
MR
6531;; (make-obsolete
6532 ;; 'window-splittable-p "use 2nd arg of `display-buffer' instead." "24.1")
3c448ab6 6533
8b10a2d1
MR
6534(defun split-window-sensibly (window)
6535 "Split WINDOW in a way suitable for `display-buffer'.
6536If `split-height-threshold' specifies an integer, WINDOW is at
6537least `split-height-threshold' lines tall and can be split
6538vertically, split WINDOW into two windows one above the other and
6539return the lower window. Otherwise, if `split-width-threshold'
6540specifies an integer, WINDOW is at least `split-width-threshold'
6541columns wide and can be split horizontally, split WINDOW into two
6542windows side by side and return the window on the right. If this
6543can't be done either and WINDOW is the only window on its frame,
6544try to split WINDOW vertically disregarding any value specified
6545by `split-height-threshold'. If that succeeds, return the lower
6546window. Return nil otherwise.
6547
6548By default `display-buffer' routines call this function to split
6549the largest or least recently used window. To change the default
6550customize the option `split-window-preferred-function'.
6551
6552You can enforce this function to not split WINDOW horizontally,
6553by setting \(or binding) the variable `split-width-threshold' to
6554nil. If, in addition, you set `split-height-threshold' to zero,
6555chances increase that this function does split WINDOW vertically.
6556
6557In order to not split WINDOW vertically, set \(or bind) the
6558variable `split-height-threshold' to nil. Additionally, you can
6559set `split-width-threshold' to zero to make a horizontal split
6560more likely to occur.
6561
6562Have a look at the function `window-splittable-p' if you want to
6563know how `split-window-sensibly' determines whether WINDOW can be
6564split."
9481c002 6565 (or (and (with-no-warnings (window-splittable-p window))
8b10a2d1
MR
6566 ;; Split window vertically.
6567 (with-selected-window window
6568 (split-window-vertically)))
9481c002 6569 (and (with-no-warnings (window-splittable-p window t))
8b10a2d1
MR
6570 ;; Split window horizontally.
6571 (with-selected-window window
6572 (split-window-horizontally)))
6573 (and (eq window (frame-root-window (window-frame window)))
6574 (not (window-minibuffer-p window))
6575 ;; If WINDOW is the only window on its frame and is not the
6576 ;; minibuffer window, try to split it vertically disregarding
6577 ;; the value of `split-height-threshold'.
6578 (let ((split-height-threshold 0))
9481c002 6579 (when (with-no-warnings (window-splittable-p window))
8b10a2d1
MR
6580 (with-selected-window window
6581 (split-window-vertically)))))))
0bf4ba9a
MR
6582;; (make-obsolete
6583 ;; 'split-window-sensibly "use 2nd arg of `display-buffer' instead." "24.1")
9481c002
MR
6584
6585;; Functions for converting Emacs 23 buffer display options to buffer
6586;; display specifiers.
6587(defun display-buffer-alist-add (identifiers specifiers &optional no-custom)
6588 "Helper function for `display-buffer-alist-set'."
6589 (unless identifiers
6590 (setq identifiers '((regexp . ".*"))))
6591 (unless (atom specifiers)
6592 (setq specifiers (delq nil specifiers)))
6593
6594 (if no-custom
6595 (setq display-buffer-alist
6596 (cons (cons identifiers specifiers) display-buffer-alist))
6597 (customize-set-variable
6598 'display-buffer-alist
6599 (cons (cons identifiers specifiers) display-buffer-alist))))
6600
6601(defun display-buffer-alist-set (&optional no-custom add)
6602 "Set `display-buffer-alist' from Emacs 23 buffer display options.
6603Optional argument NO-CUSTOM nil means use `customize-set-variable'
6604to set the value of `display-buffer-alist'. NO-CUSTOM non-nil
6605means to use `setq' instead.
6606
6607Optional argument ADD nil means to replace the actual value of
6608`display-buffer-alist' with the value calculated here. ADD
6609non-nil means prepend the value calculated here to the current
6610value of `display-buffer-alist'."
6611 (unless add
6612 (if no-custom
6613 (setq display-buffer-alist nil)
6614 (customize-set-variable 'display-buffer-alist nil)))
6615
6616 ;; Disable warnings, there are too many obsolete options here.
6617 (with-no-warnings
6618 ;; `pop-up-windows'
6619 (display-buffer-alist-add
6620 nil
6621 (let ((fun (unless (eq split-window-preferred-function
6622 'split-window-sensibly)
6623 ;; `split-window-sensibly' has been merged into the
6624 ;; `display-buffer-split-window' code as `nil'.
6625 split-window-preferred-function))
6626 (min-height
6627 (if (numberp split-height-threshold)
6628 (/ split-height-threshold 2)
6629 ;; Undocumented hack.
6630 1.0))
6631 (min-width
6632 (if (numberp split-width-threshold)
6633 (/ split-width-threshold 2)
6634 ;; Undocumented hack.
6635 1.0)))
6636 (list
6637 'pop-up-window
6638 (when pop-up-windows ; unset qualifies as t
6639 (list
6640 'pop-up-window
6641 (cons 'largest fun)
6642 (cons 'lru fun)))
6643 (cons 'pop-up-window-min-height min-height)
6644 (cons 'pop-up-window-min-width min-width)))
6645 no-custom)
6646
6647 ;; `pop-up-frames'
6648 (display-buffer-alist-add
6649 nil
6650 (list
6651 'pop-up-frame
d1067961 6652 (when pop-up-frames
9481c002
MR
6653 (list 'pop-up-frame pop-up-frames))
6654 (when pop-up-frame-function
6655 (cons 'pop-up-frame-function pop-up-frame-function))
6656 (when pop-up-frame-alist
6657 (cons 'pop-up-frame-alist pop-up-frame-alist)))
6658 no-custom)
6659
6660 ;; `special-display-regexps'
6661 (dolist (entry special-display-regexps)
6662 (cond
6663 ((stringp entry)
6664 ;; Plain string.
6665 (display-buffer-alist-add
6666 `((regexp . ,entry))
6667 (list
5386012d
MR
6668 'function
6669 (list 'function special-display-function
9481c002
MR
6670 special-display-frame-alist))
6671 no-custom))
6672 ((consp entry)
6673 (let ((name (car entry))
6674 (rest (cdr entry)))
6675 (cond
6676 ((functionp (car rest))
6677 ;; A function.
6678 (display-buffer-alist-add
6679 `((name . ,name))
6680 (list
5386012d 6681 'function
9481c002 6682 ;; Weary.
5386012d 6683 (list 'function (car rest) (cadr rest)))
9481c002
MR
6684 no-custom))
6685 ((listp rest)
6686 ;; A list of parameters.
6687 (cond
6688 ((assq 'same-window rest)
6689 (display-buffer-alist-add
6690 `((name . ,name))
6691 (list 'reuse-window
6692 (list 'reuse-window 'same)
6693 (list 'reuse-window-dedicated 'weak))
6694 no-custom))
6695 ((assq 'same-frame rest)
6696 (display-buffer-alist-add
6697 `((name . ,name)) (list 'same-frame) no-custom))
6698 (t
6699 (display-buffer-alist-add
6700 `((name . ,name))
6701 (list
5386012d
MR
6702 'function
6703 (list 'function special-display-function
9481c002
MR
6704 special-display-frame-alist))
6705 no-custom)))))))))
6706
6707 ;; `special-display-buffer-names'
6708 (dolist (entry special-display-buffer-names)
6709 (cond
6710 ((stringp entry)
6711 ;; Plain string.
6712 (display-buffer-alist-add
6713 `((name . ,entry))
6714 (list
5386012d
MR
6715 'function
6716 (list 'function special-display-function
9481c002
MR
6717 special-display-frame-alist))
6718 no-custom))
6719 ((consp entry)
6720 (let ((name (car entry))
6721 (rest (cdr entry)))
6722 (cond
6723 ((functionp (car rest))
6724 ;; A function.
6725 (display-buffer-alist-add
6726 `((name . ,name))
6727 (list
5386012d 6728 'function
9481c002 6729 ;; Weary.
5386012d 6730 (list 'function (car rest) (cadr rest)))
9481c002
MR
6731 no-custom))
6732 ((listp rest)
6733 ;; A list of parameters.
6734 (cond
6735 ((assq 'same-window rest)
6736 (display-buffer-alist-add
6737 `((name . ,name))
6738 (list 'reuse-window
6739 (list 'reuse-window 'same)
6740 (list 'reuse-window-dedicated 'weak))
6741 no-custom))
6742 ((assq 'same-frame rest)
6743 (display-buffer-alist-add
6744 `((name . ,name)) (list 'same-frame) no-custom))
6745 (t
6746 (display-buffer-alist-add
6747 `((name . ,name))
6748 (list
5386012d
MR
6749 'function
6750 (list 'function special-display-function
9481c002
MR
6751 special-display-frame-alist))
6752 no-custom)))))))))
6753
6754 ;; `same-window-regexps'
6755 (dolist (entry same-window-regexps)
6756 (cond
6757 ((stringp entry)
6758 (display-buffer-alist-add
6759 `((regexp . ,entry))
6760 (list 'reuse-window (list 'reuse-window 'same))
6761 no-custom))
6762 ((consp entry)
6763 (display-buffer-alist-add
6764 `((regexp . ,(car entry)))
6765 (list 'reuse-window (list 'reuse-window 'same))
6766 no-custom))))
6767
6768 ;; `same-window-buffer-names'
6769 (dolist (entry same-window-buffer-names)
6770 (cond
6771 ((stringp entry)
6772 (display-buffer-alist-add
6773 `((name . ,entry))
6774 (list 'reuse-window (list 'reuse-window 'same))
6775 no-custom))
6776 ((consp entry)
6777 (display-buffer-alist-add
6778 `((name . ,(car entry)))
6779 (list 'reuse-window (list 'reuse-window 'same))
6780 no-custom))))
6781
6782 ;; `reuse-window'
6783 (display-buffer-alist-add
6784 nil
6785 (list
6786 'reuse-window
6787 (list 'reuse-window nil 'same
d1067961 6788 (when (or display-buffer-reuse-frames pop-up-frames)
9481c002
MR
6789 ;; "0" (all visible and iconified frames) is hardcoded in
6790 ;; Emacs 23.
355f2e07 6791 0))
d1067961 6792 (unless (memq even-window-heights '(nil unset))
9481c002
MR
6793 (cons 'reuse-window-even-sizes t)))
6794 no-custom)
6795
6796 ;; `display-buffer-mark-dedicated'
d1067961 6797 (when display-buffer-mark-dedicated
9481c002
MR
6798 (display-buffer-alist-add
6799 nil
6800 (list
6801 (cons 'dedicated display-buffer-mark-dedicated))
6802 no-custom)))
6803
6804 display-buffer-alist)
3c448ab6
MR
6805\f
6806(defun set-window-text-height (window height)
9992ea0c 6807 "Set the height in lines of the text display area of WINDOW to HEIGHT.
6198ccd0
MR
6808WINDOW must be a live window. HEIGHT doesn't include the mode
6809line or header line, if any, or any partial-height lines in the
6810text display area.
3c448ab6
MR
6811
6812Note that the current implementation of this function cannot
6813always set the height exactly, but attempts to be conservative,
6814by allocating more lines than are actually needed in the case
6815where some error may be present."
5386012d 6816 (setq window (window-normalize-live-window window))
3c448ab6
MR
6817 (let ((delta (- height (window-text-height window))))
6818 (unless (zerop delta)
6819 ;; Setting window-min-height to a value like 1 can lead to very
6820 ;; bizarre displays because it also allows Emacs to make *other*
6821 ;; windows 1-line tall, which means that there's no more space for
6822 ;; the modeline.
6823 (let ((window-min-height (min 2 height))) ; One text line plus a modeline.
d615d6d2 6824 (window-resize window delta)))))
3c448ab6 6825
6198ccd0
MR
6826(defun enlarge-window-horizontally (delta)
6827 "Make selected window DELTA columns wider.
3c448ab6
MR
6828Interactively, if no argument is given, make selected window one
6829column wider."
6830 (interactive "p")
6198ccd0 6831 (enlarge-window delta t))
3c448ab6 6832
6198ccd0
MR
6833(defun shrink-window-horizontally (delta)
6834 "Make selected window DELTA columns narrower.
3c448ab6
MR
6835Interactively, if no argument is given, make selected window one
6836column narrower."
6837 (interactive "p")
6198ccd0 6838 (shrink-window delta t))
3c448ab6
MR
6839
6840(defun count-screen-lines (&optional beg end count-final-newline window)
6841 "Return the number of screen lines in the region.
6842The number of screen lines may be different from the number of actual lines,
6843due to line breaking, display table, etc.
6844
6845Optional arguments BEG and END default to `point-min' and `point-max'
6846respectively.
6847
6848If region ends with a newline, ignore it unless optional third argument
6849COUNT-FINAL-NEWLINE is non-nil.
6850
6851The optional fourth argument WINDOW specifies the window used for obtaining
6852parameters such as width, horizontal scrolling, and so on. The default is
6853to use the selected window's parameters.
6854
6855Like `vertical-motion', `count-screen-lines' always uses the current buffer,
6856regardless of which buffer is displayed in WINDOW. This makes possible to use
6857`count-screen-lines' in any buffer, whether or not it is currently displayed
6858in some window."
6859 (unless beg
6860 (setq beg (point-min)))
6861 (unless end
6862 (setq end (point-max)))
6863 (if (= beg end)
6864 0
6865 (save-excursion
6866 (save-restriction
6867 (widen)
6868 (narrow-to-region (min beg end)
6869 (if (and (not count-final-newline)
6870 (= ?\n (char-before (max beg end))))
6871 (1- (max beg end))
6872 (max beg end)))
6873 (goto-char (point-min))
6874 (1+ (vertical-motion (buffer-size) window))))))
6875
6198ccd0
MR
6876(defun window-buffer-height (window)
6877 "Return the height (in screen lines) of the buffer that WINDOW is displaying."
6878 (with-current-buffer (window-buffer window)
6879 (max 1
6880 (count-screen-lines (point-min) (point-max)
6881 ;; If buffer ends with a newline, ignore it when
6882 ;; counting height unless point is after it.
6883 (eobp)
6884 window))))
6885
6886;;; Resizing buffers to fit their contents exactly.
6887(defun fit-window-to-buffer (&optional window max-height min-height override)
3c448ab6 6888 "Adjust height of WINDOW to display its buffer's contents exactly.
6198ccd0
MR
6889WINDOW can be any live window and defaults to the selected one.
6890
6891Optional argument MAX-HEIGHT specifies the maximum height of
6892WINDOW and defaults to the height of WINDOW's frame. Optional
6893argument MIN-HEIGHT specifies the minimum height of WINDOW and
6894defaults to `window-min-height'. Both, MAX-HEIGHT and MIN-HEIGHT
6895are specified in lines and include the mode line and header line,
6896if any.
6897
6898Optional argument OVERRIDE non-nil means override restrictions
6899imposed by `window-min-height' and `window-min-width' on the size
6900of WINDOW.
6901
6902Return the number of lines by which WINDOW was enlarged or
6903shrunk. If an error occurs during resizing, return nil but don't
6904signal an error.
6905
6906Note that even if this function makes WINDOW large enough to show
6907_all_ lines of its buffer you might not see the first lines when
6908WINDOW was scrolled."
f7baca20
MR
6909 (interactive)
6910 ;; Do all the work in WINDOW and its buffer and restore the selected
6911 ;; window and the current buffer when we're done.
5386012d 6912 (setq window (window-normalize-live-window window))
6198ccd0 6913 ;; Can't resize a full height or fixed-size window.
9173deec 6914 (unless (or (window-size-fixed-p window)
6198ccd0
MR
6915 (window-full-height-p window))
6916 ;; `with-selected-window' should orderly restore the current buffer.
6917 (with-selected-window window
6918 ;; We are in WINDOW's buffer now.
6919 (let* ( ;; Adjust MIN-HEIGHT.
6920 (min-height
6921 (if override
6922 (window-min-size window nil window)
6923 (max (or min-height window-min-height)
6924 window-safe-min-height)))
6925 (max-window-height
6926 (window-total-size (frame-root-window window)))
6927 ;; Adjust MAX-HEIGHT.
6928 (max-height
6929 (if (or override (not max-height))
6930 max-window-height
6931 (min max-height max-window-height)))
6932 ;; Make `desired-height' the height necessary to show
6933 ;; all of WINDOW's buffer, constrained by MIN-HEIGHT
6934 ;; and MAX-HEIGHT.
6935 (desired-height
6936 (max
6937 (min
6938 (+ (count-screen-lines)
6939 ;; For non-minibuffers count the mode line, if any.
6940 (if (and (not (window-minibuffer-p window))
6941 mode-line-format)
6942 1
6943 0)
6944 ;; Count the header line, if any.
6945 (if header-line-format 1 0))
6946 max-height)
6947 min-height))
6948 (desired-delta
6949 (- desired-height (window-total-size window)))
6950 (delta
6951 (if (> desired-delta 0)
6952 (min desired-delta
6953 (window-max-delta window nil window))
6954 (max desired-delta
6955 (- (window-min-delta window nil window))))))
6956 ;; This `condition-case' shouldn't be necessary, but who knows?
6957 (condition-case nil
6958 (if (zerop delta)
6959 ;; Return zero if DELTA became zero in the proces.
6960 0
6961 ;; Don't try to redisplay with the cursor at the end on its
6962 ;; own line--that would force a scroll and spoil things.
6963 (when (and (eobp) (bolp) (not (bobp)))
6964 ;; It's silly to put `point' at the end of the previous
6965 ;; line and so maybe force horizontal scrolling.
6966 (set-window-point window (line-beginning-position 0)))
d615d6d2
MR
6967 ;; Call `window-resize' with OVERRIDE argument equal WINDOW.
6968 (window-resize window delta nil window)
f7baca20
MR
6969 ;; Check if the last line is surely fully visible. If
6970 ;; not, enlarge the window.
6971 (let ((end (save-excursion
6972 (goto-char (point-max))
6973 (when (and (bolp) (not (bobp)))
6974 ;; Don't include final newline.
6975 (backward-char 1))
6976 (when truncate-lines
6977 ;; If line-wrapping is turned off, test the
6978 ;; beginning of the last line for
6979 ;; visibility instead of the end, as the
6980 ;; end of the line could be invisible by
6981 ;; virtue of extending past the edge of the
6982 ;; window.
6983 (forward-line 0))
6984 (point))))
6985 (set-window-vscroll window 0)
6198ccd0
MR
6986 ;; This loop might in some rare pathological cases raise
6987 ;; an error - another reason for the `condition-case'.
f7baca20 6988 (while (and (< desired-height max-height)
6198ccd0 6989 (= desired-height (window-total-size))
f7baca20 6990 (not (pos-visible-in-window-p end)))
d615d6d2 6991 (window-resize window 1 nil window)
6198ccd0
MR
6992 (setq desired-height (1+ desired-height)))))
6993 (error (setq delta nil)))
6994 delta))))
3c448ab6 6995
39cffb44
MR
6996(defun window-safely-shrinkable-p (&optional window)
6997 "Return t if WINDOW can be shrunk without shrinking other windows.
6998WINDOW defaults to the selected window."
6999 (with-selected-window (or window (selected-window))
7000 (let ((edges (window-edges)))
7001 ;; The following doesn't satisfy the doc-string's claim when
7002 ;; window and previous-/next-window are not part of the same
7003 ;; combination but still share a common edge. Using
7004 ;; `window-iso-combined-p' instead should handle that.
7005 (or (= (nth 2 edges) (nth 2 (window-edges (previous-window))))
7006 (= (nth 0 edges) (nth 0 (window-edges (next-window))))))))
0bf4ba9a
MR
7007;; (make-obsolete
7008 ;; 'window-safely-shrinkable-p "use `window-iso-combined-p' instead." "24.1")
39cffb44 7009
3c448ab6
MR
7010(defun shrink-window-if-larger-than-buffer (&optional window)
7011 "Shrink height of WINDOW if its buffer doesn't need so many lines.
7012More precisely, shrink WINDOW vertically to be as small as
7013possible, while still showing the full contents of its buffer.
7014WINDOW defaults to the selected window.
7015
6198ccd0
MR
7016Do not shrink WINDOW to less than `window-min-height' lines. Do
7017nothing if the buffer contains more lines than the present window
7018height, or if some of the window's contents are scrolled out of
7019view, or if shrinking this window would also shrink another
7020window, or if the window is the only window of its frame.
3c448ab6
MR
7021
7022Return non-nil if the window was shrunk, nil otherwise."
7023 (interactive)
5386012d 7024 (setq window (window-normalize-live-window window))
6198ccd0
MR
7025 ;; Make sure that WINDOW is vertically combined and `point-min' is
7026 ;; visible (for whatever reason that's needed). The remaining issues
7027 ;; should be taken care of by `fit-window-to-buffer'.
7028 (when (and (window-iso-combined-p window)
7029 (pos-visible-in-window-p (point-min) window))
7030 (fit-window-to-buffer window (window-total-size window))))
7031\f
3c448ab6
MR
7032(defun kill-buffer-and-window ()
7033 "Kill the current buffer and delete the selected window."
7034 (interactive)
7035 (let ((window-to-delete (selected-window))
7036 (buffer-to-kill (current-buffer))
6198ccd0 7037 (delete-window-hook (lambda () (ignore-errors (delete-window)))))
3c448ab6
MR
7038 (unwind-protect
7039 (progn
7040 (add-hook 'kill-buffer-hook delete-window-hook t t)
7041 (if (kill-buffer (current-buffer))
7042 ;; If `delete-window' failed before, we rerun it to regenerate
7043 ;; the error so it can be seen in the echo area.
7044 (when (eq (selected-window) window-to-delete)
7045 (delete-window))))
7046 ;; If the buffer is not dead for some reason (probably because
7047 ;; of a `quit' signal), remove the hook again.
6198ccd0
MR
7048 (ignore-errors
7049 (with-current-buffer buffer-to-kill
7050 (remove-hook 'kill-buffer-hook delete-window-hook t))))))
3c448ab6
MR
7051
7052(defun quit-window (&optional kill window)
7053 "Quit WINDOW and bury its buffer.
7054With a prefix argument, kill the buffer instead. WINDOW defaults
7055to the selected window.
7056
7057If WINDOW is non-nil, dedicated, or a minibuffer window, delete
7058it and, if it's alone on its frame, its frame too. Otherwise, or
7059if deleting WINDOW fails in any of the preceding cases, display
7060another buffer in WINDOW using `switch-to-buffer'.
7061
7062Optional argument KILL non-nil means kill WINDOW's buffer.
7063Otherwise, bury WINDOW's buffer, see `bury-buffer'."
7064 (interactive "P")
7065 (let ((buffer (window-buffer window)))
7066 (if (or window
7067 (window-minibuffer-p window)
7068 (window-dedicated-p window))
7069 ;; WINDOW is either non-nil, a minibuffer window, or dedicated;
7070 ;; try to delete it.
a0c859f0
MR
7071 (let* ((window (or window (selected-window)))
7072 (frame (window-frame window)))
6198ccd0
MR
7073 (if (frame-root-window-p window)
7074 ;; WINDOW is alone on its frame.
7075 (delete-frame frame)
3c448ab6
MR
7076 ;; There are other windows on its frame, delete WINDOW.
7077 (delete-window window)))
7078 ;; Otherwise, switch to another buffer in the selected window.
7079 (switch-to-buffer nil))
7080
7081 ;; Deal with the buffer.
7082 (if kill
7083 (kill-buffer buffer)
7084 (bury-buffer buffer))))
74f806a1 7085\f
3c448ab6
MR
7086(defvar recenter-last-op nil
7087 "Indicates the last recenter operation performed.
0116abbd
JL
7088Possible values: `top', `middle', `bottom', integer or float numbers.")
7089
7090(defcustom recenter-positions '(middle top bottom)
7091 "Cycling order for `recenter-top-bottom'.
7092A list of elements with possible values `top', `middle', `bottom',
7093integer or float numbers that define the cycling order for
7094the command `recenter-top-bottom'.
7095
7096Top and bottom destinations are `scroll-margin' lines the from true
7097window top and bottom. Middle redraws the frame and centers point
7098vertically within the window. Integer number moves current line to
7099the specified absolute window-line. Float number between 0.0 and 1.0
7100means the percentage of the screen space from the top. The default
7101cycling order is middle -> top -> bottom."
7102 :type '(repeat (choice
7103 (const :tag "Top" top)
7104 (const :tag "Middle" middle)
7105 (const :tag "Bottom" bottom)
7106 (integer :tag "Line number")
7107 (float :tag "Percentage")))
7108 :version "23.2"
7109 :group 'windows)
3c448ab6
MR
7110
7111(defun recenter-top-bottom (&optional arg)
0116abbd
JL
7112 "Move current buffer line to the specified window line.
7113With no prefix argument, successive calls place point according
7114to the cycling order defined by `recenter-positions'.
3c448ab6
MR
7115
7116A prefix argument is handled like `recenter':
7117 With numeric prefix ARG, move current line to window-line ARG.
0116abbd 7118 With plain `C-u', move current line to window center."
3c448ab6
MR
7119 (interactive "P")
7120 (cond
0116abbd 7121 (arg (recenter arg)) ; Always respect ARG.
3c448ab6 7122 (t
0116abbd
JL
7123 (setq recenter-last-op
7124 (if (eq this-command last-command)
7125 (car (or (cdr (member recenter-last-op recenter-positions))
7126 recenter-positions))
7127 (car recenter-positions)))
3c448ab6
MR
7128 (let ((this-scroll-margin
7129 (min (max 0 scroll-margin)
7130 (truncate (/ (window-body-height) 4.0)))))
7131 (cond ((eq recenter-last-op 'middle)
0116abbd 7132 (recenter))
3c448ab6 7133 ((eq recenter-last-op 'top)
0116abbd
JL
7134 (recenter this-scroll-margin))
7135 ((eq recenter-last-op 'bottom)
7136 (recenter (- -1 this-scroll-margin)))
7137 ((integerp recenter-last-op)
7138 (recenter recenter-last-op))
7139 ((floatp recenter-last-op)
7140 (recenter (round (* recenter-last-op (window-height))))))))))
3c448ab6
MR
7141
7142(define-key global-map [?\C-l] 'recenter-top-bottom)
216349f8 7143
216349f8
SM
7144(defun move-to-window-line-top-bottom (&optional arg)
7145 "Position point relative to window.
7146
0f202d5d 7147With a prefix argument ARG, acts like `move-to-window-line'.
216349f8
SM
7148
7149With no argument, positions point at center of window.
0116abbd
JL
7150Successive calls position point at positions defined
7151by `recenter-positions'."
216349f8
SM
7152 (interactive "P")
7153 (cond
0116abbd 7154 (arg (move-to-window-line arg)) ; Always respect ARG.
216349f8 7155 (t
0116abbd
JL
7156 (setq recenter-last-op
7157 (if (eq this-command last-command)
7158 (car (or (cdr (member recenter-last-op recenter-positions))
7159 recenter-positions))
7160 (car recenter-positions)))
216349f8
SM
7161 (let ((this-scroll-margin
7162 (min (max 0 scroll-margin)
7163 (truncate (/ (window-body-height) 4.0)))))
0f202d5d 7164 (cond ((eq recenter-last-op 'middle)
0116abbd 7165 (call-interactively 'move-to-window-line))
0f202d5d 7166 ((eq recenter-last-op 'top)
0116abbd
JL
7167 (move-to-window-line this-scroll-margin))
7168 ((eq recenter-last-op 'bottom)
7169 (move-to-window-line (- -1 this-scroll-margin)))
7170 ((integerp recenter-last-op)
7171 (move-to-window-line recenter-last-op))
7172 ((floatp recenter-last-op)
7173 (move-to-window-line (round (* recenter-last-op (window-height))))))))))
216349f8
SM
7174
7175(define-key global-map [?\M-r] 'move-to-window-line-top-bottom)
3c448ab6 7176\f
74f806a1
JL
7177;;; Scrolling commands.
7178
7179;;; Scrolling commands which does not signal errors at top/bottom
7180;;; of buffer at first key-press (instead moves to top/bottom
7181;;; of buffer).
7182
7183(defcustom scroll-error-top-bottom nil
7184 "Move point to top/bottom of buffer before signalling a scrolling error.
7185A value of nil means just signal an error if no more scrolling possible.
7186A value of t means point moves to the beginning or the end of the buffer
7187\(depending on scrolling direction) when no more scrolling possible.
7188When point is already on that position, then signal an error."
7189 :type 'boolean
7190 :group 'scrolling
7191 :version "24.1")
7192
7193(defun scroll-up-command (&optional arg)
7194 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
7195If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
7196scroll window further, move cursor to the bottom line.
7197When point is already on that position, then signal an error.
7198A near full screen is `next-screen-context-lines' less than a full screen.
7199Negative ARG means scroll downward.
7200If ARG is the atom `-', scroll downward by nearly full screen."
7201 (interactive "^P")
7202 (cond
7203 ((null scroll-error-top-bottom)
7204 (scroll-up arg))
7205 ((eq arg '-)
7206 (scroll-down-command nil))
7207 ((< (prefix-numeric-value arg) 0)
7208 (scroll-down-command (- (prefix-numeric-value arg))))
7209 ((eobp)
7210 (scroll-up arg)) ; signal error
7211 (t
7212 (condition-case nil
7213 (scroll-up arg)
7214 (end-of-buffer
7215 (if arg
7216 ;; When scrolling by ARG lines can't be done,
7217 ;; move by ARG lines instead.
7218 (forward-line arg)
7219 ;; When ARG is nil for full-screen scrolling,
7220 ;; move to the bottom of the buffer.
7221 (goto-char (point-max))))))))
7222
7223(put 'scroll-up-command 'scroll-command t)
7224
7225(defun scroll-down-command (&optional arg)
7226 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
7227If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
7228scroll window further, move cursor to the top line.
7229When point is already on that position, then signal an error.
7230A near full screen is `next-screen-context-lines' less than a full screen.
7231Negative ARG means scroll upward.
7232If ARG is the atom `-', scroll upward by nearly full screen."
7233 (interactive "^P")
7234 (cond
7235 ((null scroll-error-top-bottom)
7236 (scroll-down arg))
7237 ((eq arg '-)
7238 (scroll-up-command nil))
7239 ((< (prefix-numeric-value arg) 0)
7240 (scroll-up-command (- (prefix-numeric-value arg))))
7241 ((bobp)
7242 (scroll-down arg)) ; signal error
7243 (t
7244 (condition-case nil
7245 (scroll-down arg)
7246 (beginning-of-buffer
7247 (if arg
7248 ;; When scrolling by ARG lines can't be done,
7249 ;; move by ARG lines instead.
7250 (forward-line (- arg))
7251 ;; When ARG is nil for full-screen scrolling,
7252 ;; move to the top of the buffer.
7253 (goto-char (point-min))))))))
7254
7255(put 'scroll-down-command 'scroll-command t)
7256
7257;;; Scrolling commands which scroll a line instead of full screen.
7258
7259(defun scroll-up-line (&optional arg)
7260 "Scroll text of selected window upward ARG lines; or one line if no ARG.
7261If ARG is omitted or nil, scroll upward by one line.
7262This is different from `scroll-up-command' that scrolls a full screen."
7263 (interactive "p")
7264 (scroll-up (or arg 1)))
7265
7266(put 'scroll-up-line 'scroll-command t)
7267
7268(defun scroll-down-line (&optional arg)
7269 "Scroll text of selected window down ARG lines; or one line if no ARG.
7270If ARG is omitted or nil, scroll down by one line.
7271This is different from `scroll-down-command' that scrolls a full screen."
7272 (interactive "p")
7273 (scroll-down (or arg 1)))
7274
7275(put 'scroll-down-line 'scroll-command t)
7276
7277\f
7278(defun scroll-other-window-down (lines)
7279 "Scroll the \"other window\" down.
7280For more details, see the documentation for `scroll-other-window'."
7281 (interactive "P")
7282 (scroll-other-window
7283 ;; Just invert the argument's meaning.
7284 ;; We can do that without knowing which window it will be.
7285 (if (eq lines '-) nil
7286 (if (null lines) '-
7287 (- (prefix-numeric-value lines))))))
7288
7289(defun beginning-of-buffer-other-window (arg)
7290 "Move point to the beginning of the buffer in the other window.
7291Leave mark at previous position.
7292With arg N, put point N/10 of the way from the true beginning."
7293 (interactive "P")
7294 (let ((orig-window (selected-window))
7295 (window (other-window-for-scrolling)))
7296 ;; We use unwind-protect rather than save-window-excursion
7297 ;; because the latter would preserve the things we want to change.
7298 (unwind-protect
7299 (progn
7300 (select-window window)
7301 ;; Set point and mark in that window's buffer.
7302 (with-no-warnings
7303 (beginning-of-buffer arg))
7304 ;; Set point accordingly.
7305 (recenter '(t)))
7306 (select-window orig-window))))
7307
7308(defun end-of-buffer-other-window (arg)
7309 "Move point to the end of the buffer in the other window.
7310Leave mark at previous position.
7311With arg N, put point N/10 of the way from the true end."
7312 (interactive "P")
7313 ;; See beginning-of-buffer-other-window for comments.
7314 (let ((orig-window (selected-window))
7315 (window (other-window-for-scrolling)))
7316 (unwind-protect
7317 (progn
7318 (select-window window)
7319 (with-no-warnings
7320 (end-of-buffer arg))
7321 (recenter '(t)))
7322 (select-window orig-window))))
74f806a1 7323\f
3c448ab6
MR
7324(defvar mouse-autoselect-window-timer nil
7325 "Timer used by delayed window autoselection.")
7326
7327(defvar mouse-autoselect-window-position nil
7328 "Last mouse position recorded by delayed window autoselection.")
7329
7330(defvar mouse-autoselect-window-window nil
7331 "Last window recorded by delayed window autoselection.")
7332
7333(defvar mouse-autoselect-window-state nil
7334 "When non-nil, special state of delayed window autoselection.
7335Possible values are `suspend' \(suspend autoselection after a menu or
7336scrollbar interaction\) and `select' \(the next invocation of
7337'handle-select-window' shall select the window immediately\).")
7338
7339(defun mouse-autoselect-window-cancel (&optional force)
7340 "Cancel delayed window autoselection.
7341Optional argument FORCE means cancel unconditionally."
7342 (unless (and (not force)
7343 ;; Don't cancel for select-window or select-frame events
7344 ;; or when the user drags a scroll bar.
7345 (or (memq this-command
7346 '(handle-select-window handle-switch-frame))
7347 (and (eq this-command 'scroll-bar-toolkit-scroll)
7348 (memq (nth 4 (event-end last-input-event))
7349 '(handle end-scroll)))))
7350 (setq mouse-autoselect-window-state nil)
7351 (when (timerp mouse-autoselect-window-timer)
7352 (cancel-timer mouse-autoselect-window-timer))
7353 (remove-hook 'pre-command-hook 'mouse-autoselect-window-cancel)))
7354
7355(defun mouse-autoselect-window-start (mouse-position &optional window suspend)
7356 "Start delayed window autoselection.
7357MOUSE-POSITION is the last position where the mouse was seen as returned
7358by `mouse-position'. Optional argument WINDOW non-nil denotes the
7359window where the mouse was seen. Optional argument SUSPEND non-nil
7360means suspend autoselection."
7361 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
7362 (setq mouse-autoselect-window-position mouse-position)
7363 (when window (setq mouse-autoselect-window-window window))
7364 (setq mouse-autoselect-window-state (when suspend 'suspend))
7365 ;; Install timer which runs `mouse-autoselect-window-select' after
7366 ;; `mouse-autoselect-window' seconds.
7367 (setq mouse-autoselect-window-timer
7368 (run-at-time
7369 (abs mouse-autoselect-window) nil 'mouse-autoselect-window-select)))
7370
7371(defun mouse-autoselect-window-select ()
7372 "Select window with delayed window autoselection.
7373If the mouse position has stabilized in a non-selected window, select
7374that window. The minibuffer window is selected only if the minibuffer is
7375active. This function is run by `mouse-autoselect-window-timer'."
6198ccd0
MR
7376 (ignore-errors
7377 (let* ((mouse-position (mouse-position))
7378 (window
7379 (ignore-errors
7380 (window-at (cadr mouse-position) (cddr mouse-position)
7381 (car mouse-position)))))
7382 (cond
7383 ((or (menu-or-popup-active-p)
7384 (and window
7385 (not (coordinates-in-window-p (cdr mouse-position) window))))
7386 ;; A menu / popup dialog is active or the mouse is on the scroll-bar
7387 ;; of WINDOW, temporarily suspend delayed autoselection.
7388 (mouse-autoselect-window-start mouse-position nil t))
7389 ((eq mouse-autoselect-window-state 'suspend)
7390 ;; Delayed autoselection was temporarily suspended, reenable it.
7391 (mouse-autoselect-window-start mouse-position))
7392 ((and window (not (eq window (selected-window)))
7393 (or (not (numberp mouse-autoselect-window))
7394 (and (> mouse-autoselect-window 0)
7395 ;; If `mouse-autoselect-window' is positive, select
7396 ;; window if the window is the same as before.
7397 (eq window mouse-autoselect-window-window))
7398 ;; Otherwise select window if the mouse is at the same
7399 ;; position as before. Observe that the first test after
7400 ;; starting autoselection usually fails since the value of
7401 ;; `mouse-autoselect-window-position' recorded there is the
7402 ;; position where the mouse has entered the new window and
7403 ;; not necessarily where the mouse has stopped moving.
7404 (equal mouse-position mouse-autoselect-window-position))
7405 ;; The minibuffer is a candidate window if it's active.
7406 (or (not (window-minibuffer-p window))
7407 (eq window (active-minibuffer-window))))
7408 ;; Mouse position has stabilized in non-selected window: Cancel
7409 ;; delayed autoselection and try to select that window.
7410 (mouse-autoselect-window-cancel t)
7411 ;; Select window where mouse appears unless the selected window is the
7412 ;; minibuffer. Use `unread-command-events' in order to execute pre-
7413 ;; and post-command hooks and trigger idle timers. To avoid delaying
7414 ;; autoselection again, set `mouse-autoselect-window-state'."
7415 (unless (window-minibuffer-p (selected-window))
7416 (setq mouse-autoselect-window-state 'select)
7417 (setq unread-command-events
7418 (cons (list 'select-window (list window))
7419 unread-command-events))))
7420 ((or (and window (eq window (selected-window)))
7421 (not (numberp mouse-autoselect-window))
7422 (equal mouse-position mouse-autoselect-window-position))
7423 ;; Mouse position has either stabilized in the selected window or at
7424 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
7425 (mouse-autoselect-window-cancel t))
7426 (t
7427 ;; Mouse position has not stabilized yet, resume delayed
7428 ;; autoselection.
7429 (mouse-autoselect-window-start mouse-position window))))))
3c448ab6
MR
7430
7431(defun handle-select-window (event)
7432 "Handle select-window events."
7433 (interactive "e")
7434 (let ((window (posn-window (event-start event))))
7435 (unless (or (not (window-live-p window))
7436 ;; Don't switch if we're currently in the minibuffer.
7437 ;; This tries to work around problems where the
7438 ;; minibuffer gets unselected unexpectedly, and where
7439 ;; you then have to move your mouse all the way down to
7440 ;; the minibuffer to select it.
7441 (window-minibuffer-p (selected-window))
7442 ;; Don't switch to minibuffer window unless it's active.
7443 (and (window-minibuffer-p window)
7444 (not (minibuffer-window-active-p window)))
7445 ;; Don't switch when autoselection shall be delayed.
7446 (and (numberp mouse-autoselect-window)
7447 (not (zerop mouse-autoselect-window))
7448 (not (eq mouse-autoselect-window-state 'select))
7449 (progn
7450 ;; Cancel any delayed autoselection.
7451 (mouse-autoselect-window-cancel t)
7452 ;; Start delayed autoselection from current mouse
7453 ;; position and window.
7454 (mouse-autoselect-window-start (mouse-position) window)
7455 ;; Executing a command cancels delayed autoselection.
7456 (add-hook
7457 'pre-command-hook 'mouse-autoselect-window-cancel))))
7458 (when mouse-autoselect-window
7459 ;; Reset state of delayed autoselection.
7460 (setq mouse-autoselect-window-state nil)
7461 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
7462 (run-hooks 'mouse-leave-buffer-hook))
7463 (select-window window))))
7464
3c448ab6
MR
7465(defun truncated-partial-width-window-p (&optional window)
7466 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
7467WINDOW defaults to the selected window.
7468Return nil if WINDOW is not a partial-width window
7469 (regardless of the value of `truncate-lines').
7470Otherwise, consult the value of `truncate-partial-width-windows'
7471 for the buffer shown in WINDOW."
7472 (unless window
7473 (setq window (selected-window)))
7474 (unless (window-full-width-p window)
7475 (let ((t-p-w-w (buffer-local-value 'truncate-partial-width-windows
7476 (window-buffer window))))
7477 (if (integerp t-p-w-w)
7478 (< (window-width window) t-p-w-w)
7479 t-p-w-w))))
562dd5e9
MR
7480\f
7481(define-key ctl-x-map "0" 'delete-window)
7482(define-key ctl-x-map "1" 'delete-other-windows)
7483(define-key ctl-x-map "2" 'split-window-above-each-other)
7484(define-key ctl-x-map "3" 'split-window-side-by-side)
9397e56f 7485(define-key ctl-x-map "o" 'other-window)
562dd5e9 7486(define-key ctl-x-map "^" 'enlarge-window)
3c448ab6
MR
7487(define-key ctl-x-map "}" 'enlarge-window-horizontally)
7488(define-key ctl-x-map "{" 'shrink-window-horizontally)
7489(define-key ctl-x-map "-" 'shrink-window-if-larger-than-buffer)
7490(define-key ctl-x-map "+" 'balance-windows)
7491(define-key ctl-x-4-map "0" 'kill-buffer-and-window)
7492
3c448ab6 7493;;; window.el ends here