lisp/bs.el, emacs-lock.el: Use defvar-local, setq-local.
[emacs.git] / lisp / window.el
blob5b001988ddfb0e1cfacd844688214732c3297de8
1 ;;; window.el --- GNU Emacs window commands aside from those written in C
3 ;; Copyright (C) 1985, 1989, 1992-1994, 2000-2013 Free Software
4 ;; Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: internal
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
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.
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.
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/>.
25 ;;; Commentary:
27 ;; Window tree functions.
29 ;;; Code:
31 (defun internal--before-save-selected-window ()
32 (cons (selected-window)
33 ;; We save and restore all frames' selected windows, because
34 ;; `select-window' can change the frame-selected-window of
35 ;; whatever frame that window is in. Each text terminal's
36 ;; top-frame is preserved by putting it last in the list.
37 (apply #'append
38 (mapcar (lambda (terminal)
39 (let ((frames (frames-on-display-list terminal))
40 (top-frame (tty-top-frame terminal))
41 alist)
42 (if top-frame
43 (setq frames
44 (cons top-frame
45 (delq top-frame frames))))
46 (dolist (f frames)
47 (push (cons f (frame-selected-window f))
48 alist))
49 alist))
50 (terminal-list)))))
52 (defun internal--after-save-selected-window (state)
53 (dolist (elt (cdr state))
54 (and (frame-live-p (car elt))
55 (window-live-p (cdr elt))
56 (set-frame-selected-window (car elt) (cdr elt) 'norecord)))
57 (when (window-live-p (car state))
58 (select-window (car state) 'norecord)))
60 (defmacro save-selected-window (&rest body)
61 "Execute BODY, then select the previously selected window.
62 The value returned is the value of the last form in BODY.
64 This macro saves and restores the selected window, as well as the
65 selected window in each frame. If the previously selected window
66 is no longer live, then whatever window is selected at the end of
67 BODY remains selected. If the previously selected window of some
68 frame is no longer live at the end of BODY, that frame's selected
69 window is left alone.
71 This macro saves and restores the current buffer, since otherwise
72 its normal operation could make a different buffer current. The
73 order of recently selected windows and the buffer list ordering
74 are not altered by this macro (unless they are altered in BODY)."
75 (declare (indent 0) (debug t))
76 `(let ((save-selected-window--state (internal--before-save-selected-window)))
77 (save-current-buffer
78 (unwind-protect
79 (progn ,@body)
80 (internal--after-save-selected-window save-selected-window--state)))))
82 (defvar temp-buffer-window-setup-hook nil
83 "Normal hook run by `with-temp-buffer-window' before buffer display.
84 This hook is run by `with-temp-buffer-window' with the buffer to be
85 displayed current.")
87 (defvar temp-buffer-window-show-hook nil
88 "Normal hook run by `with-temp-buffer-window' after buffer display.
89 This hook is run by `with-temp-buffer-window' with the buffer
90 displayed and current and its window selected.")
92 (defun temp-buffer-window-setup (buffer-or-name)
93 "Set up temporary buffer specified by BUFFER-OR-NAME.
94 Return the buffer."
95 (let ((old-dir default-directory)
96 (buffer (get-buffer-create buffer-or-name)))
97 (with-current-buffer buffer
98 (kill-all-local-variables)
99 (setq default-directory old-dir)
100 (delete-all-overlays)
101 (setq buffer-read-only nil)
102 (setq buffer-file-name nil)
103 (setq buffer-undo-list t)
104 (let ((inhibit-read-only t)
105 (inhibit-modification-hooks t))
106 (erase-buffer)
107 (run-hooks 'temp-buffer-window-setup-hook))
108 ;; Return the buffer.
109 buffer)))
111 (defun temp-buffer-window-show (&optional buffer action)
112 "Show temporary buffer BUFFER in a window.
113 Return the window showing BUFFER. Pass ACTION as action argument
114 to `display-buffer'."
115 (let (window frame)
116 (with-current-buffer buffer
117 (set-buffer-modified-p nil)
118 (setq buffer-read-only t)
119 (goto-char (point-min))
120 (when (let ((window-combination-limit
121 ;; When `window-combination-limit' equals
122 ;; `temp-buffer' or `temp-buffer-resize' and
123 ;; `temp-buffer-resize-mode' is enabled in this
124 ;; buffer bind it to t so resizing steals space
125 ;; preferably from the window that was split.
126 (if (or (eq window-combination-limit 'temp-buffer)
127 (and (eq window-combination-limit
128 'temp-buffer-resize)
129 temp-buffer-resize-mode))
131 window-combination-limit)))
132 (setq window (display-buffer buffer action)))
133 (setq frame (window-frame window))
134 (unless (eq frame (selected-frame))
135 (raise-frame frame))
136 (setq minibuffer-scroll-window window)
137 (set-window-hscroll window 0)
138 (with-selected-window window
139 (run-hooks 'temp-buffer-window-show-hook)
140 (when temp-buffer-resize-mode
141 (resize-temp-buffer-window window)))
142 ;; Return the window.
143 window))))
145 ;; Doc is very similar to with-output-to-temp-buffer.
146 (defmacro with-temp-buffer-window (buffer-or-name action quit-function &rest body)
147 "Bind `standard-output' to BUFFER-OR-NAME, eval BODY, show the buffer.
148 BUFFER-OR-NAME must specify either a live buffer, or the name of a
149 buffer (if it does not exist, this macro creates it).
151 This construct makes buffer BUFFER-OR-NAME empty before running BODY.
152 It does not make the buffer current for BODY.
153 Instead it binds `standard-output' to that buffer, so that output
154 generated with `prin1' and similar functions in BODY goes into
155 the buffer.
157 At the end of BODY, this marks the specified buffer unmodified and
158 read-only, and displays it in a window (but does not select it, or make
159 the buffer current). The display happens by calling `display-buffer'
160 with the ACTION argument. If `temp-buffer-resize-mode' is enabled,
161 the relevant window shrinks automatically.
163 This returns the value returned by BODY, unless QUIT-FUNCTION specifies
164 a function. In that case, it runs the function with two arguments -
165 the window showing the specified buffer and the value returned by
166 BODY - and returns the value returned by that function.
168 If the buffer is displayed on a new frame, the window manager may
169 decide to select that frame. In that case, it's usually a good
170 strategy if QUIT-FUNCTION selects the window showing the buffer
171 before reading any value from the minibuffer; for example, when
172 asking a `yes-or-no-p' question.
174 This runs the hook `temp-buffer-window-setup-hook' before BODY,
175 with the specified buffer temporarily current. It runs the
176 hook `temp-buffer-window-show-hook' after displaying the buffer,
177 with that buffer temporarily current, and the window that was used to
178 display it temporarily selected.
180 This construct is similar to `with-output-to-temp-buffer', but
181 runs different hooks. In particular, it does not run
182 `temp-buffer-setup-hook', which usually puts the buffer in Help mode.
183 Also, it does not call `temp-buffer-show-function' (the ACTION
184 argument replaces this)."
185 (declare (debug t))
186 (let ((buffer (make-symbol "buffer"))
187 (window (make-symbol "window"))
188 (value (make-symbol "value")))
189 `(let* ((,buffer (temp-buffer-window-setup ,buffer-or-name))
190 (standard-output ,buffer)
191 ,window ,value)
192 (with-current-buffer ,buffer
193 (setq ,value (progn ,@body))
194 (setq ,window (temp-buffer-window-show ,buffer ,action)))
196 (if (functionp ,quit-function)
197 (funcall ,quit-function ,window ,value)
198 ,value))))
200 ;; The following two functions are like `window-next-sibling' and
201 ;; `window-prev-sibling' but the WINDOW argument is _not_ optional (so
202 ;; they don't substitute the selected window for nil), and they return
203 ;; nil when WINDOW doesn't have a parent (like a frame's root window or
204 ;; a minibuffer window).
205 (defun window-right (window)
206 "Return WINDOW's right sibling.
207 Return nil if WINDOW is the root window of its frame. WINDOW can
208 be any window."
209 (and window (window-parent window) (window-next-sibling window)))
211 (defun window-left (window)
212 "Return WINDOW's left sibling.
213 Return nil if WINDOW is the root window of its frame. WINDOW can
214 be any window."
215 (and window (window-parent window) (window-prev-sibling window)))
217 (defun window-child (window)
218 "Return WINDOW's first child window.
219 WINDOW can be any window."
220 (or (window-top-child window) (window-left-child window)))
222 (defun window-child-count (window)
223 "Return number of WINDOW's child windows.
224 WINDOW can be any window."
225 (let ((count 0))
226 (when (and (windowp window) (setq window (window-child window)))
227 (while window
228 (setq count (1+ count))
229 (setq window (window-next-sibling window))))
230 count))
232 (defun window-last-child (window)
233 "Return last child window of WINDOW.
234 WINDOW can be any window."
235 (when (and (windowp window) (setq window (window-child window)))
236 (while (window-next-sibling window)
237 (setq window (window-next-sibling window))))
238 window)
240 (defun window-normalize-buffer (buffer-or-name)
241 "Return buffer specified by BUFFER-OR-NAME.
242 BUFFER-OR-NAME must be either a buffer or a string naming a live
243 buffer and defaults to the current buffer."
244 (cond
245 ((not buffer-or-name)
246 (current-buffer))
247 ((bufferp buffer-or-name)
248 (if (buffer-live-p buffer-or-name)
249 buffer-or-name
250 (error "Buffer %s is not a live buffer" buffer-or-name)))
251 ((get-buffer buffer-or-name))
253 (error "No such buffer %s" buffer-or-name))))
255 (defun window-normalize-frame (frame)
256 "Return frame specified by FRAME.
257 FRAME must be a live frame and defaults to the selected frame."
258 (if frame
259 (if (frame-live-p frame)
260 frame
261 (error "%s is not a live frame" frame))
262 (selected-frame)))
264 (defun window-normalize-window (window &optional live-only)
265 "Return the window specified by WINDOW.
266 If WINDOW is nil, return the selected window. Otherwise, if
267 WINDOW is a live or an internal window, return WINDOW; if
268 LIVE-ONLY is non-nil, return WINDOW for a live window only.
269 Otherwise, signal an error."
270 (cond
271 ((null window)
272 (selected-window))
273 (live-only
274 (if (window-live-p window)
275 window
276 (error "%s is not a live window" window)))
277 ((window-valid-p window)
278 window)
280 (error "%s is not a valid window" window))))
282 (defvar ignore-window-parameters nil
283 "If non-nil, standard functions ignore window parameters.
284 The functions currently affected by this are `split-window',
285 `delete-window', `delete-other-windows' and `other-window'.
287 An application may bind this to a non-nil value around calls to
288 these functions to inhibit processing of window parameters.")
290 (defconst window-safe-min-height 1
291 "The absolute minimum number of lines of a window.
292 Anything less might crash Emacs.")
294 (defcustom window-min-height 4
295 "The minimum number of lines of any window.
296 The value has to accommodate a mode- or header-line if present.
297 A value less than `window-safe-min-height' is ignored. The value
298 of this variable is honored when windows are resized or split.
300 Applications should never rebind this variable. To resize a
301 window to a height less than the one specified here, an
302 application should instead call `window-resize' with a non-nil
303 IGNORE argument. In order to have `split-window' make a window
304 shorter, explicitly specify the SIZE argument of that function."
305 :type 'integer
306 :version "24.1"
307 :group 'windows)
309 (defconst window-safe-min-width 2
310 "The absolute minimum number of columns of a window.
311 Anything less might crash Emacs.")
313 (defcustom window-min-width 10
314 "The minimum number of columns of any window.
315 The value has to accommodate margins, fringes, or scrollbars if
316 present. A value less than `window-safe-min-width' is ignored.
317 The value of this variable is honored when windows are resized or
318 split.
320 Applications should never rebind this variable. To resize a
321 window to a width less than the one specified here, an
322 application should instead call `window-resize' with a non-nil
323 IGNORE argument. In order to have `split-window' make a window
324 narrower, explicitly specify the SIZE argument of that function."
325 :type 'integer
326 :version "24.1"
327 :group 'windows)
329 (defun window-combined-p (&optional window horizontal)
330 "Return non-nil if WINDOW has siblings in a given direction.
331 WINDOW must be a valid window and defaults to the selected one.
333 HORIZONTAL determines a direction for the window combination.
334 If HORIZONTAL is omitted or nil, return non-nil if WINDOW is part
335 of a vertical window combination.
336 If HORIZONTAL is non-nil, return non-nil if WINDOW is part of a
337 horizontal window combination."
338 (setq window (window-normalize-window window))
339 (let ((parent (window-parent window)))
340 (and parent
341 (if horizontal
342 (window-left-child parent)
343 (window-top-child parent)))))
345 (defun window-combinations (window &optional horizontal)
346 "Return largest number of windows vertically arranged within WINDOW.
347 WINDOW must be a valid window and defaults to the selected one.
348 If HORIZONTAL is non-nil, return the largest number of
349 windows horizontally arranged within WINDOW."
350 (setq window (window-normalize-window window))
351 (cond
352 ((window-live-p window)
353 ;; If WINDOW is live, return 1.
355 ((if horizontal
356 (window-left-child window)
357 (window-top-child window))
358 ;; If WINDOW is iso-combined, return the sum of the values for all
359 ;; child windows of WINDOW.
360 (let ((child (window-child window))
361 (count 0))
362 (while child
363 (setq count
364 (+ (window-combinations child horizontal)
365 count))
366 (setq child (window-right child)))
367 count))
369 ;; If WINDOW is not iso-combined, return the maximum value of any
370 ;; child window of WINDOW.
371 (let ((child (window-child window))
372 (count 1))
373 (while child
374 (setq count
375 (max (window-combinations child horizontal)
376 count))
377 (setq child (window-right child)))
378 count))))
380 (defun walk-window-tree-1 (fun walk-window-tree-window any &optional sub-only)
381 "Helper function for `walk-window-tree' and `walk-window-subtree'."
382 (let (walk-window-tree-buffer)
383 (while walk-window-tree-window
384 (setq walk-window-tree-buffer
385 (window-buffer walk-window-tree-window))
386 (when (or walk-window-tree-buffer any)
387 (funcall fun walk-window-tree-window))
388 (unless walk-window-tree-buffer
389 (walk-window-tree-1
390 fun (window-left-child walk-window-tree-window) any)
391 (walk-window-tree-1
392 fun (window-top-child walk-window-tree-window) any))
393 (if sub-only
394 (setq walk-window-tree-window nil)
395 (setq walk-window-tree-window
396 (window-right walk-window-tree-window))))))
398 (defun walk-window-tree (fun &optional frame any minibuf)
399 "Run function FUN on each live window of FRAME.
400 FUN must be a function with one argument - a window. FRAME must
401 be a live frame and defaults to the selected one. ANY, if
402 non-nil, means to run FUN on all live and internal windows of
403 FRAME.
405 Optional argument MINIBUF t means run FUN on FRAME's minibuffer
406 window even if it isn't active. MINIBUF nil or omitted means run
407 FUN on FRAME's minibuffer window only if it's active. In both
408 cases the minibuffer window must be part of FRAME. MINIBUF
409 neither nil nor t means never run FUN on the minibuffer window.
411 This function performs a pre-order, depth-first traversal of the
412 window tree. If FUN changes the window tree, the result is
413 unpredictable."
414 (setq frame (window-normalize-frame frame))
415 (walk-window-tree-1 fun (frame-root-window frame) any)
416 (when (memq minibuf '(nil t))
417 ;; Run FUN on FRAME's minibuffer window if requested.
418 (let ((minibuffer-window (minibuffer-window frame)))
419 (when (and (window-live-p minibuffer-window)
420 (eq (window-frame minibuffer-window) frame)
421 (or (eq minibuf t)
422 (minibuffer-window-active-p minibuffer-window)))
423 (funcall fun minibuffer-window)))))
425 (defun walk-window-subtree (fun &optional window any)
426 "Run function FUN on the subtree of windows rooted at WINDOW.
427 WINDOW defaults to the selected window. FUN must be a function
428 with one argument - a window. By default, run FUN only on live
429 windows of the subtree. If the optional argument ANY is non-nil,
430 run FUN on all live and internal windows of the subtree. If
431 WINDOW is live, run FUN on WINDOW only.
433 This function performs a pre-order, depth-first traversal of the
434 subtree rooted at WINDOW. If FUN changes that tree, the result
435 is unpredictable."
436 (setq window (window-normalize-window window))
437 (walk-window-tree-1 fun window any t))
439 (defun window-with-parameter (parameter &optional value frame any minibuf)
440 "Return first window on FRAME with PARAMETER non-nil.
441 FRAME defaults to the selected frame. Optional argument VALUE
442 non-nil means only return a window whose window-parameter value
443 for PARAMETER equals VALUE (comparison is done with `equal').
444 Optional argument ANY non-nil means consider internal windows
445 too.
447 Optional argument MINIBUF t means consider FRAME's minibuffer
448 window even if it isn't active. MINIBUF nil or omitted means
449 consider FRAME's minibuffer window only if it's active. In both
450 cases the minibuffer window must be part of FRAME. MINIBUF
451 neither nil nor t means never consider the minibuffer window."
452 (let (this-value)
453 (catch 'found
454 (walk-window-tree
455 (lambda (window)
456 (when (and (setq this-value (window-parameter window parameter))
457 (or (not value) (equal value this-value)))
458 (throw 'found window)))
459 frame any minibuf))))
461 ;;; Atomic windows.
462 (defun window-atom-root (&optional window)
463 "Return root of atomic window WINDOW is a part of.
464 WINDOW must be a valid window and defaults to the selected one.
465 Return nil if WINDOW is not part of an atomic window."
466 (setq window (window-normalize-window window))
467 (let (root)
468 (while (and window (window-parameter window 'window-atom))
469 (setq root window)
470 (setq window (window-parent window)))
471 root))
473 (defun window-make-atom (window)
474 "Make WINDOW an atomic window.
475 WINDOW must be an internal window. Return WINDOW."
476 (if (not (window-child window))
477 (error "Window %s is not an internal window" window)
478 (walk-window-subtree
479 (lambda (window)
480 (set-window-parameter window 'window-atom t))
481 window t)
482 window))
484 (defun display-buffer-in-atom-window (buffer alist)
485 "Display BUFFER in an atomic window.
486 This function displays BUFFER in a new window that will be
487 combined with an existing window to form an atomic window. If
488 the existing window is already part of an atomic window, add the
489 new window to that atomic window. Operations like `split-window'
490 or `delete-window', when applied to a constituent of an atomic
491 window, are applied atomically to the root of that atomic window.
493 ALIST is an association list of symbols and values. The
494 following symbols can be used.
496 `window' specifies the existing window the new window shall be
497 combined with. Use `window-atom-root' to make the new window a
498 sibling of an atomic window's root. If an internal window is
499 specified here, all children of that window become part of the
500 atomic window too. If no window is specified, the new window
501 becomes a sibling of the selected window.
503 `side' denotes the side of the existing window where the new
504 window shall be located. Valid values are `below', `right',
505 `above' and `left'. The default is `below'.
507 The return value is the new window, nil when creating that window
508 failed."
509 (let ((ignore-window-parameters t)
510 (window-combination-limit t)
511 (window (cdr (assq 'window alist)))
512 (side (cdr (assq 'side alist)))
513 new)
514 (setq window (window-normalize-window window))
515 ;; Split off new window
516 (when (setq new (split-window window nil side))
517 ;; Make sure we have a valid atomic window.
518 (window-make-atom (window-parent window))
519 ;; Display BUFFER in NEW and return NEW.
520 (window--display-buffer
521 buffer new 'window alist display-buffer-mark-dedicated))))
523 (defun window--atom-check-1 (window)
524 "Subroutine of `window--atom-check'."
525 (when window
526 (if (window-parameter window 'window-atom)
527 (let ((count 0))
528 (when (or (catch 'reset
529 (walk-window-subtree
530 (lambda (window)
531 (if (window-parameter window 'window-atom)
532 (setq count (1+ count))
533 (throw 'reset t)))
534 window t))
535 ;; count >= 1 must hold here. If there's no other
536 ;; window around dissolve this atomic window.
537 (= count 1))
538 ;; Dissolve atomic window.
539 (walk-window-subtree
540 (lambda (window)
541 (set-window-parameter window 'window-atom nil))
542 window t)))
543 ;; Check children.
544 (unless (window-buffer window)
545 (window--atom-check-1 (window-left-child window))
546 (window--atom-check-1 (window-top-child window))))
547 ;; Check right sibling
548 (window--atom-check-1 (window-right window))))
550 (defun window--atom-check (&optional frame)
551 "Check atomicity of all windows on FRAME.
552 FRAME defaults to the selected frame. If an atomic window is
553 wrongly configured, reset the atomicity of all its windows on
554 FRAME to nil. An atomic window is wrongly configured if it has
555 no child windows or one of its child windows is not atomic."
556 (window--atom-check-1 (frame-root-window frame)))
558 ;; Side windows.
559 (defvar window-sides '(left top right bottom)
560 "Window sides.")
562 (defcustom window-sides-vertical nil
563 "If non-nil, left and right side windows are full height.
564 Otherwise, top and bottom side windows are full width."
565 :type 'boolean
566 :group 'windows
567 :version "24.1")
569 (defcustom window-sides-slots '(nil nil nil nil)
570 "Maximum number of side window slots.
571 The value is a list of four elements specifying the number of
572 side window slots on (in this order) the left, top, right and
573 bottom side of each frame. If an element is a number, this means
574 to display at most that many side windows on the corresponding
575 side. If an element is nil, this means there's no bound on the
576 number of slots on that side."
577 :version "24.1"
578 :risky t
579 :type
580 '(list
581 :value (nil nil nil nil)
582 (choice
583 :tag "Left"
584 :help-echo "Maximum slots of left side window."
585 :value nil
586 :format "%[Left%] %v\n"
587 (const :tag "Unlimited" :format "%t" nil)
588 (integer :tag "Number" :value 2 :size 5))
589 (choice
590 :tag "Top"
591 :help-echo "Maximum slots of top side window."
592 :value nil
593 :format "%[Top%] %v\n"
594 (const :tag "Unlimited" :format "%t" nil)
595 (integer :tag "Number" :value 3 :size 5))
596 (choice
597 :tag "Right"
598 :help-echo "Maximum slots of right side window."
599 :value nil
600 :format "%[Right%] %v\n"
601 (const :tag "Unlimited" :format "%t" nil)
602 (integer :tag "Number" :value 2 :size 5))
603 (choice
604 :tag "Bottom"
605 :help-echo "Maximum slots of bottom side window."
606 :value nil
607 :format "%[Bottom%] %v\n"
608 (const :tag "Unlimited" :format "%t" nil)
609 (integer :tag "Number" :value 3 :size 5)))
610 :group 'windows)
612 (defun window--major-non-side-window (&optional frame)
613 "Return the major non-side window of frame FRAME.
614 The optional argument FRAME must be a live frame and defaults to
615 the selected one.
617 If FRAME has at least one side window, the major non-side window
618 is either an internal non-side window such that all other
619 non-side windows on FRAME descend from it, or the single live
620 non-side window of FRAME. If FRAME has no side windows, return
621 its root window."
622 (let ((frame (window-normalize-frame frame))
623 major sibling)
624 ;; Set major to the _last_ window found by `walk-window-tree' that
625 ;; is not a side window but has a side window as its sibling.
626 (walk-window-tree
627 (lambda (window)
628 (and (not (window-parameter window 'window-side))
629 (or (and (setq sibling (window-prev-sibling window))
630 (window-parameter sibling 'window-side))
631 (and (setq sibling (window-next-sibling window))
632 (window-parameter sibling 'window-side)))
633 (setq major window)))
634 frame t)
635 (or major (frame-root-window frame))))
637 (defun window--major-side-window (side)
638 "Return major side window on SIDE.
639 SIDE must be one of the symbols `left', `top', `right' or
640 `bottom'. Return nil if no such window exists."
641 (let ((root (frame-root-window))
642 window)
643 ;; (1) If a window on the opposite side exists, return that window's
644 ;; sibling.
645 ;; (2) If the new window shall span the entire side, return the
646 ;; frame's root window.
647 ;; (3) If a window on an orthogonal side exists, return that
648 ;; window's sibling.
649 ;; (4) Otherwise return the frame's root window.
650 (cond
651 ((or (and (eq side 'left)
652 (setq window (window-with-parameter 'window-side 'right nil t)))
653 (and (eq side 'top)
654 (setq window (window-with-parameter 'window-side 'bottom nil t))))
655 (window-prev-sibling window))
656 ((or (and (eq side 'right)
657 (setq window (window-with-parameter 'window-side 'left nil t)))
658 (and (eq side 'bottom)
659 (setq window (window-with-parameter 'window-side 'top nil t))))
660 (window-next-sibling window))
661 ((memq side '(left right))
662 (cond
663 (window-sides-vertical
664 root)
665 ((setq window (window-with-parameter 'window-side 'top nil t))
666 (window-next-sibling window))
667 ((setq window (window-with-parameter 'window-side 'bottom nil t))
668 (window-prev-sibling window))
669 (t root)))
670 ((memq side '(top bottom))
671 (cond
672 ((not window-sides-vertical)
673 root)
674 ((setq window (window-with-parameter 'window-side 'left nil t))
675 (window-next-sibling window))
676 ((setq window (window-with-parameter 'window-side 'right nil t))
677 (window-prev-sibling window))
678 (t root))))))
680 (defun display-buffer-in-major-side-window (buffer side slot &optional alist)
681 "Display BUFFER in a new window on SIDE of the selected frame.
682 SIDE must be one of `left', `top', `right' or `bottom'. SLOT
683 specifies the slot to use. ALIST is an association list of
684 symbols and values as passed to `display-buffer-in-side-window'.
685 This function may be called only if no window on SIDE exists yet.
686 The new window automatically becomes the \"major\" side window on
687 SIDE. Return the new window, nil if its creation window failed."
688 (let* ((root (frame-root-window))
689 (left-or-right (memq side '(left right)))
690 (major (window--major-side-window side))
691 (selected-window (selected-window))
692 (on-side (cond
693 ((eq side 'top) 'above)
694 ((eq side 'bottom) 'below)
695 (t side)))
696 ;; The following two bindings will tell `split-window' to take
697 ;; the space for the new window from `major' and not make a new
698 ;; parent window unless needed.
699 (window-combination-resize 'side)
700 (window-combination-limit nil)
701 (new (split-window major nil on-side))
702 fun)
703 (when new
704 ;; Initialize `window-side' parameter of new window to SIDE.
705 (set-window-parameter new 'window-side side)
706 ;; Install `window-slot' parameter of new window.
707 (set-window-parameter new 'window-slot slot)
708 ;; Install `delete-window' parameter thus making sure that when
709 ;; the new window is deleted, a side window on the opposite side
710 ;; does not get resized.
711 (set-window-parameter new 'delete-window 'delete-side-window)
712 ;; Auto-adjust height/width of new window unless a size has been
713 ;; explicitly requested.
714 (unless (if left-or-right
715 (cdr (assq 'window-width alist))
716 (cdr (assq 'window-height alist)))
717 (setq alist
718 (cons
719 (cons
720 (if left-or-right 'window-width 'window-height)
721 (/ (window-total-size (frame-root-window) left-or-right)
722 ;; By default use a fourth of the size of the
723 ;; frame's root window.
725 alist)))
726 ;; Install BUFFER in new window and return NEW.
727 (window--display-buffer buffer new 'window alist 'side))))
729 (defun delete-side-window (window)
730 "Delete side window WINDOW."
731 (let ((window-combination-resize
732 (window-parameter (window-parent window) 'window-side))
733 (ignore-window-parameters t))
734 (delete-window window)))
736 (defun display-buffer-in-side-window (buffer alist)
737 "Display BUFFER in a window on side SIDE of the selected frame.
738 ALIST is an association list of symbols and values. The
739 following symbols can be used:
741 `side' denotes the side of the existing window where the new
742 window shall be located. Valid values are `bottom', `right',
743 `top' and `left'. The default is `bottom'.
745 `slot' if non-nil, specifies the window slot where to display
746 BUFFER. A value of zero or nil means use the middle slot on
747 the specified side. A negative value means use a slot
748 preceding (that is, above or on the left of) the middle slot.
749 A positive value means use a slot following (that is, below or
750 on the right of) the middle slot. The default is zero."
751 (let ((side (or (cdr (assq 'side alist)) 'bottom))
752 (slot (or (cdr (assq 'slot alist)) 0))
753 new)
754 (cond
755 ((not (memq side '(top bottom left right)))
756 (error "Invalid side %s specified" side))
757 ((not (numberp slot))
758 (error "Invalid slot %s specified" slot)))
760 (let* ((major (window-with-parameter 'window-side side nil t))
761 ;; `major' is the major window on SIDE, `windows' the list of
762 ;; life windows on SIDE.
763 (windows
764 (when major
765 (let (windows)
766 (walk-window-tree
767 (lambda (window)
768 (when (eq (window-parameter window 'window-side) side)
769 (setq windows (cons window windows)))))
770 (nreverse windows))))
771 (slots (when major (max 1 (window-child-count major))))
772 (max-slots
773 (nth (cond
774 ((eq side 'left) 0)
775 ((eq side 'top) 1)
776 ((eq side 'right) 2)
777 ((eq side 'bottom) 3))
778 window-sides-slots))
779 (selected-window (selected-window))
780 window this-window this-slot prev-window next-window
781 best-window best-slot abs-slot new-window)
783 (cond
784 ((and (numberp max-slots) (<= max-slots 0))
785 ;; No side-slots available on this side. Don't create an error,
786 ;; just return nil.
787 nil)
788 ((not windows)
789 ;; No major window exists on this side, make one.
790 (display-buffer-in-major-side-window buffer side slot alist))
792 ;; Scan windows on SIDE.
793 (catch 'found
794 (dolist (window windows)
795 (setq this-slot (window-parameter window 'window-slot))
796 (cond
797 ;; The following should not happen and probably be checked
798 ;; by window--side-check.
799 ((not (numberp this-slot)))
800 ((= this-slot slot)
801 ;; A window with a matching slot has been found.
802 (setq this-window window)
803 (throw 'found t))
805 ;; Check if this window has a better slot value wrt the
806 ;; slot of the window we want.
807 (setq abs-slot
808 (if (or (and (> this-slot 0) (> slot 0))
809 (and (< this-slot 0) (< slot 0)))
810 (abs (- slot this-slot))
811 (+ (abs slot) (abs this-slot))))
812 (unless (and best-slot (<= best-slot abs-slot))
813 (setq best-window window)
814 (setq best-slot abs-slot))
815 (cond
816 ((<= this-slot slot)
817 (setq prev-window window))
818 ((not next-window)
819 (setq next-window window)))))))
821 ;; `this-window' is the first window with the same SLOT.
822 ;; `prev-window' is the window with the largest slot < SLOT. A new
823 ;; window will be created after it.
824 ;; `next-window' is the window with the smallest slot > SLOT. A new
825 ;; window will be created before it.
826 ;; `best-window' is the window with the smallest absolute difference
827 ;; of its slot and SLOT.
829 ;; Note: We dedicate the window used softly to its buffer to
830 ;; avoid that "other" (non-side) buffer display functions steal
831 ;; it from us. This must eventually become customizable via
832 ;; ALIST (or, better, avoided in the "other" functions).
833 (or (and this-window
834 ;; Reuse `this-window'.
835 (window--display-buffer buffer this-window 'reuse alist 'side))
836 (and (or (not max-slots) (< slots max-slots))
837 (or (and next-window
838 ;; Make new window before `next-window'.
839 (let ((next-side
840 (if (memq side '(left right)) 'above 'left))
841 (window-combination-resize 'side))
842 (setq window (split-window next-window nil next-side))
843 ;; When the new window is deleted, its space
844 ;; is returned to other side windows.
845 (set-window-parameter
846 window 'delete-window 'delete-side-window)
847 window))
848 (and prev-window
849 ;; Make new window after `prev-window'.
850 (let ((prev-side
851 (if (memq side '(left right)) 'below 'right))
852 (window-combination-resize 'side))
853 (setq window (split-window prev-window nil prev-side))
854 ;; When the new window is deleted, its space
855 ;; is returned to other side windows.
856 (set-window-parameter
857 window 'delete-window 'delete-side-window)
858 window)))
859 (set-window-parameter window 'window-slot slot)
860 (window--display-buffer buffer window 'window alist 'side))
861 (and best-window
862 ;; Reuse `best-window'.
863 (progn
864 ;; Give best-window the new slot value.
865 (set-window-parameter best-window 'window-slot slot)
866 (window--display-buffer
867 buffer best-window 'reuse alist 'side)))))))))
869 (defun window--side-check (&optional frame)
870 "Check the side window configuration of FRAME.
871 FRAME defaults to the selected frame.
873 A valid side window configuration preserves the following two
874 invariants:
876 - If there exists a window whose window-side parameter is
877 non-nil, there must exist at least one live window whose
878 window-side parameter is nil.
880 - If a window W has a non-nil window-side parameter (i) it must
881 have a parent window and that parent's window-side parameter
882 must be either nil or the same as for W, and (ii) any child
883 window of W must have the same window-side parameter as W.
885 If the configuration is invalid, reset the window-side parameters
886 of all windows on FRAME to nil."
887 (let (left top right bottom none side parent parent-side)
888 (when (or (catch 'reset
889 (walk-window-tree
890 (lambda (window)
891 (setq side (window-parameter window 'window-side))
892 (setq parent (window-parent window))
893 (setq parent-side
894 (and parent (window-parameter parent 'window-side)))
895 ;; The following `cond' seems a bit tedious, but I'd
896 ;; rather stick to using just the stack.
897 (cond
898 (parent-side
899 (when (not (eq parent-side side))
900 ;; A parent whose window-side is non-nil must
901 ;; have a child with the same window-side.
902 (throw 'reset t)))
903 ((not side)
904 (when (window-buffer window)
905 ;; Record that we have at least one non-side,
906 ;; live window.
907 (setq none t)))
908 ((if (memq side '(left top))
909 (window-prev-sibling window)
910 (window-next-sibling window))
911 ;; Left and top major side windows must not have a
912 ;; previous sibling, right and bottom major side
913 ;; windows must not have a next sibling.
914 (throw 'reset t))
915 ;; Now check that there's no more than one major
916 ;; window for any of left, top, right and bottom.
917 ((eq side 'left)
918 (if left (throw 'reset t) (setq left t)))
919 ((eq side 'top)
920 (if top (throw 'reset t) (setq top t)))
921 ((eq side 'right)
922 (if right (throw 'reset t) (setq right t)))
923 ((eq side 'bottom)
924 (if bottom (throw 'reset t) (setq bottom t)))
926 (throw 'reset t))))
927 frame t))
928 ;; If there's a side window, there must be at least one
929 ;; non-side window.
930 (and (or left top right bottom) (not none)))
931 (walk-window-tree
932 (lambda (window)
933 (set-window-parameter window 'window-side nil))
934 frame t))))
936 (defun window--check (&optional frame)
937 "Check atomic and side windows on FRAME.
938 FRAME defaults to the selected frame."
939 (window--side-check frame)
940 (window--atom-check frame))
942 ;;; Window sizes.
943 (defvar window-size-fixed nil
944 "Non-nil in a buffer means windows displaying the buffer are fixed-size.
945 If the value is `height', then only the window's height is fixed.
946 If the value is `width', then only the window's width is fixed.
947 Any other non-nil value fixes both the width and the height.
949 Emacs won't change the size of any window displaying that buffer,
950 unless it has no other choice (like when deleting a neighboring
951 window).")
952 (make-variable-buffer-local 'window-size-fixed)
954 (defun window--size-ignore-p (window ignore)
955 "Return non-nil if IGNORE says to ignore size restrictions for WINDOW."
956 (if (window-valid-p ignore) (eq window ignore) ignore))
958 (defun window-min-size (&optional window horizontal ignore)
959 "Return the minimum size of WINDOW.
960 WINDOW must be a valid window and defaults to the selected one.
961 Optional argument HORIZONTAL non-nil means return the minimum
962 number of columns of WINDOW; otherwise return the minimum number
963 of WINDOW's lines.
965 Optional argument IGNORE, if non-nil, means ignore restrictions
966 imposed by fixed size windows, `window-min-height' or
967 `window-min-width' settings. If IGNORE equals `safe', live
968 windows may get as small as `window-safe-min-height' lines and
969 `window-safe-min-width' columns. If IGNORE is a window, ignore
970 restrictions for that window only. Any other non-nil value
971 means ignore all of the above restrictions for all windows."
972 (window--min-size-1
973 (window-normalize-window window) horizontal ignore))
975 (defun window--min-size-1 (window horizontal ignore)
976 "Internal function of `window-min-size'."
977 (let ((sub (window-child window)))
978 (if sub
979 (let ((value 0))
980 ;; WINDOW is an internal window.
981 (if (window-combined-p sub horizontal)
982 ;; The minimum size of an iso-combination is the sum of
983 ;; the minimum sizes of its child windows.
984 (while sub
985 (setq value (+ value
986 (window--min-size-1 sub horizontal ignore)))
987 (setq sub (window-right sub)))
988 ;; The minimum size of an ortho-combination is the maximum of
989 ;; the minimum sizes of its child windows.
990 (while sub
991 (setq value (max value
992 (window--min-size-1 sub horizontal ignore)))
993 (setq sub (window-right sub))))
994 value)
995 (with-current-buffer (window-buffer window)
996 (cond
997 ((and (not (window--size-ignore-p window ignore))
998 (window-size-fixed-p window horizontal))
999 ;; The minimum size of a fixed size window is its size.
1000 (window-total-size window horizontal))
1001 ((or (eq ignore 'safe) (eq ignore window))
1002 ;; If IGNORE equals `safe' or WINDOW return the safe values.
1003 (if horizontal window-safe-min-width window-safe-min-height))
1004 (horizontal
1005 ;; For the minimum width of a window take fringes and
1006 ;; scroll-bars into account. This is questionable and should
1007 ;; be removed as soon as we are able to split (and resize)
1008 ;; windows such that the new (or resized) windows can get a
1009 ;; size less than the user-specified `window-min-height' and
1010 ;; `window-min-width'.
1011 (let ((frame (window-frame window))
1012 (fringes (window-fringes window))
1013 (scroll-bars (window-scroll-bars window)))
1014 (max
1015 (+ window-safe-min-width
1016 (ceiling (car fringes) (frame-char-width frame))
1017 (ceiling (cadr fringes) (frame-char-width frame))
1018 (cond
1019 ((memq (nth 2 scroll-bars) '(left right))
1020 (nth 1 scroll-bars))
1021 ((memq (frame-parameter frame 'vertical-scroll-bars)
1022 '(left right))
1023 (ceiling (or (frame-parameter frame 'scroll-bar-width) 14)
1024 (frame-char-width)))
1025 (t 0)))
1026 (if (and (not (window--size-ignore-p window ignore))
1027 (numberp window-min-width))
1028 window-min-width
1029 0))))
1031 ;; For the minimum height of a window take any mode- or
1032 ;; header-line into account.
1033 (max (+ window-safe-min-height
1034 (if header-line-format 1 0)
1035 (if mode-line-format 1 0))
1036 (if (and (not (window--size-ignore-p window ignore))
1037 (numberp window-min-height))
1038 window-min-height
1039 0))))))))
1041 (defun window-sizable (window delta &optional horizontal ignore)
1042 "Return DELTA if DELTA lines can be added to WINDOW.
1043 WINDOW must be a valid window and defaults to the selected one.
1044 Optional argument HORIZONTAL non-nil means return DELTA if DELTA
1045 columns can be added to WINDOW. A return value of zero means
1046 that no lines (or columns) can be added to WINDOW.
1048 This function looks only at WINDOW and, recursively, its child
1049 windows. The function `window-resizable' looks at other windows
1050 as well.
1052 DELTA positive means WINDOW shall be enlarged by DELTA lines or
1053 columns. If WINDOW cannot be enlarged by DELTA lines or columns
1054 return the maximum value in the range 0..DELTA by which WINDOW
1055 can be enlarged.
1057 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
1058 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
1059 return the minimum value in the range DELTA..0 by which WINDOW
1060 can be shrunk.
1062 Optional argument IGNORE non-nil means ignore restrictions
1063 imposed by fixed size windows, `window-min-height' or
1064 `window-min-width' settings. If IGNORE equals `safe', live
1065 windows may get as small as `window-safe-min-height' lines and
1066 `window-safe-min-width' columns. If IGNORE is a window, ignore
1067 restrictions for that window only. Any other non-nil value means
1068 ignore all of the above restrictions for all windows."
1069 (setq window (window-normalize-window window))
1070 (cond
1071 ((< delta 0)
1072 (max (- (window-min-size window horizontal ignore)
1073 (window-total-size window horizontal))
1074 delta))
1075 ((window--size-ignore-p window ignore)
1076 delta)
1077 ((> delta 0)
1078 (if (window-size-fixed-p window horizontal)
1080 delta))
1081 (t 0)))
1083 (defun window-sizable-p (window delta &optional horizontal ignore)
1084 "Return t if WINDOW can be resized by DELTA lines.
1085 WINDOW must be a valid window and defaults to the selected one.
1086 For the meaning of the arguments of this function see the
1087 doc-string of `window-sizable'."
1088 (setq window (window-normalize-window window))
1089 (if (> delta 0)
1090 (>= (window-sizable window delta horizontal ignore) delta)
1091 (<= (window-sizable window delta horizontal ignore) delta)))
1093 (defun window--size-fixed-1 (window horizontal)
1094 "Internal function for `window-size-fixed-p'."
1095 (let ((sub (window-child window)))
1096 (catch 'fixed
1097 (if sub
1098 ;; WINDOW is an internal window.
1099 (if (window-combined-p sub horizontal)
1100 ;; An iso-combination is fixed size if all its child
1101 ;; windows are fixed-size.
1102 (progn
1103 (while sub
1104 (unless (window--size-fixed-1 sub horizontal)
1105 ;; We found a non-fixed-size child window, so
1106 ;; WINDOW's size is not fixed.
1107 (throw 'fixed nil))
1108 (setq sub (window-right sub)))
1109 ;; All child windows are fixed-size, so WINDOW's size is
1110 ;; fixed.
1111 (throw 'fixed t))
1112 ;; An ortho-combination is fixed-size if at least one of its
1113 ;; child windows is fixed-size.
1114 (while sub
1115 (when (window--size-fixed-1 sub horizontal)
1116 ;; We found a fixed-size child window, so WINDOW's size
1117 ;; is fixed.
1118 (throw 'fixed t))
1119 (setq sub (window-right sub))))
1120 ;; WINDOW is a live window.
1121 (with-current-buffer (window-buffer window)
1122 (if horizontal
1123 (memq window-size-fixed '(width t))
1124 (memq window-size-fixed '(height t))))))))
1126 (defun window-size-fixed-p (&optional window horizontal)
1127 "Return non-nil if WINDOW's height is fixed.
1128 WINDOW must be a valid window and defaults to the selected one.
1129 Optional argument HORIZONTAL non-nil means return non-nil if
1130 WINDOW's width is fixed.
1132 If this function returns nil, this does not necessarily mean that
1133 WINDOW can be resized in the desired direction. The function
1134 `window-resizable' can tell that."
1135 (window--size-fixed-1
1136 (window-normalize-window window) horizontal))
1138 (defun window--min-delta-1 (window delta &optional horizontal ignore trail noup)
1139 "Internal function for `window-min-delta'."
1140 (if (not (window-parent window))
1141 ;; If we can't go up, return zero.
1143 ;; Else try to find a non-fixed-size sibling of WINDOW.
1144 (let* ((parent (window-parent window))
1145 (sub (window-child parent)))
1146 (catch 'done
1147 (if (window-combined-p sub horizontal)
1148 ;; In an iso-combination throw DELTA if we find at least one
1149 ;; child window and that window is either not fixed-size or
1150 ;; we can ignore fixed-sizeness.
1151 (let ((skip (eq trail 'after)))
1152 (while sub
1153 (cond
1154 ((eq sub window)
1155 (setq skip (eq trail 'before)))
1156 (skip)
1157 ((and (not (window--size-ignore-p window ignore))
1158 (window-size-fixed-p sub horizontal)))
1160 ;; We found a non-fixed-size child window.
1161 (throw 'done delta)))
1162 (setq sub (window-right sub))))
1163 ;; In an ortho-combination set DELTA to the minimum value by
1164 ;; which other child windows can shrink.
1165 (while sub
1166 (unless (eq sub window)
1167 (setq delta
1168 (min delta
1169 (- (window-total-size sub horizontal)
1170 (window-min-size sub horizontal ignore)))))
1171 (setq sub (window-right sub))))
1172 (if noup
1173 delta
1174 (window--min-delta-1 parent delta horizontal ignore trail))))))
1176 (defun window-min-delta (&optional window horizontal ignore trail noup nodown)
1177 "Return number of lines by which WINDOW can be shrunk.
1178 WINDOW must be a valid window and defaults to the selected one.
1179 Return zero if WINDOW cannot be shrunk.
1181 Optional argument HORIZONTAL non-nil means return number of
1182 columns by which WINDOW can be shrunk.
1184 Optional argument IGNORE non-nil means ignore restrictions
1185 imposed by fixed size windows, `window-min-height' or
1186 `window-min-width' settings. If IGNORE is a window, ignore
1187 restrictions for that window only. If IGNORE equals `safe',
1188 live windows may get as small as `window-safe-min-height' lines
1189 and `window-safe-min-width' columns. Any other non-nil value
1190 means ignore all of the above restrictions for all windows.
1192 Optional argument TRAIL restricts the windows that can be enlarged.
1193 If its value is `before', only windows to the left of or above WINDOW
1194 can be enlarged. If it is `after', only windows to the right of or
1195 below WINDOW can be enlarged.
1197 Optional argument NOUP non-nil means don't go up in the window
1198 tree, but try to enlarge windows within WINDOW's combination only.
1200 Optional argument NODOWN non-nil means don't check whether WINDOW
1201 itself (and its child windows) can be shrunk; check only whether
1202 at least one other window can be enlarged appropriately."
1203 (setq window (window-normalize-window window))
1204 (let ((size (window-total-size window horizontal))
1205 (minimum (window-min-size window horizontal ignore)))
1206 (cond
1207 (nodown
1208 ;; If NODOWN is t, try to recover the entire size of WINDOW.
1209 (window--min-delta-1 window size horizontal ignore trail noup))
1210 ((= size minimum)
1211 ;; If NODOWN is nil and WINDOW's size is already at its minimum,
1212 ;; there's nothing to recover.
1215 ;; Otherwise, try to recover whatever WINDOW is larger than its
1216 ;; minimum size.
1217 (window--min-delta-1
1218 window (- size minimum) horizontal ignore trail noup)))))
1220 (defun window--max-delta-1 (window delta &optional horizontal ignore trail noup)
1221 "Internal function of `window-max-delta'."
1222 (if (not (window-parent window))
1223 ;; Can't go up. Return DELTA.
1224 delta
1225 (let* ((parent (window-parent window))
1226 (sub (window-child parent)))
1227 (catch 'fixed
1228 (if (window-combined-p sub horizontal)
1229 ;; For an iso-combination calculate how much we can get from
1230 ;; other child windows.
1231 (let ((skip (eq trail 'after)))
1232 (while sub
1233 (cond
1234 ((eq sub window)
1235 (setq skip (eq trail 'before)))
1236 (skip)
1238 (setq delta
1239 (+ delta
1240 (- (window-total-size sub horizontal)
1241 (window-min-size sub horizontal ignore))))))
1242 (setq sub (window-right sub))))
1243 ;; For an ortho-combination throw DELTA when at least one
1244 ;; child window is fixed-size.
1245 (while sub
1246 (when (and (not (eq sub window))
1247 (not (window--size-ignore-p sub ignore))
1248 (window-size-fixed-p sub horizontal))
1249 (throw 'fixed delta))
1250 (setq sub (window-right sub))))
1251 (if noup
1252 ;; When NOUP is nil, DELTA is all we can get.
1253 delta
1254 ;; Else try with parent of WINDOW, passing the DELTA we
1255 ;; recovered so far.
1256 (window--max-delta-1 parent delta horizontal ignore trail))))))
1258 (defun window-max-delta (&optional window horizontal ignore trail noup nodown)
1259 "Return maximum number of lines by which WINDOW can be enlarged.
1260 WINDOW must be a valid window and defaults to the selected one.
1261 The return value is zero if WINDOW cannot be enlarged.
1263 Optional argument HORIZONTAL non-nil means return maximum number
1264 of columns by which WINDOW can be enlarged.
1266 Optional argument IGNORE non-nil means ignore restrictions
1267 imposed by fixed size windows, `window-min-height' or
1268 `window-min-width' settings. If IGNORE is a window, ignore
1269 restrictions for that window only. If IGNORE equals `safe',
1270 live windows may get as small as `window-safe-min-height' lines
1271 and `window-safe-min-width' columns. Any other non-nil value means
1272 ignore all of the above restrictions for all windows.
1274 Optional argument TRAIL restricts the windows that can be enlarged.
1275 If its value is `before', only windows to the left of or above WINDOW
1276 can be enlarged. If it is `after', only windows to the right of or
1277 below WINDOW can be enlarged.
1279 Optional argument NOUP non-nil means don't go up in the window
1280 tree but try to obtain the entire space from windows within
1281 WINDOW's combination.
1283 Optional argument NODOWN non-nil means do not check whether
1284 WINDOW itself (and its child windows) can be enlarged; check
1285 only whether other windows can be shrunk appropriately."
1286 (setq window (window-normalize-window window))
1287 (if (and (not (window--size-ignore-p window ignore))
1288 (not nodown) (window-size-fixed-p window horizontal))
1289 ;; With IGNORE and NOWDON nil return zero if WINDOW has fixed
1290 ;; size.
1292 ;; WINDOW has no fixed size.
1293 (window--max-delta-1 window 0 horizontal ignore trail noup)))
1295 ;; Make NOUP also inhibit the min-size check.
1296 (defun window--resizable (window delta &optional horizontal ignore trail noup nodown)
1297 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
1298 WINDOW must be a valid window and defaults to the selected one.
1299 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
1300 can be resized horizontally by DELTA columns. A return value of
1301 zero means that WINDOW is not resizable.
1303 DELTA positive means WINDOW shall be enlarged by DELTA lines or
1304 columns. If WINDOW cannot be enlarged by DELTA lines or columns,
1305 return the maximum value in the range 0..DELTA by which WINDOW
1306 can be enlarged.
1308 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
1309 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
1310 return the minimum value in the range DELTA..0 that can be used
1311 for shrinking WINDOW.
1313 Optional argument IGNORE non-nil means ignore restrictions
1314 imposed by fixed size windows, `window-min-height' or
1315 `window-min-width' settings. If IGNORE is a window, ignore
1316 restrictions for that window only. If IGNORE equals `safe',
1317 live windows may get as small as `window-safe-min-height' lines
1318 and `window-safe-min-width' columns. Any other non-nil value
1319 means ignore all of the above restrictions for all windows.
1321 Optional argument TRAIL `before' means only windows to the left
1322 of or below WINDOW can be shrunk. Optional argument TRAIL
1323 `after' means only windows to the right of or above WINDOW can be
1324 shrunk.
1326 Optional argument NOUP non-nil means don't go up in the window
1327 tree but check only whether space can be obtained from (or given
1328 to) WINDOW's siblings.
1330 Optional argument NODOWN non-nil means don't go down in the
1331 window tree. This means do not check whether resizing would
1332 violate size restrictions of WINDOW or its child windows."
1333 (setq window (window-normalize-window window))
1334 (cond
1335 ((< delta 0)
1336 (max (- (window-min-delta window horizontal ignore trail noup nodown))
1337 delta))
1338 ((> delta 0)
1339 (min (window-max-delta window horizontal ignore trail noup nodown)
1340 delta))
1341 (t 0)))
1343 (defun window-resizable-p (window delta &optional horizontal ignore trail noup nodown)
1344 "Return t if WINDOW can be resized vertically by DELTA lines.
1345 WINDOW must be a valid window and defaults to the selected one.
1346 For the meaning of the arguments of this function see the
1347 doc-string of `window--resizable'."
1348 (setq window (window-normalize-window window))
1349 (if (> delta 0)
1350 (>= (window--resizable window delta horizontal ignore trail noup nodown)
1351 delta)
1352 (<= (window--resizable window delta horizontal ignore trail noup nodown)
1353 delta)))
1355 (defun window-resizable (window delta &optional horizontal ignore)
1356 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
1357 WINDOW must be a valid window and defaults to the selected one.
1358 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
1359 can be resized horizontally by DELTA columns. A return value of
1360 zero means that WINDOW is not resizable.
1362 DELTA positive means WINDOW shall be enlarged by DELTA lines or
1363 columns. If WINDOW cannot be enlarged by DELTA lines or columns
1364 return the maximum value in the range 0..DELTA by which WINDOW
1365 can be enlarged.
1367 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
1368 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
1369 return the minimum value in the range DELTA..0 that can be used
1370 for shrinking WINDOW.
1372 Optional argument IGNORE non-nil means ignore restrictions
1373 imposed by fixed size windows, `window-min-height' or
1374 `window-min-width' settings. If IGNORE is a window, ignore
1375 restrictions for that window only. If IGNORE equals `safe',
1376 live windows may get as small as `window-safe-min-height' lines
1377 and `window-safe-min-width' columns. Any other non-nil value
1378 means ignore all of the above restrictions for all windows."
1379 (setq window (window-normalize-window window))
1380 (window--resizable window delta horizontal ignore))
1382 (defun window-total-size (&optional window horizontal)
1383 "Return the total height or width of WINDOW.
1384 WINDOW must be a valid window and defaults to the selected one.
1386 If HORIZONTAL is omitted or nil, return the total height of
1387 WINDOW, in lines, like `window-total-height'. Otherwise return
1388 the total width, in columns, like `window-total-width'."
1389 (if horizontal
1390 (window-total-width window)
1391 (window-total-height window)))
1393 ;; Eventually we should make `window-height' obsolete.
1394 (defalias 'window-height 'window-total-height)
1396 ;; See discussion in bug#4543.
1397 (defun window-full-height-p (&optional window)
1398 "Return t if WINDOW is as high as its containing frame.
1399 More precisely, return t if and only if the total height of
1400 WINDOW equals the total height of the root window of WINDOW's
1401 frame. WINDOW must be a valid window and defaults to the
1402 selected one."
1403 (setq window (window-normalize-window window))
1404 (= (window-total-size window)
1405 (window-total-size (frame-root-window window))))
1407 (defun window-full-width-p (&optional window)
1408 "Return t if WINDOW is as wide as its containing frame.
1409 More precisely, return t if and only if the total width of WINDOW
1410 equals the total width of the root window of WINDOW's frame.
1411 WINDOW must be a valid window and defaults to the selected one."
1412 (setq window (window-normalize-window window))
1413 (= (window-total-size window t)
1414 (window-total-size (frame-root-window window) t)))
1416 (defun window-body-size (&optional window horizontal)
1417 "Return the height or width of WINDOW's text area.
1418 WINDOW must be a live window and defaults to the selected one.
1420 If HORIZONTAL is omitted or nil, return the height of the text
1421 area, like `window-body-height'. Otherwise, return the width of
1422 the text area, like `window-body-width'."
1423 (if horizontal
1424 (window-body-width window)
1425 (window-body-height window)))
1427 ;; Eventually we should make `window-height' obsolete.
1428 (defalias 'window-width 'window-body-width)
1430 (defun window-current-scroll-bars (&optional window)
1431 "Return the current scroll bar settings for WINDOW.
1432 WINDOW must be a live window and defaults to the selected one.
1434 The return value is a cons cell (VERTICAL . HORIZONTAL) where
1435 VERTICAL specifies the current location of the vertical scroll
1436 bars (`left', `right', or nil), and HORIZONTAL specifies the
1437 current location of the horizontal scroll bars (`top', `bottom',
1438 or nil).
1440 Unlike `window-scroll-bars', this function reports the scroll bar
1441 type actually used, once frame defaults and `scroll-bar-mode' are
1442 taken into account."
1443 (setq window (window-normalize-window window t))
1444 (let ((vert (nth 2 (window-scroll-bars window)))
1445 (hor nil))
1446 (when (or (eq vert t) (eq hor t))
1447 (let ((fcsb (frame-current-scroll-bars (window-frame window))))
1448 (if (eq vert t)
1449 (setq vert (car fcsb)))
1450 (if (eq hor t)
1451 (setq hor (cdr fcsb)))))
1452 (cons vert hor)))
1454 (defun walk-windows (fun &optional minibuf all-frames)
1455 "Cycle through all live windows, calling FUN for each one.
1456 FUN must specify a function with a window as its sole argument.
1457 The optional arguments MINIBUF and ALL-FRAMES specify the set of
1458 windows to include in the walk.
1460 MINIBUF t means include the minibuffer window even if the
1461 minibuffer is not active. MINIBUF nil or omitted means include
1462 the minibuffer window only if the minibuffer is active. Any
1463 other value means do not include the minibuffer window even if
1464 the minibuffer is active.
1466 ALL-FRAMES nil or omitted means consider all windows on the
1467 selected frame, plus the minibuffer window if specified by the
1468 MINIBUF argument. If the minibuffer counts, consider all windows
1469 on all frames that share that minibuffer too. The following
1470 non-nil values of ALL-FRAMES have special meanings:
1472 - t means consider all windows on all existing frames.
1474 - `visible' means consider all windows on all visible frames on
1475 the current terminal.
1477 - 0 (the number zero) means consider all windows on all visible
1478 and iconified frames on the current terminal.
1480 - A frame means consider all windows on that frame only.
1482 Anything else means consider all windows on the selected frame
1483 and no others.
1485 This function changes neither the order of recently selected
1486 windows nor the buffer list."
1487 ;; If we start from the minibuffer window, don't fail to come
1488 ;; back to it.
1489 (when (window-minibuffer-p (selected-window))
1490 (setq minibuf t))
1491 ;; Make sure to not mess up the order of recently selected
1492 ;; windows. Use `save-selected-window' and `select-window'
1493 ;; with second argument non-nil for this purpose.
1494 (save-selected-window
1495 (when (framep all-frames)
1496 (select-window (frame-first-window all-frames) 'norecord))
1497 (dolist (walk-windows-window (window-list-1 nil minibuf all-frames))
1498 (funcall fun walk-windows-window))))
1500 (defun window-at-side-p (&optional window side)
1501 "Return t if WINDOW is at SIDE of its containing frame.
1502 WINDOW must be a valid window and defaults to the selected one.
1503 SIDE can be any of the symbols `left', `top', `right' or
1504 `bottom'. The default value nil is handled like `bottom'."
1505 (setq window (window-normalize-window window))
1506 (let ((edge
1507 (cond
1508 ((eq side 'left) 0)
1509 ((eq side 'top) 1)
1510 ((eq side 'right) 2)
1511 ((memq side '(bottom nil)) 3))))
1512 (= (nth edge (window-edges window))
1513 (nth edge (window-edges (frame-root-window window))))))
1515 (defun window-at-side-list (&optional frame side)
1516 "Return list of all windows on SIDE of FRAME.
1517 FRAME must be a live frame and defaults to the selected frame.
1518 SIDE can be any of the symbols `left', `top', `right' or
1519 `bottom'. The default value nil is handled like `bottom'."
1520 (setq frame (window-normalize-frame frame))
1521 (let (windows)
1522 (walk-window-tree
1523 (lambda (window)
1524 (when (window-at-side-p window side)
1525 (setq windows (cons window windows))))
1526 frame nil 'nomini)
1527 (nreverse windows)))
1529 (defun window--in-direction-2 (window posn &optional horizontal)
1530 "Support function for `window-in-direction'."
1531 (if horizontal
1532 (let ((top (window-top-line window)))
1533 (if (> top posn)
1534 (- top posn)
1535 (- posn top (window-total-height window))))
1536 (let ((left (window-left-column window)))
1537 (if (> left posn)
1538 (- left posn)
1539 (- posn left (window-total-width window))))))
1541 ;; Predecessors to the below have been devised by Julian Assange in
1542 ;; change-windows-intuitively.el and Hovav Shacham in windmove.el.
1543 ;; Neither of these allow to selectively ignore specific windows
1544 ;; (windows whose `no-other-window' parameter is non-nil) as targets of
1545 ;; the movement.
1546 (defun window-in-direction (direction &optional window ignore)
1547 "Return window in DIRECTION as seen from WINDOW.
1548 More precisely, return the nearest window in direction DIRECTION
1549 as seen from the position of `window-point' in window WINDOW.
1550 DIRECTION must be one of `above', `below', `left' or `right'.
1551 WINDOW must be a live window and defaults to the selected one.
1553 Do not return a window whose `no-other-window' parameter is
1554 non-nil. If the nearest window's `no-other-window' parameter is
1555 non-nil, try to find another window in the indicated direction.
1556 If, however, the optional argument IGNORE is non-nil, return that
1557 window even if its `no-other-window' parameter is non-nil.
1559 Return nil if no suitable window can be found."
1560 (setq window (window-normalize-window window t))
1561 (unless (memq direction '(above below left right))
1562 (error "Wrong direction %s" direction))
1563 (let* ((frame (window-frame window))
1564 (hor (memq direction '(left right)))
1565 (first (if hor
1566 (window-left-column window)
1567 (window-top-line window)))
1568 (last (+ first (if hor
1569 (window-total-width window)
1570 (window-total-height window))))
1571 (posn-cons (nth 6 (posn-at-point (window-point window) window)))
1572 ;; The column / row value of `posn-at-point' can be nil for the
1573 ;; mini-window, guard against that.
1574 (posn (if hor
1575 (+ (or (cdr posn-cons) 1) (window-top-line window))
1576 (+ (or (car posn-cons) 1) (window-left-column window))))
1577 (best-edge
1578 (cond
1579 ((eq direction 'below) (frame-height frame))
1580 ((eq direction 'right) (frame-width frame))
1581 (t -1)))
1582 (best-edge-2 best-edge)
1583 (best-diff-2 (if hor (frame-height frame) (frame-width frame)))
1584 best best-2 best-diff-2-new)
1585 (walk-window-tree
1586 (lambda (w)
1587 (let* ((w-top (window-top-line w))
1588 (w-left (window-left-column w)))
1589 (cond
1590 ((or (eq window w)
1591 ;; Ignore ourselves.
1592 (and (window-parameter w 'no-other-window)
1593 ;; Ignore W unless IGNORE is non-nil.
1594 (not ignore))))
1595 (hor
1596 (cond
1597 ((and (<= w-top posn)
1598 (< posn (+ w-top (window-total-height w))))
1599 ;; W is to the left or right of WINDOW and covers POSN.
1600 (when (or (and (eq direction 'left)
1601 (<= w-left first) (> w-left best-edge))
1602 (and (eq direction 'right)
1603 (>= w-left last) (< w-left best-edge)))
1604 (setq best-edge w-left)
1605 (setq best w)))
1606 ((and (or (and (eq direction 'left)
1607 (<= (+ w-left (window-total-width w)) first))
1608 (and (eq direction 'right) (<= last w-left)))
1609 ;; W is to the left or right of WINDOW but does not
1610 ;; cover POSN.
1611 (setq best-diff-2-new
1612 (window--in-direction-2 w posn hor))
1613 (or (< best-diff-2-new best-diff-2)
1614 (and (= best-diff-2-new best-diff-2)
1615 (if (eq direction 'left)
1616 (> w-left best-edge-2)
1617 (< w-left best-edge-2)))))
1618 (setq best-edge-2 w-left)
1619 (setq best-diff-2 best-diff-2-new)
1620 (setq best-2 w))))
1622 (cond
1623 ((and (<= w-left posn)
1624 (< posn (+ w-left (window-total-width w))))
1625 ;; W is above or below WINDOW and covers POSN.
1626 (when (or (and (eq direction 'above)
1627 (<= w-top first) (> w-top best-edge))
1628 (and (eq direction 'below)
1629 (>= w-top first) (< w-top best-edge)))
1630 (setq best-edge w-top)
1631 (setq best w)))
1632 ((and (or (and (eq direction 'above)
1633 (<= (+ w-top (window-total-height w)) first))
1634 (and (eq direction 'below) (<= last w-top)))
1635 ;; W is above or below WINDOW but does not cover POSN.
1636 (setq best-diff-2-new
1637 (window--in-direction-2 w posn hor))
1638 (or (< best-diff-2-new best-diff-2)
1639 (and (= best-diff-2-new best-diff-2)
1640 (if (eq direction 'above)
1641 (> w-top best-edge-2)
1642 (< w-top best-edge-2)))))
1643 (setq best-edge-2 w-top)
1644 (setq best-diff-2 best-diff-2-new)
1645 (setq best-2 w)))))))
1646 frame)
1647 (or best best-2)))
1649 (defun get-window-with-predicate (predicate &optional minibuf all-frames default)
1650 "Return a live window satisfying PREDICATE.
1651 More precisely, cycle through all windows calling the function
1652 PREDICATE on each one of them with the window as its sole
1653 argument. Return the first window for which PREDICATE returns
1654 non-nil. Windows are scanned starting with the window following
1655 the selected window. If no window satisfies PREDICATE, return
1656 DEFAULT.
1658 MINIBUF t means include the minibuffer window even if the
1659 minibuffer is not active. MINIBUF nil or omitted means include
1660 the minibuffer window only if the minibuffer is active. Any
1661 other value means do not include the minibuffer window even if
1662 the minibuffer is active.
1664 ALL-FRAMES nil or omitted means consider all windows on the selected
1665 frame, plus the minibuffer window if specified by the MINIBUF
1666 argument. If the minibuffer counts, consider all windows on all
1667 frames that share that minibuffer too. The following non-nil
1668 values of ALL-FRAMES have special meanings:
1670 - t means consider all windows on all existing frames.
1672 - `visible' means consider all windows on all visible frames on
1673 the current terminal.
1675 - 0 (the number zero) means consider all windows on all visible
1676 and iconified frames on the current terminal.
1678 - A frame means consider all windows on that frame only.
1680 Anything else means consider all windows on the selected frame
1681 and no others."
1682 (catch 'found
1683 (dolist (window (window-list-1
1684 (next-window nil minibuf all-frames)
1685 minibuf all-frames))
1686 (when (funcall predicate window)
1687 (throw 'found window)))
1688 default))
1690 (defalias 'some-window 'get-window-with-predicate)
1692 (defun get-lru-window (&optional all-frames dedicated not-selected)
1693 "Return the least recently used window on frames specified by ALL-FRAMES.
1694 Return a full-width window if possible. A minibuffer window is
1695 never a candidate. A dedicated window is never a candidate
1696 unless DEDICATED is non-nil, so if all windows are dedicated, the
1697 value is nil. Avoid returning the selected window if possible.
1698 Optional argument NOT-SELECTED non-nil means never return the
1699 selected window.
1701 The following non-nil values of the optional argument ALL-FRAMES
1702 have special meanings:
1704 - t means consider all windows on all existing frames.
1706 - `visible' means consider all windows on all visible frames on
1707 the current terminal.
1709 - 0 (the number zero) means consider all windows on all visible
1710 and iconified frames on the current terminal.
1712 - A frame means consider all windows on that frame only.
1714 Any other value of ALL-FRAMES means consider all windows on the
1715 selected frame and no others."
1716 (let (best-window best-time second-best-window second-best-time time)
1717 (dolist (window (window-list-1 nil 'nomini all-frames))
1718 (when (and (or dedicated (not (window-dedicated-p window)))
1719 (or (not not-selected) (not (eq window (selected-window)))))
1720 (setq time (window-use-time window))
1721 (if (or (eq window (selected-window))
1722 (not (window-full-width-p window)))
1723 (when (or (not second-best-time) (< time second-best-time))
1724 (setq second-best-time time)
1725 (setq second-best-window window))
1726 (when (or (not best-time) (< time best-time))
1727 (setq best-time time)
1728 (setq best-window window)))))
1729 (or best-window second-best-window)))
1731 (defun get-mru-window (&optional all-frames dedicated not-selected)
1732 "Return the most recently used window on frames specified by ALL-FRAMES.
1733 A minibuffer window is never a candidate. A dedicated window is
1734 never a candidate unless DEDICATED is non-nil, so if all windows
1735 are dedicated, the value is nil. Optional argument NOT-SELECTED
1736 non-nil means never return the selected window.
1738 The following non-nil values of the optional argument ALL-FRAMES
1739 have special meanings:
1741 - t means consider all windows on all existing frames.
1743 - `visible' means consider all windows on all visible frames on
1744 the current terminal.
1746 - 0 (the number zero) means consider all windows on all visible
1747 and iconified frames on the current terminal.
1749 - A frame means consider all windows on that frame only.
1751 Any other value of ALL-FRAMES means consider all windows on the
1752 selected frame and no others."
1753 (let (best-window best-time time)
1754 (dolist (window (window-list-1 nil 'nomini all-frames))
1755 (setq time (window-use-time window))
1756 (when (and (or dedicated (not (window-dedicated-p window)))
1757 (or (not not-selected) (not (eq window (selected-window))))
1758 (or (not best-time) (> time best-time)))
1759 (setq best-time time)
1760 (setq best-window window)))
1761 best-window))
1763 (defun get-largest-window (&optional all-frames dedicated not-selected)
1764 "Return the largest window on frames specified by ALL-FRAMES.
1765 A minibuffer window is never a candidate. A dedicated window is
1766 never a candidate unless DEDICATED is non-nil, so if all windows
1767 are dedicated, the value is nil. Optional argument NOT-SELECTED
1768 non-nil means never return the selected window.
1770 The following non-nil values of the optional argument ALL-FRAMES
1771 have special meanings:
1773 - t means consider all windows on all existing frames.
1775 - `visible' means consider all windows on all visible frames on
1776 the current terminal.
1778 - 0 (the number zero) means consider all windows on all visible
1779 and iconified frames on the current terminal.
1781 - A frame means consider all windows on that frame only.
1783 Any other value of ALL-FRAMES means consider all windows on the
1784 selected frame and no others."
1785 (let ((best-size 0)
1786 best-window size)
1787 (dolist (window (window-list-1 nil 'nomini all-frames))
1788 (when (and (or dedicated (not (window-dedicated-p window)))
1789 (or (not not-selected) (not (eq window (selected-window)))))
1790 (setq size (* (window-total-size window)
1791 (window-total-size window t)))
1792 (when (> size best-size)
1793 (setq best-size size)
1794 (setq best-window window))))
1795 best-window))
1797 (defun get-buffer-window-list (&optional buffer-or-name minibuf all-frames)
1798 "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
1799 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
1800 and defaults to the current buffer. Windows are scanned starting
1801 with the selected window.
1803 MINIBUF t means include the minibuffer window even if the
1804 minibuffer is not active. MINIBUF nil or omitted means include
1805 the minibuffer window only if the minibuffer is active. Any
1806 other value means do not include the minibuffer window even if
1807 the minibuffer is active.
1809 ALL-FRAMES nil or omitted means consider all windows on the
1810 selected frame, plus the minibuffer window if specified by the
1811 MINIBUF argument. If the minibuffer counts, consider all windows
1812 on all frames that share that minibuffer too. The following
1813 non-nil values of ALL-FRAMES have special meanings:
1815 - t means consider all windows on all existing frames.
1817 - `visible' means consider all windows on all visible frames on
1818 the current terminal.
1820 - 0 (the number zero) means consider all windows on all visible
1821 and iconified frames on the current terminal.
1823 - A frame means consider all windows on that frame only.
1825 Anything else means consider all windows on the selected frame
1826 and no others."
1827 (let ((buffer (window-normalize-buffer buffer-or-name))
1828 windows)
1829 (dolist (window (window-list-1 (selected-window) minibuf all-frames))
1830 (when (eq (window-buffer window) buffer)
1831 (setq windows (cons window windows))))
1832 (nreverse windows)))
1834 (defun minibuffer-window-active-p (window)
1835 "Return t if WINDOW is the currently active minibuffer window."
1836 (eq window (active-minibuffer-window)))
1838 (defun count-windows (&optional minibuf)
1839 "Return the number of live windows on the selected frame.
1840 The optional argument MINIBUF specifies whether the minibuffer
1841 window shall be counted. See `walk-windows' for the precise
1842 meaning of this argument."
1843 (length (window-list-1 nil minibuf)))
1845 ;;; Resizing windows.
1846 (defun window--resize-reset (&optional frame horizontal)
1847 "Reset resize values for all windows on FRAME.
1848 FRAME defaults to the selected frame.
1850 This function stores the current value of `window-total-size' applied
1851 with argument HORIZONTAL in the new total size of all windows on
1852 FRAME. It also resets the new normal size of each of these
1853 windows."
1854 (window--resize-reset-1
1855 (frame-root-window (window-normalize-frame frame)) horizontal))
1857 (defun window--resize-reset-1 (window horizontal)
1858 "Internal function of `window--resize-reset'."
1859 ;; Register old size in the new total size.
1860 (set-window-new-total window (window-total-size window horizontal))
1861 ;; Reset new normal size.
1862 (set-window-new-normal window)
1863 (when (window-child window)
1864 (window--resize-reset-1 (window-child window) horizontal))
1865 (when (window-right window)
1866 (window--resize-reset-1 (window-right window) horizontal)))
1868 ;; The following routine is used to manually resize the minibuffer
1869 ;; window and is currently used, for example, by ispell.el.
1870 (defun window--resize-mini-window (window delta)
1871 "Resize minibuffer window WINDOW by DELTA lines.
1872 If WINDOW cannot be resized by DELTA lines make it as large (or
1873 as small) as possible, but don't signal an error."
1874 (when (window-minibuffer-p window)
1875 (let* ((frame (window-frame window))
1876 (root (frame-root-window frame))
1877 (height (window-total-size window))
1878 (min-delta
1879 (- (window-total-size root)
1880 (window-min-size root))))
1881 ;; Sanitize DELTA.
1882 (cond
1883 ((<= (+ height delta) 0)
1884 (setq delta (- (- height 1))))
1885 ((> delta min-delta)
1886 (setq delta min-delta)))
1888 ;; Resize now.
1889 (window--resize-reset frame)
1890 ;; Ideally we should be able to resize just the last child of root
1891 ;; here. See the comment in `resize-root-window-vertically' for
1892 ;; why we do not do that.
1893 (window--resize-this-window root (- delta) nil nil t)
1894 (set-window-new-total window (+ height delta))
1895 ;; The following routine catches the case where we want to resize
1896 ;; a minibuffer-only frame.
1897 (resize-mini-window-internal window))))
1899 (defun window-resize (window delta &optional horizontal ignore)
1900 "Resize WINDOW vertically by DELTA lines.
1901 WINDOW can be an arbitrary window and defaults to the selected
1902 one. An attempt to resize the root window of a frame will raise
1903 an error though.
1905 DELTA a positive number means WINDOW shall be enlarged by DELTA
1906 lines. DELTA negative means WINDOW shall be shrunk by -DELTA
1907 lines.
1909 Optional argument HORIZONTAL non-nil means resize WINDOW
1910 horizontally by DELTA columns. In this case a positive DELTA
1911 means enlarge WINDOW by DELTA columns. DELTA negative means
1912 WINDOW shall be shrunk by -DELTA columns.
1914 Optional argument IGNORE non-nil means ignore restrictions
1915 imposed by fixed size windows, `window-min-height' or
1916 `window-min-width' settings. If IGNORE is a window, ignore
1917 restrictions for that window only. If IGNORE equals `safe',
1918 live windows may get as small as `window-safe-min-height' lines
1919 and `window-safe-min-width' columns. Any other non-nil value
1920 means ignore all of the above restrictions for all windows.
1922 This function resizes other windows proportionally and never
1923 deletes any windows. If you want to move only the low (right)
1924 edge of WINDOW consider using `adjust-window-trailing-edge'
1925 instead."
1926 (setq window (window-normalize-window window))
1927 (let* ((frame (window-frame window))
1928 (minibuffer-window (minibuffer-window frame))
1929 sibling)
1930 (cond
1931 ((eq window (frame-root-window frame))
1932 (error "Cannot resize the root window of a frame"))
1933 ((window-minibuffer-p window)
1934 (if horizontal
1935 (error "Cannot resize minibuffer window horizontally")
1936 (window--resize-mini-window window delta)))
1937 ((and (not horizontal)
1938 (window-full-height-p window)
1939 (eq (window-frame minibuffer-window) frame)
1940 (or (not resize-mini-windows)
1941 (eq minibuffer-window (active-minibuffer-window))))
1942 ;; If WINDOW is full height and either `resize-mini-windows' is
1943 ;; nil or the minibuffer window is active, resize the minibuffer
1944 ;; window.
1945 (window--resize-mini-window minibuffer-window (- delta)))
1946 ((window-resizable-p window delta horizontal ignore)
1947 (window--resize-reset frame horizontal)
1948 (window--resize-this-window window delta horizontal ignore t)
1949 (if (and (not window-combination-resize)
1950 (window-combined-p window horizontal)
1951 (setq sibling (or (window-right window) (window-left window)))
1952 (window-sizable-p sibling (- delta) horizontal ignore))
1953 ;; If window-combination-resize is nil, WINDOW is part of an
1954 ;; iso-combination, and WINDOW's neighboring right or left
1955 ;; sibling can be resized as requested, resize that sibling.
1956 (let ((normal-delta
1957 (/ (float delta)
1958 (window-total-size (window-parent window) horizontal))))
1959 (window--resize-this-window sibling (- delta) horizontal nil t)
1960 (set-window-new-normal
1961 window (+ (window-normal-size window horizontal)
1962 normal-delta))
1963 (set-window-new-normal
1964 sibling (- (window-normal-size sibling horizontal)
1965 normal-delta)))
1966 ;; Otherwise, resize all other windows in the same combination.
1967 (window--resize-siblings window delta horizontal ignore))
1968 (window-resize-apply frame horizontal))
1970 (error "Cannot resize window %s" window)))))
1972 (defun window-resize-no-error (window delta &optional horizontal ignore)
1973 "Resize WINDOW vertically if it is resizable by DELTA lines.
1974 This function is like `window-resize' but does not signal an
1975 error when WINDOW cannot be resized. For the meaning of the
1976 optional arguments see the documentation of `window-resize'."
1977 (when (window-resizable-p window delta horizontal ignore)
1978 (window-resize window delta horizontal ignore)))
1980 (defun window--resize-child-windows-skip-p (window)
1981 "Return non-nil if WINDOW shall be skipped by resizing routines."
1982 (memq (window-new-normal window) '(ignore stuck skip)))
1984 (defun window--resize-child-windows-normal (parent horizontal window this-delta &optional trail other-delta)
1985 "Recursively set new normal height of child windows of window PARENT.
1986 HORIZONTAL non-nil means set the new normal width of these
1987 windows. WINDOW specifies a child window of PARENT that has been
1988 resized by THIS-DELTA lines (columns).
1990 Optional argument TRAIL either `before' or `after' means set values
1991 only for windows before or after WINDOW. Optional argument
1992 OTHER-DELTA, a number, specifies that this many lines (columns)
1993 have been obtained from (or returned to) an ancestor window of
1994 PARENT in order to resize WINDOW."
1995 (let* ((delta-normal
1996 (if (and (= (- this-delta) (window-total-size window horizontal))
1997 (zerop other-delta))
1998 ;; When WINDOW gets deleted and we can return its entire
1999 ;; space to its siblings, use WINDOW's normal size as the
2000 ;; normal delta.
2001 (- (window-normal-size window horizontal))
2002 ;; In any other case calculate the normal delta from the
2003 ;; relation of THIS-DELTA to the total size of PARENT.
2004 (/ (float this-delta) (window-total-size parent horizontal))))
2005 (sub (window-child parent))
2006 (parent-normal 0.0)
2007 (skip (eq trail 'after)))
2009 ;; Set parent-normal to the sum of the normal sizes of all child
2010 ;; windows of PARENT that shall be resized, excluding only WINDOW
2011 ;; and any windows specified by the optional TRAIL argument.
2012 (while sub
2013 (cond
2014 ((eq sub window)
2015 (setq skip (eq trail 'before)))
2016 (skip)
2018 (setq parent-normal
2019 (+ parent-normal (window-normal-size sub horizontal)))))
2020 (setq sub (window-right sub)))
2022 ;; Set the new normal size of all child windows of PARENT from what
2023 ;; they should have contributed for recovering THIS-DELTA lines
2024 ;; (columns).
2025 (setq sub (window-child parent))
2026 (setq skip (eq trail 'after))
2027 (while sub
2028 (cond
2029 ((eq sub window)
2030 (setq skip (eq trail 'before)))
2031 (skip)
2033 (let ((old-normal (window-normal-size sub horizontal)))
2034 (set-window-new-normal
2035 sub (min 1.0 ; Don't get larger than 1.
2036 (max (- old-normal
2037 (* (/ old-normal parent-normal)
2038 delta-normal))
2039 ;; Don't drop below 0.
2040 0.0))))))
2041 (setq sub (window-right sub)))
2043 (when (numberp other-delta)
2044 ;; Set the new normal size of windows from what they should have
2045 ;; contributed for recovering OTHER-DELTA lines (columns).
2046 (setq delta-normal (/ (float (window-total-size parent horizontal))
2047 (+ (window-total-size parent horizontal)
2048 other-delta)))
2049 (setq sub (window-child parent))
2050 (setq skip (eq trail 'after))
2051 (while sub
2052 (cond
2053 ((eq sub window)
2054 (setq skip (eq trail 'before)))
2055 (skip)
2057 (set-window-new-normal
2058 sub (min 1.0 ; Don't get larger than 1.
2059 (max (* (window-new-normal sub) delta-normal)
2060 ;; Don't drop below 0.
2061 0.0)))))
2062 (setq sub (window-right sub))))
2064 ;; Set the new normal size of WINDOW to what is left by the sum of
2065 ;; the normal sizes of its siblings.
2066 (set-window-new-normal
2067 window
2068 (let ((sum 0))
2069 (setq sub (window-child parent))
2070 (while sub
2071 (cond
2072 ((eq sub window))
2073 ((not (numberp (window-new-normal sub)))
2074 (setq sum (+ sum (window-normal-size sub horizontal))))
2076 (setq sum (+ sum (window-new-normal sub)))))
2077 (setq sub (window-right sub)))
2078 ;; Don't get larger than 1 or smaller than 0.
2079 (min 1.0 (max (- 1.0 sum) 0.0))))))
2081 (defun window--resize-child-windows (parent delta &optional horizontal window ignore trail edge)
2082 "Resize child windows of window PARENT vertically by DELTA lines.
2083 PARENT must be a vertically combined internal window.
2085 Optional argument HORIZONTAL non-nil means resize child windows of
2086 PARENT horizontally by DELTA columns. In this case PARENT must
2087 be a horizontally combined internal window.
2089 WINDOW, if specified, must denote a child window of PARENT that
2090 is resized by DELTA lines.
2092 Optional argument IGNORE non-nil means ignore restrictions
2093 imposed by fixed size windows, `window-min-height' or
2094 `window-min-width' settings. If IGNORE equals `safe', live
2095 windows may get as small as `window-safe-min-height' lines and
2096 `window-safe-min-width' columns. If IGNORE is a window, ignore
2097 restrictions for that window only. Any other non-nil value means
2098 ignore all of the above restrictions for all windows.
2100 Optional arguments TRAIL and EDGE, when non-nil, restrict the set
2101 of windows that shall be resized. If TRAIL equals `before',
2102 resize only windows on the left or above EDGE. If TRAIL equals
2103 `after', resize only windows on the right or below EDGE. Also,
2104 preferably only resize windows adjacent to EDGE.
2106 Return the symbol `normalized' if new normal sizes have been
2107 already set by this routine."
2108 (let* ((first (window-child parent))
2109 (last (window-last-child parent))
2110 (parent-total (+ (window-total-size parent horizontal) delta))
2111 sub best-window best-value)
2113 (if (and edge (memq trail '(before after))
2114 (progn
2115 (setq sub first)
2116 (while (and (window-right sub)
2117 (or (and (eq trail 'before)
2118 (not (window--resize-child-windows-skip-p
2119 (window-right sub))))
2120 (and (eq trail 'after)
2121 (window--resize-child-windows-skip-p sub))))
2122 (setq sub (window-right sub)))
2123 sub)
2124 (if horizontal
2125 (if (eq trail 'before)
2126 (= (+ (window-left-column sub)
2127 (window-total-size sub t))
2128 edge)
2129 (= (window-left-column sub) edge))
2130 (if (eq trail 'before)
2131 (= (+ (window-top-line sub)
2132 (window-total-size sub))
2133 edge)
2134 (= (window-top-line sub) edge)))
2135 (window-sizable-p sub delta horizontal ignore))
2136 ;; Resize only windows adjacent to EDGE.
2137 (progn
2138 (window--resize-this-window
2139 sub delta horizontal ignore t trail edge)
2140 (if (and window (eq (window-parent sub) parent))
2141 (progn
2142 ;; Assign new normal sizes.
2143 (set-window-new-normal
2144 sub (/ (float (window-new-total sub)) parent-total))
2145 (set-window-new-normal
2146 window (- (window-normal-size window horizontal)
2147 (- (window-new-normal sub)
2148 (window-normal-size sub horizontal)))))
2149 (window--resize-child-windows-normal
2150 parent horizontal sub 0 trail delta))
2151 ;; Return 'normalized to notify `window--resize-siblings' that
2152 ;; normal sizes have been already set.
2153 'normalized)
2154 ;; Resize all windows proportionally.
2155 (setq sub last)
2156 (while sub
2157 (cond
2158 ((or (window--resize-child-windows-skip-p sub)
2159 ;; Ignore windows to skip and fixed-size child windows -
2160 ;; in the latter case make it a window to skip.
2161 (and (not ignore)
2162 (window-size-fixed-p sub horizontal)
2163 (set-window-new-normal sub 'ignore))))
2164 ((< delta 0)
2165 ;; When shrinking store the number of lines/cols we can get
2166 ;; from this window here together with the total/normal size
2167 ;; factor.
2168 (set-window-new-normal
2170 (cons
2171 ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
2172 (window-min-delta sub horizontal ignore trail t) ; t)
2173 (- (/ (float (window-total-size sub horizontal))
2174 parent-total)
2175 (window-normal-size sub horizontal)))))
2176 ((> delta 0)
2177 ;; When enlarging store the total/normal size factor only
2178 (set-window-new-normal
2180 (- (/ (float (window-total-size sub horizontal))
2181 parent-total)
2182 (window-normal-size sub horizontal)))))
2184 (setq sub (window-left sub)))
2186 (cond
2187 ((< delta 0)
2188 ;; Shrink windows by delta.
2189 (setq best-window t)
2190 (while (and best-window (not (zerop delta)))
2191 (setq sub last)
2192 (setq best-window nil)
2193 (setq best-value most-negative-fixnum)
2194 (while sub
2195 (when (and (consp (window-new-normal sub))
2196 (not (zerop (car (window-new-normal sub))))
2197 (> (cdr (window-new-normal sub)) best-value))
2198 (setq best-window sub)
2199 (setq best-value (cdr (window-new-normal sub))))
2201 (setq sub (window-left sub)))
2203 (when best-window
2204 (setq delta (1+ delta)))
2205 (set-window-new-total best-window -1 t)
2206 (set-window-new-normal
2207 best-window
2208 (if (= (car (window-new-normal best-window)) 1)
2209 'skip ; We can't shrink best-window any further.
2210 (cons (1- (car (window-new-normal best-window)))
2211 (- (/ (float (window-new-total best-window))
2212 parent-total)
2213 (window-normal-size best-window horizontal)))))))
2214 ((> delta 0)
2215 ;; Enlarge windows by delta.
2216 (setq best-window t)
2217 (while (and best-window (not (zerop delta)))
2218 (setq sub last)
2219 (setq best-window nil)
2220 (setq best-value most-positive-fixnum)
2221 (while sub
2222 (when (and (numberp (window-new-normal sub))
2223 (< (window-new-normal sub) best-value))
2224 (setq best-window sub)
2225 (setq best-value (window-new-normal sub)))
2227 (setq sub (window-left sub)))
2229 (when best-window
2230 (setq delta (1- delta)))
2231 (set-window-new-total best-window 1 t)
2232 (set-window-new-normal
2233 best-window
2234 (- (/ (float (window-new-total best-window))
2235 parent-total)
2236 (window-normal-size best-window horizontal))))))
2238 (when best-window
2239 (setq sub last)
2240 (while sub
2241 (when (or (consp (window-new-normal sub))
2242 (numberp (window-new-normal sub)))
2243 ;; Reset new normal size fields so `window-resize-apply'
2244 ;; won't use them to apply new sizes.
2245 (set-window-new-normal sub))
2247 (unless (eq (window-new-normal sub) 'ignore)
2248 ;; Resize this window's child windows (back-engineering
2249 ;; delta from sub's old and new total sizes).
2250 (let ((delta (- (window-new-total sub)
2251 (window-total-size sub horizontal))))
2252 (unless (and (zerop delta) (not trail))
2253 ;; For the TRAIL non-nil case we have to resize SUB
2254 ;; recursively even if it's size does not change.
2255 (window--resize-this-window
2256 sub delta horizontal ignore nil trail edge))))
2257 (setq sub (window-left sub)))))))
2259 (defun window--resize-siblings (window delta &optional horizontal ignore trail edge)
2260 "Resize other windows when WINDOW is resized vertically by DELTA lines.
2261 Optional argument HORIZONTAL non-nil means resize other windows
2262 when WINDOW is resized horizontally by DELTA columns. WINDOW
2263 itself is not resized by this function.
2265 Optional argument IGNORE non-nil means ignore restrictions
2266 imposed by fixed size windows, `window-min-height' or
2267 `window-min-width' settings. If IGNORE equals `safe', live
2268 windows may get as small as `window-safe-min-height' lines and
2269 `window-safe-min-width' columns. If IGNORE is a window, ignore
2270 restrictions for that window only. Any other non-nil value means
2271 ignore all of the above restrictions for all windows.
2273 Optional arguments TRAIL and EDGE, when non-nil, refine the set
2274 of windows that shall be resized. If TRAIL equals `before',
2275 resize only windows on the left or above EDGE. If TRAIL equals
2276 `after', resize only windows on the right or below EDGE. Also,
2277 preferably only resize windows adjacent to EDGE."
2278 (when (window-parent window)
2279 (let* ((parent (window-parent window))
2280 (sub (window-child parent)))
2281 (if (window-combined-p sub horizontal)
2282 ;; In an iso-combination try to extract DELTA from WINDOW's
2283 ;; siblings.
2284 (let ((skip (eq trail 'after))
2285 this-delta other-delta)
2286 ;; Decide which windows shall be left alone.
2287 (while sub
2288 (cond
2289 ((eq sub window)
2290 ;; Make sure WINDOW is left alone when
2291 ;; resizing its siblings.
2292 (set-window-new-normal sub 'ignore)
2293 (setq skip (eq trail 'before)))
2294 (skip
2295 ;; Make sure this sibling is left alone when
2296 ;; resizing its siblings.
2297 (set-window-new-normal sub 'ignore))
2298 ((or (window--size-ignore-p sub ignore)
2299 (not (window-size-fixed-p sub horizontal)))
2300 ;; Set this-delta to t to signal that we found a sibling
2301 ;; of WINDOW whose size is not fixed.
2302 (setq this-delta t)))
2304 (setq sub (window-right sub)))
2306 ;; Set this-delta to what we can get from WINDOW's siblings.
2307 (if (= (- delta) (window-total-size window horizontal))
2308 ;; A deletion, presumably. We must handle this case
2309 ;; specially since `window--resizable' can't be used.
2310 (if this-delta
2311 ;; There's at least one resizable sibling we can
2312 ;; give WINDOW's size to.
2313 (setq this-delta delta)
2314 ;; No resizable sibling exists.
2315 (setq this-delta 0))
2316 ;; Any other form of resizing.
2317 (setq this-delta
2318 (window--resizable window delta horizontal ignore trail t)))
2320 ;; Set other-delta to what we still have to get from
2321 ;; ancestor windows of parent.
2322 (setq other-delta (- delta this-delta))
2323 (unless (zerop other-delta)
2324 ;; Unless we got everything from WINDOW's siblings, PARENT
2325 ;; must be resized by other-delta lines or columns.
2326 (set-window-new-total parent other-delta 'add))
2328 (if (zerop this-delta)
2329 ;; We haven't got anything from WINDOW's siblings but we
2330 ;; must update the normal sizes to respect other-delta.
2331 (window--resize-child-windows-normal
2332 parent horizontal window this-delta trail other-delta)
2333 ;; We did get something from WINDOW's siblings which means
2334 ;; we have to resize their child windows.
2335 (unless (eq (window--resize-child-windows
2336 parent (- this-delta) horizontal
2337 window ignore trail edge)
2338 ;; If `window--resize-child-windows' returns
2339 ;; 'normalized, this means it has set the
2340 ;; normal sizes already.
2341 'normalized)
2342 ;; Set the normal sizes.
2343 (window--resize-child-windows-normal
2344 parent horizontal window this-delta trail other-delta))
2345 ;; Set DELTA to what we still have to get from ancestor
2346 ;; windows.
2347 (setq delta other-delta)))
2349 ;; In an ortho-combination all siblings of WINDOW must be
2350 ;; resized by DELTA.
2351 (set-window-new-total parent delta 'add)
2352 (while sub
2353 (unless (eq sub window)
2354 (window--resize-this-window sub delta horizontal ignore t))
2355 (setq sub (window-right sub))))
2357 (unless (zerop delta)
2358 ;; "Go up."
2359 (window--resize-siblings
2360 parent delta horizontal ignore trail edge)))))
2362 (defun window--resize-this-window (window delta &optional horizontal ignore add trail edge)
2363 "Resize WINDOW vertically by DELTA lines.
2364 Optional argument HORIZONTAL non-nil means resize WINDOW
2365 horizontally by DELTA columns.
2367 Optional argument IGNORE non-nil means ignore restrictions
2368 imposed by fixed size windows, `window-min-height' or
2369 `window-min-width' settings. If IGNORE equals `safe', live
2370 windows may get as small as `window-safe-min-height' lines and
2371 `window-safe-min-width' columns. If IGNORE is a window, ignore
2372 restrictions for that window only. Any other non-nil value
2373 means ignore all of the above restrictions for all windows.
2375 Optional argument ADD non-nil means add DELTA to the new total
2376 size of WINDOW.
2378 Optional arguments TRAIL and EDGE, when non-nil, refine the set
2379 of windows that shall be resized. If TRAIL equals `before',
2380 resize only windows on the left or above EDGE. If TRAIL equals
2381 `after', resize only windows on the right or below EDGE. Also,
2382 preferably only resize windows adjacent to EDGE.
2384 This function recursively resizes WINDOW's child windows to fit the
2385 new size. Make sure that WINDOW is `window--resizable' before
2386 calling this function. Note that this function does not resize
2387 siblings of WINDOW or WINDOW's parent window. You have to
2388 eventually call `window-resize-apply' in order to make resizing
2389 actually take effect."
2390 (when add
2391 ;; Add DELTA to the new total size of WINDOW.
2392 (set-window-new-total window delta t))
2394 (let ((sub (window-child window)))
2395 (cond
2396 ((not sub))
2397 ((window-combined-p sub horizontal)
2398 ;; In an iso-combination resize child windows according to their
2399 ;; normal sizes.
2400 (window--resize-child-windows
2401 window delta horizontal nil ignore trail edge))
2402 ;; In an ortho-combination resize each child window by DELTA.
2404 (while sub
2405 (window--resize-this-window
2406 sub delta horizontal ignore t trail edge)
2407 (setq sub (window-right sub)))))))
2409 (defun window--resize-root-window (window delta horizontal ignore)
2410 "Resize root window WINDOW vertically by DELTA lines.
2411 HORIZONTAL non-nil means resize root window WINDOW horizontally
2412 by DELTA columns.
2414 IGNORE non-nil means ignore any restrictions imposed by fixed
2415 size windows, `window-min-height' or `window-min-width' settings.
2417 This function is only called by the frame resizing routines. It
2418 resizes windows proportionally and never deletes any windows."
2419 (when (and (windowp window) (numberp delta)
2420 (window-sizable-p window delta horizontal ignore))
2421 (window--resize-reset (window-frame window) horizontal)
2422 (window--resize-this-window window delta horizontal ignore t)))
2424 (defun window--resize-root-window-vertically (window delta)
2425 "Resize root window WINDOW vertically by DELTA lines.
2426 If DELTA is less than zero and we can't shrink WINDOW by DELTA
2427 lines, shrink it as much as possible. If DELTA is greater than
2428 zero, this function can resize fixed-size windows in order to
2429 recover the necessary lines.
2431 Return the number of lines that were recovered.
2433 This function is only called by the minibuffer window resizing
2434 routines. It resizes windows proportionally and never deletes
2435 any windows."
2436 (let ((frame (window-frame window))
2437 ignore)
2438 (cond
2439 ((not (numberp delta))
2440 (setq delta 0))
2441 ((zerop delta))
2442 ((< delta 0)
2443 (setq delta (window-sizable window delta))
2444 (window--resize-reset frame)
2445 ;; When shrinking the root window, emulate an edge drag in order
2446 ;; to not resize other windows if we can avoid it (Bug#12419).
2447 (window--resize-this-window
2448 window delta nil ignore t 'before
2449 (+ (window-top-line window) (window-total-size window)))
2450 ;; Don't record new normal sizes to make sure that shrinking back
2451 ;; proportionally works as intended.
2452 (walk-window-tree
2453 (lambda (window) (set-window-new-normal window 'ignore)) frame t))
2454 ((> delta 0)
2455 (window--resize-reset frame)
2456 (unless (window-sizable window delta)
2457 (setq ignore t))
2458 ;; When growing the root window, resize proportionally. This
2459 ;; should give windows back their original sizes (hopefully).
2460 (window--resize-this-window window delta nil ignore t)))
2461 ;; Return the possibly adjusted DELTA.
2462 delta))
2464 (defun adjust-window-trailing-edge (window delta &optional horizontal)
2465 "Move WINDOW's bottom edge by DELTA lines.
2466 Optional argument HORIZONTAL non-nil means move WINDOW's right
2467 edge by DELTA columns. WINDOW must be a valid window and
2468 defaults to the selected one.
2470 If DELTA is greater than zero, move the edge downwards or to the
2471 right. If DELTA is less than zero, move the edge upwards or to
2472 the left. If the edge can't be moved by DELTA lines or columns,
2473 move it as far as possible in the desired direction."
2474 (setq window (window-normalize-window window))
2475 (let* ((frame (window-frame window))
2476 (minibuffer-window (minibuffer-window frame))
2477 (right window)
2478 left this-delta min-delta max-delta)
2479 ;; Find the edge we want to move.
2480 (while (and (or (not (window-combined-p right horizontal))
2481 (not (window-right right)))
2482 (setq right (window-parent right))))
2483 (cond
2484 ((and (not right) (not horizontal)
2485 ;; Resize the minibuffer window if it's on the same frame as
2486 ;; and immediately below WINDOW and it's either active or
2487 ;; `resize-mini-windows' is nil.
2488 (eq (window-frame minibuffer-window) frame)
2489 (= (nth 1 (window-edges minibuffer-window))
2490 (nth 3 (window-edges window)))
2491 (or (not resize-mini-windows)
2492 (eq minibuffer-window (active-minibuffer-window))))
2493 (window--resize-mini-window minibuffer-window (- delta)))
2494 ((or (not (setq left right)) (not (setq right (window-right right))))
2495 (if horizontal
2496 (error "No window on the right of this one")
2497 (error "No window below this one")))
2499 ;; Set LEFT to the first resizable window on the left. This step is
2500 ;; needed to handle fixed-size windows.
2501 (while (and left (window-size-fixed-p left horizontal))
2502 (setq left
2503 (or (window-left left)
2504 (progn
2505 (while (and (setq left (window-parent left))
2506 (not (window-combined-p left horizontal))))
2507 (window-left left)))))
2508 (unless left
2509 (if horizontal
2510 (error "No resizable window on the left of this one")
2511 (error "No resizable window above this one")))
2513 ;; Set RIGHT to the first resizable window on the right. This step
2514 ;; is needed to handle fixed-size windows.
2515 (while (and right (window-size-fixed-p right horizontal))
2516 (setq right
2517 (or (window-right right)
2518 (progn
2519 (while (and (setq right (window-parent right))
2520 (not (window-combined-p right horizontal))))
2521 (window-right right)))))
2522 (unless right
2523 (if horizontal
2524 (error "No resizable window on the right of this one")
2525 (error "No resizable window below this one")))
2527 ;; LEFT and RIGHT (which might be both internal windows) are now the
2528 ;; two windows we want to resize.
2529 (cond
2530 ((> delta 0)
2531 (setq max-delta (window--max-delta-1 left 0 horizontal nil 'after))
2532 (setq min-delta (window--min-delta-1 right (- delta) horizontal nil 'before))
2533 (when (or (< max-delta delta) (> min-delta (- delta)))
2534 ;; We can't get the whole DELTA - move as far as possible.
2535 (setq delta (min max-delta (- min-delta))))
2536 (unless (zerop delta)
2537 ;; Start resizing.
2538 (window--resize-reset frame horizontal)
2539 ;; Try to enlarge LEFT first.
2540 (setq this-delta (window--resizable left delta horizontal))
2541 (unless (zerop this-delta)
2542 (window--resize-this-window
2543 left this-delta horizontal nil t 'before
2544 (if horizontal
2545 (+ (window-left-column left) (window-total-size left t))
2546 (+ (window-top-line left) (window-total-size left)))))
2547 ;; Shrink windows on right of LEFT.
2548 (window--resize-siblings
2549 left delta horizontal nil 'after
2550 (if horizontal
2551 (window-left-column right)
2552 (window-top-line right)))))
2553 ((< delta 0)
2554 (setq max-delta (window--max-delta-1 right 0 horizontal nil 'before))
2555 (setq min-delta (window--min-delta-1 left delta horizontal nil 'after))
2556 (when (or (< max-delta (- delta)) (> min-delta delta))
2557 ;; We can't get the whole DELTA - move as far as possible.
2558 (setq delta (max (- max-delta) min-delta)))
2559 (unless (zerop delta)
2560 ;; Start resizing.
2561 (window--resize-reset frame horizontal)
2562 ;; Try to enlarge RIGHT.
2563 (setq this-delta (window--resizable right (- delta) horizontal))
2564 (unless (zerop this-delta)
2565 (window--resize-this-window
2566 right this-delta horizontal nil t 'after
2567 (if horizontal
2568 (window-left-column right)
2569 (window-top-line right))))
2570 ;; Shrink windows on left of RIGHT.
2571 (window--resize-siblings
2572 right (- delta) horizontal nil 'before
2573 (if horizontal
2574 (+ (window-left-column left) (window-total-size left t))
2575 (+ (window-top-line left) (window-total-size left)))))))
2576 (unless (zerop delta)
2577 ;; Don't report an error in the standard case.
2578 (unless (window-resize-apply frame horizontal)
2579 ;; But do report an error if applying the changes fails.
2580 (error "Failed adjusting window %s" window)))))))
2582 (defun enlarge-window (delta &optional horizontal)
2583 "Make the selected window DELTA lines taller.
2584 Interactively, if no argument is given, make the selected window
2585 one line taller. If optional argument HORIZONTAL is non-nil,
2586 make selected window wider by DELTA columns. If DELTA is
2587 negative, shrink selected window by -DELTA lines or columns."
2588 (interactive "p")
2589 (let ((minibuffer-window (minibuffer-window)))
2590 (cond
2591 ((zerop delta))
2592 ((window-size-fixed-p nil horizontal)
2593 (error "Selected window has fixed size"))
2594 ((window-minibuffer-p)
2595 (if horizontal
2596 (error "Cannot resize minibuffer window horizontally")
2597 (window--resize-mini-window (selected-window) delta)))
2598 ((and (not horizontal)
2599 (window-full-height-p)
2600 (eq (window-frame minibuffer-window) (selected-frame))
2601 (not resize-mini-windows))
2602 ;; If the selected window is full height and `resize-mini-windows'
2603 ;; is nil, resize the minibuffer window.
2604 (window--resize-mini-window minibuffer-window (- delta)))
2605 ((window-resizable-p nil delta horizontal)
2606 (window-resize nil delta horizontal))
2608 (window-resize
2609 nil (if (> delta 0)
2610 (window-max-delta nil horizontal)
2611 (- (window-min-delta nil horizontal)))
2612 horizontal)))))
2614 (defun shrink-window (delta &optional horizontal)
2615 "Make the selected window DELTA lines smaller.
2616 Interactively, if no argument is given, make the selected window
2617 one line smaller. If optional argument HORIZONTAL is non-nil,
2618 make selected window narrower by DELTA columns. If DELTA is
2619 negative, enlarge selected window by -DELTA lines or columns.
2620 Also see the `window-min-height' variable."
2621 (interactive "p")
2622 (let ((minibuffer-window (minibuffer-window)))
2623 (cond
2624 ((zerop delta))
2625 ((window-size-fixed-p nil horizontal)
2626 (error "Selected window has fixed size"))
2627 ((window-minibuffer-p)
2628 (if horizontal
2629 (error "Cannot resize minibuffer window horizontally")
2630 (window--resize-mini-window (selected-window) (- delta))))
2631 ((and (not horizontal)
2632 (window-full-height-p)
2633 (eq (window-frame minibuffer-window) (selected-frame))
2634 (not resize-mini-windows))
2635 ;; If the selected window is full height and `resize-mini-windows'
2636 ;; is nil, resize the minibuffer window.
2637 (window--resize-mini-window minibuffer-window delta))
2638 ((window-resizable-p nil (- delta) horizontal)
2639 (window-resize nil (- delta) horizontal))
2641 (window-resize
2642 nil (if (> delta 0)
2643 (- (window-min-delta nil horizontal))
2644 (window-max-delta nil horizontal))
2645 horizontal)))))
2647 (defun maximize-window (&optional window)
2648 "Maximize WINDOW.
2649 Make WINDOW as large as possible without deleting any windows.
2650 WINDOW must be a valid window and defaults to the selected one."
2651 (interactive)
2652 (setq window (window-normalize-window window))
2653 (window-resize window (window-max-delta window))
2654 (window-resize window (window-max-delta window t) t))
2656 (defun minimize-window (&optional window)
2657 "Minimize WINDOW.
2658 Make WINDOW as small as possible without deleting any windows.
2659 WINDOW must be a valid window and defaults to the selected one."
2660 (interactive)
2661 (setq window (window-normalize-window window))
2662 (window-resize window (- (window-min-delta window)))
2663 (window-resize window (- (window-min-delta window t)) t))
2665 (defun frame-root-window-p (window)
2666 "Return non-nil if WINDOW is the root window of its frame."
2667 (eq window (frame-root-window window)))
2669 (defun window--subtree (window &optional next)
2670 "Return window subtree rooted at WINDOW.
2671 Optional argument NEXT non-nil means include WINDOW's right
2672 siblings in the return value.
2674 See the documentation of `window-tree' for a description of the
2675 return value."
2676 (let (list)
2677 (while window
2678 (setq list
2679 (cons
2680 (cond
2681 ((window-top-child window)
2682 (cons t (cons (window-edges window)
2683 (window--subtree (window-top-child window) t))))
2684 ((window-left-child window)
2685 (cons nil (cons (window-edges window)
2686 (window--subtree (window-left-child window) t))))
2687 (t window))
2688 list))
2689 (setq window (when next (window-next-sibling window))))
2690 (nreverse list)))
2692 (defun window-tree (&optional frame)
2693 "Return the window tree of frame FRAME.
2694 FRAME must be a live frame and defaults to the selected frame.
2695 The return value is a list of the form (ROOT MINI), where ROOT
2696 represents the window tree of the frame's root window, and MINI
2697 is the frame's minibuffer window.
2699 If the root window is not split, ROOT is the root window itself.
2700 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
2701 for a horizontal split, and t for a vertical split. EDGES gives
2702 the combined size and position of the child windows in the split,
2703 and the rest of the elements are the child windows in the split.
2704 Each of the child windows may again be a window or a list
2705 representing a window split, and so on. EDGES is a list (LEFT
2706 TOP RIGHT BOTTOM) as returned by `window-edges'."
2707 (setq frame (window-normalize-frame frame))
2708 (window--subtree (frame-root-window frame) t))
2710 (defun other-window (count &optional all-frames)
2711 "Select another window in cyclic ordering of windows.
2712 COUNT specifies the number of windows to skip, starting with the
2713 selected window, before making the selection. If COUNT is
2714 positive, skip COUNT windows forwards. If COUNT is negative,
2715 skip -COUNT windows backwards. COUNT zero means do not skip any
2716 window, so select the selected window. In an interactive call,
2717 COUNT is the numeric prefix argument. Return nil.
2719 If the `other-window' parameter of the selected window is a
2720 function and `ignore-window-parameters' is nil, call that
2721 function with the arguments COUNT and ALL-FRAMES.
2723 This function does not select a window whose `no-other-window'
2724 window parameter is non-nil.
2726 This function uses `next-window' for finding the window to
2727 select. The argument ALL-FRAMES has the same meaning as in
2728 `next-window', but the MINIBUF argument of `next-window' is
2729 always effectively nil."
2730 (interactive "p")
2731 (let* ((window (selected-window))
2732 (function (and (not ignore-window-parameters)
2733 (window-parameter window 'other-window)))
2734 old-window old-count)
2735 (if (functionp function)
2736 (funcall function count all-frames)
2737 ;; `next-window' and `previous-window' may return a window we are
2738 ;; not allowed to select. Hence we need an exit strategy in case
2739 ;; all windows are non-selectable.
2740 (catch 'exit
2741 (while (> count 0)
2742 (setq window (next-window window nil all-frames))
2743 (cond
2744 ((eq window old-window)
2745 (when (= count old-count)
2746 ;; Keep out of infinite loops. When COUNT has not changed
2747 ;; since we last looked at `window' we're probably in one.
2748 (throw 'exit nil)))
2749 ((window-parameter window 'no-other-window)
2750 (unless old-window
2751 ;; The first non-selectable window `next-window' got us:
2752 ;; Remember it and the current value of COUNT.
2753 (setq old-window window)
2754 (setq old-count count)))
2756 (setq count (1- count)))))
2757 (while (< count 0)
2758 (setq window (previous-window window nil all-frames))
2759 (cond
2760 ((eq window old-window)
2761 (when (= count old-count)
2762 ;; Keep out of infinite loops. When COUNT has not changed
2763 ;; since we last looked at `window' we're probably in one.
2764 (throw 'exit nil)))
2765 ((window-parameter window 'no-other-window)
2766 (unless old-window
2767 ;; The first non-selectable window `previous-window' got
2768 ;; us: Remember it and the current value of COUNT.
2769 (setq old-window window)
2770 (setq old-count count)))
2772 (setq count (1+ count)))))
2774 (select-window window)
2775 ;; Always return nil.
2776 nil))))
2778 ;; This should probably return non-nil when the selected window is part
2779 ;; of an atomic window whose root is the frame's root window.
2780 (defun one-window-p (&optional nomini all-frames)
2781 "Return non-nil if the selected window is the only window.
2782 Optional arg NOMINI non-nil means don't count the minibuffer
2783 even if it is active. Otherwise, the minibuffer is counted
2784 when it is active.
2786 Optional argument ALL-FRAMES specifies the set of frames to
2787 consider, see also `next-window'. ALL-FRAMES nil or omitted
2788 means consider windows on the selected frame only, plus the
2789 minibuffer window if specified by the NOMINI argument. If the
2790 minibuffer counts, consider all windows on all frames that share
2791 that minibuffer too. The remaining non-nil values of ALL-FRAMES
2792 with a special meaning are:
2794 - t means consider all windows on all existing frames.
2796 - `visible' means consider all windows on all visible frames on
2797 the current terminal.
2799 - 0 (the number zero) means consider all windows on all visible
2800 and iconified frames on the current terminal.
2802 - A frame means consider all windows on that frame only.
2804 Anything else means consider all windows on the selected frame
2805 and no others."
2806 (let ((base-window (selected-window)))
2807 (if (and nomini (eq base-window (minibuffer-window)))
2808 (setq base-window (next-window base-window)))
2809 (eq base-window
2810 (next-window base-window (if nomini 'arg) all-frames))))
2812 ;;; Deleting windows.
2813 (defun window-deletable-p (&optional window)
2814 "Return t if WINDOW can be safely deleted from its frame.
2815 WINDOW must be a valid window and defaults to the selected one.
2816 Return `frame' if deleting WINDOW should also delete its frame."
2817 (setq window (window-normalize-window window))
2819 (unless ignore-window-parameters
2820 ;; Handle atomicity.
2821 (when (window-parameter window 'window-atom)
2822 (setq window (window-atom-root window))))
2824 (let ((frame (window-frame window)))
2825 (cond
2826 ((frame-root-window-p window)
2827 ;; WINDOW's frame can be deleted only if there are other frames
2828 ;; on the same terminal, and it does not contain the active
2829 ;; minibuffer.
2830 (unless (or (eq frame (next-frame frame 0))
2831 (let ((minibuf (active-minibuffer-window)))
2832 (and minibuf (eq frame (window-frame minibuf)))))
2833 'frame))
2834 ((or ignore-window-parameters
2835 (not (eq window (window--major-non-side-window frame))))
2836 ;; WINDOW can be deleted unless it is the major non-side window of
2837 ;; its frame.
2838 t))))
2840 (defun window--in-subtree-p (window root)
2841 "Return t if WINDOW is either ROOT or a member of ROOT's subtree."
2842 (or (eq window root)
2843 (let ((parent (window-parent window)))
2844 (catch 'done
2845 (while parent
2846 (if (eq parent root)
2847 (throw 'done t)
2848 (setq parent (window-parent parent))))))))
2850 (defun delete-window (&optional window)
2851 "Delete WINDOW.
2852 WINDOW must be a valid window and defaults to the selected one.
2853 Return nil.
2855 If the variable `ignore-window-parameters' is non-nil or the
2856 `delete-window' parameter of WINDOW equals t, do not process any
2857 parameters of WINDOW. Otherwise, if the `delete-window'
2858 parameter of WINDOW specifies a function, call that function with
2859 WINDOW as its sole argument and return the value returned by that
2860 function.
2862 Otherwise, if WINDOW is part of an atomic window, call
2863 `delete-window' with the root of the atomic window as its
2864 argument. Signal an error if WINDOW is either the only window on
2865 its frame, the last non-side window, or part of an atomic window
2866 that is its frame's root window."
2867 (interactive)
2868 (setq window (window-normalize-window window))
2869 (let* ((frame (window-frame window))
2870 (function (window-parameter window 'delete-window))
2871 (parent (window-parent window))
2872 atom-root)
2873 (window--check frame)
2874 (catch 'done
2875 ;; Handle window parameters.
2876 (cond
2877 ;; Ignore window parameters if `ignore-window-parameters' tells
2878 ;; us so or `delete-window' equals t.
2879 ((or ignore-window-parameters (eq function t)))
2880 ((functionp function)
2881 ;; The `delete-window' parameter specifies the function to call.
2882 ;; If that function is `ignore' nothing is done. It's up to the
2883 ;; function called here to avoid infinite recursion.
2884 (throw 'done (funcall function window)))
2885 ((and (window-parameter window 'window-atom)
2886 (setq atom-root (window-atom-root window))
2887 (not (eq atom-root window)))
2888 (if (eq atom-root (frame-root-window frame))
2889 (error "Root of atomic window is root window of its frame")
2890 (throw 'done (delete-window atom-root))))
2891 ((not parent)
2892 (error "Attempt to delete minibuffer or sole ordinary window"))
2893 ((eq window (window--major-non-side-window frame))
2894 (error "Attempt to delete last non-side window")))
2896 (let* ((horizontal (window-left-child parent))
2897 (size (window-total-size window horizontal))
2898 (frame-selected
2899 (window--in-subtree-p (frame-selected-window frame) window))
2900 ;; Emacs 23 preferably gives WINDOW's space to its left
2901 ;; sibling.
2902 (sibling (or (window-left window) (window-right window))))
2903 (window--resize-reset frame horizontal)
2904 (cond
2905 ((and (not window-combination-resize)
2906 sibling (window-sizable-p sibling size))
2907 ;; Resize WINDOW's sibling.
2908 (window--resize-this-window sibling size horizontal nil t)
2909 (set-window-new-normal
2910 sibling (+ (window-normal-size sibling horizontal)
2911 (window-normal-size window horizontal))))
2912 ((window-resizable-p window (- size) horizontal nil nil nil t)
2913 ;; Can do without resizing fixed-size windows.
2914 (window--resize-siblings window (- size) horizontal))
2916 ;; Can't do without resizing fixed-size windows.
2917 (window--resize-siblings window (- size) horizontal t)))
2918 ;; Actually delete WINDOW.
2919 (delete-window-internal window)
2920 (when (and frame-selected
2921 (window-parameter
2922 (frame-selected-window frame) 'no-other-window))
2923 ;; `delete-window-internal' has selected a window that should
2924 ;; not be selected, fix this here.
2925 (other-window -1 frame))
2926 (run-window-configuration-change-hook frame)
2927 (window--check frame)
2928 ;; Always return nil.
2929 nil))))
2931 (defun delete-other-windows (&optional window)
2932 "Make WINDOW fill its frame.
2933 WINDOW must be a valid window and defaults to the selected one.
2934 Return nil.
2936 If the variable `ignore-window-parameters' is non-nil or the
2937 `delete-other-windows' parameter of WINDOW equals t, do not
2938 process any parameters of WINDOW. Otherwise, if the
2939 `delete-other-windows' parameter of WINDOW specifies a function,
2940 call that function with WINDOW as its sole argument and return
2941 the value returned by that function.
2943 Otherwise, if WINDOW is part of an atomic window, call this
2944 function with the root of the atomic window as its argument. If
2945 WINDOW is a non-side window, make WINDOW the only non-side window
2946 on the frame. Side windows are not deleted. If WINDOW is a side
2947 window signal an error."
2948 (interactive)
2949 (setq window (window-normalize-window window))
2950 (let* ((frame (window-frame window))
2951 (function (window-parameter window 'delete-other-windows))
2952 (window-side (window-parameter window 'window-side))
2953 atom-root side-main)
2954 (window--check frame)
2955 (catch 'done
2956 (cond
2957 ;; Ignore window parameters if `ignore-window-parameters' is t or
2958 ;; `delete-other-windows' is t.
2959 ((or ignore-window-parameters (eq function t)))
2960 ((functionp function)
2961 ;; The `delete-other-windows' parameter specifies the function
2962 ;; to call. If the function is `ignore' no windows are deleted.
2963 ;; It's up to the function called to avoid infinite recursion.
2964 (throw 'done (funcall function window)))
2965 ((and (window-parameter window 'window-atom)
2966 (setq atom-root (window-atom-root window))
2967 (not (eq atom-root window)))
2968 (if (eq atom-root (frame-root-window frame))
2969 (error "Root of atomic window is root window of its frame")
2970 (throw 'done (delete-other-windows atom-root))))
2971 ((memq window-side window-sides)
2972 (error "Cannot make side window the only window"))
2973 ((and (window-minibuffer-p window)
2974 (not (eq window (frame-root-window window))))
2975 (error "Can't expand minibuffer to full frame")))
2977 ;; If WINDOW is the major non-side window, do nothing.
2978 (if (window-with-parameter 'window-side)
2979 (setq side-main (window--major-non-side-window frame))
2980 (setq side-main (frame-root-window frame)))
2981 (unless (eq window side-main)
2982 (delete-other-windows-internal window side-main)
2983 (run-window-configuration-change-hook frame)
2984 (window--check frame))
2985 ;; Always return nil.
2986 nil)))
2988 (defun delete-other-windows-vertically (&optional window)
2989 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
2990 This may be a useful alternative binding for \\[delete-other-windows]
2991 if you often split windows horizontally."
2992 (interactive)
2993 (let* ((window (or window (selected-window)))
2994 (edges (window-edges window))
2995 (w window) delenda)
2996 (while (not (eq (setq w (next-window w 1)) window))
2997 (let ((e (window-edges w)))
2998 (when (and (= (car e) (car edges))
2999 (= (nth 2 e) (nth 2 edges)))
3000 (push w delenda))))
3001 (mapc 'delete-window delenda)))
3003 ;;; Windows and buffers.
3005 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
3006 ;; for (1) determining which buffer to show in the window when its
3007 ;; buffer shall be buried or killed and (2) which buffer to show for
3008 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
3010 ;; `prev-buffers' consists of <buffer, window-start, window-point>
3011 ;; triples. The entries on this list are ordered by the time their
3012 ;; buffer has been removed from the window, the most recently removed
3013 ;; buffer's entry being first. The window-start and window-point
3014 ;; components are `window-start' and `window-point' at the time the
3015 ;; buffer was removed from the window which implies that the entry must
3016 ;; be added when `set-window-buffer' removes the buffer from the window.
3018 ;; `next-buffers' is the list of buffers that have been replaced
3019 ;; recently by `switch-to-prev-buffer'. These buffers are the least
3020 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
3021 ;; candidates of `switch-to-next-buffer' to switch to. This list is
3022 ;; reset to nil by any action changing the window's buffer with the
3023 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
3024 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
3025 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
3027 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
3028 ;; if such a buffer was killed while the window was hidden within a
3029 ;; window configuration. Such killed buffers get removed whenever
3030 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
3032 ;; The following function is called by `set-window-buffer' _before_ it
3033 ;; replaces the buffer of the argument window with the new buffer.
3034 (defun record-window-buffer (&optional window)
3035 "Record WINDOW's buffer.
3036 WINDOW must be a live window and defaults to the selected one."
3037 (let* ((window (window-normalize-window window t))
3038 (buffer (window-buffer window))
3039 (entry (assq buffer (window-prev-buffers window))))
3040 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
3041 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
3042 (set-window-next-buffers window nil)
3044 (when entry
3045 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
3046 (set-window-prev-buffers
3047 window (assq-delete-all buffer (window-prev-buffers window))))
3049 ;; Don't record insignificant buffers.
3050 (unless (eq (aref (buffer-name buffer) 0) ?\s)
3051 ;; Add an entry for buffer to WINDOW's previous buffers.
3052 (with-current-buffer buffer
3053 (let ((start (window-start window))
3054 (point (window-point window)))
3055 (setq entry
3056 (cons buffer
3057 (if entry
3058 ;; We have an entry, update marker positions.
3059 (list (set-marker (nth 1 entry) start)
3060 (set-marker (nth 2 entry) point))
3061 ;; Make new markers.
3062 (list (copy-marker start)
3063 (copy-marker
3064 ;; Preserve window-point-insertion-type
3065 ;; (Bug#12588).
3066 point window-point-insertion-type)))))
3067 (set-window-prev-buffers
3068 window (cons entry (window-prev-buffers window))))))))
3070 (defun unrecord-window-buffer (&optional window buffer)
3071 "Unrecord BUFFER in WINDOW.
3072 WINDOW must be a live window and defaults to the selected one.
3073 BUFFER must be a live buffer and defaults to the buffer of
3074 WINDOW."
3075 (let* ((window (window-normalize-window window t))
3076 (buffer (or buffer (window-buffer window))))
3077 (set-window-prev-buffers
3078 window (assq-delete-all buffer (window-prev-buffers window)))
3079 (set-window-next-buffers
3080 window (delq buffer (window-next-buffers window)))))
3082 (defun set-window-buffer-start-and-point (window buffer &optional start point)
3083 "Set WINDOW's buffer to BUFFER.
3084 WINDOW must be a live window and defaults to the selected one.
3085 Optional argument START non-nil means set WINDOW's start position
3086 to START. Optional argument POINT non-nil means set WINDOW's
3087 point to POINT. If WINDOW is selected this also sets BUFFER's
3088 `point' to POINT. If WINDOW is selected and the buffer it showed
3089 before was current this also makes BUFFER the current buffer."
3090 (setq window (window-normalize-window window t))
3091 (let ((selected (eq window (selected-window)))
3092 (current (eq (window-buffer window) (current-buffer))))
3093 (set-window-buffer window buffer)
3094 (when (and selected current)
3095 (set-buffer buffer))
3096 (when start
3097 ;; Don't force window-start here (even if POINT is nil).
3098 (set-window-start window start t))
3099 (when point
3100 (set-window-point window point))))
3102 (defcustom switch-to-visible-buffer t
3103 "If non-nil, allow switching to an already visible buffer.
3104 If this variable is non-nil, `switch-to-prev-buffer' and
3105 `switch-to-next-buffer' may switch to an already visible buffer
3106 provided the buffer was shown before in the window specified as
3107 argument to those functions. If this variable is nil,
3108 `switch-to-prev-buffer' and `switch-to-next-buffer' always try to
3109 avoid switching to a buffer that is already visible in another
3110 window on the same frame."
3111 :type 'boolean
3112 :version "24.1"
3113 :group 'windows)
3115 (defun switch-to-prev-buffer (&optional window bury-or-kill)
3116 "In WINDOW switch to previous buffer.
3117 WINDOW must be a live window and defaults to the selected one.
3118 Return the buffer switched to, nil if no suitable buffer could be
3119 found.
3121 Optional argument BURY-OR-KILL non-nil means the buffer currently
3122 shown in WINDOW is about to be buried or killed and consequently
3123 shall not be switched to in future invocations of this command.
3125 As a special case, if BURY-OR-KILL equals `append', this means to
3126 move the buffer to the end of WINDOW's previous buffers list so a
3127 future invocation of `switch-to-prev-buffer' less likely switches
3128 to it."
3129 (interactive)
3130 (let* ((window (window-normalize-window window t))
3131 (frame (window-frame window))
3132 (old-buffer (window-buffer window))
3133 ;; Save this since it's destroyed by `set-window-buffer'.
3134 (next-buffers (window-next-buffers window))
3135 (pred (frame-parameter frame 'buffer-predicate))
3136 entry new-buffer killed-buffers visible)
3137 (when (window-minibuffer-p window)
3138 ;; Don't switch in minibuffer window.
3139 (unless (setq window (minibuffer-selected-window))
3140 (error "Window %s is a minibuffer window" window)))
3142 (when (window-dedicated-p window)
3143 ;; Don't switch in dedicated window.
3144 (error "Window %s is dedicated to buffer %s" window old-buffer))
3146 (catch 'found
3147 ;; Scan WINDOW's previous buffers first, skipping entries of next
3148 ;; buffers.
3149 (dolist (entry (window-prev-buffers window))
3150 (when (and (setq new-buffer (car entry))
3151 (or (buffer-live-p new-buffer)
3152 (not (setq killed-buffers
3153 (cons new-buffer killed-buffers))))
3154 (not (eq new-buffer old-buffer))
3155 (or (null pred) (funcall pred new-buffer))
3156 ;; When BURY-OR-KILL is nil, avoid switching to a
3157 ;; buffer in WINDOW's next buffers list.
3158 (or bury-or-kill (not (memq new-buffer next-buffers))))
3159 (if (and (not switch-to-visible-buffer)
3160 (get-buffer-window new-buffer frame))
3161 ;; Try to avoid showing a buffer visible in some other
3162 ;; window.
3163 (setq visible new-buffer)
3164 (set-window-buffer-start-and-point
3165 window new-buffer (nth 1 entry) (nth 2 entry))
3166 (throw 'found t))))
3167 ;; Scan reverted buffer list of WINDOW's frame next, skipping
3168 ;; entries of next buffers. Note that when we bury or kill a
3169 ;; buffer we don't reverse the global buffer list to avoid showing
3170 ;; a buried buffer instead. Otherwise, we must reverse the global
3171 ;; buffer list in order to make sure that switching to the
3172 ;; previous/next buffer traverse it in opposite directions.
3173 (dolist (buffer (if bury-or-kill
3174 (buffer-list frame)
3175 (nreverse (buffer-list frame))))
3176 (when (and (buffer-live-p buffer)
3177 (not (eq buffer old-buffer))
3178 (or (null pred) (funcall pred buffer))
3179 (not (eq (aref (buffer-name buffer) 0) ?\s))
3180 (or bury-or-kill (not (memq buffer next-buffers))))
3181 (if (get-buffer-window buffer frame)
3182 ;; Try to avoid showing a buffer visible in some other window.
3183 (unless visible
3184 (setq visible buffer))
3185 (setq new-buffer buffer)
3186 (set-window-buffer-start-and-point window new-buffer)
3187 (throw 'found t))))
3188 (unless bury-or-kill
3189 ;; Scan reverted next buffers last (must not use nreverse
3190 ;; here!).
3191 (dolist (buffer (reverse next-buffers))
3192 ;; Actually, buffer _must_ be live here since otherwise it
3193 ;; would have been caught in the scan of previous buffers.
3194 (when (and (or (buffer-live-p buffer)
3195 (not (setq killed-buffers
3196 (cons buffer killed-buffers))))
3197 (not (eq buffer old-buffer))
3198 (or (null pred) (funcall pred buffer))
3199 (setq entry (assq buffer (window-prev-buffers window))))
3200 (setq new-buffer buffer)
3201 (set-window-buffer-start-and-point
3202 window new-buffer (nth 1 entry) (nth 2 entry))
3203 (throw 'found t))))
3205 ;; Show a buffer visible in another window.
3206 (when visible
3207 (setq new-buffer visible)
3208 (set-window-buffer-start-and-point window new-buffer)))
3210 (if bury-or-kill
3211 (let ((entry (and (eq bury-or-kill 'append)
3212 (assq old-buffer (window-prev-buffers window)))))
3213 ;; Remove `old-buffer' from WINDOW's previous and (restored list
3214 ;; of) next buffers.
3215 (set-window-prev-buffers
3216 window (assq-delete-all old-buffer (window-prev-buffers window)))
3217 (set-window-next-buffers window (delq old-buffer next-buffers))
3218 (when entry
3219 ;; Append old-buffer's entry to list of WINDOW's previous
3220 ;; buffers so it's less likely to get switched to soon but
3221 ;; `display-buffer-in-previous-window' can nevertheless find
3222 ;; it.
3223 (set-window-prev-buffers
3224 window (append (window-prev-buffers window) (list entry)))))
3225 ;; Move `old-buffer' to head of WINDOW's restored list of next
3226 ;; buffers.
3227 (set-window-next-buffers
3228 window (cons old-buffer (delq old-buffer next-buffers))))
3230 ;; Remove killed buffers from WINDOW's previous and next buffers.
3231 (when killed-buffers
3232 (dolist (buffer killed-buffers)
3233 (set-window-prev-buffers
3234 window (assq-delete-all buffer (window-prev-buffers window)))
3235 (set-window-next-buffers
3236 window (delq buffer (window-next-buffers window)))))
3238 ;; Return new-buffer.
3239 new-buffer))
3241 (defun switch-to-next-buffer (&optional window)
3242 "In WINDOW switch to next buffer.
3243 WINDOW must be a live window and defaults to the selected one.
3244 Return the buffer switched to, nil if no suitable buffer could be
3245 found."
3246 (interactive)
3247 (let* ((window (window-normalize-window window t))
3248 (frame (window-frame window))
3249 (old-buffer (window-buffer window))
3250 (next-buffers (window-next-buffers window))
3251 (pred (frame-parameter frame 'buffer-predicate))
3252 new-buffer entry killed-buffers visible)
3253 (when (window-minibuffer-p window)
3254 ;; Don't switch in minibuffer window.
3255 (unless (setq window (minibuffer-selected-window))
3256 (error "Window %s is a minibuffer window" window)))
3258 (when (window-dedicated-p window)
3259 ;; Don't switch in dedicated window.
3260 (error "Window %s is dedicated to buffer %s" window old-buffer))
3262 (catch 'found
3263 ;; Scan WINDOW's next buffers first.
3264 (dolist (buffer next-buffers)
3265 (when (and (or (buffer-live-p buffer)
3266 (not (setq killed-buffers
3267 (cons buffer killed-buffers))))
3268 (not (eq buffer old-buffer))
3269 (or (null pred) (funcall pred buffer))
3270 (setq entry (assq buffer (window-prev-buffers window))))
3271 (setq new-buffer buffer)
3272 (set-window-buffer-start-and-point
3273 window new-buffer (nth 1 entry) (nth 2 entry))
3274 (throw 'found t)))
3275 ;; Scan the buffer list of WINDOW's frame next, skipping previous
3276 ;; buffers entries.
3277 (dolist (buffer (buffer-list frame))
3278 (when (and (buffer-live-p buffer)
3279 (not (eq buffer old-buffer))
3280 (or (null pred) (funcall pred buffer))
3281 (not (eq (aref (buffer-name buffer) 0) ?\s))
3282 (not (assq buffer (window-prev-buffers window))))
3283 (if (get-buffer-window buffer frame)
3284 ;; Try to avoid showing a buffer visible in some other window.
3285 (setq visible buffer)
3286 (setq new-buffer buffer)
3287 (set-window-buffer-start-and-point window new-buffer)
3288 (throw 'found t))))
3289 ;; Scan WINDOW's reverted previous buffers last (must not use
3290 ;; nreverse here!)
3291 (dolist (entry (reverse (window-prev-buffers window)))
3292 (when (and (setq new-buffer (car entry))
3293 (or (buffer-live-p new-buffer)
3294 (not (setq killed-buffers
3295 (cons new-buffer killed-buffers))))
3296 (not (eq new-buffer old-buffer))
3297 (or (null pred) (funcall pred new-buffer)))
3298 (if (and (not switch-to-visible-buffer)
3299 (get-buffer-window new-buffer frame))
3300 ;; Try to avoid showing a buffer visible in some other window.
3301 (unless visible
3302 (setq visible new-buffer))
3303 (set-window-buffer-start-and-point
3304 window new-buffer (nth 1 entry) (nth 2 entry))
3305 (throw 'found t))))
3307 ;; Show a buffer visible in another window.
3308 (when visible
3309 (setq new-buffer visible)
3310 (set-window-buffer-start-and-point window new-buffer)))
3312 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
3313 (set-window-next-buffers window (delq new-buffer next-buffers))
3315 ;; Remove killed buffers from WINDOW's previous and next buffers.
3316 (when killed-buffers
3317 (dolist (buffer killed-buffers)
3318 (set-window-prev-buffers
3319 window (assq-delete-all buffer (window-prev-buffers window)))
3320 (set-window-next-buffers
3321 window (delq buffer (window-next-buffers window)))))
3323 ;; Return new-buffer.
3324 new-buffer))
3326 (defun get-next-valid-buffer (list &optional buffer visible-ok frame)
3327 "Search LIST for a valid buffer to display in FRAME.
3328 Return nil when all buffers in LIST are undesirable for display,
3329 otherwise return the first suitable buffer in LIST.
3331 Buffers not visible in windows are preferred to visible buffers,
3332 unless VISIBLE-OK is non-nil.
3333 If the optional argument FRAME is nil, it defaults to the selected frame.
3334 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
3335 ;; This logic is more or less copied from other-buffer.
3336 (setq frame (or frame (selected-frame)))
3337 (let ((pred (frame-parameter frame 'buffer-predicate))
3338 found buf)
3339 (while (and (not found) list)
3340 (setq buf (car list))
3341 (if (and (not (eq buffer buf))
3342 (buffer-live-p buf)
3343 (or (null pred) (funcall pred buf))
3344 (not (eq (aref (buffer-name buf) 0) ?\s))
3345 (or visible-ok (null (get-buffer-window buf 'visible))))
3346 (setq found buf)
3347 (setq list (cdr list))))
3348 (car list)))
3350 (defun last-buffer (&optional buffer visible-ok frame)
3351 "Return the last buffer in FRAME's buffer list.
3352 If BUFFER is the last buffer, return the preceding buffer
3353 instead. Buffers not visible in windows are preferred to visible
3354 buffers, unless optional argument VISIBLE-OK is non-nil.
3355 Optional third argument FRAME nil or omitted means use the
3356 selected frame's buffer list. If no such buffer exists, return
3357 the buffer `*scratch*', creating it if necessary."
3358 (setq frame (or frame (selected-frame)))
3359 (or (get-next-valid-buffer (nreverse (buffer-list frame))
3360 buffer visible-ok frame)
3361 (get-buffer "*scratch*")
3362 (let ((scratch (get-buffer-create "*scratch*")))
3363 (set-buffer-major-mode scratch)
3364 scratch)))
3366 (defcustom frame-auto-hide-function #'iconify-frame
3367 "Function called to automatically hide frames.
3368 The function is called with one argument - a frame.
3370 Functions affected by this option are those that bury a buffer
3371 shown in a separate frame like `quit-window' and `bury-buffer'."
3372 :type '(choice (const :tag "Iconify" iconify-frame)
3373 (const :tag "Delete" delete-frame)
3374 (const :tag "Do nothing" ignore)
3375 function)
3376 :group 'windows
3377 :group 'frames
3378 :version "24.1")
3380 (defun window--delete (&optional window dedicated-only kill)
3381 "Delete WINDOW if possible.
3382 WINDOW must be a live window and defaults to the selected one.
3383 Optional argument DEDICATED-ONLY non-nil means to delete WINDOW
3384 only if it's dedicated to its buffer. Optional argument KILL
3385 means the buffer shown in window will be killed. Return non-nil
3386 if WINDOW gets deleted or its frame is auto-hidden."
3387 (setq window (window-normalize-window window t))
3388 (unless (and dedicated-only (not (window-dedicated-p window)))
3389 (let ((deletable (window-deletable-p window)))
3390 (cond
3391 ((eq deletable 'frame)
3392 (let ((frame (window-frame window)))
3393 (cond
3394 (kill
3395 (delete-frame frame))
3396 ((functionp frame-auto-hide-function)
3397 (funcall frame-auto-hide-function frame))))
3398 'frame)
3399 (deletable
3400 (delete-window window)
3401 t)))))
3403 (defun bury-buffer (&optional buffer-or-name)
3404 "Put BUFFER-OR-NAME at the end of the list of all buffers.
3405 There it is the least likely candidate for `other-buffer' to
3406 return; thus, the least likely buffer for \\[switch-to-buffer] to
3407 select by default.
3409 You can specify a buffer name as BUFFER-OR-NAME, or an actual
3410 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
3411 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
3412 remove the current buffer from the selected window if it is
3413 displayed there."
3414 (interactive)
3415 (let* ((buffer (window-normalize-buffer buffer-or-name)))
3416 ;; If `buffer-or-name' is not on the selected frame we unrecord it
3417 ;; although it's not "here" (call it a feature).
3418 (bury-buffer-internal buffer)
3419 ;; Handle case where `buffer-or-name' is nil and the current buffer
3420 ;; is shown in the selected window.
3421 (cond
3422 ((or buffer-or-name (not (eq buffer (window-buffer)))))
3423 ((window--delete nil t))
3425 ;; Switch to another buffer in window.
3426 (set-window-dedicated-p nil nil)
3427 (switch-to-prev-buffer nil 'bury)))
3429 ;; Always return nil.
3430 nil))
3432 (defun unbury-buffer ()
3433 "Switch to the last buffer in the buffer list."
3434 (interactive)
3435 (switch-to-buffer (last-buffer)))
3437 (defun next-buffer ()
3438 "In selected window switch to next buffer."
3439 (interactive)
3440 (cond
3441 ((window-minibuffer-p)
3442 (error "Cannot switch buffers in minibuffer window"))
3443 ((eq (window-dedicated-p) t)
3444 (error "Window is strongly dedicated to its buffer"))
3446 (switch-to-next-buffer))))
3448 (defun previous-buffer ()
3449 "In selected window switch to previous buffer."
3450 (interactive)
3451 (cond
3452 ((window-minibuffer-p)
3453 (error "Cannot switch buffers in minibuffer window"))
3454 ((eq (window-dedicated-p) t)
3455 (error "Window is strongly dedicated to its buffer"))
3457 (switch-to-prev-buffer))))
3459 (defun delete-windows-on (&optional buffer-or-name frame)
3460 "Delete all windows showing BUFFER-OR-NAME.
3461 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
3462 and defaults to the current buffer.
3464 The following non-nil values of the optional argument FRAME
3465 have special meanings:
3467 - t means consider all windows on the selected frame only.
3469 - `visible' means consider all windows on all visible frames on
3470 the current terminal.
3472 - 0 (the number zero) means consider all windows on all visible
3473 and iconified frames on the current terminal.
3475 - A frame means consider all windows on that frame only.
3477 Any other value of FRAME means consider all windows on all
3478 frames.
3480 When a window showing BUFFER-OR-NAME is dedicated and the only
3481 window of its frame, that frame is deleted when there are other
3482 frames left."
3483 (interactive "BDelete windows on (buffer):\nP")
3484 (let ((buffer (window-normalize-buffer buffer-or-name))
3485 ;; Handle the "inverted" meaning of the FRAME argument wrt other
3486 ;; `window-list-1' based function.
3487 (all-frames (cond ((not frame) t) ((eq frame t) nil) (t frame))))
3488 (dolist (window (window-list-1 nil nil all-frames))
3489 (if (eq (window-buffer window) buffer)
3490 (let ((deletable (window-deletable-p window)))
3491 (cond
3492 ((and (eq deletable 'frame) (window-dedicated-p window))
3493 ;; Delete frame if and only if window is dedicated.
3494 (delete-frame (window-frame window)))
3495 ((eq deletable t)
3496 ;; Delete window.
3497 (delete-window window))
3499 ;; In window switch to previous buffer.
3500 (set-window-dedicated-p window nil)
3501 (switch-to-prev-buffer window 'bury))))
3502 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
3503 (unrecord-window-buffer window buffer)))))
3505 (defun replace-buffer-in-windows (&optional buffer-or-name)
3506 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
3507 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
3508 and defaults to the current buffer.
3510 When a window showing BUFFER-OR-NAME is dedicated, that window is
3511 deleted. If that window is the only window on its frame, the
3512 frame is deleted too when there are other frames left. If there
3513 are no other frames left, some other buffer is displayed in that
3514 window.
3516 This function removes the buffer denoted by BUFFER-OR-NAME from
3517 all window-local buffer lists."
3518 (interactive "bBuffer to replace: ")
3519 (let ((buffer (window-normalize-buffer buffer-or-name)))
3520 (dolist (window (window-list-1 nil nil t))
3521 (if (eq (window-buffer window) buffer)
3522 (unless (window--delete window t t)
3523 ;; Switch to another buffer in window.
3524 (set-window-dedicated-p window nil)
3525 (switch-to-prev-buffer window 'kill))
3526 ;; Unrecord BUFFER in WINDOW.
3527 (unrecord-window-buffer window buffer)))))
3529 (defun quit-restore-window (&optional window bury-or-kill)
3530 "Quit WINDOW and deal with its buffer.
3531 WINDOW must be a live window and defaults to the selected one.
3533 According to information stored in WINDOW's `quit-restore' window
3534 parameter either (1) delete WINDOW and its frame, (2) delete
3535 WINDOW, (3) restore the buffer previously displayed in WINDOW,
3536 or (4) make WINDOW display some other buffer than the present
3537 one. If non-nil, reset `quit-restore' parameter to nil.
3539 Optional second argument BURY-OR-KILL tells how to proceed with
3540 the buffer of WINDOW. The following values are handled:
3542 `nil' means to not handle the buffer in a particular way. This
3543 means that if WINDOW is not deleted by this function, invoking
3544 `switch-to-prev-buffer' will usually show the buffer again.
3546 `append' means that if WINDOW is not deleted, move its buffer to
3547 the end of WINDOW's previous buffers so it's less likely that a
3548 future invocation of `switch-to-prev-buffer' will switch to it.
3549 Also, move the buffer to the end of the frame's buffer list.
3551 `bury' means that if WINDOW is not deleted, remove its buffer
3552 from WINDOW'S list of previous buffers. Also, move the buffer
3553 to the end of the frame's buffer list. This value provides the
3554 most reliable remedy to not have `switch-to-prev-buffer' switch
3555 to this buffer again without killing the buffer.
3557 `kill' means to kill WINDOW's buffer."
3558 (setq window (window-normalize-window window t))
3559 (let* ((buffer (window-buffer window))
3560 (quit-restore (window-parameter window 'quit-restore))
3561 (prev-buffer
3562 (let* ((prev-buffers (window-prev-buffers window))
3563 (prev-buffer (caar prev-buffers)))
3564 (and (or (not (eq prev-buffer buffer))
3565 (and (cdr prev-buffers)
3566 (not (eq (setq prev-buffer (cadr prev-buffers))
3567 buffer))))
3568 prev-buffer)))
3569 quad entry)
3570 (cond
3571 ((and (not prev-buffer)
3572 (or (eq (nth 1 quit-restore) 'frame)
3573 (and (eq (nth 1 quit-restore) 'window)
3574 ;; If the window has been created on an existing
3575 ;; frame and ended up as the sole window on that
3576 ;; frame, do not delete it (Bug#12764).
3577 (not (eq window (frame-root-window window)))))
3578 (eq (nth 3 quit-restore) buffer)
3579 ;; Delete WINDOW if possible.
3580 (window--delete window nil (eq bury-or-kill 'kill)))
3581 ;; If the previously selected window is still alive, select it.
3582 (when (window-live-p (nth 2 quit-restore))
3583 (select-window (nth 2 quit-restore))))
3584 ((and (listp (setq quad (nth 1 quit-restore)))
3585 (buffer-live-p (car quad))
3586 (eq (nth 3 quit-restore) buffer))
3587 ;; Show another buffer stored in quit-restore parameter.
3588 (when (and (integerp (nth 3 quad))
3589 (/= (nth 3 quad) (window-total-size window)))
3590 ;; Try to resize WINDOW to its old height but don't signal an
3591 ;; error.
3592 (condition-case nil
3593 (window-resize window (- (nth 3 quad) (window-total-size window)))
3594 (error nil)))
3595 (set-window-dedicated-p window nil)
3596 ;; Restore WINDOW's previous buffer, start and point position.
3597 (set-window-buffer-start-and-point
3598 window (nth 0 quad) (nth 1 quad) (nth 2 quad))
3599 ;; Deal with the buffer we just removed from WINDOW.
3600 (setq entry (and (eq bury-or-kill 'append)
3601 (assq buffer (window-prev-buffers window))))
3602 (when bury-or-kill
3603 ;; Remove buffer from WINDOW's previous and next buffers.
3604 (set-window-prev-buffers
3605 window (assq-delete-all buffer (window-prev-buffers window)))
3606 (set-window-next-buffers
3607 window (delq buffer (window-next-buffers window))))
3608 (when entry
3609 ;; Append old buffer's entry to list of WINDOW's previous
3610 ;; buffers so it's less likely to get switched to soon but
3611 ;; `display-buffer-in-previous-window' can nevertheless find it.
3612 (set-window-prev-buffers
3613 window (append (window-prev-buffers window) (list entry))))
3614 ;; Reset the quit-restore parameter.
3615 (set-window-parameter window 'quit-restore nil)
3616 ;; Select old window.
3617 (when (window-live-p (nth 2 quit-restore))
3618 (select-window (nth 2 quit-restore))))
3620 ;; Show some other buffer in WINDOW and reset the quit-restore
3621 ;; parameter.
3622 (set-window-parameter window 'quit-restore nil)
3623 ;; Make sure that WINDOW is no more dedicated.
3624 (set-window-dedicated-p window nil)
3625 (switch-to-prev-buffer window bury-or-kill)))
3627 ;; Deal with the buffer.
3628 (cond
3629 ((not (buffer-live-p buffer)))
3630 ((eq bury-or-kill 'kill)
3631 (kill-buffer buffer))
3632 (bury-or-kill
3633 (bury-buffer-internal buffer)))))
3635 (defun quit-window (&optional kill window)
3636 "Quit WINDOW and bury its buffer.
3637 WINDOW must be a live window and defaults to the selected one.
3638 With prefix argument KILL non-nil, kill the buffer instead of
3639 burying it.
3641 According to information stored in WINDOW's `quit-restore' window
3642 parameter either (1) delete WINDOW and its frame, (2) delete
3643 WINDOW, (3) restore the buffer previously displayed in WINDOW,
3644 or (4) make WINDOW display some other buffer than the present
3645 one. If non-nil, reset `quit-restore' parameter to nil."
3646 (interactive "P")
3647 (quit-restore-window window (if kill 'kill 'bury)))
3649 (defun quit-windows-on (&optional buffer-or-name kill frame)
3650 "Quit all windows showing BUFFER-OR-NAME.
3651 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
3652 and defaults to the current buffer. Optional argument KILL
3653 non-nil means to kill BUFFER-OR-NAME. KILL nil means to bury
3654 BUFFER-OR-NAME. Optional argument FRAME is handled as by
3655 `delete-windows-on'.
3657 This function calls `quit-window' on all candidate windows
3658 showing BUFFER-OR-NAME."
3659 (interactive "BQuit windows on (buffer):\nP")
3660 (let ((buffer (window-normalize-buffer buffer-or-name))
3661 ;; Handle the "inverted" meaning of the FRAME argument wrt other
3662 ;; `window-list-1' based function.
3663 (all-frames (cond ((not frame) t) ((eq frame t) nil) (t frame))))
3664 (dolist (window (window-list-1 nil nil all-frames))
3665 (if (eq (window-buffer window) buffer)
3666 (quit-window kill window)
3667 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
3668 (unrecord-window-buffer window buffer)))))
3670 ;;; Splitting windows.
3671 (defun window-split-min-size (&optional horizontal)
3672 "Return minimum height of any window when splitting windows.
3673 Optional argument HORIZONTAL non-nil means return minimum width."
3674 (if horizontal
3675 (max window-min-width window-safe-min-width)
3676 (max window-min-height window-safe-min-height)))
3678 (defun split-window (&optional window size side)
3679 "Make a new window adjacent to WINDOW.
3680 WINDOW must be a valid window and defaults to the selected one.
3681 Return the new window which is always a live window.
3683 Optional argument SIZE a positive number means make WINDOW SIZE
3684 lines or columns tall. If SIZE is negative, make the new window
3685 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
3686 absolute value can be less than `window-min-height' or
3687 `window-min-width'; so this command can make a new window as
3688 small as one line or two columns. SIZE defaults to half of
3689 WINDOW's size.
3691 Optional third argument SIDE nil (or `below') specifies that the
3692 new window shall be located below WINDOW. SIDE `above' means the
3693 new window shall be located above WINDOW. In both cases SIZE
3694 specifies the new number of lines for WINDOW (or the new window
3695 if SIZE is negative) including space reserved for the mode and/or
3696 header line.
3698 SIDE t (or `right') specifies that the new window shall be
3699 located on the right side of WINDOW. SIDE `left' means the new
3700 window shall be located on the left of WINDOW. In both cases
3701 SIZE specifies the new number of columns for WINDOW (or the new
3702 window provided SIZE is negative) including space reserved for
3703 fringes and the scrollbar or a divider column. Any other non-nil
3704 value for SIDE is currently handled like t (or `right').
3706 If the variable `ignore-window-parameters' is non-nil or the
3707 `split-window' parameter of WINDOW equals t, do not process any
3708 parameters of WINDOW. Otherwise, if the `split-window' parameter
3709 of WINDOW specifies a function, call that function with all three
3710 arguments and return the value returned by that function.
3712 Otherwise, if WINDOW is part of an atomic window, \"split\" the
3713 root of that atomic window. The new window does not become a
3714 member of that atomic window.
3716 If WINDOW is live, properties of the new window like margins and
3717 scrollbars are inherited from WINDOW. If WINDOW is an internal
3718 window, these properties as well as the buffer displayed in the
3719 new window are inherited from the window selected on WINDOW's
3720 frame. The selected window is not changed by this function."
3721 (setq window (window-normalize-window window))
3722 (let* ((side (cond
3723 ((not side) 'below)
3724 ((memq side '(below above right left)) side)
3725 (t 'right)))
3726 (horizontal (not (memq side '(below above))))
3727 (frame (window-frame window))
3728 (parent (window-parent window))
3729 (function (window-parameter window 'split-window))
3730 (window-side (window-parameter window 'window-side))
3731 ;; Rebind the following two variables since in some cases we
3732 ;; have to override their value.
3733 (window-combination-limit window-combination-limit)
3734 (window-combination-resize window-combination-resize)
3735 atom-root)
3737 (window--check frame)
3738 (catch 'done
3739 (cond
3740 ;; Ignore window parameters if either `ignore-window-parameters'
3741 ;; is t or the `split-window' parameter equals t.
3742 ((or ignore-window-parameters (eq function t)))
3743 ((functionp function)
3744 ;; The `split-window' parameter specifies the function to call.
3745 ;; If that function is `ignore', do nothing.
3746 (throw 'done (funcall function window size side)))
3747 ;; If WINDOW is part of an atomic window, split the root window
3748 ;; of that atomic window instead.
3749 ((and (window-parameter window 'window-atom)
3750 (setq atom-root (window-atom-root window))
3751 (not (eq atom-root window)))
3752 (throw 'done (split-window atom-root size side)))
3753 ;; If WINDOW is a side window or its first or last child is a
3754 ;; side window, throw an error unless `window-combination-resize'
3755 ;; equals 'side.
3756 ((and (not (eq window-combination-resize 'side))
3757 (or (window-parameter window 'window-side)
3758 (and (window-child window)
3759 (or (window-parameter
3760 (window-child window) 'window-side)
3761 (window-parameter
3762 (window-last-child window) 'window-side)))))
3763 (error "Cannot split side window or parent of side window"))
3764 ;; If `window-combination-resize' is 'side and window has a side
3765 ;; window sibling, bind `window-combination-limit' to t.
3766 ((and (not (eq window-combination-resize 'side))
3767 (or (and (window-prev-sibling window)
3768 (window-parameter
3769 (window-prev-sibling window) 'window-side))
3770 (and (window-next-sibling window)
3771 (window-parameter
3772 (window-next-sibling window) 'window-side))))
3773 (setq window-combination-limit t)))
3775 ;; If `window-combination-resize' is t and SIZE is non-negative,
3776 ;; bind `window-combination-limit' to t.
3777 (when (and (eq window-combination-resize t) size (> size 0))
3778 (setq window-combination-limit t))
3780 (let* ((parent-size
3781 ;; `parent-size' is the size of WINDOW's parent, provided
3782 ;; it has one.
3783 (when parent (window-total-size parent horizontal)))
3784 ;; `resize' non-nil means we are supposed to resize other
3785 ;; windows in WINDOW's combination.
3786 (resize
3787 (and window-combination-resize
3788 (or (window-parameter window 'window-side)
3789 (not (eq window-combination-resize 'side)))
3790 (not (eq window-combination-limit t))
3791 ;; Resize makes sense in iso-combinations only.
3792 (window-combined-p window horizontal)))
3793 ;; `old-size' is the current size of WINDOW.
3794 (old-size (window-total-size window horizontal))
3795 ;; `new-size' is the specified or calculated size of the
3796 ;; new window.
3797 (new-size
3798 (cond
3799 ((not size)
3800 (max (window-split-min-size horizontal)
3801 (if resize
3802 ;; When resizing try to give the new window the
3803 ;; average size of a window in its combination.
3804 (min (- parent-size
3805 (window-min-size parent horizontal))
3806 (/ parent-size
3807 (1+ (window-combinations
3808 parent horizontal))))
3809 ;; Else try to give the new window half the size
3810 ;; of WINDOW (plus an eventual odd line).
3811 (+ (/ old-size 2) (% old-size 2)))))
3812 ((>= size 0)
3813 ;; SIZE non-negative specifies the new size of WINDOW.
3815 ;; Note: Specifying a non-negative SIZE is practically
3816 ;; always done as workaround for making the new window
3817 ;; appear above or on the left of the new window (the
3818 ;; ispell window is a typical example of that). In all
3819 ;; these cases the SIDE argument should be set to 'above
3820 ;; or 'left in order to support the 'resize option.
3821 ;; Here we have to nest the windows instead, see above.
3822 (- old-size size))
3824 ;; SIZE negative specifies the size of the new window.
3825 (- size))))
3826 new-parent new-normal)
3828 ;; Check SIZE.
3829 (cond
3830 ((not size)
3831 (cond
3832 (resize
3833 ;; SIZE unspecified, resizing.
3834 (when (and (not (window-sizable-p parent (- new-size) horizontal))
3835 ;; Try again with minimum split size.
3836 (setq new-size
3837 (max new-size (window-split-min-size horizontal)))
3838 (not (window-sizable-p parent (- new-size) horizontal)))
3839 (error "Window %s too small for splitting" parent)))
3840 ((> (+ new-size (window-min-size window horizontal)) old-size)
3841 ;; SIZE unspecified, no resizing.
3842 (error "Window %s too small for splitting" window))))
3843 ((and (>= size 0)
3844 (or (>= size old-size)
3845 (< new-size (if horizontal
3846 window-safe-min-width
3847 window-safe-min-width))))
3848 ;; SIZE specified as new size of old window. If the new size
3849 ;; is larger than the old size or the size of the new window
3850 ;; would be less than the safe minimum, signal an error.
3851 (error "Window %s too small for splitting" window))
3852 (resize
3853 ;; SIZE specified, resizing.
3854 (unless (window-sizable-p parent (- new-size) horizontal)
3855 ;; If we cannot resize the parent give up.
3856 (error "Window %s too small for splitting" parent)))
3857 ((or (< new-size
3858 (if horizontal window-safe-min-width window-safe-min-height))
3859 (< (- old-size new-size)
3860 (if horizontal window-safe-min-width window-safe-min-height)))
3861 ;; SIZE specification violates minimum size restrictions.
3862 (error "Window %s too small for splitting" window)))
3864 (window--resize-reset frame horizontal)
3866 (setq new-parent
3867 ;; Make new-parent non-nil if we need a new parent window;
3868 ;; either because we want to nest or because WINDOW is not
3869 ;; iso-combined.
3870 (or (eq window-combination-limit t)
3871 (not (window-combined-p window horizontal))))
3872 (setq new-normal
3873 ;; Make new-normal the normal size of the new window.
3874 (cond
3875 (size (/ (float new-size) (if new-parent old-size parent-size)))
3876 (new-parent 0.5)
3877 (resize (/ 1.0 (1+ (window-combinations parent horizontal))))
3878 (t (/ (window-normal-size window horizontal) 2.0))))
3880 (if resize
3881 ;; Try to get space from OLD's siblings. We could go "up" and
3882 ;; try getting additional space from surrounding windows but
3883 ;; we won't be able to return space to those windows when we
3884 ;; delete the one we create here. Hence we do not go up.
3885 (progn
3886 (window--resize-child-windows parent (- new-size) horizontal)
3887 (let* ((normal (- 1.0 new-normal))
3888 (sub (window-child parent)))
3889 (while sub
3890 (set-window-new-normal
3891 sub (* (window-normal-size sub horizontal) normal))
3892 (setq sub (window-right sub)))))
3893 ;; Get entire space from WINDOW.
3894 (set-window-new-total window (- old-size new-size))
3895 (window--resize-this-window window (- new-size) horizontal)
3896 (set-window-new-normal
3897 window (- (if new-parent 1.0 (window-normal-size window horizontal))
3898 new-normal)))
3900 (let* ((new (split-window-internal window new-size side new-normal)))
3901 ;; Assign window-side parameters, if any.
3902 (when (eq window-combination-resize 'side)
3903 (let ((window-side
3904 (cond
3905 (window-side window-side)
3906 ((eq side 'above) 'top)
3907 ((eq side 'below) 'bottom)
3908 (t side))))
3909 ;; We made a new side window.
3910 (set-window-parameter new 'window-side window-side)
3911 (when (and new-parent (window-parameter window 'window-side))
3912 ;; We've been splitting a side root window. Give the
3913 ;; new parent the same window-side parameter.
3914 (set-window-parameter
3915 (window-parent new) 'window-side window-side))))
3917 (run-window-configuration-change-hook frame)
3918 (window--check frame)
3919 ;; Always return the new window.
3920 new)))))
3922 ;; I think this should be the default; I think people will prefer it--rms.
3923 (defcustom split-window-keep-point t
3924 "If non-nil, \\[split-window-below] preserves point in the new window.
3925 If nil, adjust point in the two windows to minimize redisplay.
3926 This option applies only to `split-window-below' and functions
3927 that call it. The low-level `split-window' function always keeps
3928 the original point in both windows."
3929 :type 'boolean
3930 :group 'windows)
3932 (defun split-window-below (&optional size)
3933 "Split the selected window into two windows, one above the other.
3934 The selected window is above. The newly split-off window is
3935 below, and displays the same buffer. Return the new window.
3937 If optional argument SIZE is omitted or nil, both windows get the
3938 same height, or close to it. If SIZE is positive, the upper
3939 \(selected) window gets SIZE lines. If SIZE is negative, the
3940 lower (new) window gets -SIZE lines.
3942 If the variable `split-window-keep-point' is non-nil, both
3943 windows get the same value of point as the selected window.
3944 Otherwise, the window starts are chosen so as to minimize the
3945 amount of redisplay; this is convenient on slow terminals."
3946 (interactive "P")
3947 (let ((old-window (selected-window))
3948 (old-point (window-point))
3949 (size (and size (prefix-numeric-value size)))
3950 moved-by-window-height moved new-window bottom)
3951 (when (and size (< size 0) (< (- size) window-min-height))
3952 ;; `split-window' would not signal an error here.
3953 (error "Size of new window too small"))
3954 (setq new-window (split-window nil size))
3955 (unless split-window-keep-point
3956 (with-current-buffer (window-buffer)
3957 ;; Use `save-excursion' around vertical movements below
3958 ;; (Bug#10971). Note: When the selected window's buffer has a
3959 ;; header line, up to two lines of the buffer may not show up
3960 ;; in the resulting configuration.
3961 (save-excursion
3962 (goto-char (window-start))
3963 (setq moved (vertical-motion (window-height)))
3964 (set-window-start new-window (point))
3965 (when (> (point) (window-point new-window))
3966 (set-window-point new-window (point)))
3967 (when (= moved (window-height))
3968 (setq moved-by-window-height t)
3969 (vertical-motion -1))
3970 (setq bottom (point)))
3971 (and moved-by-window-height
3972 (<= bottom (point))
3973 (set-window-point old-window (1- bottom)))
3974 (and moved-by-window-height
3975 (<= (window-start new-window) old-point)
3976 (set-window-point new-window old-point)
3977 (select-window new-window))))
3978 ;; Always copy quit-restore parameter in interactive use.
3979 (let ((quit-restore (window-parameter old-window 'quit-restore)))
3980 (when quit-restore
3981 (set-window-parameter new-window 'quit-restore quit-restore)))
3982 new-window))
3984 (defalias 'split-window-vertically 'split-window-below)
3986 (defun split-window-right (&optional size)
3987 "Split the selected window into two side-by-side windows.
3988 The selected window is on the left. The newly split-off window
3989 is on the right, and displays the same buffer. Return the new
3990 window.
3992 If optional argument SIZE is omitted or nil, both windows get the
3993 same width, or close to it. If SIZE is positive, the left-hand
3994 \(selected) window gets SIZE columns. If SIZE is negative, the
3995 right-hand (new) window gets -SIZE columns. Here, SIZE includes
3996 the width of the window's scroll bar; if there are no scroll
3997 bars, it includes the width of the divider column to the window's
3998 right, if any."
3999 (interactive "P")
4000 (let ((old-window (selected-window))
4001 (size (and size (prefix-numeric-value size)))
4002 new-window)
4003 (when (and size (< size 0) (< (- size) window-min-width))
4004 ;; `split-window' would not signal an error here.
4005 (error "Size of new window too small"))
4006 (setq new-window (split-window nil size t))
4007 ;; Always copy quit-restore parameter in interactive use.
4008 (let ((quit-restore (window-parameter old-window 'quit-restore)))
4009 (when quit-restore
4010 (set-window-parameter new-window 'quit-restore quit-restore)))
4011 new-window))
4013 (defalias 'split-window-horizontally 'split-window-right)
4015 ;;; Balancing windows.
4017 ;; The following routine uses the recycled code from an old version of
4018 ;; `window--resize-child-windows'. It's not very pretty, but coding it the way the
4019 ;; new `window--resize-child-windows' code does would hardly make it any shorter or
4020 ;; more readable (FWIW we'd need three loops - one to calculate the
4021 ;; minimum sizes per window, one to enlarge or shrink windows until the
4022 ;; new parent-size matches, and one where we shrink the largest/enlarge
4023 ;; the smallest window).
4024 (defun balance-windows-2 (window horizontal)
4025 "Subroutine of `balance-windows-1'.
4026 WINDOW must be a vertical combination (horizontal if HORIZONTAL
4027 is non-nil)."
4028 (let* ((first (window-child window))
4029 (sub first)
4030 (number-of-children 0)
4031 (parent-size (window-new-total window))
4032 (total-sum parent-size)
4033 failed size sub-total sub-delta sub-amount rest)
4034 (while sub
4035 (setq number-of-children (1+ number-of-children))
4036 (when (window-size-fixed-p sub horizontal)
4037 (setq total-sum
4038 (- total-sum (window-total-size sub horizontal)))
4039 (set-window-new-normal sub 'ignore))
4040 (setq sub (window-right sub)))
4042 (setq failed t)
4043 (while (and failed (> number-of-children 0))
4044 (setq size (/ total-sum number-of-children))
4045 (setq failed nil)
4046 (setq sub first)
4047 (while (and sub (not failed))
4048 ;; Ignore child windows that should be ignored or are stuck.
4049 (unless (window--resize-child-windows-skip-p sub)
4050 (setq sub-total (window-total-size sub horizontal))
4051 (setq sub-delta (- size sub-total))
4052 (setq sub-amount
4053 (window-sizable sub sub-delta horizontal))
4054 ;; Register the new total size for this child window.
4055 (set-window-new-total sub (+ sub-total sub-amount))
4056 (unless (= sub-amount sub-delta)
4057 (setq total-sum (- total-sum sub-total sub-amount))
4058 (setq number-of-children (1- number-of-children))
4059 ;; We failed and need a new round.
4060 (setq failed t)
4061 (set-window-new-normal sub 'skip)))
4062 (setq sub (window-right sub))))
4064 (setq rest (% total-sum number-of-children))
4065 ;; Fix rounding by trying to enlarge non-stuck windows by one line
4066 ;; (column) until `rest' is zero.
4067 (setq sub first)
4068 (while (and sub (> rest 0))
4069 (unless (window--resize-child-windows-skip-p window)
4070 (set-window-new-total sub 1 t)
4071 (setq rest (1- rest)))
4072 (setq sub (window-right sub)))
4074 ;; Fix rounding by trying to enlarge stuck windows by one line
4075 ;; (column) until `rest' equals zero.
4076 (setq sub first)
4077 (while (and sub (> rest 0))
4078 (unless (eq (window-new-normal sub) 'ignore)
4079 (set-window-new-total sub 1 t)
4080 (setq rest (1- rest)))
4081 (setq sub (window-right sub)))
4083 (setq sub first)
4084 (while sub
4085 ;; Record new normal sizes.
4086 (set-window-new-normal
4087 sub (/ (if (eq (window-new-normal sub) 'ignore)
4088 (window-total-size sub horizontal)
4089 (window-new-total sub))
4090 (float parent-size)))
4091 ;; Recursively balance each window's child windows.
4092 (balance-windows-1 sub horizontal)
4093 (setq sub (window-right sub)))))
4095 (defun balance-windows-1 (window &optional horizontal)
4096 "Subroutine of `balance-windows'."
4097 (if (window-child window)
4098 (let ((sub (window-child window)))
4099 (if (window-combined-p sub horizontal)
4100 (balance-windows-2 window horizontal)
4101 (let ((size (window-new-total window)))
4102 (while sub
4103 (set-window-new-total sub size)
4104 (balance-windows-1 sub horizontal)
4105 (setq sub (window-right sub))))))))
4107 (defun balance-windows (&optional window-or-frame)
4108 "Balance the sizes of windows of WINDOW-OR-FRAME.
4109 WINDOW-OR-FRAME is optional and defaults to the selected frame.
4110 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
4111 windows of that frame. If WINDOW-OR-FRAME denotes a window,
4112 recursively balance the sizes of all child windows of that
4113 window."
4114 (interactive)
4115 (let* ((window
4116 (cond
4117 ((or (not window-or-frame)
4118 (frame-live-p window-or-frame))
4119 (frame-root-window window-or-frame))
4120 ((or (window-live-p window-or-frame)
4121 (window-child window-or-frame))
4122 window-or-frame)
4124 (error "Not a window or frame %s" window-or-frame))))
4125 (frame (window-frame window)))
4126 ;; Balance vertically.
4127 (window--resize-reset (window-frame window))
4128 (balance-windows-1 window)
4129 (window-resize-apply frame)
4130 ;; Balance horizontally.
4131 (window--resize-reset (window-frame window) t)
4132 (balance-windows-1 window t)
4133 (window-resize-apply frame t)))
4135 (defun window-fixed-size-p (&optional window direction)
4136 "Return t if WINDOW cannot be resized in DIRECTION.
4137 WINDOW defaults to the selected window. DIRECTION can be
4138 nil (i.e. any), `height' or `width'."
4139 (with-current-buffer (window-buffer window)
4140 (when (and (boundp 'window-size-fixed) window-size-fixed)
4141 (not (and direction
4142 (member (cons direction window-size-fixed)
4143 '((height . width) (width . height))))))))
4145 ;;; A different solution to balance-windows.
4146 (defvar window-area-factor 1
4147 "Factor by which the window area should be over-estimated.
4148 This is used by `balance-windows-area'.
4149 Changing this globally has no effect.")
4150 (make-variable-buffer-local 'window-area-factor)
4152 (defun balance-windows-area-adjust (window delta horizontal)
4153 "Wrapper around `window-resize' with error checking.
4154 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
4155 ;; `window-resize' may fail if delta is too large.
4156 (while (>= (abs delta) 1)
4157 (condition-case nil
4158 (progn
4159 (window-resize window delta horizontal)
4160 (setq delta 0))
4161 (error
4162 ;;(message "adjust: %s" (error-message-string err))
4163 (setq delta (/ delta 2))))))
4165 (defun balance-windows-area ()
4166 "Make all visible windows the same area (approximately).
4167 See also `window-area-factor' to change the relative size of
4168 specific buffers."
4169 (interactive)
4170 (let* ((unchanged 0) (carry 0) (round 0)
4171 ;; Remove fixed-size windows.
4172 (wins (delq nil (mapcar (lambda (win)
4173 (if (not (window-fixed-size-p win)) win))
4174 (window-list nil 'nomini))))
4175 (changelog nil)
4176 next)
4177 ;; Resizing a window changes the size of surrounding windows in complex
4178 ;; ways, so it's difficult to balance them all. The introduction of
4179 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
4180 ;; very difficult to do. `balance-window' above takes an off-line
4181 ;; approach: get the whole window tree, then balance it, then try to
4182 ;; adjust the windows so they fit the result.
4183 ;; Here, instead, we take a "local optimization" approach, where we just
4184 ;; go through all the windows several times until nothing needs to be
4185 ;; changed. The main problem with this approach is that it's difficult
4186 ;; to make sure it terminates, so we use some heuristic to try and break
4187 ;; off infinite loops.
4188 ;; After a round without any change, we allow a second, to give a chance
4189 ;; to the carry to propagate a minor imbalance from the end back to
4190 ;; the beginning.
4191 (while (< unchanged 2)
4192 ;; (message "New round")
4193 (setq unchanged (1+ unchanged) round (1+ round))
4194 (dolist (win wins)
4195 (setq next win)
4196 (while (progn (setq next (next-window next))
4197 (window-fixed-size-p next)))
4198 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
4199 (let* ((horiz
4200 (< (car (window-edges win)) (car (window-edges next))))
4201 (areadiff (/ (- (* (window-height next) (window-width next)
4202 (buffer-local-value 'window-area-factor
4203 (window-buffer next)))
4204 (* (window-height win) (window-width win)
4205 (buffer-local-value 'window-area-factor
4206 (window-buffer win))))
4207 (max (buffer-local-value 'window-area-factor
4208 (window-buffer win))
4209 (buffer-local-value 'window-area-factor
4210 (window-buffer next)))))
4211 (edgesize (if horiz
4212 (+ (window-height win) (window-height next))
4213 (+ (window-width win) (window-width next))))
4214 (diff (/ areadiff edgesize)))
4215 (when (zerop diff)
4216 ;; Maybe diff is actually closer to 1 than to 0.
4217 (setq diff (/ (* 3 areadiff) (* 2 edgesize))))
4218 (when (and (zerop diff) (not (zerop areadiff)))
4219 (setq diff (/ (+ areadiff carry) edgesize))
4220 ;; Change things smoothly.
4221 (if (or (> diff 1) (< diff -1)) (setq diff (/ diff 2))))
4222 (if (zerop diff)
4223 ;; Make sure negligible differences don't accumulate to
4224 ;; become significant.
4225 (setq carry (+ carry areadiff))
4226 ;; This used `adjust-window-trailing-edge' before and uses
4227 ;; `window-resize' now. Error wrapping is still needed.
4228 (balance-windows-area-adjust win diff horiz)
4229 ;; (sit-for 0.5)
4230 (let ((change (cons win (window-edges win))))
4231 ;; If the same change has been seen already for this window,
4232 ;; we're most likely in an endless loop, so don't count it as
4233 ;; a change.
4234 (unless (member change changelog)
4235 (push change changelog)
4236 (setq unchanged 0 carry 0)))))))
4237 ;; We've now basically balanced all the windows.
4238 ;; But there may be some minor off-by-one imbalance left over,
4239 ;; so let's do some fine tuning.
4240 ;; (bw-finetune wins)
4241 ;; (message "Done in %d rounds" round)
4244 ;;; Window states, how to get them and how to put them in a window.
4245 (defun window--state-get-1 (window &optional writable)
4246 "Helper function for `window-state-get'."
4247 (let* ((type
4248 (cond
4249 ((window-top-child window) 'vc)
4250 ((window-left-child window) 'hc)
4251 (t 'leaf)))
4252 (buffer (window-buffer window))
4253 (selected (eq window (selected-window)))
4254 (head
4255 `(,type
4256 ,@(unless (window-next-sibling window) `((last . t)))
4257 (total-height . ,(window-total-size window))
4258 (total-width . ,(window-total-size window t))
4259 (normal-height . ,(window-normal-size window))
4260 (normal-width . ,(window-normal-size window t))
4261 (combination-limit . ,(window-combination-limit window))
4262 ,@(let ((parameters (window-parameters window))
4263 list)
4264 ;; Make copies of those window parameters whose
4265 ;; persistence property is `writable' if WRITABLE is
4266 ;; non-nil and non-nil if WRITABLE is nil.
4267 (dolist (par parameters)
4268 (let ((pers (cdr (assq (car par)
4269 window-persistent-parameters))))
4270 (when (and pers (or (not writable) (eq pers 'writable)))
4271 (setq list (cons (cons (car par) (cdr par)) list)))))
4272 ;; Add `clone-of' parameter if necessary.
4273 (let ((pers (cdr (assq 'clone-of
4274 window-persistent-parameters))))
4275 (when (and pers (or (not writable) (eq pers 'writable))
4276 (not (assq 'clone-of list)))
4277 (setq list (cons (cons 'clone-of window) list))))
4278 (when list
4279 `((parameters . ,list))))
4280 ,@(when buffer
4281 ;; All buffer related things go in here.
4282 (let ((point (window-point window))
4283 (start (window-start window)))
4284 `((buffer
4285 ,(buffer-name buffer)
4286 (selected . ,selected)
4287 (hscroll . ,(window-hscroll window))
4288 (fringes . ,(window-fringes window))
4289 (margins . ,(window-margins window))
4290 (scroll-bars . ,(window-scroll-bars window))
4291 (vscroll . ,(window-vscroll window))
4292 (dedicated . ,(window-dedicated-p window))
4293 (point . ,(if writable point
4294 (copy-marker point
4295 (buffer-local-value
4296 'window-point-insertion-type
4297 buffer))))
4298 (start . ,(if writable start (copy-marker start)))))))))
4299 (tail
4300 (when (memq type '(vc hc))
4301 (let (list)
4302 (setq window (window-child window))
4303 (while window
4304 (setq list (cons (window--state-get-1 window writable) list))
4305 (setq window (window-right window)))
4306 (nreverse list)))))
4307 (append head tail)))
4309 (defun window-state-get (&optional window writable)
4310 "Return state of WINDOW as a Lisp object.
4311 WINDOW can be any window and defaults to the root window of the
4312 selected frame.
4314 Optional argument WRITABLE non-nil means do not use markers for
4315 sampling `window-point' and `window-start'. Together, WRITABLE
4316 and the variable `window-persistent-parameters' specify which
4317 window parameters are saved by this function. WRITABLE should be
4318 non-nil when the return value shall be written to a file and read
4319 back in another session. Otherwise, an application may run into
4320 an `invalid-read-syntax' error while attempting to read back the
4321 value from file.
4323 The return value can be used as argument for `window-state-put'
4324 to put the state recorded here into an arbitrary window. The
4325 value can be also stored on disk and read back in a new session."
4326 (setq window
4327 (if window
4328 (if (window-valid-p window)
4329 window
4330 (error "%s is not a live or internal window" window))
4331 (frame-root-window)))
4332 ;; The return value is a cons whose car specifies some constraints on
4333 ;; the size of WINDOW. The cdr lists the states of the child windows
4334 ;; of WINDOW.
4335 (cons
4336 ;; Frame related things would go into a function, say `frame-state',
4337 ;; calling `window-state-get' to insert the frame's root window.
4338 `((min-height . ,(window-min-size window))
4339 (min-width . ,(window-min-size window t))
4340 (min-height-ignore . ,(window-min-size window nil t))
4341 (min-width-ignore . ,(window-min-size window t t))
4342 (min-height-safe . ,(window-min-size window nil 'safe))
4343 (min-width-safe . ,(window-min-size window t 'safe)))
4344 (window--state-get-1 window writable)))
4346 (defvar window-state-put-list nil
4347 "Helper variable for `window-state-put'.")
4349 (defun window--state-put-1 (state &optional window ignore totals)
4350 "Helper function for `window-state-put'."
4351 (let ((type (car state)))
4352 (setq state (cdr state))
4353 (cond
4354 ((eq type 'leaf)
4355 ;; For a leaf window just add unprocessed entries to
4356 ;; `window-state-put-list'.
4357 (push (cons window state) window-state-put-list))
4358 ((memq type '(vc hc))
4359 (let* ((horizontal (eq type 'hc))
4360 (total (window-total-size window horizontal))
4361 (first t)
4362 size new)
4363 (dolist (item state)
4364 ;; Find the next child window. WINDOW always points to the
4365 ;; real window that we want to fill with what we find here.
4366 (when (memq (car item) '(leaf vc hc))
4367 (if (assq 'last item)
4368 ;; The last child window. Below `window--state-put-1'
4369 ;; will put into it whatever ITEM has in store.
4370 (setq new nil)
4371 ;; Not the last child window, prepare for splitting
4372 ;; WINDOW. SIZE is the new (and final) size of the old
4373 ;; window.
4374 (setq size
4375 (if totals
4376 ;; Use total size.
4377 (cdr (assq (if horizontal 'total-width 'total-height) item))
4378 ;; Use normalized size and round.
4379 (round (* total
4380 (cdr (assq
4381 (if horizontal 'normal-width 'normal-height)
4382 item))))))
4384 ;; Use safe sizes, we try to resize later.
4385 (setq size (max size (if horizontal
4386 window-safe-min-height
4387 window-safe-min-width)))
4389 (if (window-sizable-p window (- size) horizontal 'safe)
4390 (let* ((window-combination-limit
4391 (assq 'combination-limit item)))
4392 ;; We must inherit the combination limit, otherwise
4393 ;; we might mess up handling of atomic and side
4394 ;; window.
4395 (setq new (split-window window size horizontal)))
4396 ;; Give up if we can't resize window down to safe sizes.
4397 (error "Cannot resize window %s" window))
4399 (when first
4400 (setq first nil)
4401 ;; When creating the first child window add for parent
4402 ;; unprocessed entries to `window-state-put-list'.
4403 (setq window-state-put-list
4404 (cons (cons (window-parent window) state)
4405 window-state-put-list))))
4407 ;; Now process the current window (either the one we've just
4408 ;; split or the last child of its parent).
4409 (window--state-put-1 item window ignore totals)
4410 ;; Continue with the last window split off.
4411 (setq window new))))))))
4413 (defun window--state-put-2 (ignore)
4414 "Helper function for `window-state-put'."
4415 (dolist (item window-state-put-list)
4416 (let ((window (car item))
4417 (combination-limit (cdr (assq 'combination-limit item)))
4418 (parameters (cdr (assq 'parameters item)))
4419 (state (cdr (assq 'buffer item))))
4420 (when combination-limit
4421 (set-window-combination-limit window combination-limit))
4422 ;; Reset window's parameters and assign saved ones (we might want
4423 ;; a `remove-window-parameters' function here).
4424 (dolist (parameter (window-parameters window))
4425 (set-window-parameter window (car parameter) nil))
4426 (when parameters
4427 (dolist (parameter parameters)
4428 (set-window-parameter window (car parameter) (cdr parameter))))
4429 ;; Process buffer related state.
4430 (when state
4431 ;; We don't want to raise an error here so we create a buffer if
4432 ;; there's none.
4433 (set-window-buffer window (get-buffer-create (car state)))
4434 (with-current-buffer (window-buffer window)
4435 (set-window-hscroll window (cdr (assq 'hscroll state)))
4436 (apply 'set-window-fringes
4437 (cons window (cdr (assq 'fringes state))))
4438 (let ((margins (cdr (assq 'margins state))))
4439 (set-window-margins window (car margins) (cdr margins)))
4440 (let ((scroll-bars (cdr (assq 'scroll-bars state))))
4441 (set-window-scroll-bars
4442 window (car scroll-bars) (nth 2 scroll-bars) (nth 3 scroll-bars)))
4443 (set-window-vscroll window (cdr (assq 'vscroll state)))
4444 ;; Adjust vertically.
4445 (if (memq window-size-fixed '(t height))
4446 ;; A fixed height window, try to restore the original size.
4447 (let ((delta (- (cdr (assq 'total-height item))
4448 (window-total-height window)))
4449 window-size-fixed)
4450 (when (window-resizable-p window delta)
4451 (window-resize window delta)))
4452 ;; Else check whether the window is not high enough.
4453 (let* ((min-size (window-min-size window nil ignore))
4454 (delta (- min-size (window-total-size window))))
4455 (when (and (> delta 0)
4456 (window-resizable-p window delta nil ignore))
4457 (window-resize window delta nil ignore))))
4458 ;; Adjust horizontally.
4459 (if (memq window-size-fixed '(t width))
4460 ;; A fixed width window, try to restore the original size.
4461 (let ((delta (- (cdr (assq 'total-width item))
4462 (window-total-width window)))
4463 window-size-fixed)
4464 (when (window-resizable-p window delta)
4465 (window-resize window delta)))
4466 ;; Else check whether the window is not wide enough.
4467 (let* ((min-size (window-min-size window t ignore))
4468 (delta (- min-size (window-total-size window t))))
4469 (when (and (> delta 0)
4470 (window-resizable-p window delta t ignore))
4471 (window-resize window delta t ignore))))
4472 ;; Set dedicated status.
4473 (set-window-dedicated-p window (cdr (assq 'dedicated state)))
4474 ;; Install positions (maybe we should do this after all windows
4475 ;; have been created and sized).
4476 (ignore-errors
4477 (set-window-start window (cdr (assq 'start state)))
4478 (set-window-point window (cdr (assq 'point state))))
4479 ;; Select window if it's the selected one.
4480 (when (cdr (assq 'selected state))
4481 (select-window window)))))))
4483 (defun window-state-put (state &optional window ignore)
4484 "Put window state STATE into WINDOW.
4485 STATE should be the state of a window returned by an earlier
4486 invocation of `window-state-get'. Optional argument WINDOW must
4487 specify a live window and defaults to the selected one.
4489 Optional argument IGNORE non-nil means ignore minimum window
4490 sizes and fixed size restrictions. IGNORE equal `safe' means
4491 windows can get as small as `window-safe-min-height' and
4492 `window-safe-min-width'."
4493 (setq window (window-normalize-window window t))
4494 (let* ((frame (window-frame window))
4495 (head (car state))
4496 ;; We check here (1) whether the total sizes of root window of
4497 ;; STATE and that of WINDOW are equal so we can avoid
4498 ;; calculating new sizes, and (2) if we do have to resize
4499 ;; whether we can do so without violating size restrictions.
4500 (totals
4501 (and (= (window-total-size window)
4502 (cdr (assq 'total-height state)))
4503 (= (window-total-size window t)
4504 (cdr (assq 'total-width state)))))
4505 (min-height (cdr (assq 'min-height head)))
4506 (min-width (cdr (assq 'min-width head))))
4507 (if (and (not totals)
4508 (or (> min-height (window-total-size window))
4509 (> min-width (window-total-size window t)))
4510 (or (not ignore)
4511 (and (setq min-height
4512 (cdr (assq 'min-height-ignore head)))
4513 (setq min-width
4514 (cdr (assq 'min-width-ignore head)))
4515 (or (> min-height (window-total-size window))
4516 (> min-width (window-total-size window t)))
4517 (or (not (eq ignore 'safe))
4518 (and (setq min-height
4519 (cdr (assq 'min-height-safe head)))
4520 (setq min-width
4521 (cdr (assq 'min-width-safe head)))
4522 (or (> min-height
4523 (window-total-size window))
4524 (> min-width
4525 (window-total-size window t))))))))
4526 ;; The check above might not catch all errors due to rounding
4527 ;; issues - so IGNORE equal 'safe might not always produce the
4528 ;; minimum possible state. But such configurations hardly make
4529 ;; sense anyway.
4530 (error "Window %s too small to accommodate state" window)
4531 (setq state (cdr state))
4532 (setq window-state-put-list nil)
4533 ;; Work on the windows of a temporary buffer to make sure that
4534 ;; splitting proceeds regardless of any buffer local values of
4535 ;; `window-size-fixed'. Release that buffer after the buffers of
4536 ;; all live windows have been set by `window--state-put-2'.
4537 (with-temp-buffer
4538 (set-window-buffer window (current-buffer))
4539 (window--state-put-1 state window nil totals)
4540 (window--state-put-2 ignore))
4541 (window--check frame))))
4543 (defun display-buffer-record-window (type window buffer)
4544 "Record information for window used by `display-buffer'.
4545 TYPE specifies the type of the calling operation and must be one
4546 of the symbols 'reuse (when WINDOW existed already and was
4547 reused for displaying BUFFER), 'window (when WINDOW was created
4548 on an already existing frame), or 'frame (when WINDOW was
4549 created on a new frame). WINDOW is the window used for or created
4550 by the `display-buffer' routines. BUFFER is the buffer that
4551 shall be displayed.
4553 This function installs or updates the quit-restore parameter of
4554 WINDOW. The quit-restore parameter is a list of four elements:
4555 The first element is one of the symbols 'window, 'frame, 'same or
4556 'other. The second element is either one of the symbols 'window
4557 or 'frame or a list whose elements are the buffer previously
4558 shown in the window, that buffer's window start and window point,
4559 and the window's height. The third element is the window
4560 selected at the time the parameter was created. The fourth
4561 element is BUFFER."
4562 (cond
4563 ((eq type 'reuse)
4564 (if (eq (window-buffer window) buffer)
4565 ;; WINDOW shows BUFFER already.
4566 (when (consp (window-parameter window 'quit-restore))
4567 ;; If WINDOW has a quit-restore parameter, reset its car.
4568 (setcar (window-parameter window 'quit-restore) 'same))
4569 ;; WINDOW shows another buffer.
4570 (with-current-buffer (window-buffer window)
4571 (set-window-parameter
4572 window 'quit-restore
4573 (list 'other
4574 ;; A quadruple of WINDOW's buffer, start, point and height.
4575 (list (current-buffer) (window-start window)
4576 ;; Preserve window-point-insertion-type (Bug#12588).
4577 (copy-marker
4578 (window-point window) window-point-insertion-type)
4579 (window-total-size window))
4580 (selected-window) buffer)))))
4581 ((eq type 'window)
4582 ;; WINDOW has been created on an existing frame.
4583 (set-window-parameter
4584 window 'quit-restore
4585 (list 'window 'window (selected-window) buffer)))
4586 ((eq type 'frame)
4587 ;; WINDOW has been created on a new frame.
4588 (set-window-parameter
4589 window 'quit-restore
4590 (list 'frame 'frame (selected-window) buffer)))))
4592 (defcustom display-buffer-function nil
4593 "If non-nil, function to call to handle `display-buffer'.
4594 It will receive two args, the buffer and a flag which if non-nil
4595 means that the currently selected window is not acceptable. It
4596 should choose or create a window, display the specified buffer in
4597 it, and return the window.
4599 The specified function should call `display-buffer-record-window'
4600 with corresponding arguments to set up the quit-restore parameter
4601 of the window used."
4602 :type '(choice
4603 (const nil)
4604 (function :tag "function"))
4605 :group 'windows)
4607 (make-obsolete-variable 'display-buffer-function
4608 'display-buffer-alist "24.3")
4610 ;; Eventually, we want to turn this into a defvar; instead of
4611 ;; customizing this, the user should use a `pop-up-frame-parameters'
4612 ;; alist entry in `display-buffer-base-action'.
4613 (defcustom pop-up-frame-alist nil
4614 "Alist of parameters for automatically generated new frames.
4615 If non-nil, the value you specify here is used by the default
4616 `pop-up-frame-function' for the creation of new frames.
4618 Since `pop-up-frame-function' is used by `display-buffer' for
4619 making new frames, any value specified here by default affects
4620 the automatic generation of new frames via `display-buffer' and
4621 all functions based on it. The behavior of `make-frame' is not
4622 affected by this variable."
4623 :type '(repeat (cons :format "%v"
4624 (symbol :tag "Parameter")
4625 (sexp :tag "Value")))
4626 :group 'frames)
4628 (defcustom pop-up-frame-function
4629 (lambda () (make-frame pop-up-frame-alist))
4630 "Function used by `display-buffer' for creating a new frame.
4631 This function is called with no arguments and should return a new
4632 frame. The default value calls `make-frame' with the argument
4633 `pop-up-frame-alist'."
4634 :type 'function
4635 :group 'frames)
4637 (defcustom special-display-buffer-names nil
4638 "List of names of buffers that should be displayed specially.
4639 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
4640 its name is in this list, displays the buffer in a way specified
4641 by `special-display-function'. `special-display-popup-frame'
4642 \(the default for `special-display-function') usually displays
4643 the buffer in a separate frame made with the parameters specified
4644 by `special-display-frame-alist'. If `special-display-function'
4645 has been set to some other function, that function is called with
4646 the buffer as first, and nil as second argument.
4648 Alternatively, an element of this list can be specified as
4649 \(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
4650 name and FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
4651 `special-display-popup-frame' will interpret such pairs as frame
4652 parameters when it creates a special frame, overriding the
4653 corresponding values from `special-display-frame-alist'.
4655 As a special case, if FRAME-PARAMETERS contains (same-window . t)
4656 `special-display-popup-frame' displays that buffer in the
4657 selected window. If FRAME-PARAMETERS contains (same-frame . t),
4658 it displays that buffer in a window on the selected frame.
4660 If `special-display-function' specifies some other function than
4661 `special-display-popup-frame', that function is called with the
4662 buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
4663 argument.
4665 Finally, an element of this list can be also specified as
4666 \(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
4667 `special-display-popup-frame' will call FUNCTION with the buffer
4668 named BUFFER-NAME as first argument, and OTHER-ARGS as the
4669 second.
4671 Any alternative function specified here is responsible for
4672 setting up the quit-restore parameter of the window used.
4674 If this variable appears \"not to work\", because you added a
4675 name to it but the corresponding buffer is displayed in the
4676 selected window, look at the values of `same-window-buffer-names'
4677 and `same-window-regexps'. Those variables take precedence over
4678 this one.
4680 See also `special-display-regexps'."
4681 :type '(repeat
4682 (choice :tag "Buffer"
4683 :value ""
4684 (string :format "%v")
4685 (cons :tag "With parameters"
4686 :format "%v"
4687 :value ("" . nil)
4688 (string :format "%v")
4689 (repeat :tag "Parameters"
4690 (cons :format "%v"
4691 (symbol :tag "Parameter")
4692 (sexp :tag "Value"))))
4693 (list :tag "With function"
4694 :format "%v"
4695 :value ("" . nil)
4696 (string :format "%v")
4697 (function :tag "Function")
4698 (repeat :tag "Arguments" (sexp)))))
4699 :group 'windows
4700 :group 'frames)
4701 (make-obsolete-variable 'special-display-buffer-names 'display-buffer-alist "24.3")
4702 (put 'special-display-buffer-names 'risky-local-variable t)
4704 (defcustom special-display-regexps nil
4705 "List of regexps saying which buffers should be displayed specially.
4706 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
4707 any regexp in this list matches its name, displays it specially
4708 using `special-display-function'. `special-display-popup-frame'
4709 \(the default for `special-display-function') usually displays
4710 the buffer in a separate frame made with the parameters specified
4711 by `special-display-frame-alist'. If `special-display-function'
4712 has been set to some other function, that function is called with
4713 the buffer as first, and nil as second argument.
4715 Alternatively, an element of this list can be specified as
4716 \(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
4717 FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
4718 `special-display-popup-frame' will then interpret these pairs as
4719 frame parameters when creating a special frame for a buffer whose
4720 name matches REGEXP, overriding the corresponding values from
4721 `special-display-frame-alist'.
4723 As a special case, if FRAME-PARAMETERS contains (same-window . t)
4724 `special-display-popup-frame' displays buffers matching REGEXP in
4725 the selected window. (same-frame . t) in FRAME-PARAMETERS means
4726 to display such buffers in a window on the selected frame.
4728 If `special-display-function' specifies some other function than
4729 `special-display-popup-frame', that function is called with the
4730 buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
4731 as second argument.
4733 Finally, an element of this list can be also specified as
4734 \(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
4735 will then call FUNCTION with the buffer whose name matched
4736 REGEXP as first, and OTHER-ARGS as second argument.
4738 Any alternative function specified here is responsible for
4739 setting up the quit-restore parameter of the window used.
4741 If this variable appears \"not to work\", because you added a
4742 name to it but the corresponding buffer is displayed in the
4743 selected window, look at the values of `same-window-buffer-names'
4744 and `same-window-regexps'. Those variables take precedence over
4745 this one.
4747 See also `special-display-buffer-names'."
4748 :type '(repeat
4749 (choice :tag "Buffer"
4750 :value ""
4751 (regexp :format "%v")
4752 (cons :tag "With parameters"
4753 :format "%v"
4754 :value ("" . nil)
4755 (regexp :format "%v")
4756 (repeat :tag "Parameters"
4757 (cons :format "%v"
4758 (symbol :tag "Parameter")
4759 (sexp :tag "Value"))))
4760 (list :tag "With function"
4761 :format "%v"
4762 :value ("" . nil)
4763 (regexp :format "%v")
4764 (function :tag "Function")
4765 (repeat :tag "Arguments" (sexp)))))
4766 :group 'windows
4767 :group 'frames)
4768 (make-obsolete-variable 'special-display-regexps 'display-buffer-alist "24.3")
4769 (put 'special-display-regexps 'risky-local-variable t)
4771 (defun special-display-p (buffer-name)
4772 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
4773 More precisely, return t if `special-display-buffer-names' or
4774 `special-display-regexps' contain a string entry equaling or
4775 matching BUFFER-NAME. If `special-display-buffer-names' or
4776 `special-display-regexps' contain a list entry whose car equals
4777 or matches BUFFER-NAME, the return value is the cdr of that
4778 entry."
4779 (let (tmp)
4780 (cond
4781 ((member buffer-name special-display-buffer-names)
4783 ((setq tmp (assoc buffer-name special-display-buffer-names))
4784 (cdr tmp))
4785 ((catch 'found
4786 (dolist (regexp special-display-regexps)
4787 (cond
4788 ((stringp regexp)
4789 (when (string-match-p regexp buffer-name)
4790 (throw 'found t)))
4791 ((and (consp regexp) (stringp (car regexp))
4792 (string-match-p (car regexp) buffer-name))
4793 (throw 'found (cdr regexp))))))))))
4795 (defcustom special-display-frame-alist
4796 '((height . 14) (width . 80) (unsplittable . t))
4797 "Alist of parameters for special frames.
4798 Special frames are used for buffers whose names are listed in
4799 `special-display-buffer-names' and for buffers whose names match
4800 one of the regular expressions in `special-display-regexps'.
4802 This variable can be set in your init file, like this:
4804 (setq special-display-frame-alist '((width . 80) (height . 20)))
4806 These supersede the values given in `default-frame-alist'."
4807 :type '(repeat (cons :format "%v"
4808 (symbol :tag "Parameter")
4809 (sexp :tag "Value")))
4810 :group 'frames)
4811 (make-obsolete-variable 'special-display-frame-alist 'display-buffer-alist "24.3")
4813 (defun special-display-popup-frame (buffer &optional args)
4814 "Pop up a frame displaying BUFFER and return its window.
4815 If BUFFER is already displayed in a visible or iconified frame,
4816 raise that frame. Otherwise, display BUFFER in a new frame.
4818 Optional argument ARGS is a list specifying additional
4819 information.
4821 If ARGS is an alist, use it as a list of frame parameters. If
4822 these parameters contain (same-window . t), display BUFFER in
4823 the selected window. If they contain (same-frame . t), display
4824 BUFFER in a window of the selected frame.
4826 If ARGS is a list whose car is a symbol, use (car ARGS) as a
4827 function to do the work. Pass it BUFFER as first argument, and
4828 pass the elements of (cdr ARGS) as the remaining arguments."
4829 (if (and args (symbolp (car args)))
4830 (apply (car args) buffer (cdr args))
4831 (let ((window (get-buffer-window buffer 0)))
4833 ;; If we have a window already, make it visible.
4834 (when window
4835 (let ((frame (window-frame window)))
4836 (make-frame-visible frame)
4837 (raise-frame frame)
4838 (display-buffer-record-window 'reuse window buffer)
4839 window))
4840 ;; Reuse the current window if the user requested it.
4841 (when (cdr (assq 'same-window args))
4842 (condition-case nil
4843 (progn (switch-to-buffer buffer nil t) (selected-window))
4844 (error nil)))
4845 ;; Stay on the same frame if requested.
4846 (when (or (cdr (assq 'same-frame args)) (cdr (assq 'same-window args)))
4847 (let* ((pop-up-windows t)
4848 pop-up-frames
4849 special-display-buffer-names special-display-regexps)
4850 (display-buffer buffer)))
4851 ;; If no window yet, make one in a new frame.
4852 (let* ((frame
4853 (with-current-buffer buffer
4854 (make-frame (append args special-display-frame-alist))))
4855 (window (frame-selected-window frame)))
4856 (display-buffer-record-window 'frame window buffer)
4857 (unless (eq buffer (window-buffer window))
4858 (set-window-buffer window buffer)
4859 (set-window-prev-buffers window nil))
4860 (set-window-dedicated-p window t)
4861 window)))))
4863 (defcustom special-display-function 'special-display-popup-frame
4864 "Function to call for displaying special buffers.
4865 This function is called with two arguments - the buffer and,
4866 optionally, a list - and should return a window displaying that
4867 buffer. The default value usually makes a separate frame for the
4868 buffer using `special-display-frame-alist' to specify the frame
4869 parameters. See the definition of `special-display-popup-frame'
4870 for how to specify such a function.
4872 A buffer is special when its name is either listed in
4873 `special-display-buffer-names' or matches a regexp in
4874 `special-display-regexps'.
4876 The specified function should call `display-buffer-record-window'
4877 with corresponding arguments to set up the quit-restore parameter
4878 of the window used."
4879 :type 'function
4880 :group 'frames)
4881 (make-obsolete-variable 'special-display-function 'display-buffer-alist "24.3")
4883 (defcustom same-window-buffer-names nil
4884 "List of names of buffers that should appear in the \"same\" window.
4885 `display-buffer' and `pop-to-buffer' show a buffer whose name is
4886 on this list in the selected rather than some other window.
4888 An element of this list can be a cons cell instead of just a
4889 string. In that case, the cell's car must be a string specifying
4890 the buffer name. This is for compatibility with
4891 `special-display-buffer-names'; the cdr of the cons cell is
4892 ignored.
4894 See also `same-window-regexps'."
4895 :type '(repeat (string :format "%v"))
4896 :group 'windows)
4898 (defcustom same-window-regexps nil
4899 "List of regexps saying which buffers should appear in the \"same\" window.
4900 `display-buffer' and `pop-to-buffer' show a buffer whose name
4901 matches a regexp on this list in the selected rather than some
4902 other window.
4904 An element of this list can be a cons cell instead of just a
4905 string. In that case, the cell's car must be a regexp matching
4906 the buffer name. This is for compatibility with
4907 `special-display-regexps'; the cdr of the cons cell is ignored.
4909 See also `same-window-buffer-names'."
4910 :type '(repeat (regexp :format "%v"))
4911 :group 'windows)
4913 (defun same-window-p (buffer-name)
4914 "Return non-nil if a buffer named BUFFER-NAME would be shown in the \"same\" window.
4915 This function returns non-nil if `display-buffer' or
4916 `pop-to-buffer' would show a buffer named BUFFER-NAME in the
4917 selected rather than (as usual) some other window. See
4918 `same-window-buffer-names' and `same-window-regexps'."
4919 (cond
4920 ((not (stringp buffer-name)))
4921 ;; The elements of `same-window-buffer-names' can be buffer
4922 ;; names or cons cells whose cars are buffer names.
4923 ((member buffer-name same-window-buffer-names))
4924 ((assoc buffer-name same-window-buffer-names))
4925 ((catch 'found
4926 (dolist (regexp same-window-regexps)
4927 ;; The elements of `same-window-regexps' can be regexps
4928 ;; or cons cells whose cars are regexps.
4929 (when (or (and (stringp regexp)
4930 (string-match-p regexp buffer-name))
4931 (and (consp regexp) (stringp (car regexp))
4932 (string-match-p (car regexp) buffer-name)))
4933 (throw 'found t)))))))
4935 (defcustom pop-up-frames nil
4936 "Whether `display-buffer' should make a separate frame.
4937 If nil, never make a separate frame.
4938 If the value is `graphic-only', make a separate frame
4939 on graphic displays only.
4940 Any other non-nil value means always make a separate frame."
4941 :type '(choice
4942 (const :tag "Never" nil)
4943 (const :tag "On graphic displays only" graphic-only)
4944 (const :tag "Always" t))
4945 :group 'windows)
4947 (defcustom display-buffer-reuse-frames nil
4948 "Non-nil means `display-buffer' should reuse frames.
4949 If the buffer in question is already displayed in a frame, raise
4950 that frame."
4951 :type 'boolean
4952 :version "21.1"
4953 :group 'windows)
4955 (make-obsolete-variable
4956 'display-buffer-reuse-frames
4957 "use a `reusable-frames' alist entry in `display-buffer-alist'."
4958 "24.3")
4960 (defcustom pop-up-windows t
4961 "Non-nil means `display-buffer' should make a new window."
4962 :type 'boolean
4963 :group 'windows)
4965 (defcustom split-window-preferred-function 'split-window-sensibly
4966 "Function called by `display-buffer' routines to split a window.
4967 This function is called with a window as single argument and is
4968 supposed to split that window and return the new window. If the
4969 window can (or shall) not be split, it is supposed to return nil.
4970 The default is to call the function `split-window-sensibly' which
4971 tries to split the window in a way which seems most suitable.
4972 You can customize the options `split-height-threshold' and/or
4973 `split-width-threshold' in order to have `split-window-sensibly'
4974 prefer either vertical or horizontal splitting.
4976 If you set this to any other function, bear in mind that the
4977 `display-buffer' routines may call this function two times. The
4978 argument of the first call is the largest window on its frame.
4979 If that call fails to return a live window, the function is
4980 called again with the least recently used window as argument. If
4981 that call fails too, `display-buffer' will use an existing window
4982 to display its buffer.
4984 The window selected at the time `display-buffer' was invoked is
4985 still selected when this function is called. Hence you can
4986 compare the window argument with the value of `selected-window'
4987 if you intend to split the selected window instead or if you do
4988 not want to split the selected window."
4989 :type 'function
4990 :version "23.1"
4991 :group 'windows)
4993 (defcustom split-height-threshold 80
4994 "Minimum height for splitting windows sensibly.
4995 If this is an integer, `split-window-sensibly' may split a window
4996 vertically only if it has at least this many lines. If this is
4997 nil, `split-window-sensibly' is not allowed to split a window
4998 vertically. If, however, a window is the only window on its
4999 frame, `split-window-sensibly' may split it vertically
5000 disregarding the value of this variable."
5001 :type '(choice (const nil) (integer :tag "lines"))
5002 :version "23.1"
5003 :group 'windows)
5005 (defcustom split-width-threshold 160
5006 "Minimum width for splitting windows sensibly.
5007 If this is an integer, `split-window-sensibly' may split a window
5008 horizontally only if it has at least this many columns. If this
5009 is nil, `split-window-sensibly' is not allowed to split a window
5010 horizontally."
5011 :type '(choice (const nil) (integer :tag "columns"))
5012 :version "23.1"
5013 :group 'windows)
5015 (defun window-splittable-p (window &optional horizontal)
5016 "Return non-nil if `split-window-sensibly' may split WINDOW.
5017 Optional argument HORIZONTAL nil or omitted means check whether
5018 `split-window-sensibly' may split WINDOW vertically. HORIZONTAL
5019 non-nil means check whether WINDOW may be split horizontally.
5021 WINDOW may be split vertically when the following conditions
5022 hold:
5023 - `window-size-fixed' is either nil or equals `width' for the
5024 buffer of WINDOW.
5025 - `split-height-threshold' is an integer and WINDOW is at least as
5026 high as `split-height-threshold'.
5027 - When WINDOW is split evenly, the emanating windows are at least
5028 `window-min-height' lines tall and can accommodate at least one
5029 line plus - if WINDOW has one - a mode line.
5031 WINDOW may be split horizontally when the following conditions
5032 hold:
5033 - `window-size-fixed' is either nil or equals `height' for the
5034 buffer of WINDOW.
5035 - `split-width-threshold' is an integer and WINDOW is at least as
5036 wide as `split-width-threshold'.
5037 - When WINDOW is split evenly, the emanating windows are at least
5038 `window-min-width' or two (whichever is larger) columns wide."
5039 (when (window-live-p window)
5040 (with-current-buffer (window-buffer window)
5041 (if horizontal
5042 ;; A window can be split horizontally when its width is not
5043 ;; fixed, it is at least `split-width-threshold' columns wide
5044 ;; and at least twice as wide as `window-min-width' and 2 (the
5045 ;; latter value is hardcoded).
5046 (and (memq window-size-fixed '(nil height))
5047 ;; Testing `window-full-width-p' here hardly makes any
5048 ;; sense nowadays. This can be done more intuitively by
5049 ;; setting up `split-width-threshold' appropriately.
5050 (numberp split-width-threshold)
5051 (>= (window-width window)
5052 (max split-width-threshold
5053 (* 2 (max window-min-width 2)))))
5054 ;; A window can be split vertically when its height is not
5055 ;; fixed, it is at least `split-height-threshold' lines high,
5056 ;; and it is at least twice as high as `window-min-height' and 2
5057 ;; if it has a mode line or 1.
5058 (and (memq window-size-fixed '(nil width))
5059 (numberp split-height-threshold)
5060 (>= (window-height window)
5061 (max split-height-threshold
5062 (* 2 (max window-min-height
5063 (if mode-line-format 2 1))))))))))
5065 (defun split-window-sensibly (&optional window)
5066 "Split WINDOW in a way suitable for `display-buffer'.
5067 WINDOW defaults to the currently selected window.
5068 If `split-height-threshold' specifies an integer, WINDOW is at
5069 least `split-height-threshold' lines tall and can be split
5070 vertically, split WINDOW into two windows one above the other and
5071 return the lower window. Otherwise, if `split-width-threshold'
5072 specifies an integer, WINDOW is at least `split-width-threshold'
5073 columns wide and can be split horizontally, split WINDOW into two
5074 windows side by side and return the window on the right. If this
5075 can't be done either and WINDOW is the only window on its frame,
5076 try to split WINDOW vertically disregarding any value specified
5077 by `split-height-threshold'. If that succeeds, return the lower
5078 window. Return nil otherwise.
5080 By default `display-buffer' routines call this function to split
5081 the largest or least recently used window. To change the default
5082 customize the option `split-window-preferred-function'.
5084 You can enforce this function to not split WINDOW horizontally,
5085 by setting (or binding) the variable `split-width-threshold' to
5086 nil. If, in addition, you set `split-height-threshold' to zero,
5087 chances increase that this function does split WINDOW vertically.
5089 In order to not split WINDOW vertically, set (or bind) the
5090 variable `split-height-threshold' to nil. Additionally, you can
5091 set `split-width-threshold' to zero to make a horizontal split
5092 more likely to occur.
5094 Have a look at the function `window-splittable-p' if you want to
5095 know how `split-window-sensibly' determines whether WINDOW can be
5096 split."
5097 (let ((window (or window (selected-window))))
5098 (or (and (window-splittable-p window)
5099 ;; Split window vertically.
5100 (with-selected-window window
5101 (split-window-below)))
5102 (and (window-splittable-p window t)
5103 ;; Split window horizontally.
5104 (with-selected-window window
5105 (split-window-right)))
5106 (and (eq window (frame-root-window (window-frame window)))
5107 (not (window-minibuffer-p window))
5108 ;; If WINDOW is the only window on its frame and is not the
5109 ;; minibuffer window, try to split it vertically disregarding
5110 ;; the value of `split-height-threshold'.
5111 (let ((split-height-threshold 0))
5112 (when (window-splittable-p window)
5113 (with-selected-window window
5114 (split-window-below))))))))
5116 (defun window--try-to-split-window (window &optional alist)
5117 "Try to split WINDOW.
5118 Return value returned by `split-window-preferred-function' if it
5119 represents a live window, nil otherwise."
5120 (and (window-live-p window)
5121 (not (frame-parameter (window-frame window) 'unsplittable))
5122 (let* ((window-combination-limit
5123 ;; When `window-combination-limit' equals
5124 ;; `display-buffer' or equals `resize-window' and a
5125 ;; `window-height' or `window-width' alist entry are
5126 ;; present, bind it to t so resizing steals space
5127 ;; preferably from the window that was split.
5128 (if (or (eq window-combination-limit 'display-buffer)
5129 (and (eq window-combination-limit 'window-size)
5130 (or (cdr (assq 'window-height alist))
5131 (cdr (assq 'window-width alist)))))
5133 window-combination-limit))
5134 (new-window
5135 ;; Since `split-window-preferred-function' might
5136 ;; throw an error use `condition-case'.
5137 (condition-case nil
5138 (funcall split-window-preferred-function window)
5139 (error nil))))
5140 (and (window-live-p new-window) new-window))))
5142 (defun window--frame-usable-p (frame)
5143 "Return FRAME if it can be used to display a buffer."
5144 (when (frame-live-p frame)
5145 (let ((window (frame-root-window frame)))
5146 ;; `frame-root-window' may be an internal window which is considered
5147 ;; "dead" by `window-live-p'. Hence if `window' is not live we
5148 ;; implicitly know that `frame' has a visible window we can use.
5149 (unless (and (window-live-p window)
5150 (or (window-minibuffer-p window)
5151 ;; If the window is soft-dedicated, the frame is usable.
5152 ;; Actually, even if the window is really dedicated,
5153 ;; the frame is still usable by splitting it.
5154 ;; At least Emacs-22 allowed it, and it is desirable
5155 ;; when displaying same-frame windows.
5156 nil ; (eq t (window-dedicated-p window))
5158 frame))))
5160 (defcustom even-window-heights t
5161 "If non-nil `display-buffer' will try to even window heights.
5162 Otherwise `display-buffer' will leave the window configuration
5163 alone. Heights are evened only when `display-buffer' chooses a
5164 window that appears above or below the selected window."
5165 :type 'boolean
5166 :group 'windows)
5168 (defun window--even-window-heights (window)
5169 "Even heights of WINDOW and selected window.
5170 Do this only if these windows are vertically adjacent to each
5171 other, `even-window-heights' is non-nil, and the selected window
5172 is higher than WINDOW."
5173 (when (and even-window-heights
5174 ;; Even iff WINDOW forms a vertical combination with the
5175 ;; selected window, and WINDOW's height exceeds that of the
5176 ;; selected window, see also bug#11880.
5177 (window-combined-p window)
5178 (= (window-child-count (window-parent window)) 2)
5179 (eq (window-parent) (window-parent window))
5180 (> (window-total-height) (window-total-height window)))
5181 ;; Don't throw an error if we can't even window heights for
5182 ;; whatever reason.
5183 (condition-case nil
5184 (enlarge-window
5185 (/ (- (window-total-height window) (window-total-height)) 2))
5186 (error nil))))
5188 (defun window--display-buffer (buffer window type &optional alist dedicated)
5189 "Display BUFFER in WINDOW.
5190 TYPE must be one of the symbols `reuse', `window' or `frame' and
5191 is passed unaltered to `display-buffer-record-window'. ALIST is
5192 the alist argument of `display-buffer'. Set `window-dedicated-p'
5193 to DEDICATED if non-nil. Return WINDOW if BUFFER and WINDOW are
5194 live."
5195 (when (and (buffer-live-p buffer) (window-live-p window))
5196 (display-buffer-record-window type window buffer)
5197 (unless (eq buffer (window-buffer window))
5198 (set-window-dedicated-p window nil)
5199 (set-window-buffer window buffer)
5200 (when dedicated
5201 (set-window-dedicated-p window dedicated))
5202 (when (memq type '(window frame))
5203 (set-window-prev-buffers window nil)))
5204 (let ((parameter (window-parameter window 'quit-restore))
5205 (height (cdr (assq 'window-height alist)))
5206 (width (cdr (assq 'window-width alist))))
5207 (when (or (eq type 'window)
5208 (and (eq (car parameter) 'same)
5209 (eq (nth 1 parameter) 'window)))
5210 ;; Adjust height of window if asked for.
5211 (cond
5212 ((not height))
5213 ((numberp height)
5214 (let* ((new-height
5215 (if (integerp height)
5216 height
5217 (round
5218 (* (window-total-size (frame-root-window window))
5219 height))))
5220 (delta (- new-height (window-total-size window))))
5221 (when (and (window-resizable-p window delta nil 'safe)
5222 (window-combined-p window))
5223 (window-resize window delta nil 'safe))))
5224 ((functionp height)
5225 (ignore-errors (funcall height window))))
5226 ;; Adjust width of window if asked for.
5227 (cond
5228 ((not width))
5229 ((numberp width)
5230 (let* ((new-width
5231 (if (integerp width)
5232 width
5233 (round
5234 (* (window-total-size (frame-root-window window) t)
5235 width))))
5236 (delta (- new-width (window-total-size window t))))
5237 (when (and (window-resizable-p window delta t 'safe)
5238 (window-combined-p window t))
5239 (window-resize window delta t 'safe))))
5240 ((functionp width)
5241 (ignore-errors (funcall width window))))))
5243 window))
5245 (defun window--maybe-raise-frame (frame)
5246 (let ((visible (frame-visible-p frame)))
5247 (unless (or (not visible)
5248 ;; Assume the selected frame is already visible enough.
5249 (eq frame (selected-frame))
5250 ;; Assume the frame from which we invoked the
5251 ;; minibuffer is visible.
5252 (and (minibuffer-window-active-p (selected-window))
5253 (eq frame (window-frame (minibuffer-selected-window)))))
5254 (raise-frame frame))))
5256 ;; FIXME: Not implemented.
5257 ;; FIXME: By the way, there could be more levels of dedication:
5258 ;; - `barely' dedicated doesn't prevent reuse of the window, only records that
5259 ;; the window hasn't been used for something else yet.
5260 ;; - `softly' dedicated only allows reuse when asked explicitly.
5261 ;; - `strongly' never allows reuse.
5262 (defvar display-buffer-mark-dedicated nil
5263 "If non-nil, `display-buffer' marks the windows it creates as dedicated.
5264 The actual non-nil value of this variable will be copied to the
5265 `window-dedicated-p' flag.")
5267 (defconst display-buffer--action-function-custom-type
5268 '(choice :tag "Function"
5269 (const :tag "--" ignore) ; default for insertion
5270 (const display-buffer-reuse-window)
5271 (const display-buffer-pop-up-window)
5272 (const display-buffer-same-window)
5273 (const display-buffer-pop-up-frame)
5274 (const display-buffer-use-some-window)
5275 (function :tag "Other function"))
5276 "Custom type for `display-buffer' action functions.")
5278 (defconst display-buffer--action-custom-type
5279 `(cons :tag "Action"
5280 (choice :tag "Action functions"
5281 ,display-buffer--action-function-custom-type
5282 (repeat
5283 :tag "List of functions"
5284 ,display-buffer--action-function-custom-type))
5285 (alist :tag "Action arguments"
5286 :key-type symbol
5287 :value-type (sexp :tag "Value")))
5288 "Custom type for `display-buffer' actions.")
5290 (defvar display-buffer-overriding-action '(nil . nil)
5291 "Overriding action to perform to display a buffer.
5292 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
5293 function or a list of functions. Each function should accept two
5294 arguments: a buffer to display and an alist similar to ALIST.
5295 See `display-buffer' for details.")
5296 (put 'display-buffer-overriding-action 'risky-local-variable t)
5298 (defcustom display-buffer-alist nil
5299 "Alist of conditional actions for `display-buffer'.
5300 This is a list of elements (CONDITION . ACTION), where:
5302 CONDITION is either a regexp matching buffer names, or a
5303 function that takes two arguments - a buffer name and the
5304 ACTION argument of `display-buffer' - and returns a boolean.
5306 ACTION is a cons cell (FUNCTION . ALIST), where FUNCTION is a
5307 function or a list of functions. Each such function should
5308 accept two arguments: a buffer to display and an alist of the
5309 same form as ALIST. See `display-buffer' for details.
5311 `display-buffer' scans this alist until it either finds a
5312 matching regular expression or the function specified by a
5313 condition returns non-nil. In any of these cases, it adds the
5314 associated action to the list of actions it will try."
5315 :type `(alist :key-type
5316 (choice :tag "Condition"
5317 regexp
5318 (function :tag "Matcher function"))
5319 :value-type ,display-buffer--action-custom-type)
5320 :risky t
5321 :version "24.1"
5322 :group 'windows)
5324 (defcustom display-buffer-base-action '(nil . nil)
5325 "User-specified default action for `display-buffer'.
5326 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
5327 function or a list of functions. Each function should accept two
5328 arguments: a buffer to display and an alist similar to ALIST.
5329 See `display-buffer' for details."
5330 :type display-buffer--action-custom-type
5331 :risky t
5332 :version "24.1"
5333 :group 'windows)
5335 (defconst display-buffer-fallback-action
5336 '((display-buffer--maybe-same-window ;FIXME: why isn't this redundant?
5337 display-buffer-reuse-window
5338 display-buffer--maybe-pop-up-frame-or-window
5339 display-buffer-use-some-window
5340 ;; If all else fails, pop up a new frame.
5341 display-buffer-pop-up-frame))
5342 "Default fallback action for `display-buffer'.
5343 This is the action used by `display-buffer' if no other actions
5344 specified, e.g. by the user options `display-buffer-alist' or
5345 `display-buffer-base-action'. See `display-buffer'.")
5346 (put 'display-buffer-fallback-action 'risky-local-variable t)
5348 (defun display-buffer-assq-regexp (buffer-name alist action)
5349 "Retrieve ALIST entry corresponding to BUFFER-NAME.
5350 ACTION is the action argument passed to `display-buffer'."
5351 (catch 'match
5352 (dolist (entry alist)
5353 (let ((key (car entry)))
5354 (when (or (and (stringp key)
5355 (string-match-p key buffer-name))
5356 (and (functionp key)
5357 (funcall key buffer-name action)))
5358 (throw 'match (cdr entry)))))))
5360 (defvar display-buffer--same-window-action
5361 '(display-buffer-same-window
5362 (inhibit-same-window . nil))
5363 "A `display-buffer' action for displaying in the same window.")
5364 (put 'display-buffer--same-window-action 'risky-local-variable t)
5366 (defvar display-buffer--other-frame-action
5367 '((display-buffer-reuse-window
5368 display-buffer-pop-up-frame)
5369 (reusable-frames . 0)
5370 (inhibit-same-window . t))
5371 "A `display-buffer' action for displaying in another frame.")
5372 (put 'display-buffer--other-frame-action 'risky-local-variable t)
5374 (defun display-buffer (buffer-or-name &optional action frame)
5375 "Display BUFFER-OR-NAME in some window, without selecting it.
5376 BUFFER-OR-NAME must be a buffer or the name of an existing
5377 buffer. Return the window chosen for displaying BUFFER-OR-NAME,
5378 or nil if no such window is found.
5380 Optional argument ACTION, if non-nil, should specify a display
5381 action. Its form is described below.
5383 Optional argument FRAME, if non-nil, acts like an additional
5384 ALIST entry (reusable-frames . FRAME) to the action list of ACTION,
5385 specifying the frame(s) to search for a window that is already
5386 displaying the buffer. See `display-buffer-reuse-window'
5388 If ACTION is non-nil, it should have the form (FUNCTION . ALIST),
5389 where FUNCTION is either a function or a list of functions, and
5390 ALIST is an arbitrary association list (alist).
5392 Each such FUNCTION should accept two arguments: the buffer to
5393 display and an alist. Based on those arguments, it should either
5394 display the buffer and return the window, or return nil if unable
5395 to display the buffer.
5397 The `display-buffer' function builds a function list and an alist
5398 by combining the functions and alists specified in
5399 `display-buffer-overriding-action', `display-buffer-alist', the
5400 ACTION argument, `display-buffer-base-action', and
5401 `display-buffer-fallback-action' (in order). Then it calls each
5402 function in the combined function list in turn, passing the
5403 buffer as the first argument and the combined alist as the second
5404 argument, until one of the functions returns non-nil.
5406 If ACTION is nil, the function list and the alist are built using
5407 only the other variables mentioned above.
5409 Available action functions include:
5410 `display-buffer-same-window'
5411 `display-buffer-reuse-window'
5412 `display-buffer-pop-up-frame'
5413 `display-buffer-pop-up-window'
5414 `display-buffer-use-some-window'
5416 Recognized alist entries include:
5418 `inhibit-same-window' -- A non-nil value prevents the same
5419 window from being used for display.
5421 `inhibit-switch-frame' -- A non-nil value prevents any other
5422 frame from being raised or selected,
5423 even if the window is displayed there.
5425 `reusable-frames' -- Value specifies frame(s) to search for a
5426 window that already displays the buffer.
5427 See `display-buffer-reuse-window'.
5429 `pop-up-frame-parameters' -- Value specifies an alist of frame
5430 parameters to give a new frame, if
5431 one is created.
5433 `window-height' -- Value specifies either an integer (the number
5434 of lines of a new window), a floating point number (the
5435 fraction of a new window with respect to the height of the
5436 frame's root window) or a function to be called with one
5437 argument - a new window. The function is supposed to adjust
5438 the height of the window; its return value is ignored.
5439 Suitable functions are `shrink-window-if-larger-than-buffer'
5440 and `fit-window-to-buffer'.
5442 `window-width' -- Value specifies either an integer (the number
5443 of columns of a new window), a floating point number (the
5444 fraction of a new window with respect to the width of the
5445 frame's root window) or a function to be called with one
5446 argument - a new window. The function is supposed to adjust
5447 the width of the window; its return value is ignored.
5449 The ACTION argument to `display-buffer' can also have a non-nil
5450 and non-list value. This means to display the buffer in a window
5451 other than the selected one, even if it is already displayed in
5452 the selected window. If called interactively with a prefix
5453 argument, ACTION is t."
5454 (interactive (list (read-buffer "Display buffer: " (other-buffer))
5455 (if current-prefix-arg t)))
5456 (let ((buffer (if (bufferp buffer-or-name)
5457 buffer-or-name
5458 (get-buffer buffer-or-name)))
5459 ;; Handle the old form of the first argument.
5460 (inhibit-same-window (and action (not (listp action)))))
5461 (unless (listp action) (setq action nil))
5462 (if display-buffer-function
5463 ;; If `display-buffer-function' is defined, let it do the job.
5464 (funcall display-buffer-function buffer inhibit-same-window)
5465 ;; Otherwise, use the defined actions.
5466 (let* ((user-action
5467 (display-buffer-assq-regexp
5468 (buffer-name buffer) display-buffer-alist action))
5469 (special-action (display-buffer--special-action buffer))
5470 ;; Extra actions from the arguments to this function:
5471 (extra-action
5472 (cons nil (append (if inhibit-same-window
5473 '((inhibit-same-window . t)))
5474 (if frame
5475 `((reusable-frames . ,frame))))))
5476 ;; Construct action function list and action alist.
5477 (actions (list display-buffer-overriding-action
5478 user-action special-action action extra-action
5479 display-buffer-base-action
5480 display-buffer-fallback-action))
5481 (functions (apply 'append
5482 (mapcar (lambda (x)
5483 (setq x (car x))
5484 (if (functionp x) (list x) x))
5485 actions)))
5486 (alist (apply 'append (mapcar 'cdr actions)))
5487 window)
5488 (unless (buffer-live-p buffer)
5489 (error "Invalid buffer"))
5490 (while (and functions (not window))
5491 (setq window (funcall (car functions) buffer alist)
5492 functions (cdr functions)))
5493 window))))
5495 (defun display-buffer-other-frame (buffer)
5496 "Display buffer BUFFER in another frame.
5497 This uses the function `display-buffer' as a subroutine; see
5498 its documentation for additional customization information."
5499 (interactive "BDisplay buffer in other frame: ")
5500 (display-buffer buffer display-buffer--other-frame-action t))
5502 ;;; `display-buffer' action functions:
5504 (defun display-buffer-same-window (buffer alist)
5505 "Display BUFFER in the selected window.
5506 This fails if ALIST has a non-nil `inhibit-same-window' entry, or
5507 if the selected window is a minibuffer window or is dedicated to
5508 another buffer; in that case, return nil. Otherwise, return the
5509 selected window."
5510 (unless (or (cdr (assq 'inhibit-same-window alist))
5511 (window-minibuffer-p)
5512 (window-dedicated-p))
5513 (window--display-buffer buffer (selected-window) 'reuse alist)))
5515 (defun display-buffer--maybe-same-window (buffer alist)
5516 "Conditionally display BUFFER in the selected window.
5517 If `same-window-p' returns non-nil for BUFFER's name, call
5518 `display-buffer-same-window' and return its value. Otherwise,
5519 return nil."
5520 (and (same-window-p (buffer-name buffer))
5521 (display-buffer-same-window buffer alist)))
5523 (defun display-buffer-reuse-window (buffer alist)
5524 "Return a window that is already displaying BUFFER.
5525 Return nil if no usable window is found.
5527 If ALIST has a non-nil `inhibit-same-window' entry, the selected
5528 window is not eligible for reuse.
5530 If ALIST contains a `reusable-frames' entry, its value determines
5531 which frames to search for a reusable window:
5532 nil -- the selected frame (actually the last non-minibuffer frame)
5533 A frame -- just that frame
5534 `visible' -- all visible frames
5535 0 -- all frames on the current terminal
5536 t -- all frames.
5538 If ALIST contains no `reusable-frames' entry, search just the
5539 selected frame if `display-buffer-reuse-frames' and
5540 `pop-up-frames' are both nil; search all frames on the current
5541 terminal if either of those variables is non-nil.
5543 If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
5544 event that a window on another frame is chosen, avoid raising
5545 that frame."
5546 (let* ((alist-entry (assq 'reusable-frames alist))
5547 (frames (cond (alist-entry (cdr alist-entry))
5548 ((if (eq pop-up-frames 'graphic-only)
5549 (display-graphic-p)
5550 pop-up-frames)
5552 (display-buffer-reuse-frames 0)
5553 (t (last-nonminibuffer-frame))))
5554 (window (if (and (eq buffer (window-buffer))
5555 (not (cdr (assq 'inhibit-same-window alist))))
5556 (selected-window)
5557 (car (delq (selected-window)
5558 (get-buffer-window-list buffer 'nomini
5559 frames))))))
5560 (when (window-live-p window)
5561 (prog1 (window--display-buffer buffer window 'reuse alist)
5562 (unless (cdr (assq 'inhibit-switch-frame alist))
5563 (window--maybe-raise-frame (window-frame window)))))))
5565 (defun display-buffer--special-action (buffer)
5566 "Return special display action for BUFFER, if any.
5567 If `special-display-p' returns non-nil for BUFFER, return an
5568 appropriate display action involving `special-display-function'.
5569 See `display-buffer' for the format of display actions."
5570 (and special-display-function
5571 ;; `special-display-p' returns either t or a list of frame
5572 ;; parameters to pass to `special-display-function'.
5573 (let ((pars (special-display-p (buffer-name buffer))))
5574 (when pars
5575 (list (list #'display-buffer-reuse-window
5576 `(lambda (buffer _alist)
5577 (funcall special-display-function
5578 buffer ',(if (listp pars) pars)))))))))
5580 (defun display-buffer-pop-up-frame (buffer alist)
5581 "Display BUFFER in a new frame.
5582 This works by calling `pop-up-frame-function'. If successful,
5583 return the window used; otherwise return nil.
5585 If ALIST has a non-nil `inhibit-switch-frame' entry, avoid
5586 raising the new frame.
5588 If ALIST has a non-nil `pop-up-frame-parameters' entry, the
5589 corresponding value is an alist of frame parameters to give the
5590 new frame."
5591 (let* ((params (cdr (assq 'pop-up-frame-parameters alist)))
5592 (pop-up-frame-alist (append params pop-up-frame-alist))
5593 (fun pop-up-frame-function)
5594 frame window)
5595 (when (and fun
5596 (setq frame (funcall fun))
5597 (setq window (frame-selected-window frame)))
5598 (prog1 (window--display-buffer
5599 buffer window 'frame alist display-buffer-mark-dedicated)
5600 (unless (cdr (assq 'inhibit-switch-frame alist))
5601 (window--maybe-raise-frame frame))))))
5603 (defun display-buffer-pop-up-window (buffer alist)
5604 "Display BUFFER by popping up a new window.
5605 The new window is created on the selected frame, or in
5606 `last-nonminibuffer-frame' if no windows can be created there.
5607 If successful, return the new window; otherwise return nil.
5609 If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
5610 event that the new window is created on another frame, avoid
5611 raising the frame."
5612 (let ((frame (or (window--frame-usable-p (selected-frame))
5613 (window--frame-usable-p (last-nonminibuffer-frame))))
5614 window)
5615 (when (and (or (not (frame-parameter frame 'unsplittable))
5616 ;; If the selected frame cannot be split, look at
5617 ;; `last-nonminibuffer-frame'.
5618 (and (eq frame (selected-frame))
5619 (setq frame (last-nonminibuffer-frame))
5620 (window--frame-usable-p frame)
5621 (not (frame-parameter frame 'unsplittable))))
5622 ;; Attempt to split largest or least recently used window.
5623 (setq window (or (window--try-to-split-window
5624 (get-largest-window frame t) alist)
5625 (window--try-to-split-window
5626 (get-lru-window frame t) alist))))
5627 (prog1 (window--display-buffer
5628 buffer window 'window alist display-buffer-mark-dedicated)
5629 (unless (cdr (assq 'inhibit-switch-frame alist))
5630 (window--maybe-raise-frame (window-frame window)))))))
5632 (defun display-buffer--maybe-pop-up-frame-or-window (buffer alist)
5633 "Try displaying BUFFER based on `pop-up-frames' or `pop-up-windows'.
5635 If `pop-up-frames' is non-nil (and not `graphic-only' on a
5636 text-only terminal), try with `display-buffer-pop-up-frame'.
5638 If that cannot be done, and `pop-up-windows' is non-nil, try
5639 again with `display-buffer-pop-up-window'."
5640 (or (and (if (eq pop-up-frames 'graphic-only)
5641 (display-graphic-p)
5642 pop-up-frames)
5643 (display-buffer-pop-up-frame buffer alist))
5644 (and pop-up-windows
5645 (display-buffer-pop-up-window buffer alist))))
5647 (defun display-buffer-below-selected (buffer alist)
5648 "Try displaying BUFFER in a window below the selected window.
5649 This either splits the selected window or reuses the window below
5650 the selected one."
5651 (let (window)
5652 (or (and (not (frame-parameter nil 'unsplittable))
5653 (setq window (window--try-to-split-window (selected-window) alist))
5654 (window--display-buffer
5655 buffer window 'window alist display-buffer-mark-dedicated))
5656 (and (setq window (window-in-direction 'below))
5657 (not (window-dedicated-p window))
5658 (window--display-buffer
5659 buffer window 'reuse alist display-buffer-mark-dedicated)))))
5661 (defun display-buffer-at-bottom (buffer alist)
5662 "Try displaying BUFFER in a window at the bottom of the selected frame.
5663 This either splits the window at the bottom of the frame or the
5664 frame's root window, or reuses an existing window at the bottom
5665 of the selected frame."
5666 (let (bottom-window window)
5667 (walk-window-tree (lambda (window) (setq bottom-window window)))
5668 (or (and (not (frame-parameter nil 'unsplittable))
5669 (setq window (window--try-to-split-window bottom-window alist))
5670 (window--display-buffer
5671 buffer window 'window alist display-buffer-mark-dedicated))
5672 (and (not (frame-parameter nil 'unsplittable))
5673 (setq window
5674 (condition-case nil
5675 (split-window (frame-root-window))
5676 (error nil)))
5677 (window--display-buffer
5678 buffer window 'window alist display-buffer-mark-dedicated))
5679 (and (setq window bottom-window)
5680 (not (window-dedicated-p window))
5681 (window--display-buffer
5682 buffer window 'reuse alist display-buffer-mark-dedicated)))))
5684 (defun display-buffer-in-previous-window (buffer alist)
5685 "Display BUFFER in a window previously showing it.
5686 If ALIST has a non-nil `inhibit-same-window' entry, the selected
5687 window is not eligible for reuse.
5689 If ALIST contains a `reusable-frames' entry, its value determines
5690 which frames to search for a reusable window:
5691 nil -- the selected frame (actually the last non-minibuffer frame)
5692 A frame -- just that frame
5693 `visible' -- all visible frames
5694 0 -- all frames on the current terminal
5695 t -- all frames.
5697 If ALIST contains no `reusable-frames' entry, search just the
5698 selected frame if `display-buffer-reuse-frames' and
5699 `pop-up-frames' are both nil; search all frames on the current
5700 terminal if either of those variables is non-nil.
5702 If ALIST has a `previous-window' entry, the window specified by
5703 that entry will override any other window found by the methods
5704 above, even if that window never showed BUFFER before."
5705 (let* ((alist-entry (assq 'reusable-frames alist))
5706 (inhibit-same-window
5707 (cdr (assq 'inhibit-same-window alist)))
5708 (frames (cond
5709 (alist-entry (cdr alist-entry))
5710 ((if (eq pop-up-frames 'graphic-only)
5711 (display-graphic-p)
5712 pop-up-frames)
5714 (display-buffer-reuse-frames 0)
5715 (t (last-nonminibuffer-frame))))
5716 entry best-window second-best-window window)
5717 ;; Scan windows whether they have shown the buffer recently.
5718 (catch 'best
5719 (dolist (window (window-list-1 (frame-first-window) 'nomini frames))
5720 (when (and (assq buffer (window-prev-buffers window))
5721 (not (window-dedicated-p window)))
5722 (if (eq window (selected-window))
5723 (unless inhibit-same-window
5724 (setq second-best-window window))
5725 (setq best-window window)
5726 (throw 'best t)))))
5727 ;; When ALIST has a `previous-window' entry, that entry may override
5728 ;; anything we found so far.
5729 (when (and (setq window (cdr (assq 'previous-window alist)))
5730 (window-live-p window)
5731 (not (window-dedicated-p window)))
5732 (if (eq window (selected-window))
5733 (unless inhibit-same-window
5734 (setq second-best-window window))
5735 (setq best-window window)))
5736 ;; Return best or second best window found.
5737 (when (setq window (or best-window second-best-window))
5738 (window--display-buffer buffer window 'reuse alist))))
5740 (defun display-buffer-use-some-window (buffer alist)
5741 "Display BUFFER in an existing window.
5742 Search for a usable window, set that window to the buffer, and
5743 return the window. If no suitable window is found, return nil.
5745 If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
5746 event that a window in another frame is chosen, avoid raising
5747 that frame."
5748 (let* ((not-this-window (cdr (assq 'inhibit-same-window alist)))
5749 (frame (or (window--frame-usable-p (selected-frame))
5750 (window--frame-usable-p (last-nonminibuffer-frame))))
5751 (window
5752 ;; Reuse an existing window.
5753 (or (get-lru-window frame nil not-this-window)
5754 (let ((window (get-buffer-window buffer 'visible)))
5755 (unless (and not-this-window
5756 (eq window (selected-window)))
5757 window))
5758 (get-largest-window 'visible nil not-this-window)
5759 (let ((window (get-buffer-window buffer 0)))
5760 (unless (and not-this-window
5761 (eq window (selected-window)))
5762 window))
5763 (get-largest-window 0 not-this-window))))
5764 (when (window-live-p window)
5765 (prog1
5766 (window--display-buffer buffer window 'reuse alist)
5767 (window--even-window-heights window)
5768 (unless (cdr (assq 'inhibit-switch-frame alist))
5769 (window--maybe-raise-frame (window-frame window)))))))
5771 ;;; Display + selection commands:
5772 (defun pop-to-buffer (buffer &optional action norecord)
5773 "Select buffer BUFFER in some window, preferably a different one.
5774 BUFFER may be a buffer, a string (a buffer name), or nil. If it
5775 is a string not naming an existent buffer, create a buffer with
5776 that name. If BUFFER is nil, choose some other buffer. Return
5777 the buffer.
5779 This uses `display-buffer' as a subroutine. The optional ACTION
5780 argument is passed to `display-buffer' as its ACTION argument.
5781 See `display-buffer' for more information. ACTION is t if called
5782 interactively with a prefix argument, which means to pop to a
5783 window other than the selected one even if the buffer is already
5784 displayed in the selected window.
5786 If the window to show BUFFER is not on the selected
5787 frame, raise that window's frame and give it input focus.
5789 Optional third arg NORECORD non-nil means do not put this buffer
5790 at the front of the list of recently selected ones."
5791 (interactive (list (read-buffer "Pop to buffer: " (other-buffer))
5792 (if current-prefix-arg t)))
5793 (setq buffer (window-normalize-buffer-to-switch-to buffer))
5794 (set-buffer buffer)
5795 (let* ((old-frame (selected-frame))
5796 (window (display-buffer buffer action))
5797 (frame (window-frame window)))
5798 ;; If we chose another frame, make sure it gets input focus.
5799 (unless (eq frame old-frame)
5800 (select-frame-set-input-focus frame norecord))
5801 ;; Make sure new window is selected (Bug#8615), (Bug#6954).
5802 (select-window window norecord)
5803 buffer))
5805 (defun pop-to-buffer-same-window (buffer &optional norecord)
5806 "Select buffer BUFFER in some window, preferably the same one.
5807 This function behaves much like `switch-to-buffer', except it
5808 displays with `special-display-function' if BUFFER has a match in
5809 `special-display-buffer-names' or `special-display-regexps'.
5811 Unlike `pop-to-buffer', this function prefers using the selected
5812 window over popping up a new window or frame.
5814 BUFFER may be a buffer, a string (a buffer name), or nil. If it
5815 is a string not naming an existent buffer, create a buffer with
5816 that name. If BUFFER is nil, choose some other buffer. Return
5817 the buffer.
5819 NORECORD, if non-nil means do not put this buffer at the front of
5820 the list of recently selected ones."
5821 (pop-to-buffer buffer display-buffer--same-window-action norecord))
5823 (defun read-buffer-to-switch (prompt)
5824 "Read the name of a buffer to switch to, prompting with PROMPT.
5825 Return the name of the buffer as a string.
5827 This function is intended for the `switch-to-buffer' family of
5828 commands since these need to omit the name of the current buffer
5829 from the list of completions and default values."
5830 (let ((rbts-completion-table (internal-complete-buffer-except)))
5831 (minibuffer-with-setup-hook
5832 (lambda ()
5833 (setq minibuffer-completion-table rbts-completion-table)
5834 ;; Since rbts-completion-table is built dynamically, we
5835 ;; can't just add it to the default value of
5836 ;; icomplete-with-completion-tables, so we add it
5837 ;; here manually.
5838 (if (and (boundp 'icomplete-with-completion-tables)
5839 (listp icomplete-with-completion-tables))
5840 (set (make-local-variable 'icomplete-with-completion-tables)
5841 (cons rbts-completion-table
5842 icomplete-with-completion-tables))))
5843 (read-buffer prompt (other-buffer (current-buffer))
5844 (confirm-nonexistent-file-or-buffer)))))
5846 (defun window-normalize-buffer-to-switch-to (buffer-or-name)
5847 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
5848 If BUFFER-OR-NAME is nil, return the buffer returned by
5849 `other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
5850 exists, return that buffer. If no such buffer exists, create a
5851 buffer with the name BUFFER-OR-NAME and return that buffer."
5852 (if buffer-or-name
5853 (or (get-buffer buffer-or-name)
5854 (let ((buffer (get-buffer-create buffer-or-name)))
5855 (set-buffer-major-mode buffer)
5856 buffer))
5857 (other-buffer)))
5859 (defcustom switch-to-buffer-preserve-window-point nil
5860 "If non-nil, `switch-to-buffer' tries to preserve `window-point'.
5861 If this is nil, `switch-to-buffer' displays the buffer at that
5862 buffer's `point'. If this is `already-displayed', it tries to
5863 display the buffer at its previous position in the selected
5864 window, provided the buffer is currently displayed in some other
5865 window on any visible or iconified frame. If this is t, it
5866 unconditionally tries to display the buffer at its previous
5867 position in the selected window.
5869 This variable is ignored if the buffer is already displayed in
5870 the selected window or never appeared in it before, or if
5871 `switch-to-buffer' calls `pop-to-buffer' to display the buffer."
5872 :type '(choice
5873 (const :tag "Never" nil)
5874 (const :tag "If already displayed elsewhere" already-displayed)
5875 (const :tag "Always" t))
5876 :group 'windows
5877 :version "24.3")
5879 (defun switch-to-buffer (buffer-or-name &optional norecord force-same-window)
5880 "Display buffer BUFFER-OR-NAME in the selected window.
5882 WARNING: This is NOT the way to work on another buffer temporarily
5883 within a Lisp program! Use `set-buffer' instead. That avoids
5884 messing with the window-buffer correspondences.
5886 If the selected window cannot display the specified
5887 buffer (e.g. if it is a minibuffer window or strongly dedicated
5888 to another buffer), call `pop-to-buffer' to select the buffer in
5889 another window.
5891 If called interactively, read the buffer name using the
5892 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5893 determines whether to request confirmation before creating a new
5894 buffer.
5896 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or nil.
5897 If BUFFER-OR-NAME is a string that does not identify an existing
5898 buffer, create a buffer with that name. If BUFFER-OR-NAME is
5899 nil, switch to the buffer returned by `other-buffer'.
5901 If optional argument NORECORD is non-nil, do not put the buffer
5902 at the front of the buffer list, and do not make the window
5903 displaying it the most recently selected one.
5905 If optional argument FORCE-SAME-WINDOW is non-nil, the buffer
5906 must be displayed in the selected window; if that is impossible,
5907 signal an error rather than calling `pop-to-buffer'.
5909 The option `switch-to-buffer-preserve-window-point' can be used
5910 to make the buffer appear at its last position in the selected
5911 window.
5913 Return the buffer switched to."
5914 (interactive
5915 (list (read-buffer-to-switch "Switch to buffer: ") nil 'force-same-window))
5916 (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name)))
5917 (cond
5918 ;; Don't call set-window-buffer if it's not needed since it
5919 ;; might signal an error (e.g. if the window is dedicated).
5920 ((eq buffer (window-buffer)))
5921 ((window-minibuffer-p)
5922 (if force-same-window
5923 (user-error "Cannot switch buffers in minibuffer window")
5924 (pop-to-buffer buffer norecord)))
5925 ((eq (window-dedicated-p) t)
5926 (if force-same-window
5927 (user-error "Cannot switch buffers in a dedicated window")
5928 (pop-to-buffer buffer norecord)))
5930 (let* ((entry (assq buffer (window-prev-buffers)))
5931 (displayed (and (eq switch-to-buffer-preserve-window-point
5932 'already-displayed)
5933 (get-buffer-window buffer 0))))
5934 (set-window-buffer nil buffer)
5935 (when (and entry
5936 (or (eq switch-to-buffer-preserve-window-point t)
5937 displayed))
5938 ;; Try to restore start and point of buffer in the selected
5939 ;; window (Bug#4041).
5940 (set-window-start (selected-window) (nth 1 entry) t)
5941 (set-window-point nil (nth 2 entry))))))
5943 (unless norecord
5944 (select-window (selected-window)))
5945 (set-buffer buffer)))
5947 (defun switch-to-buffer-other-window (buffer-or-name &optional norecord)
5948 "Select the buffer specified by BUFFER-OR-NAME in another window.
5949 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5950 nil. Return the buffer switched to.
5952 If called interactively, prompt for the buffer name using the
5953 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5954 determines whether to request confirmation before creating a new
5955 buffer.
5957 If BUFFER-OR-NAME is a string and does not identify an existing
5958 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5959 nil, switch to the buffer returned by `other-buffer'.
5961 Optional second argument NORECORD non-nil means do not put this
5962 buffer at the front of the list of recently selected ones.
5964 This uses the function `display-buffer' as a subroutine; see its
5965 documentation for additional customization information."
5966 (interactive
5967 (list (read-buffer-to-switch "Switch to buffer in other window: ")))
5968 (let ((pop-up-windows t))
5969 (pop-to-buffer buffer-or-name t norecord)))
5971 (defun switch-to-buffer-other-frame (buffer-or-name &optional norecord)
5972 "Switch to buffer BUFFER-OR-NAME in another frame.
5973 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5974 nil. Return the buffer switched to.
5976 If called interactively, prompt for the buffer name using the
5977 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5978 determines whether to request confirmation before creating a new
5979 buffer.
5981 If BUFFER-OR-NAME is a string and does not identify an existing
5982 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5983 nil, switch to the buffer returned by `other-buffer'.
5985 Optional second arg NORECORD non-nil means do not put this
5986 buffer at the front of the list of recently selected ones.
5988 This uses the function `display-buffer' as a subroutine; see its
5989 documentation for additional customization information."
5990 (interactive
5991 (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
5992 (pop-to-buffer buffer-or-name display-buffer--other-frame-action norecord))
5994 (defun set-window-text-height (window height)
5995 "Set the height in lines of the text display area of WINDOW to HEIGHT.
5996 WINDOW must be a live window and defaults to the selected one.
5997 HEIGHT doesn't include the mode line or header line, if any, or
5998 any partial-height lines in the text display area.
6000 Note that the current implementation of this function cannot
6001 always set the height exactly, but attempts to be conservative,
6002 by allocating more lines than are actually needed in the case
6003 where some error may be present."
6004 (setq window (window-normalize-window window t))
6005 (let ((delta (- height (window-text-height window))))
6006 (unless (zerop delta)
6007 ;; Setting window-min-height to a value like 1 can lead to very
6008 ;; bizarre displays because it also allows Emacs to make *other*
6009 ;; windows one line tall, which means that there's no more space
6010 ;; for the mode line.
6011 (let ((window-min-height (min 2 height)))
6012 (window-resize window delta)))))
6014 (defun enlarge-window-horizontally (delta)
6015 "Make selected window DELTA columns wider.
6016 Interactively, if no argument is given, make selected window one
6017 column wider."
6018 (interactive "p")
6019 (enlarge-window delta t))
6021 (defun shrink-window-horizontally (delta)
6022 "Make selected window DELTA columns narrower.
6023 Interactively, if no argument is given, make selected window one
6024 column narrower."
6025 (interactive "p")
6026 (shrink-window delta t))
6028 (defun count-screen-lines (&optional beg end count-final-newline window)
6029 "Return the number of screen lines in the region.
6030 The number of screen lines may be different from the number of actual lines,
6031 due to line breaking, display table, etc.
6033 Optional arguments BEG and END default to `point-min' and `point-max'
6034 respectively.
6036 If region ends with a newline, ignore it unless optional third argument
6037 COUNT-FINAL-NEWLINE is non-nil.
6039 The optional fourth argument WINDOW specifies the window used for obtaining
6040 parameters such as width, horizontal scrolling, and so on. The default is
6041 to use the selected window's parameters.
6043 Like `vertical-motion', `count-screen-lines' always uses the current buffer,
6044 regardless of which buffer is displayed in WINDOW. This makes possible to use
6045 `count-screen-lines' in any buffer, whether or not it is currently displayed
6046 in some window."
6047 (unless beg
6048 (setq beg (point-min)))
6049 (unless end
6050 (setq end (point-max)))
6051 (if (= beg end)
6053 (save-excursion
6054 (save-restriction
6055 (widen)
6056 (narrow-to-region (min beg end)
6057 (if (and (not count-final-newline)
6058 (= ?\n (char-before (max beg end))))
6059 (1- (max beg end))
6060 (max beg end)))
6061 (goto-char (point-min))
6062 (1+ (vertical-motion (buffer-size) window))))))
6064 (defun window-buffer-height (window)
6065 "Return the height (in screen lines) of the buffer that WINDOW is displaying.
6066 WINDOW must be a live window and defaults to the selected one."
6067 (setq window (window-normalize-window window t))
6068 (with-current-buffer (window-buffer window)
6069 (max 1
6070 (count-screen-lines (point-min) (point-max)
6071 ;; If buffer ends with a newline, ignore it when
6072 ;; counting height unless point is after it.
6073 (eobp)
6074 window))))
6076 ;;; Resizing buffers to fit their contents exactly.
6077 (defcustom fit-frame-to-buffer nil
6078 "Non-nil means `fit-window-to-buffer' can resize frames.
6079 A frame can be resized if and only if its root window is a live
6080 window. The height of the root window is subject to the values
6081 of `fit-frame-to-buffer-max-height' and `window-min-height'."
6082 :type 'boolean
6083 :version "24.3"
6084 :group 'help)
6086 (defcustom fit-frame-to-buffer-bottom-margin 4
6087 "Bottom margin for the command `fit-frame-to-buffer'.
6088 This is the number of lines that function leaves free at the bottom of
6089 the display, in order to not obscure any system task bar or panel.
6090 If you do not have one (or if it is vertical) you might want to
6091 reduce this. If it is thicker, you might want to increase this."
6092 ;; If you set this too small, fit-frame-to-buffer can shift the
6093 ;; frame up to avoid the panel.
6094 :type 'integer
6095 :version "24.3"
6096 :group 'windows)
6098 (defun fit-frame-to-buffer (&optional frame max-height min-height)
6099 "Adjust height of FRAME to display its buffer contents exactly.
6100 FRAME can be any live frame and defaults to the selected one.
6102 Optional argument MAX-HEIGHT specifies the maximum height of FRAME.
6103 It defaults to the height of the display below the current
6104 top line of FRAME, minus `fit-frame-to-buffer-bottom-margin'.
6105 Optional argument MIN-HEIGHT specifies the minimum height of FRAME.
6106 The default corresponds to `window-min-height'."
6107 (interactive)
6108 (setq frame (window-normalize-frame frame))
6109 (let* ((root (frame-root-window frame))
6110 (frame-min-height
6111 (+ (- (frame-height frame) (window-total-size root))
6112 window-min-height))
6113 (frame-top (frame-parameter frame 'top))
6114 (top (if (consp frame-top)
6115 (funcall (car frame-top) (cadr frame-top))
6116 frame-top))
6117 (frame-max-height
6118 (- (/ (- (x-display-pixel-height frame) top)
6119 (frame-char-height frame))
6120 fit-frame-to-buffer-bottom-margin))
6121 (compensate 0)
6122 delta)
6123 (when (and (window-live-p root) (not (window-size-fixed-p root)))
6124 (with-selected-window root
6125 (cond
6126 ((not max-height)
6127 (setq max-height frame-max-height))
6128 ((numberp max-height)
6129 (setq max-height (min max-height frame-max-height)))
6131 (error "%s is an invalid maximum height" max-height)))
6132 (cond
6133 ((not min-height)
6134 (setq min-height frame-min-height))
6135 ((numberp min-height)
6136 (setq min-height (min min-height frame-min-height)))
6138 (error "%s is an invalid minimum height" min-height)))
6139 ;; When tool-bar-mode is enabled and we have just created a new
6140 ;; frame, reserve lines for toolbar resizing. This is needed
6141 ;; because for reasons unknown to me Emacs (1) reserves one line
6142 ;; for the toolbar when making the initial frame and toolbars
6143 ;; are enabled, and (2) later adds the remaining lines needed.
6144 ;; Our code runs IN BETWEEN (1) and (2). YMMV when you're on a
6145 ;; system that behaves differently.
6146 (let ((quit-restore (window-parameter root 'quit-restore))
6147 (lines (tool-bar-lines-needed frame)))
6148 (when (and quit-restore (eq (car quit-restore) 'frame)
6149 (not (zerop lines)))
6150 (setq compensate (1- lines))))
6151 (message "%s" compensate)
6152 (setq delta
6153 ;; Always count a final newline - we don't do any
6154 ;; post-processing, so let's play safe.
6155 (+ (count-screen-lines nil nil t)
6156 (- (window-body-size))
6157 compensate)))
6158 ;; Move away from final newline.
6159 (when (and (eobp) (bolp) (not (bobp)))
6160 (set-window-point root (line-beginning-position 0)))
6161 (set-window-start root (point-min))
6162 (set-window-vscroll root 0)
6163 (condition-case nil
6164 (set-frame-height
6165 frame
6166 (min (max (+ (frame-height frame) delta)
6167 min-height)
6168 max-height))
6169 (error (setq delta nil))))
6170 delta))
6172 (defun fit-window-to-buffer (&optional window max-height min-height)
6173 "Adjust height of WINDOW to display its buffer's contents exactly.
6174 WINDOW must be a live window and defaults to the selected one.
6176 Optional argument MAX-HEIGHT specifies the maximum height of
6177 WINDOW and defaults to the height of WINDOW's frame. Optional
6178 argument MIN-HEIGHT specifies the minimum height of WINDOW and
6179 defaults to `window-min-height'. Both MAX-HEIGHT and MIN-HEIGHT
6180 are specified in lines and include the mode line and header line,
6181 if any.
6183 If WINDOW is a full height window, then if the option
6184 `fit-frame-to-buffer' is non-nil, this calls the function
6185 `fit-frame-to-buffer' to adjust the frame height.
6187 Return the number of lines by which WINDOW was enlarged or
6188 shrunk. If an error occurs during resizing, return nil but don't
6189 signal an error.
6191 Note that even if this function makes WINDOW large enough to show
6192 _all_ lines of its buffer you might not see the first lines when
6193 WINDOW was scrolled."
6194 (interactive)
6195 (setq window (window-normalize-window window t))
6196 (cond
6197 ((window-size-fixed-p window))
6198 ((window-full-height-p window)
6199 (when fit-frame-to-buffer
6200 (fit-frame-to-buffer (window-frame window))))
6202 (with-selected-window window
6203 (let* ((height (window-total-size))
6204 (min-height
6205 ;; Adjust MIN-HEIGHT.
6206 (if (numberp min-height)
6207 ;; Can't get smaller than `window-safe-min-height'.
6208 (max min-height window-safe-min-height)
6209 ;; Preserve header and mode line if present.
6210 (window-min-size nil nil t)))
6211 (max-height
6212 ;; Adjust MAX-HEIGHT.
6213 (if (numberp max-height)
6214 ;; Can't get larger than height of frame.
6215 (min max-height
6216 (window-total-size (frame-root-window window)))
6217 ;; Don't delete other windows.
6218 (+ height (window-max-delta nil nil window))))
6219 ;; Make `desired-height' the height necessary to show
6220 ;; all of WINDOW's buffer, constrained by MIN-HEIGHT
6221 ;; and MAX-HEIGHT.
6222 (desired-height
6223 (max
6224 (min
6225 (+ (count-screen-lines)
6226 ;; For non-minibuffers count the mode line, if any.
6227 (if (and (not (window-minibuffer-p window))
6228 mode-line-format)
6231 ;; Count the header line, if any.
6232 (if header-line-format 1 0))
6233 max-height)
6234 min-height))
6235 (desired-delta
6236 (- desired-height (window-total-size window)))
6237 (delta
6238 (if (> desired-delta 0)
6239 (min desired-delta
6240 (window-max-delta window nil window))
6241 (max desired-delta
6242 (- (window-min-delta window nil window))))))
6243 (condition-case nil
6244 (if (zerop delta)
6245 ;; Return zero if DELTA became zero in the process.
6247 ;; Don't try to redisplay with the cursor at the end on its
6248 ;; own line--that would force a scroll and spoil things.
6249 (when (and (eobp) (bolp) (not (bobp)))
6250 ;; It's silly to put `point' at the end of the previous
6251 ;; line and so maybe force horizontal scrolling.
6252 (set-window-point window (line-beginning-position 0)))
6253 ;; Call `window-resize' with OVERRIDE argument equal WINDOW.
6254 (window-resize window delta nil window)
6255 ;; Check if the last line is surely fully visible. If
6256 ;; not, enlarge the window.
6257 (let ((end (save-excursion
6258 (goto-char (point-max))
6259 (when (and (bolp) (not (bobp)))
6260 ;; Don't include final newline.
6261 (backward-char 1))
6262 (when truncate-lines
6263 ;; If line-wrapping is turned off, test the
6264 ;; beginning of the last line for
6265 ;; visibility instead of the end, as the
6266 ;; end of the line could be invisible by
6267 ;; virtue of extending past the edge of the
6268 ;; window.
6269 (forward-line 0))
6270 (point))))
6271 (set-window-vscroll window 0)
6272 ;; This loop might in some rare pathological cases raise
6273 ;; an error - another reason for the `condition-case'.
6274 (while (and (< desired-height max-height)
6275 (= desired-height (window-total-size))
6276 (not (pos-visible-in-window-p end)))
6277 (window-resize window 1 nil window)
6278 (setq desired-height (1+ desired-height)))))
6279 (error (setq delta nil)))
6280 delta)))))
6282 (defun window-safely-shrinkable-p (&optional window)
6283 "Return t if WINDOW can be shrunk without shrinking other windows.
6284 WINDOW defaults to the selected window."
6285 (with-selected-window (or window (selected-window))
6286 (let ((edges (window-edges)))
6287 (or (= (nth 2 edges) (nth 2 (window-edges (previous-window))))
6288 (= (nth 0 edges) (nth 0 (window-edges (next-window))))))))
6290 (defun shrink-window-if-larger-than-buffer (&optional window)
6291 "Shrink height of WINDOW if its buffer doesn't need so many lines.
6292 More precisely, shrink WINDOW vertically to be as small as
6293 possible, while still showing the full contents of its buffer.
6294 WINDOW must be a live window and defaults to the selected one.
6296 Do not shrink WINDOW to less than `window-min-height' lines. Do
6297 nothing if the buffer contains more lines than the present window
6298 height, or if some of the window's contents are scrolled out of
6299 view, or if shrinking this window would also shrink another
6300 window, or if the window is the only window of its frame.
6302 Return non-nil if the window was shrunk, nil otherwise."
6303 (interactive)
6304 (setq window (window-normalize-window window t))
6305 ;; Make sure that WINDOW is vertically combined and `point-min' is
6306 ;; visible (for whatever reason that's needed). The remaining issues
6307 ;; should be taken care of by `fit-window-to-buffer'.
6308 (when (and (window-combined-p window)
6309 (pos-visible-in-window-p (point-min) window))
6310 (fit-window-to-buffer window (window-total-size window))))
6312 (defun kill-buffer-and-window ()
6313 "Kill the current buffer and delete the selected window."
6314 (interactive)
6315 (let ((window-to-delete (selected-window))
6316 (buffer-to-kill (current-buffer))
6317 (delete-window-hook (lambda () (ignore-errors (delete-window)))))
6318 (unwind-protect
6319 (progn
6320 (add-hook 'kill-buffer-hook delete-window-hook t t)
6321 (if (kill-buffer (current-buffer))
6322 ;; If `delete-window' failed before, we rerun it to regenerate
6323 ;; the error so it can be seen in the echo area.
6324 (when (eq (selected-window) window-to-delete)
6325 (delete-window))))
6326 ;; If the buffer is not dead for some reason (probably because
6327 ;; of a `quit' signal), remove the hook again.
6328 (ignore-errors
6329 (with-current-buffer buffer-to-kill
6330 (remove-hook 'kill-buffer-hook delete-window-hook t))))))
6333 (defvar recenter-last-op nil
6334 "Indicates the last recenter operation performed.
6335 Possible values: `top', `middle', `bottom', integer or float numbers.")
6337 (defcustom recenter-positions '(middle top bottom)
6338 "Cycling order for `recenter-top-bottom'.
6339 A list of elements with possible values `top', `middle', `bottom',
6340 integer or float numbers that define the cycling order for
6341 the command `recenter-top-bottom'.
6343 Top and bottom destinations are `scroll-margin' lines from the true
6344 window top and bottom. Middle redraws the frame and centers point
6345 vertically within the window. Integer number moves current line to
6346 the specified absolute window-line. Float number between 0.0 and 1.0
6347 means the percentage of the screen space from the top. The default
6348 cycling order is middle -> top -> bottom."
6349 :type '(repeat (choice
6350 (const :tag "Top" top)
6351 (const :tag "Middle" middle)
6352 (const :tag "Bottom" bottom)
6353 (integer :tag "Line number")
6354 (float :tag "Percentage")))
6355 :version "23.2"
6356 :group 'windows)
6358 (defun recenter-top-bottom (&optional arg)
6359 "Move current buffer line to the specified window line.
6360 With no prefix argument, successive calls place point according
6361 to the cycling order defined by `recenter-positions'.
6363 A prefix argument is handled like `recenter':
6364 With numeric prefix ARG, move current line to window-line ARG.
6365 With plain `C-u', move current line to window center."
6366 (interactive "P")
6367 (cond
6368 (arg (recenter arg)) ; Always respect ARG.
6370 (setq recenter-last-op
6371 (if (eq this-command last-command)
6372 (car (or (cdr (member recenter-last-op recenter-positions))
6373 recenter-positions))
6374 (car recenter-positions)))
6375 (let ((this-scroll-margin
6376 (min (max 0 scroll-margin)
6377 (truncate (/ (window-body-height) 4.0)))))
6378 (cond ((eq recenter-last-op 'middle)
6379 (recenter))
6380 ((eq recenter-last-op 'top)
6381 (recenter this-scroll-margin))
6382 ((eq recenter-last-op 'bottom)
6383 (recenter (- -1 this-scroll-margin)))
6384 ((integerp recenter-last-op)
6385 (recenter recenter-last-op))
6386 ((floatp recenter-last-op)
6387 (recenter (round (* recenter-last-op (window-height))))))))))
6389 (define-key global-map [?\C-l] 'recenter-top-bottom)
6391 (defun move-to-window-line-top-bottom (&optional arg)
6392 "Position point relative to window.
6394 With a prefix argument ARG, acts like `move-to-window-line'.
6396 With no argument, positions point at center of window.
6397 Successive calls position point at positions defined
6398 by `recenter-positions'."
6399 (interactive "P")
6400 (cond
6401 (arg (move-to-window-line arg)) ; Always respect ARG.
6403 (setq recenter-last-op
6404 (if (eq this-command last-command)
6405 (car (or (cdr (member recenter-last-op recenter-positions))
6406 recenter-positions))
6407 (car recenter-positions)))
6408 (let ((this-scroll-margin
6409 (min (max 0 scroll-margin)
6410 (truncate (/ (window-body-height) 4.0)))))
6411 (cond ((eq recenter-last-op 'middle)
6412 (call-interactively 'move-to-window-line))
6413 ((eq recenter-last-op 'top)
6414 (move-to-window-line this-scroll-margin))
6415 ((eq recenter-last-op 'bottom)
6416 (move-to-window-line (- -1 this-scroll-margin)))
6417 ((integerp recenter-last-op)
6418 (move-to-window-line recenter-last-op))
6419 ((floatp recenter-last-op)
6420 (move-to-window-line (round (* recenter-last-op (window-height))))))))))
6422 (define-key global-map [?\M-r] 'move-to-window-line-top-bottom)
6424 ;;; Scrolling commands.
6426 ;;; Scrolling commands which do not signal errors at top/bottom
6427 ;;; of buffer at first key-press (instead move to top/bottom
6428 ;;; of buffer).
6430 (defcustom scroll-error-top-bottom nil
6431 "Move point to top/bottom of buffer before signaling a scrolling error.
6432 A value of nil means just signal an error if no more scrolling possible.
6433 A value of t means point moves to the beginning or the end of the buffer
6434 \(depending on scrolling direction) when no more scrolling possible.
6435 When point is already on that position, then signal an error."
6436 :type 'boolean
6437 :group 'windows
6438 :version "24.1")
6440 (defun scroll-up-command (&optional arg)
6441 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
6442 If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
6443 scroll window further, move cursor to the bottom line.
6444 When point is already on that position, then signal an error.
6445 A near full screen is `next-screen-context-lines' less than a full screen.
6446 Negative ARG means scroll downward.
6447 If ARG is the atom `-', scroll downward by nearly full screen."
6448 (interactive "^P")
6449 (cond
6450 ((null scroll-error-top-bottom)
6451 (scroll-up arg))
6452 ((eq arg '-)
6453 (scroll-down-command nil))
6454 ((< (prefix-numeric-value arg) 0)
6455 (scroll-down-command (- (prefix-numeric-value arg))))
6456 ((eobp)
6457 (scroll-up arg)) ; signal error
6459 (condition-case nil
6460 (scroll-up arg)
6461 (end-of-buffer
6462 (if arg
6463 ;; When scrolling by ARG lines can't be done,
6464 ;; move by ARG lines instead.
6465 (forward-line arg)
6466 ;; When ARG is nil for full-screen scrolling,
6467 ;; move to the bottom of the buffer.
6468 (goto-char (point-max))))))))
6470 (put 'scroll-up-command 'scroll-command t)
6472 (defun scroll-down-command (&optional arg)
6473 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
6474 If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
6475 scroll window further, move cursor to the top line.
6476 When point is already on that position, then signal an error.
6477 A near full screen is `next-screen-context-lines' less than a full screen.
6478 Negative ARG means scroll upward.
6479 If ARG is the atom `-', scroll upward by nearly full screen."
6480 (interactive "^P")
6481 (cond
6482 ((null scroll-error-top-bottom)
6483 (scroll-down arg))
6484 ((eq arg '-)
6485 (scroll-up-command nil))
6486 ((< (prefix-numeric-value arg) 0)
6487 (scroll-up-command (- (prefix-numeric-value arg))))
6488 ((bobp)
6489 (scroll-down arg)) ; signal error
6491 (condition-case nil
6492 (scroll-down arg)
6493 (beginning-of-buffer
6494 (if arg
6495 ;; When scrolling by ARG lines can't be done,
6496 ;; move by ARG lines instead.
6497 (forward-line (- arg))
6498 ;; When ARG is nil for full-screen scrolling,
6499 ;; move to the top of the buffer.
6500 (goto-char (point-min))))))))
6502 (put 'scroll-down-command 'scroll-command t)
6504 ;;; Scrolling commands which scroll a line instead of full screen.
6506 (defun scroll-up-line (&optional arg)
6507 "Scroll text of selected window upward ARG lines; or one line if no ARG.
6508 If ARG is omitted or nil, scroll upward by one line.
6509 This is different from `scroll-up-command' that scrolls a full screen."
6510 (interactive "p")
6511 (scroll-up (or arg 1)))
6513 (put 'scroll-up-line 'scroll-command t)
6515 (defun scroll-down-line (&optional arg)
6516 "Scroll text of selected window down ARG lines; or one line if no ARG.
6517 If ARG is omitted or nil, scroll down by one line.
6518 This is different from `scroll-down-command' that scrolls a full screen."
6519 (interactive "p")
6520 (scroll-down (or arg 1)))
6522 (put 'scroll-down-line 'scroll-command t)
6525 (defun scroll-other-window-down (&optional lines)
6526 "Scroll the \"other window\" down.
6527 For more details, see the documentation for `scroll-other-window'."
6528 (interactive "P")
6529 (scroll-other-window
6530 ;; Just invert the argument's meaning.
6531 ;; We can do that without knowing which window it will be.
6532 (if (eq lines '-) nil
6533 (if (null lines) '-
6534 (- (prefix-numeric-value lines))))))
6536 (defun beginning-of-buffer-other-window (arg)
6537 "Move point to the beginning of the buffer in the other window.
6538 Leave mark at previous position.
6539 With arg N, put point N/10 of the way from the true beginning."
6540 (interactive "P")
6541 (let ((orig-window (selected-window))
6542 (window (other-window-for-scrolling)))
6543 ;; We use unwind-protect rather than save-window-excursion
6544 ;; because the latter would preserve the things we want to change.
6545 (unwind-protect
6546 (progn
6547 (select-window window)
6548 ;; Set point and mark in that window's buffer.
6549 (with-no-warnings
6550 (beginning-of-buffer arg))
6551 ;; Set point accordingly.
6552 (recenter '(t)))
6553 (select-window orig-window))))
6555 (defun end-of-buffer-other-window (arg)
6556 "Move point to the end of the buffer in the other window.
6557 Leave mark at previous position.
6558 With arg N, put point N/10 of the way from the true end."
6559 (interactive "P")
6560 ;; See beginning-of-buffer-other-window for comments.
6561 (let ((orig-window (selected-window))
6562 (window (other-window-for-scrolling)))
6563 (unwind-protect
6564 (progn
6565 (select-window window)
6566 (with-no-warnings
6567 (end-of-buffer arg))
6568 (recenter '(t)))
6569 (select-window orig-window))))
6571 (defvar mouse-autoselect-window-timer nil
6572 "Timer used by delayed window autoselection.")
6574 (defvar mouse-autoselect-window-position nil
6575 "Last mouse position recorded by delayed window autoselection.")
6577 (defvar mouse-autoselect-window-window nil
6578 "Last window recorded by delayed window autoselection.")
6580 (defvar mouse-autoselect-window-state nil
6581 "When non-nil, special state of delayed window autoselection.
6582 Possible values are `suspend' (suspend autoselection after a menu or
6583 scrollbar interaction) and `select' (the next invocation of
6584 `handle-select-window' shall select the window immediately).")
6586 (defun mouse-autoselect-window-cancel (&optional force)
6587 "Cancel delayed window autoselection.
6588 Optional argument FORCE means cancel unconditionally."
6589 (unless (and (not force)
6590 ;; Don't cancel for select-window or select-frame events
6591 ;; or when the user drags a scroll bar.
6592 (or (memq this-command
6593 '(handle-select-window handle-switch-frame))
6594 (and (eq this-command 'scroll-bar-toolkit-scroll)
6595 (memq (nth 4 (event-end last-input-event))
6596 '(handle end-scroll)))))
6597 (setq mouse-autoselect-window-state nil)
6598 (when (timerp mouse-autoselect-window-timer)
6599 (cancel-timer mouse-autoselect-window-timer))
6600 (remove-hook 'pre-command-hook 'mouse-autoselect-window-cancel)))
6602 (defun mouse-autoselect-window-start (mouse-position &optional window suspend)
6603 "Start delayed window autoselection.
6604 MOUSE-POSITION is the last position where the mouse was seen as returned
6605 by `mouse-position'. Optional argument WINDOW non-nil denotes the
6606 window where the mouse was seen. Optional argument SUSPEND non-nil
6607 means suspend autoselection."
6608 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
6609 (setq mouse-autoselect-window-position mouse-position)
6610 (when window (setq mouse-autoselect-window-window window))
6611 (setq mouse-autoselect-window-state (when suspend 'suspend))
6612 ;; Install timer which runs `mouse-autoselect-window-select' after
6613 ;; `mouse-autoselect-window' seconds.
6614 (setq mouse-autoselect-window-timer
6615 (run-at-time
6616 (abs mouse-autoselect-window) nil 'mouse-autoselect-window-select)))
6618 (defun mouse-autoselect-window-select ()
6619 "Select window with delayed window autoselection.
6620 If the mouse position has stabilized in a non-selected window, select
6621 that window. The minibuffer window is selected only if the minibuffer
6622 is active. This function is run by `mouse-autoselect-window-timer'."
6623 (ignore-errors
6624 (let* ((mouse-position (mouse-position))
6625 (window
6626 (ignore-errors
6627 (window-at (cadr mouse-position) (cddr mouse-position)
6628 (car mouse-position)))))
6629 (cond
6630 ((or (menu-or-popup-active-p)
6631 (and window
6632 (not (coordinates-in-window-p (cdr mouse-position) window))))
6633 ;; A menu / popup dialog is active or the mouse is on the scroll-bar
6634 ;; of WINDOW, temporarily suspend delayed autoselection.
6635 (mouse-autoselect-window-start mouse-position nil t))
6636 ((eq mouse-autoselect-window-state 'suspend)
6637 ;; Delayed autoselection was temporarily suspended, reenable it.
6638 (mouse-autoselect-window-start mouse-position))
6639 ((and window (not (eq window (selected-window)))
6640 (or (not (numberp mouse-autoselect-window))
6641 (and (> mouse-autoselect-window 0)
6642 ;; If `mouse-autoselect-window' is positive, select
6643 ;; window if the window is the same as before.
6644 (eq window mouse-autoselect-window-window))
6645 ;; Otherwise select window if the mouse is at the same
6646 ;; position as before. Observe that the first test after
6647 ;; starting autoselection usually fails since the value of
6648 ;; `mouse-autoselect-window-position' recorded there is the
6649 ;; position where the mouse has entered the new window and
6650 ;; not necessarily where the mouse has stopped moving.
6651 (equal mouse-position mouse-autoselect-window-position))
6652 ;; The minibuffer is a candidate window if it's active.
6653 (or (not (window-minibuffer-p window))
6654 (eq window (active-minibuffer-window))))
6655 ;; Mouse position has stabilized in non-selected window: Cancel
6656 ;; delayed autoselection and try to select that window.
6657 (mouse-autoselect-window-cancel t)
6658 ;; Select window where mouse appears unless the selected window is the
6659 ;; minibuffer. Use `unread-command-events' in order to execute pre-
6660 ;; and post-command hooks and trigger idle timers. To avoid delaying
6661 ;; autoselection again, set `mouse-autoselect-window-state'."
6662 (unless (window-minibuffer-p (selected-window))
6663 (setq mouse-autoselect-window-state 'select)
6664 (setq unread-command-events
6665 (cons (list 'select-window (list window))
6666 unread-command-events))))
6667 ((or (and window (eq window (selected-window)))
6668 (not (numberp mouse-autoselect-window))
6669 (equal mouse-position mouse-autoselect-window-position))
6670 ;; Mouse position has either stabilized in the selected window or at
6671 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
6672 (mouse-autoselect-window-cancel t))
6674 ;; Mouse position has not stabilized yet, resume delayed
6675 ;; autoselection.
6676 (mouse-autoselect-window-start mouse-position window))))))
6678 (defun handle-select-window (event)
6679 "Handle select-window events."
6680 (interactive "e")
6681 (let ((window (posn-window (event-start event))))
6682 (unless (or (not (window-live-p window))
6683 ;; Don't switch if we're currently in the minibuffer.
6684 ;; This tries to work around problems where the
6685 ;; minibuffer gets unselected unexpectedly, and where
6686 ;; you then have to move your mouse all the way down to
6687 ;; the minibuffer to select it.
6688 (window-minibuffer-p (selected-window))
6689 ;; Don't switch to minibuffer window unless it's active.
6690 (and (window-minibuffer-p window)
6691 (not (minibuffer-window-active-p window)))
6692 ;; Don't switch when autoselection shall be delayed.
6693 (and (numberp mouse-autoselect-window)
6694 (not (zerop mouse-autoselect-window))
6695 (not (eq mouse-autoselect-window-state 'select))
6696 (progn
6697 ;; Cancel any delayed autoselection.
6698 (mouse-autoselect-window-cancel t)
6699 ;; Start delayed autoselection from current mouse
6700 ;; position and window.
6701 (mouse-autoselect-window-start (mouse-position) window)
6702 ;; Executing a command cancels delayed autoselection.
6703 (add-hook
6704 'pre-command-hook 'mouse-autoselect-window-cancel))))
6705 (when mouse-autoselect-window
6706 ;; Reset state of delayed autoselection.
6707 (setq mouse-autoselect-window-state nil)
6708 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
6709 (run-hooks 'mouse-leave-buffer-hook))
6710 ;; Clear echo area.
6711 (message nil)
6712 (select-window window))))
6714 (defun truncated-partial-width-window-p (&optional window)
6715 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
6716 WINDOW must be a live window and defaults to the selected one.
6717 Return nil if WINDOW is not a partial-width window
6718 (regardless of the value of `truncate-lines').
6719 Otherwise, consult the value of `truncate-partial-width-windows'
6720 for the buffer shown in WINDOW."
6721 (setq window (window-normalize-window window t))
6722 (unless (window-full-width-p window)
6723 (let ((t-p-w-w (buffer-local-value 'truncate-partial-width-windows
6724 (window-buffer window))))
6725 (if (integerp t-p-w-w)
6726 (< (window-width window) t-p-w-w)
6727 t-p-w-w))))
6729 ;; Some of these are in tutorial--default-keys, so update that if you
6730 ;; change these.
6731 (define-key ctl-x-map "0" 'delete-window)
6732 (define-key ctl-x-map "1" 'delete-other-windows)
6733 (define-key ctl-x-map "2" 'split-window-below)
6734 (define-key ctl-x-map "3" 'split-window-right)
6735 (define-key ctl-x-map "o" 'other-window)
6736 (define-key ctl-x-map "^" 'enlarge-window)
6737 (define-key ctl-x-map "}" 'enlarge-window-horizontally)
6738 (define-key ctl-x-map "{" 'shrink-window-horizontally)
6739 (define-key ctl-x-map "-" 'shrink-window-if-larger-than-buffer)
6740 (define-key ctl-x-map "+" 'balance-windows)
6741 (define-key ctl-x-4-map "0" 'kill-buffer-and-window)
6743 ;;; window.el ends here