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