]> code.delx.au - gnu-emacs/blob - lisp/window.el
Merge from origin/emacs-25
[gnu-emacs] / lisp / window.el
1 ;;; window.el --- GNU Emacs window commands aside from those written in C
2
3 ;; Copyright (C) 1985, 1989, 1992-1994, 2000-2016 Free Software
4 ;; Foundation, Inc.
5
6 ;; Maintainer: emacs-devel@gnu.org
7 ;; Keywords: internal
8 ;; Package: emacs
9
10 ;; This file is part of GNU Emacs.
11
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
16
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
21
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24
25 ;;; Commentary:
26
27 ;; Window tree functions.
28
29 ;;; Code:
30
31 (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)))))
51
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)))
59
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.
63
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.
70
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)))))
81
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.")
86
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.")
91
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)))
110
111 (defun temp-buffer-window-show (buffer &optional 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))
130 t
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))))
144
145 (defmacro with-temp-buffer-window (buffer-or-name action quit-function &rest body)
146 "Bind `standard-output' to BUFFER-OR-NAME, eval BODY, show the buffer.
147 BUFFER-OR-NAME must specify either a live buffer, or the name of
148 a buffer (if it does not exist, this macro creates it).
149
150 Make the buffer specified by BUFFER-OR-NAME empty before running
151 BODY and bind `standard-output' to that buffer, so that output
152 generated with `prin1' and similar functions in BODY goes into
153 that buffer. Do not make that buffer current for running the
154 forms in BODY. Use `with-current-buffer-window' instead if you
155 need to run BODY with that buffer current.
156
157 At the end of BODY, mark the specified buffer unmodified and
158 read-only, and display it in a window (but do not select it).
159 The display happens by calling `display-buffer' passing it the
160 ACTION argument. If `temp-buffer-resize-mode' is enabled, the
161 corresponding window may be resized automatically.
162
163 Return the value returned by BODY, unless QUIT-FUNCTION specifies
164 a function. In that case, run that function with two arguments -
165 the window showing the specified buffer and the value returned by
166 BODY - and return the value returned by that function.
167
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.
173
174 This runs the hook `temp-buffer-window-setup-hook' before BODY,
175 with the specified buffer temporarily current. It runs the hook
176 `temp-buffer-window-show-hook' after displaying the buffer, with
177 that buffer temporarily current, and the window that was used to
178 display it temporarily selected.
179
180 This construct is similar to `with-output-to-temp-buffer' but,
181 neither runs `temp-buffer-setup-hook' which usually puts the
182 buffer in Help mode, nor `temp-buffer-show-function' (the ACTION
183 argument replaces this)."
184 (declare (debug t))
185 (let ((buffer (make-symbol "buffer"))
186 (window (make-symbol "window"))
187 (value (make-symbol "value")))
188 (macroexp-let2* nil ((vbuffer-or-name buffer-or-name)
189 (vaction action)
190 (vquit-function quit-function))
191 `(let* ((,buffer (temp-buffer-window-setup ,vbuffer-or-name))
192 (standard-output ,buffer)
193 ,window ,value)
194 (setq ,value (progn ,@body))
195 (with-current-buffer ,buffer
196 (setq ,window (temp-buffer-window-show ,buffer ,vaction)))
197
198 (if (functionp ,vquit-function)
199 (funcall ,vquit-function ,window ,value)
200 ,value)))))
201
202 (defmacro with-current-buffer-window (buffer-or-name action quit-function &rest body)
203 "Evaluate BODY with a buffer BUFFER-OR-NAME current and show that buffer.
204 This construct is like `with-temp-buffer-window' but unlike that
205 makes the buffer specified by BUFFER-OR-NAME current for running
206 BODY."
207 (declare (debug t))
208 (let ((buffer (make-symbol "buffer"))
209 (window (make-symbol "window"))
210 (value (make-symbol "value")))
211 (macroexp-let2* nil ((vbuffer-or-name buffer-or-name)
212 (vaction action)
213 (vquit-function quit-function))
214 `(let* ((,buffer (temp-buffer-window-setup ,vbuffer-or-name))
215 (standard-output ,buffer)
216 ,window ,value)
217 (with-current-buffer ,buffer
218 (setq ,value (progn ,@body))
219 (setq ,window (temp-buffer-window-show ,buffer ,vaction)))
220
221 (if (functionp ,vquit-function)
222 (funcall ,vquit-function ,window ,value)
223 ,value)))))
224
225 (defmacro with-displayed-buffer-window (buffer-or-name action quit-function &rest body)
226 "Show a buffer BUFFER-OR-NAME and evaluate BODY in that buffer.
227 This construct is like `with-current-buffer-window' but unlike that
228 displays the buffer specified by BUFFER-OR-NAME before running BODY."
229 (declare (debug t))
230 (let ((buffer (make-symbol "buffer"))
231 (window (make-symbol "window"))
232 (value (make-symbol "value")))
233 (macroexp-let2* nil ((vbuffer-or-name buffer-or-name)
234 (vaction action)
235 (vquit-function quit-function))
236 `(let* ((,buffer (temp-buffer-window-setup ,vbuffer-or-name))
237 (standard-output ,buffer)
238 ,window ,value)
239 (with-current-buffer ,buffer
240 (setq ,window (temp-buffer-window-show
241 ,buffer
242 ;; Remove window-height when it's handled below.
243 (if (functionp (cdr (assq 'window-height (cdr ,vaction))))
244 (assq-delete-all 'window-height (copy-sequence ,vaction))
245 ,vaction))))
246
247 (let ((inhibit-read-only t)
248 (inhibit-modification-hooks t))
249 (setq ,value (progn ,@body)))
250
251 (set-window-point ,window (point-min))
252
253 (when (functionp (cdr (assq 'window-height (cdr ,vaction))))
254 (ignore-errors
255 (funcall (cdr (assq 'window-height (cdr ,vaction))) ,window)))
256
257 (when (consp (cdr (assq 'preserve-size (cdr ,vaction))))
258 (window-preserve-size
259 ,window t (cadr (assq 'preserve-size (cdr ,vaction))))
260 (window-preserve-size
261 ,window nil (cddr (assq 'preserve-size (cdr ,vaction)))))
262
263 (if (functionp ,vquit-function)
264 (funcall ,vquit-function ,window ,value)
265 ,value)))))
266
267 ;; The following two functions are like `window-next-sibling' and
268 ;; `window-prev-sibling' but the WINDOW argument is _not_ optional (so
269 ;; they don't substitute the selected window for nil), and they return
270 ;; nil when WINDOW doesn't have a parent (like a frame's root window or
271 ;; a minibuffer window).
272 (defun window-right (window)
273 "Return WINDOW's right sibling.
274 Return nil if WINDOW is the root window of its frame. WINDOW can
275 be any window."
276 (and window (window-parent window) (window-next-sibling window)))
277
278 (defun window-left (window)
279 "Return WINDOW's left sibling.
280 Return nil if WINDOW is the root window of its frame. WINDOW can
281 be any window."
282 (and window (window-parent window) (window-prev-sibling window)))
283
284 (defun window-child (window)
285 "Return WINDOW's first child window.
286 WINDOW can be any window."
287 (or (window-top-child window) (window-left-child window)))
288
289 (defun window-child-count (window)
290 "Return number of WINDOW's child windows.
291 WINDOW can be any window."
292 (let ((count 0))
293 (when (and (windowp window) (setq window (window-child window)))
294 (while window
295 (setq count (1+ count))
296 (setq window (window-next-sibling window))))
297 count))
298
299 (defun window-last-child (window)
300 "Return last child window of WINDOW.
301 WINDOW can be any window."
302 (when (and (windowp window) (setq window (window-child window)))
303 (while (window-next-sibling window)
304 (setq window (window-next-sibling window))))
305 window)
306
307 (defun window-normalize-buffer (buffer-or-name)
308 "Return buffer specified by BUFFER-OR-NAME.
309 BUFFER-OR-NAME must be either a buffer or a string naming a live
310 buffer and defaults to the current buffer."
311 (cond
312 ((not buffer-or-name)
313 (current-buffer))
314 ((bufferp buffer-or-name)
315 (if (buffer-live-p buffer-or-name)
316 buffer-or-name
317 (error "Buffer %s is not a live buffer" buffer-or-name)))
318 ((get-buffer buffer-or-name))
319 (t
320 (error "No such buffer %s" buffer-or-name))))
321
322 (defun window-normalize-frame (frame)
323 "Return frame specified by FRAME.
324 FRAME must be a live frame and defaults to the selected frame."
325 (if frame
326 (if (frame-live-p frame)
327 frame
328 (error "%s is not a live frame" frame))
329 (selected-frame)))
330
331 (defun window-normalize-window (window &optional live-only)
332 "Return the window specified by WINDOW.
333 If WINDOW is nil, return the selected window. Otherwise, if
334 WINDOW is a live or an internal window, return WINDOW; if
335 LIVE-ONLY is non-nil, return WINDOW for a live window only.
336 Otherwise, signal an error."
337 (cond
338 ((null window)
339 (selected-window))
340 (live-only
341 (if (window-live-p window)
342 window
343 (error "%s is not a live window" window)))
344 ((window-valid-p window)
345 window)
346 (t
347 (error "%s is not a valid window" window))))
348
349 ;; Maybe this should go to frame.el.
350 (defun frame-char-size (&optional window-or-frame horizontal)
351 "Return the value of `frame-char-height' for WINDOW-OR-FRAME.
352 If WINDOW-OR-FRAME is a live frame, return the value of
353 `frame-char-height' for that frame. If WINDOW-OR-FRAME is a
354 valid window, return the value of `frame-char-height' for that
355 window's frame. In any other case, return the value of
356 `frame-char-height' for the selected frame.
357
358 Optional argument HORIZONTAL non-nil means to return the value of
359 `frame-char-width' for WINDOW-OR-FRAME."
360 (let ((frame
361 (cond
362 ((window-valid-p window-or-frame)
363 (window-frame window-or-frame))
364 ((frame-live-p window-or-frame)
365 window-or-frame)
366 (t (selected-frame)))))
367 (if horizontal
368 (frame-char-width frame)
369 (frame-char-height frame))))
370
371 (defvar ignore-window-parameters nil
372 "If non-nil, standard functions ignore window parameters.
373 The functions currently affected by this are `split-window',
374 `delete-window', `delete-other-windows' and `other-window'.
375
376 An application may bind this to a non-nil value around calls to
377 these functions to inhibit processing of window parameters.")
378
379 ;; This must go to C, finally (or get removed).
380 (defconst window-safe-min-height 1
381 "The absolute minimum number of lines of any window.
382 Anything less might crash Emacs.")
383
384 (defun window-safe-min-pixel-height (&optional window)
385 "Return the absolute minimum pixel height of WINDOW."
386 (* window-safe-min-height
387 (frame-char-size (window-normalize-window window))))
388
389 (defcustom window-min-height 4
390 "The minimum total height, in lines, of any window.
391 The value has to accommodate one text line, a mode and header
392 line, a horizontal scroll bar and a bottom divider, if present.
393 A value less than `window-safe-min-height' is ignored. The value
394 of this variable is honored when windows are resized or split.
395
396 Applications should never rebind this variable. To resize a
397 window to a height less than the one specified here, an
398 application should instead call `window-resize' with a non-nil
399 IGNORE argument. In order to have `split-window' make a window
400 shorter, explicitly specify the SIZE argument of that function."
401 :type 'integer
402 :version "24.1"
403 :group 'windows)
404
405 (defun window-min-pixel-height (&optional window)
406 "Return the minimum pixel height of window WINDOW."
407 (* (max window-min-height window-safe-min-height)
408 (frame-char-size window)))
409
410 ;; This must go to C, finally (or get removed).
411 (defconst window-safe-min-width 2
412 "The absolute minimum number of columns of a window.
413 Anything less might crash Emacs.")
414
415 (defun window-safe-min-pixel-width (&optional window)
416 "Return the absolute minimum pixel width of WINDOW."
417 (* window-safe-min-width
418 (frame-char-size (window-normalize-window window) t)))
419
420 (defcustom window-min-width 10
421 "The minimum total width, in columns, of any window.
422 The value has to accommodate two text columns as well as margins,
423 fringes, a scroll bar and a right divider, if present. A value
424 less than `window-safe-min-width' is ignored. The value of this
425 variable is honored when windows are resized or split.
426
427 Applications should never rebind this variable. To resize a
428 window to a width less than the one specified here, an
429 application should instead call `window-resize' with a non-nil
430 IGNORE argument. In order to have `split-window' make a window
431 narrower, explicitly specify the SIZE argument of that function."
432 :type 'integer
433 :version "24.1"
434 :group 'windows)
435
436 (defun window-min-pixel-width (&optional window)
437 "Return the minimum pixel width of window WINDOW."
438 (* (max window-min-width window-safe-min-width)
439 (frame-char-size window t)))
440
441 (defun window-safe-min-pixel-size (&optional window horizontal)
442 "Return the absolute minimum pixel height of WINDOW.
443 Optional argument HORIZONTAL non-nil means return the absolute
444 minimum pixel width of WINDOW."
445 (if horizontal
446 (window-safe-min-pixel-width window)
447 (window-safe-min-pixel-height window)))
448
449 (defun window-min-pixel-size (&optional window horizontal)
450 "Return the minimum pixel height of WINDOW.
451 Optional argument HORIZONTAL non-nil means return the minimum
452 pixel width of WINDOW."
453 (if horizontal
454 (window-min-pixel-width window)
455 (window-min-pixel-height window)))
456
457 (defun window-combined-p (&optional window horizontal)
458 "Return non-nil if WINDOW has siblings in a given direction.
459 WINDOW must be a valid window and defaults to the selected one.
460
461 HORIZONTAL determines a direction for the window combination. If
462 HORIZONTAL is omitted or nil, return non-nil if WINDOW is part of
463 a vertical window combination. If HORIZONTAL is non-nil, return
464 non-nil if WINDOW is part of a horizontal window combination."
465 (setq window (window-normalize-window window))
466 (let ((parent (window-parent window)))
467 (and parent
468 (if horizontal
469 (window-left-child parent)
470 (window-top-child parent)))))
471
472 (defun window-combination-p (&optional window horizontal)
473 "Return WINDOW's first child if WINDOW is a vertical combination.
474 WINDOW can be any window and defaults to the selected one.
475 Optional argument HORIZONTAL non-nil means return WINDOW's first
476 child if WINDOW is a horizontal combination."
477 (setq window (window-normalize-window window))
478 (if horizontal
479 (window-left-child window)
480 (window-top-child window)))
481
482 (defun window-combinations (window &optional horizontal)
483 "Return largest number of windows vertically arranged within WINDOW.
484 WINDOW must be a valid window and defaults to the selected one.
485 If HORIZONTAL is non-nil, return the largest number of
486 windows horizontally arranged within WINDOW."
487 (setq window (window-normalize-window window))
488 (cond
489 ((window-live-p window)
490 ;; If WINDOW is live, return 1.
491 1)
492 ((if horizontal
493 (window-left-child window)
494 (window-top-child window))
495 ;; If WINDOW is iso-combined, return the sum of the values for all
496 ;; child windows of WINDOW.
497 (let ((child (window-child window))
498 (count 0))
499 (while child
500 (setq count
501 (+ (window-combinations child horizontal)
502 count))
503 (setq child (window-right child)))
504 count))
505 (t
506 ;; If WINDOW is not iso-combined, return the maximum value of any
507 ;; child window of WINDOW.
508 (let ((child (window-child window))
509 (count 1))
510 (while child
511 (setq count
512 (max (window-combinations child horizontal)
513 count))
514 (setq child (window-right child)))
515 count))))
516
517 (defun walk-window-tree-1 (fun walk-window-tree-window any &optional sub-only)
518 "Helper function for `walk-window-tree' and `walk-window-subtree'."
519 (let (walk-window-tree-buffer)
520 (while walk-window-tree-window
521 (setq walk-window-tree-buffer
522 (window-buffer walk-window-tree-window))
523 (when (or walk-window-tree-buffer any)
524 (funcall fun walk-window-tree-window))
525 (unless walk-window-tree-buffer
526 (walk-window-tree-1
527 fun (window-left-child walk-window-tree-window) any)
528 (walk-window-tree-1
529 fun (window-top-child walk-window-tree-window) any))
530 (if sub-only
531 (setq walk-window-tree-window nil)
532 (setq walk-window-tree-window
533 (window-right walk-window-tree-window))))))
534
535 (defun walk-window-tree (fun &optional frame any minibuf)
536 "Run function FUN on each live window of FRAME.
537 FUN must be a function with one argument - a window. FRAME must
538 be a live frame and defaults to the selected one. ANY, if
539 non-nil, means to run FUN on all live and internal windows of
540 FRAME.
541
542 Optional argument MINIBUF t means run FUN on FRAME's minibuffer
543 window even if it isn't active. MINIBUF nil or omitted means run
544 FUN on FRAME's minibuffer window only if it's active. In both
545 cases the minibuffer window must be part of FRAME. MINIBUF
546 neither nil nor t means never run FUN on the minibuffer window.
547
548 This function performs a pre-order, depth-first traversal of the
549 window tree. If FUN changes the window tree, the result is
550 unpredictable."
551 (setq frame (window-normalize-frame frame))
552 (walk-window-tree-1 fun (frame-root-window frame) any)
553 (when (memq minibuf '(nil t))
554 ;; Run FUN on FRAME's minibuffer window if requested.
555 (let ((minibuffer-window (minibuffer-window frame)))
556 (when (and (window-live-p minibuffer-window)
557 (eq (window-frame minibuffer-window) frame)
558 (or (eq minibuf t)
559 (minibuffer-window-active-p minibuffer-window)))
560 (funcall fun minibuffer-window)))))
561
562 (defun walk-window-subtree (fun &optional window any)
563 "Run function FUN on the subtree of windows rooted at WINDOW.
564 WINDOW defaults to the selected window. FUN must be a function
565 with one argument - a window. By default, run FUN only on live
566 windows of the subtree. If the optional argument ANY is non-nil,
567 run FUN on all live and internal windows of the subtree. If
568 WINDOW is live, run FUN on WINDOW only.
569
570 This function performs a pre-order, depth-first traversal of the
571 subtree rooted at WINDOW. If FUN changes that tree, the result
572 is unpredictable."
573 (setq window (window-normalize-window window))
574 (walk-window-tree-1 fun window any t))
575
576 (defun window-with-parameter (parameter &optional value frame any minibuf)
577 "Return first window on FRAME with PARAMETER non-nil.
578 FRAME defaults to the selected frame. Optional argument VALUE
579 non-nil means only return a window whose window-parameter value
580 for PARAMETER equals VALUE (comparison is done with `equal').
581 Optional argument ANY non-nil means consider internal windows
582 too.
583
584 Optional argument MINIBUF t means consider FRAME's minibuffer
585 window even if it isn't active. MINIBUF nil or omitted means
586 consider FRAME's minibuffer window only if it's active. In both
587 cases the minibuffer window must be part of FRAME. MINIBUF
588 neither nil nor t means never consider the minibuffer window."
589 (let (this-value)
590 (catch 'found
591 (walk-window-tree
592 (lambda (window)
593 (when (and (setq this-value (window-parameter window parameter))
594 (or (not value) (equal value this-value)))
595 (throw 'found window)))
596 frame any minibuf))))
597
598 ;;; Atomic windows.
599 (defun window-atom-root (&optional window)
600 "Return root of atomic window WINDOW is a part of.
601 WINDOW must be a valid window and defaults to the selected one.
602 Return nil if WINDOW is not part of an atomic window."
603 (setq window (window-normalize-window window))
604 (let (root)
605 (while (and window (window-parameter window 'window-atom))
606 (setq root window)
607 (setq window (window-parent window)))
608 root))
609
610 (defun window-make-atom (window)
611 "Make WINDOW an atomic window.
612 WINDOW must be an internal window. Return WINDOW."
613 (if (not (window-child window))
614 (error "Window %s is not an internal window" window)
615 (walk-window-subtree
616 (lambda (window)
617 (unless (window-parameter window 'window-atom)
618 (set-window-parameter window 'window-atom t)))
619 window t)
620 window))
621
622 (defun display-buffer-in-atom-window (buffer alist)
623 "Display BUFFER in an atomic window.
624 This function displays BUFFER in a new window that will be
625 combined with an existing window to form an atomic window. If
626 the existing window is already part of an atomic window, add the
627 new window to that atomic window. Operations like `split-window'
628 or `delete-window', when applied to a constituent of an atomic
629 window, are applied atomically to the root of that atomic window.
630
631 ALIST is an association list of symbols and values. The
632 following symbols can be used.
633
634 `window' specifies the existing window the new window shall be
635 combined with. Use `window-atom-root' to make the new window a
636 sibling of an atomic window's root. If an internal window is
637 specified here, all children of that window become part of the
638 atomic window too. If no window is specified, the new window
639 becomes a sibling of the selected window. By default, the
640 `window-atom' parameter of the existing window is set to `main'
641 provided it is live and was not set before.
642
643 `side' denotes the side of the existing window where the new
644 window shall be located. Valid values are `below', `right',
645 `above' and `left'. The default is `below'. By default, the
646 `window-atom' parameter of the new window is set to this value.
647
648 The return value is the new window, nil when creating that window
649 failed."
650 (let* ((ignore-window-parameters t)
651 (window-combination-limit t)
652 (window-combination-resize 'atom)
653 (window (cdr (assq 'window alist)))
654 (side (cdr (assq 'side alist)))
655 (atom (when window (window-parameter window 'window-atom)))
656 root new)
657 (setq window (window-normalize-window window))
658 (setq root (window-atom-root window))
659 ;; Split off new window.
660 (when (setq new (split-window window nil side))
661 (window-make-atom
662 (if (and root (not (eq root window)))
663 ;; When WINDOW was part of an atomic window and we did not
664 ;; split its root, root atomic window at old root.
665 root
666 ;; Otherwise, root atomic window at WINDOW's new parent.
667 (window-parent window)))
668 ;; Assign `window-atom' parameters, if needed.
669 (when (and (not atom) (window-live-p window))
670 (set-window-parameter window 'window-atom 'main))
671 (set-window-parameter new 'window-atom side)
672 ;; Display BUFFER in NEW and return NEW.
673 (window--display-buffer
674 buffer new 'window alist display-buffer-mark-dedicated))))
675
676 (defun window--atom-check-1 (window)
677 "Subroutine of `window--atom-check'."
678 (when window
679 (if (window-parameter window 'window-atom)
680 (let ((count 0))
681 (when (or (catch 'reset
682 (walk-window-subtree
683 (lambda (window)
684 (if (window-parameter window 'window-atom)
685 (setq count (1+ count))
686 (throw 'reset t)))
687 window t))
688 ;; count >= 1 must hold here. If there's no other
689 ;; window around dissolve this atomic window.
690 (= count 1))
691 ;; Dissolve atomic window.
692 (walk-window-subtree
693 (lambda (window)
694 (set-window-parameter window 'window-atom nil))
695 window t)))
696 ;; Check children.
697 (unless (window-buffer window)
698 (window--atom-check-1 (window-left-child window))
699 (window--atom-check-1 (window-top-child window))))
700 ;; Check right sibling
701 (window--atom-check-1 (window-right window))))
702
703 (defun window--atom-check (&optional frame)
704 "Check atomicity of all windows on FRAME.
705 FRAME defaults to the selected frame. If an atomic window is
706 wrongly configured, reset the atomicity of all its windows on
707 FRAME to nil. An atomic window is wrongly configured if it has
708 no child windows or one of its child windows is not atomic."
709 (window--atom-check-1 (frame-root-window frame)))
710
711 ;; Side windows.
712 (defvar window-sides '(left top right bottom)
713 "Window sides.")
714
715 (defcustom window-sides-vertical nil
716 "If non-nil, left and right side windows are full height.
717 Otherwise, top and bottom side windows are full width."
718 :type 'boolean
719 :group 'windows
720 :version "24.1")
721
722 (defcustom window-sides-slots '(nil nil nil nil)
723 "Maximum number of side window slots.
724 The value is a list of four elements specifying the number of
725 side window slots on (in this order) the left, top, right and
726 bottom side of each frame. If an element is a number, this means
727 to display at most that many side windows on the corresponding
728 side. If an element is nil, this means there's no bound on the
729 number of slots on that side."
730 :version "24.1"
731 :risky t
732 :type
733 '(list
734 :value (nil nil nil nil)
735 (choice
736 :tag "Left"
737 :help-echo "Maximum slots of left side window."
738 :value nil
739 :format "%[Left%] %v\n"
740 (const :tag "Unlimited" :format "%t" nil)
741 (integer :tag "Number" :value 2 :size 5))
742 (choice
743 :tag "Top"
744 :help-echo "Maximum slots of top side window."
745 :value nil
746 :format "%[Top%] %v\n"
747 (const :tag "Unlimited" :format "%t" nil)
748 (integer :tag "Number" :value 3 :size 5))
749 (choice
750 :tag "Right"
751 :help-echo "Maximum slots of right side window."
752 :value nil
753 :format "%[Right%] %v\n"
754 (const :tag "Unlimited" :format "%t" nil)
755 (integer :tag "Number" :value 2 :size 5))
756 (choice
757 :tag "Bottom"
758 :help-echo "Maximum slots of bottom side window."
759 :value nil
760 :format "%[Bottom%] %v\n"
761 (const :tag "Unlimited" :format "%t" nil)
762 (integer :tag "Number" :value 3 :size 5)))
763 :group 'windows)
764
765 (defun window--side-window-p (window)
766 "Return non-nil if WINDOW is a side window or the parent of one."
767 (or (window-parameter window 'window-side)
768 (and (window-child window)
769 (or (window-parameter
770 (window-child window) 'window-side)
771 (window-parameter
772 (window-last-child window) 'window-side)))))
773
774 (defun window--major-non-side-window (&optional frame)
775 "Return the major non-side window of frame FRAME.
776 The optional argument FRAME must be a live frame and defaults to
777 the selected one.
778
779 If FRAME has at least one side window, the major non-side window
780 is either an internal non-side window such that all other
781 non-side windows on FRAME descend from it, or the single live
782 non-side window of FRAME. If FRAME has no side windows, return
783 its root window."
784 (let ((frame (window-normalize-frame frame))
785 major sibling)
786 ;; Set major to the _last_ window found by `walk-window-tree' that
787 ;; is not a side window but has a side window as its sibling.
788 (walk-window-tree
789 (lambda (window)
790 (and (not (window-parameter window 'window-side))
791 (or (and (setq sibling (window-prev-sibling window))
792 (window-parameter sibling 'window-side))
793 (and (setq sibling (window-next-sibling window))
794 (window-parameter sibling 'window-side)))
795 (setq major window)))
796 frame t 'nomini)
797 (or major (frame-root-window frame))))
798
799 (defun window--major-side-window (side)
800 "Return major side window on SIDE.
801 SIDE must be one of the symbols `left', `top', `right' or
802 `bottom'. Return nil if no such window exists."
803 (let ((root (frame-root-window))
804 window)
805 ;; (1) If a window on the opposite side exists, return that window's
806 ;; sibling.
807 ;; (2) If the new window shall span the entire side, return the
808 ;; frame's root window.
809 ;; (3) If a window on an orthogonal side exists, return that
810 ;; window's sibling.
811 ;; (4) Otherwise return the frame's root window.
812 (cond
813 ((or (and (eq side 'left)
814 (setq window (window-with-parameter 'window-side 'right nil t)))
815 (and (eq side 'top)
816 (setq window (window-with-parameter 'window-side 'bottom nil t))))
817 (window-prev-sibling window))
818 ((or (and (eq side 'right)
819 (setq window (window-with-parameter 'window-side 'left nil t)))
820 (and (eq side 'bottom)
821 (setq window (window-with-parameter 'window-side 'top nil t))))
822 (window-next-sibling window))
823 ((memq side '(left right))
824 (cond
825 (window-sides-vertical
826 root)
827 ((setq window (window-with-parameter 'window-side 'top nil t))
828 (window-next-sibling window))
829 ((setq window (window-with-parameter 'window-side 'bottom nil t))
830 (window-prev-sibling window))
831 (t root)))
832 ((memq side '(top bottom))
833 (cond
834 ((not window-sides-vertical)
835 root)
836 ((setq window (window-with-parameter 'window-side 'left nil t))
837 (window-next-sibling window))
838 ((setq window (window-with-parameter 'window-side 'right nil t))
839 (window-prev-sibling window))
840 (t root))))))
841
842 (defun display-buffer-in-major-side-window (buffer side slot &optional alist)
843 "Display BUFFER in a new window on SIDE of the selected frame.
844 SIDE must be one of `left', `top', `right' or `bottom'. SLOT
845 specifies the slot to use. ALIST is an association list of
846 symbols and values as passed to `display-buffer-in-side-window'.
847 This function may be called only if no window on SIDE exists yet.
848 The new window automatically becomes the \"major\" side window on
849 SIDE. Return the new window, nil if its creation window failed."
850 (let* ((left-or-right (memq side '(left right)))
851 (major (window--major-side-window side))
852 (on-side (cond
853 ((eq side 'top) 'above)
854 ((eq side 'bottom) 'below)
855 (t side)))
856 ;; The following two bindings will tell `split-window' to take
857 ;; the space for the new window from `major' and not make a new
858 ;; parent window unless needed.
859 (window-combination-resize 'side)
860 (window-combination-limit nil)
861 (new (split-window major nil on-side)))
862 (when new
863 ;; Initialize `window-side' parameter of new window to SIDE.
864 (set-window-parameter new 'window-side side)
865 ;; Install `window-slot' parameter of new window.
866 (set-window-parameter new 'window-slot slot)
867 ;; Install `delete-window' parameter thus making sure that when
868 ;; the new window is deleted, a side window on the opposite side
869 ;; does not get resized.
870 (set-window-parameter new 'delete-window 'delete-side-window)
871 ;; Auto-adjust height/width of new window unless a size has been
872 ;; explicitly requested.
873 (unless (if left-or-right
874 (cdr (assq 'window-width alist))
875 (cdr (assq 'window-height alist)))
876 (setq alist
877 (cons
878 (cons
879 (if left-or-right 'window-width 'window-height)
880 (/ (window-total-size (frame-root-window) left-or-right)
881 ;; By default use a fourth of the size of the frame's
882 ;; root window.
883 4))
884 alist)))
885 ;; Install BUFFER in new window and return NEW.
886 (window--display-buffer buffer new 'window alist 'side))))
887
888 (defun delete-side-window (window)
889 "Delete side window WINDOW."
890 (let ((window-combination-resize
891 (window-parameter (window-parent window) 'window-side))
892 (ignore-window-parameters t))
893 (delete-window window)))
894
895 (defun display-buffer-in-side-window (buffer alist)
896 "Display BUFFER in a side window of the selected frame.
897 ALIST is an association list of symbols and values. The
898 following special symbols can be used in ALIST.
899
900 `side' denotes the side of the frame where the new window shall
901 be located. Valid values are `bottom', `right', `top' and
902 `left'. The default is `bottom'.
903
904 `slot' if non-nil, specifies the window slot where to display
905 BUFFER. A value of zero or nil means use the middle slot on
906 the specified side. A negative value means use a slot
907 preceding (that is, above or on the left of) the middle slot.
908 A positive value means use a slot following (that is, below or
909 on the right of) the middle slot. The default is zero."
910 (let ((side (or (cdr (assq 'side alist)) 'bottom))
911 (slot (or (cdr (assq 'slot alist)) 0)))
912 (cond
913 ((not (memq side '(top bottom left right)))
914 (error "Invalid side %s specified" side))
915 ((not (numberp slot))
916 (error "Invalid slot %s specified" slot)))
917
918 (let* ((major (window-with-parameter 'window-side side nil t))
919 ;; `major' is the major window on SIDE, `windows' the list of
920 ;; life windows on SIDE.
921 (windows
922 (when major
923 (let (windows)
924 (walk-window-tree
925 (lambda (window)
926 (when (eq (window-parameter window 'window-side) side)
927 (setq windows (cons window windows))))
928 nil nil 'nomini)
929 (nreverse windows))))
930 (slots (when major (max 1 (window-child-count major))))
931 (max-slots
932 (nth (cond
933 ((eq side 'left) 0)
934 ((eq side 'top) 1)
935 ((eq side 'right) 2)
936 ((eq side 'bottom) 3))
937 window-sides-slots))
938 window this-window this-slot prev-window next-window
939 best-window best-slot abs-slot)
940
941 (cond
942 ((and (numberp max-slots) (<= max-slots 0))
943 ;; No side-slots available on this side. Don't create an error,
944 ;; just return nil.
945 nil)
946 ((not windows)
947 ;; No major window exists on this side, make one.
948 (display-buffer-in-major-side-window buffer side slot alist))
949 (t
950 ;; Scan windows on SIDE.
951 (catch 'found
952 (dolist (window windows)
953 (setq this-slot (window-parameter window 'window-slot))
954 (cond
955 ;; The following should not happen and probably be checked
956 ;; by window--side-check.
957 ((not (numberp this-slot)))
958 ((= this-slot slot)
959 ;; A window with a matching slot has been found.
960 (setq this-window window)
961 (throw 'found t))
962 (t
963 ;; Check if this window has a better slot value wrt the
964 ;; slot of the window we want.
965 (setq abs-slot
966 (if (or (and (> this-slot 0) (> slot 0))
967 (and (< this-slot 0) (< slot 0)))
968 (abs (- slot this-slot))
969 (+ (abs slot) (abs this-slot))))
970 (unless (and best-slot (<= best-slot abs-slot))
971 (setq best-window window)
972 (setq best-slot abs-slot))
973 (cond
974 ((<= this-slot slot)
975 (setq prev-window window))
976 ((not next-window)
977 (setq next-window window)))))))
978
979 ;; `this-window' is the first window with the same SLOT.
980 ;; `prev-window' is the window with the largest slot < SLOT. A new
981 ;; window will be created after it.
982 ;; `next-window' is the window with the smallest slot > SLOT. A new
983 ;; window will be created before it.
984 ;; `best-window' is the window with the smallest absolute difference
985 ;; of its slot and SLOT.
986
987 ;; Note: We dedicate the window used softly to its buffer to
988 ;; avoid that "other" (non-side) buffer display functions steal
989 ;; it from us. This must eventually become customizable via
990 ;; ALIST (or, better, avoided in the "other" functions).
991 (or (and this-window
992 ;; Reuse `this-window'.
993 (window--display-buffer buffer this-window 'reuse alist 'side))
994 (and (or (not max-slots) (< slots max-slots))
995 (or (and next-window
996 ;; Make new window before `next-window'.
997 (let ((next-side
998 (if (memq side '(left right)) 'above 'left))
999 (window-combination-resize 'side))
1000 (setq window (split-window next-window nil next-side))
1001 ;; When the new window is deleted, its space
1002 ;; is returned to other side windows.
1003 (set-window-parameter
1004 window 'delete-window 'delete-side-window)
1005 window))
1006 (and prev-window
1007 ;; Make new window after `prev-window'.
1008 (let ((prev-side
1009 (if (memq side '(left right)) 'below 'right))
1010 (window-combination-resize 'side))
1011 (setq window (split-window prev-window nil prev-side))
1012 ;; When the new window is deleted, its space
1013 ;; is returned to other side windows.
1014 (set-window-parameter
1015 window 'delete-window 'delete-side-window)
1016 window)))
1017 (set-window-parameter window 'window-slot slot)
1018 (window--display-buffer buffer window 'window alist 'side))
1019 (and best-window
1020 ;; Reuse `best-window'.
1021 (progn
1022 ;; Give best-window the new slot value.
1023 (set-window-parameter best-window 'window-slot slot)
1024 (window--display-buffer
1025 buffer best-window 'reuse alist 'side)))))))))
1026
1027 (defun window--side-check (&optional frame)
1028 "Check the side window configuration of FRAME.
1029 FRAME defaults to the selected frame.
1030
1031 A valid side window configuration preserves the following two
1032 invariants:
1033
1034 - If there exists a window whose window-side parameter is
1035 non-nil, there must exist at least one live window whose
1036 window-side parameter is nil.
1037
1038 - If a window W has a non-nil window-side parameter (i) it must
1039 have a parent window and that parent's window-side parameter
1040 must be either nil or the same as for W, and (ii) any child
1041 window of W must have the same window-side parameter as W.
1042
1043 If the configuration is invalid, reset the window-side parameters
1044 of all windows on FRAME to nil."
1045 (let (left top right bottom none side parent parent-side)
1046 (when (or (catch 'reset
1047 (walk-window-tree
1048 (lambda (window)
1049 (setq side (window-parameter window 'window-side))
1050 (setq parent (window-parent window))
1051 (setq parent-side
1052 (and parent (window-parameter parent 'window-side)))
1053 ;; The following `cond' seems a bit tedious, but I'd
1054 ;; rather stick to using just the stack.
1055 (cond
1056 (parent-side
1057 (when (not (eq parent-side side))
1058 ;; A parent whose window-side is non-nil must
1059 ;; have a child with the same window-side.
1060 (throw 'reset t)))
1061 ((not side)
1062 (when (window-buffer window)
1063 ;; Record that we have at least one non-side,
1064 ;; live window.
1065 (setq none t)))
1066 ((if (memq side '(left top))
1067 (window-prev-sibling window)
1068 (window-next-sibling window))
1069 ;; Left and top major side windows must not have a
1070 ;; previous sibling, right and bottom major side
1071 ;; windows must not have a next sibling.
1072 (throw 'reset t))
1073 ;; Now check that there's no more than one major
1074 ;; window for any of left, top, right and bottom.
1075 ((eq side 'left)
1076 (if left (throw 'reset t) (setq left t)))
1077 ((eq side 'top)
1078 (if top (throw 'reset t) (setq top t)))
1079 ((eq side 'right)
1080 (if right (throw 'reset t) (setq right t)))
1081 ((eq side 'bottom)
1082 (if bottom (throw 'reset t) (setq bottom t)))
1083 (t
1084 (throw 'reset t))))
1085 frame t 'nomini))
1086 ;; If there's a side window, there must be at least one
1087 ;; non-side window.
1088 (and (or left top right bottom) (not none)))
1089 (walk-window-tree
1090 (lambda (window)
1091 (set-window-parameter window 'window-side nil))
1092 frame t 'nomini))))
1093
1094 (defun window--check (&optional frame)
1095 "Check atomic and side windows on FRAME.
1096 FRAME defaults to the selected frame."
1097 (window--side-check frame)
1098 (window--atom-check frame))
1099
1100 ;; Dumping frame/window contents.
1101 (defun window--dump-window (&optional window erase)
1102 "Dump WINDOW to buffer *window-frame-dump*.
1103 WINDOW must be a valid window and defaults to the selected one.
1104 Optional argument ERASE non-nil means erase *window-frame-dump*
1105 before writing to it."
1106 (setq window (window-normalize-window window))
1107 (with-current-buffer (get-buffer-create "*window-frame-dump*")
1108 (when erase (erase-buffer))
1109 (insert
1110 (format "%s parent: %s\n" window (window-parent window))
1111 (format "pixel left: %s top: %s size: %s x %s new: %s\n"
1112 (window-pixel-left window) (window-pixel-top window)
1113 (window-size window t t) (window-size window nil t)
1114 (window-new-pixel window))
1115 (format "char left: %s top: %s size: %s x %s new: %s\n"
1116 (window-left-column window) (window-top-line window)
1117 (window-total-size window t) (window-total-size window)
1118 (window-new-total window))
1119 (format "normal: %s x %s new: %s\n"
1120 (window-normal-size window t) (window-normal-size window)
1121 (window-new-normal window)))
1122 (when (window-live-p window)
1123 (let ((fringes (window-fringes window))
1124 (margins (window-margins window)))
1125 (insert
1126 (format "body pixel: %s x %s char: %s x %s\n"
1127 (window-body-width window t) (window-body-height window t)
1128 (window-body-width window) (window-body-height window))
1129 (format "width left fringe: %s left margin: %s right margin: %s\n"
1130 (car fringes) (or (car margins) 0) (or (cdr margins) 0))
1131 (format "width right fringe: %s scroll-bar: %s divider: %s\n"
1132 (cadr fringes)
1133 (window-scroll-bar-width window)
1134 (window-right-divider-width window))
1135 (format "height header-line: %s mode-line: %s divider: %s\n"
1136 (window-header-line-height window)
1137 (window-mode-line-height window)
1138 (window-bottom-divider-width window)))))
1139 (insert "\n")))
1140
1141 (defun window--dump-frame (&optional window-or-frame)
1142 "Dump WINDOW-OR-FRAME to buffer *window-frame-dump*.
1143 WINDOW-OR-FRAME can be a frame or a window and defaults to the
1144 selected frame. When WINDOW-OR-FRAME is a window, dump that
1145 window's frame. The buffer *window-frame-dump* is erased before
1146 dumping to it."
1147 (let* ((window
1148 (cond
1149 ((or (not window-or-frame)
1150 (frame-live-p window-or-frame))
1151 (frame-root-window window-or-frame))
1152 ((or (window-live-p window-or-frame)
1153 (window-child window-or-frame))
1154 window-or-frame)
1155 (t
1156 (frame-root-window))))
1157 (frame (window-frame window)))
1158 (with-current-buffer (get-buffer-create "*window-frame-dump*")
1159 (erase-buffer)
1160 (insert
1161 (format "frame pixel: %s x %s cols/lines: %s x %s units: %s x %s\n"
1162 (frame-pixel-width frame) (frame-pixel-height frame)
1163 (frame-total-cols frame) (frame-total-lines frame)
1164 (frame-char-width frame) (frame-char-height frame))
1165 (format "frame text pixel: %s x %s cols/lines: %s x %s\n"
1166 (frame-text-width frame) (frame-text-height frame)
1167 (frame-text-cols frame) (frame-text-lines frame))
1168 (format "tool: %s scroll: %s/%s fringe: %s border: %s right: %s bottom: %s\n\n"
1169 (if (fboundp 'tool-bar-height)
1170 (tool-bar-height frame t)
1171 "0")
1172 (frame-scroll-bar-width frame)
1173 (frame-scroll-bar-height frame)
1174 (frame-fringe-width frame)
1175 (frame-border-width frame)
1176 (frame-right-divider-width frame)
1177 (frame-bottom-divider-width frame)))
1178 (walk-window-tree 'window--dump-window frame t t))))
1179
1180 ;;; Window sizes.
1181 (defun window-total-size (&optional window horizontal round)
1182 "Return the total height or width of WINDOW.
1183 WINDOW must be a valid window and defaults to the selected one.
1184
1185 If HORIZONTAL is omitted or nil, return the total height of
1186 WINDOW, in lines. If WINDOW is live, its total height includes,
1187 in addition to the height of WINDOW's text, the heights of
1188 WINDOW's mode and header line and a bottom divider, if any.
1189
1190 If HORIZONTAL is non-nil, return the total width of WINDOW, in
1191 columns. If WINDOW is live, its total width includes, in
1192 addition to the width of WINDOW's text, the widths of WINDOW's
1193 fringes, margins, scroll bars and its right divider, if any.
1194
1195 If WINDOW is internal, return the respective size of the screen
1196 areas spanned by its children.
1197
1198 Optional argument ROUND is handled as for `window-total-height'
1199 and `window-total-width'."
1200 (if horizontal
1201 (window-total-width window round)
1202 (window-total-height window round)))
1203
1204 (defun window-size (&optional window horizontal pixelwise round)
1205 "Return the height or width of WINDOW.
1206 WINDOW must be a valid window and defaults to the selected one.
1207
1208 If HORIZONTAL is omitted or nil, return the total height of
1209 WINDOW, in lines, like `window-total-height'. Otherwise return
1210 the total width, in columns, like `window-total-width'.
1211
1212 Optional argument PIXELWISE means return the pixel size of WINDOW
1213 like `window-pixel-height' and `window-pixel-width'.
1214
1215 Optional argument ROUND is ignored if PIXELWISE is non-nil and
1216 handled as for `window-total-height' and `window-total-width'
1217 otherwise."
1218 (if horizontal
1219 (if pixelwise
1220 (window-pixel-width window)
1221 (window-total-width window round))
1222 (if pixelwise
1223 (window-pixel-height window)
1224 (window-total-height window round))))
1225
1226 (defvar window-size-fixed nil
1227 "Non-nil in a buffer means windows displaying the buffer are fixed-size.
1228 If the value is `height', then only the window's height is fixed.
1229 If the value is `width', then only the window's width is fixed.
1230 Any other non-nil value fixes both the width and the height.
1231
1232 Emacs won't change the size of any window displaying that buffer,
1233 unless it has no other choice (like when deleting a neighboring
1234 window).")
1235 (make-variable-buffer-local 'window-size-fixed)
1236
1237 (defun window--preservable-size (window &optional horizontal)
1238 "Return height of WINDOW as `window-preserve-size' would preserve it.
1239 Optional argument HORIZONTAL non-nil means to return the width of
1240 WINDOW as `window-preserve-size' would preserve it."
1241 (if horizontal
1242 (window-body-width window t)
1243 (+ (window-body-height window t)
1244 (window-header-line-height window)
1245 (window-mode-line-height window))))
1246
1247 (defun window-preserve-size (&optional window horizontal preserve)
1248 "Preserve height of window WINDOW.
1249 WINDOW must be a live window and defaults to the selected one.
1250 Optional argument HORIZONTAL non-nil means preserve the width of
1251 WINDOW.
1252
1253 PRESERVE t means to preserve the current height/width of WINDOW's
1254 body in frame and window resizing operations whenever possible.
1255 The height/width of WINDOW will change only if Emacs has no other
1256 choice. Resizing a window whose height/width is preserved never
1257 throws an error.
1258
1259 PRESERVE nil means to stop preserving the height/width of WINDOW,
1260 lifting the respective restraint induced by a previous call of
1261 `window-preserve-size' for WINDOW. Calling `enlarge-window',
1262 `shrink-window', `split-window' or `fit-window-to-buffer' with
1263 WINDOW as argument also removes the respective restraint.
1264
1265 Other values of PRESERVE are reserved for future use."
1266 (setq window (window-normalize-window window t))
1267 (let* ((parameter (window-parameter window 'window-preserved-size))
1268 (width (nth 1 parameter))
1269 (height (nth 2 parameter)))
1270 (if horizontal
1271 (set-window-parameter
1272 window 'window-preserved-size
1273 (list
1274 (window-buffer window)
1275 (and preserve (window--preservable-size window t))
1276 height))
1277 (set-window-parameter
1278 window 'window-preserved-size
1279 (list
1280 (window-buffer window)
1281 width
1282 (and preserve (window--preservable-size window)))))))
1283
1284 (defun window-preserved-size (&optional window horizontal)
1285 "Return preserved height of window WINDOW.
1286 WINDOW must be a live window and defaults to the selected one.
1287 Optional argument HORIZONTAL non-nil means to return preserved
1288 width of WINDOW."
1289 (setq window (window-normalize-window window t))
1290 (let* ((parameter (window-parameter window 'window-preserved-size))
1291 (buffer (nth 0 parameter))
1292 (width (nth 1 parameter))
1293 (height (nth 2 parameter)))
1294 (when (eq buffer (window-buffer window))
1295 (if horizontal width height))))
1296
1297 (defun window--preserve-size (window horizontal)
1298 "Return non-nil when the height of WINDOW shall be preserved.
1299 Optional argument HORIZONTAL non-nil means to return non-nil when
1300 the width of WINDOW shall be preserved."
1301 (let ((size (window-preserved-size window horizontal)))
1302 (and (numberp size)
1303 (= size (window--preservable-size window horizontal)))))
1304
1305 (defun window-safe-min-size (&optional window horizontal pixelwise)
1306 "Return safe minimum size of WINDOW.
1307 WINDOW must be a valid window and defaults to the selected one.
1308 Optional argument HORIZONTAL non-nil means return the minimum
1309 number of columns of WINDOW; otherwise return the minimum number
1310 of WINDOW's lines.
1311
1312 Optional argument PIXELWISE non-nil means return the minimum pixel-size
1313 of WINDOW."
1314 (setq window (window-normalize-window window))
1315 (if pixelwise
1316 (if horizontal
1317 (* window-safe-min-width
1318 (frame-char-width (window-frame window)))
1319 (* window-safe-min-height
1320 (frame-char-height (window-frame window))))
1321 (if horizontal window-safe-min-width window-safe-min-height)))
1322
1323 (defun window-min-size (&optional window horizontal ignore pixelwise)
1324 "Return the minimum size of WINDOW.
1325 WINDOW must be a valid window and defaults to the selected one.
1326 Optional argument HORIZONTAL non-nil means return the minimum
1327 number of columns of WINDOW; otherwise return the minimum number
1328 of WINDOW's lines.
1329
1330 The optional argument IGNORE has the same meaning as for
1331 `window-resizable'. Optional argument PIXELWISE non-nil means
1332 return the minimum pixel-size of WINDOW."
1333 (window--min-size-1
1334 (window-normalize-window window) horizontal ignore pixelwise))
1335
1336 (defun window--min-size-ignore-p (window horizontal ignore)
1337 "Return non-nil if IGNORE says to ignore height restrictions for WINDOW.
1338 HORIZONTAL non-nil means to return non-nil if IGNORE says to
1339 ignore width restrictions for WINDOW."
1340 (if (window-valid-p ignore)
1341 (eq window ignore)
1342 (not (memq ignore '(nil preserved)))))
1343
1344 (defun window--min-size-1 (window horizontal ignore pixelwise)
1345 "Internal function of `window-min-size'."
1346 (let ((sub (window-child window)))
1347 (if sub
1348 (let ((value 0))
1349 ;; WINDOW is an internal window.
1350 (if (window-combined-p sub horizontal)
1351 ;; The minimum size of an iso-combination is the sum of
1352 ;; the minimum sizes of its child windows.
1353 (while sub
1354 (setq value (+ value
1355 (window--min-size-1
1356 sub horizontal ignore pixelwise)))
1357 (setq sub (window-right sub)))
1358 ;; The minimum size of an ortho-combination is the maximum
1359 ;; of the minimum sizes of its child windows.
1360 (while sub
1361 (setq value (max value
1362 (window--min-size-1
1363 sub horizontal ignore pixelwise)))
1364 (setq sub (window-right sub))))
1365 value)
1366 (with-current-buffer (window-buffer window)
1367 (cond
1368 ((window-minibuffer-p window)
1369 (if pixelwise (frame-char-height (window-frame window)) 1))
1370 ((window-size-fixed-p window horizontal ignore)
1371 ;; The minimum size of a fixed size window is its size.
1372 (window-size window horizontal pixelwise))
1373 ((eq ignore 'safe)
1374 ;; If IGNORE equals `safe' return the safe value.
1375 (window-safe-min-size window horizontal pixelwise))
1376 (horizontal
1377 ;; For the minimum width of a window take fringes and
1378 ;; scroll-bars into account. This is questionable and should
1379 ;; be removed as soon as we are able to split (and resize)
1380 ;; windows such that the new (or resized) windows can get a
1381 ;; size less than the user-specified `window-min-height' and
1382 ;; `window-min-width'.
1383 (let* ((char-size (frame-char-size window t))
1384 (fringes (window-fringes window))
1385 (margins (window-margins window))
1386 (pixel-width
1387 (+ (window-safe-min-size window t t)
1388 (* (or (car margins) 0) char-size)
1389 (* (or (cdr margins) 0) char-size)
1390 (car fringes) (cadr fringes)
1391 (window-scroll-bar-width window)
1392 (window-right-divider-width window))))
1393 (if pixelwise
1394 (max
1395 (if window-resize-pixelwise
1396 pixel-width
1397 ;; Round up to next integral of columns.
1398 (* (ceiling pixel-width char-size) char-size))
1399 (if (window--min-size-ignore-p window horizontal ignore)
1400 0
1401 (window-min-pixel-width window)))
1402 (max
1403 (ceiling pixel-width char-size)
1404 (if (window--min-size-ignore-p window horizontal ignore)
1405 0
1406 window-min-width)))))
1407 ((let ((char-size (frame-char-size window))
1408 (pixel-height
1409 (+ (window-safe-min-size window nil t)
1410 (window-header-line-height window)
1411 (window-scroll-bar-height window)
1412 (window-mode-line-height window)
1413 (window-bottom-divider-width window))))
1414 (if pixelwise
1415 (max
1416 (if window-resize-pixelwise
1417 pixel-height
1418 ;; Round up to next integral of lines.
1419 (* (ceiling pixel-height char-size) char-size))
1420 (if (window--min-size-ignore-p window horizontal ignore)
1421 0
1422 (window-min-pixel-height window)))
1423 (max (ceiling pixel-height char-size)
1424 (if (window--min-size-ignore-p window horizontal ignore)
1425 0
1426 window-min-height))))))))))
1427
1428 (defun window-sizable (window delta &optional horizontal ignore pixelwise)
1429 "Return DELTA if DELTA lines can be added to WINDOW.
1430 WINDOW must be a valid window and defaults to the selected one.
1431 Optional argument HORIZONTAL non-nil means return DELTA if DELTA
1432 columns can be added to WINDOW. A return value of zero means
1433 that no lines (or columns) can be added to WINDOW.
1434
1435 This function looks only at WINDOW and, recursively, its child
1436 windows. The function `window-resizable' looks at other windows
1437 as well.
1438
1439 DELTA positive means WINDOW shall be enlarged by DELTA lines or
1440 columns. If WINDOW cannot be enlarged by DELTA lines or columns
1441 return the maximum value in the range 0..DELTA by which WINDOW
1442 can be enlarged.
1443
1444 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
1445 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
1446 return the minimum value in the range DELTA..0 by which WINDOW
1447 can be shrunk.
1448
1449 The optional argument IGNORE has the same meaning as for
1450 `window-resizable'. Optional argument PIXELWISE non-nil means
1451 interpret DELTA as pixels."
1452 (setq window (window-normalize-window window))
1453 (cond
1454 ((< delta 0)
1455 (max (- (window-min-size window horizontal ignore pixelwise)
1456 (window-size window horizontal pixelwise))
1457 delta))
1458 ((> delta 0)
1459 (if (window-size-fixed-p window horizontal ignore)
1460 0
1461 delta))
1462 (t 0)))
1463
1464 (defun window-sizable-p (window delta &optional horizontal ignore pixelwise)
1465 "Return t if WINDOW can be resized by DELTA lines.
1466 WINDOW must be a valid window and defaults to the selected one.
1467 For the meaning of the arguments of this function see the
1468 doc-string of `window-sizable'."
1469 (setq window (window-normalize-window window))
1470 (if (> delta 0)
1471 (>= (window-sizable window delta horizontal ignore pixelwise)
1472 delta)
1473 (<= (window-sizable window delta horizontal ignore pixelwise)
1474 delta)))
1475
1476 (defun window--size-fixed-1 (window horizontal ignore)
1477 "Internal function for `window-size-fixed-p'."
1478 (let ((sub (window-child window)))
1479 (catch 'fixed
1480 (if sub
1481 ;; WINDOW is an internal window.
1482 (if (window-combined-p sub horizontal)
1483 ;; An iso-combination is fixed size if all its child
1484 ;; windows are fixed-size.
1485 (progn
1486 (while sub
1487 (unless (window--size-fixed-1 sub horizontal ignore)
1488 ;; We found a non-fixed-size child window, so
1489 ;; WINDOW's size is not fixed.
1490 (throw 'fixed nil))
1491 (setq sub (window-right sub)))
1492 ;; All child windows are fixed-size, so WINDOW's size is
1493 ;; fixed.
1494 (throw 'fixed t))
1495 ;; An ortho-combination is fixed-size if at least one of its
1496 ;; child windows is fixed-size.
1497 (while sub
1498 (when (window--size-fixed-1 sub horizontal ignore)
1499 ;; We found a fixed-size child window, so WINDOW's size
1500 ;; is fixed.
1501 (throw 'fixed t))
1502 (setq sub (window-right sub))))
1503 ;; WINDOW is a live window.
1504 (and (or (not (windowp ignore)) (not (eq window ignore)))
1505 (or (and (not (eq ignore 'preserved))
1506 (window--preserve-size window horizontal))
1507 (with-current-buffer (window-buffer window)
1508 (if horizontal
1509 (memq window-size-fixed '(width t))
1510 (memq window-size-fixed '(height t))))))))))
1511
1512 (defun window-size-fixed-p (&optional window horizontal ignore)
1513 "Return non-nil if WINDOW's height is fixed.
1514 WINDOW must be a valid window and defaults to the selected one.
1515 Optional argument HORIZONTAL non-nil means return non-nil if
1516 WINDOW's width is fixed. The optional argument IGNORE has the
1517 same meaning as for `window-resizable'.
1518
1519 If this function returns nil, this does not necessarily mean that
1520 WINDOW can be resized in the desired direction. The function
1521 `window-resizable' can tell that."
1522 (when (or (windowp ignore) (memq ignore '(nil preserved)))
1523 (window--size-fixed-1
1524 (window-normalize-window window) horizontal ignore)))
1525
1526 (defun window--min-delta-1 (window delta &optional horizontal ignore trail noup pixelwise)
1527 "Internal function for `window-min-delta'."
1528 (if (not (window-parent window))
1529 ;; If we can't go up, return zero.
1530 0
1531 ;; Else try to find a non-fixed-size sibling of WINDOW.
1532 (let* ((parent (window-parent window))
1533 (sub (window-child parent)))
1534 (catch 'done
1535 (if (window-combined-p sub horizontal)
1536 ;; In an iso-combination throw DELTA if we find at least one
1537 ;; child window and that window is either not fixed-size or
1538 ;; we can ignore fixed-sizeness.
1539 (let ((skip (eq trail 'after)))
1540 (while sub
1541 (cond
1542 ((eq sub window)
1543 (setq skip (eq trail 'before)))
1544 (skip)
1545 ((window-size-fixed-p sub horizontal ignore))
1546 (t
1547 ;; We found a non-fixed-size child window.
1548 (throw 'done delta)))
1549 (setq sub (window-right sub))))
1550 ;; In an ortho-combination set DELTA to the minimum value by
1551 ;; which other child windows can shrink.
1552 (while sub
1553 (unless (eq sub window)
1554 (setq delta
1555 (min delta
1556 (max (- (window-size sub horizontal pixelwise 'ceiling)
1557 (window-min-size
1558 sub horizontal ignore pixelwise))
1559 0))))
1560 (setq sub (window-right sub))))
1561 (if noup
1562 delta
1563 (window--min-delta-1
1564 parent delta horizontal ignore trail nil pixelwise))))))
1565
1566 (defun window-min-delta (&optional window horizontal ignore trail noup nodown pixelwise)
1567 "Return number of lines by which WINDOW can be shrunk.
1568 WINDOW must be a valid window and defaults to the selected one.
1569 Return zero if WINDOW cannot be shrunk.
1570
1571 Optional argument HORIZONTAL non-nil means return number of
1572 columns by which WINDOW can be shrunk.
1573
1574 The optional argument IGNORE has the same meaning as for
1575 `window-resizable'. Optional argument TRAIL restricts the
1576 windows that can be enlarged. If its value is `before', only
1577 windows to the left of or above WINDOW can be enlarged. If it is
1578 `after', only windows to the right of or below WINDOW can be
1579 enlarged.
1580
1581 Optional argument NOUP non-nil means don't go up in the window
1582 tree, but try to enlarge windows within WINDOW's combination
1583 only. Optional argument NODOWN non-nil means don't check whether
1584 WINDOW itself (and its child windows) can be shrunk; check only
1585 whether at least one other window can be enlarged appropriately.
1586
1587 Optional argument PIXELWISE non-nil means return number of pixels
1588 by which WINDOW can be shrunk."
1589 (setq window (window-normalize-window window))
1590 (let ((size (window-size window horizontal pixelwise 'floor))
1591 (minimum (window-min-size window horizontal ignore pixelwise)))
1592 (cond
1593 (nodown
1594 ;; If NODOWN is t, try to recover the entire size of WINDOW.
1595 (window--min-delta-1
1596 window size horizontal ignore trail noup pixelwise))
1597 ((<= size minimum)
1598 ;; If NODOWN is nil and WINDOW's size is already at its minimum,
1599 ;; there's nothing to recover.
1600 0)
1601 (t
1602 ;; Otherwise, try to recover whatever WINDOW is larger than its
1603 ;; minimum size.
1604 (window--min-delta-1
1605 window (- size minimum) horizontal ignore trail noup pixelwise)))))
1606
1607 (defun frame-windows-min-size (&optional frame horizontal ignore pixelwise)
1608 "Return minimum number of lines of FRAME's windows.
1609 HORIZONTAL non-nil means return number of columns of FRAME's
1610 windows. The optional argument IGNORE has the same meaning as
1611 for `window-resizable'. PIXELWISE non-nil means return sizes in
1612 pixels."
1613 (setq frame (window-normalize-frame frame))
1614 (let* ((root (frame-root-window frame))
1615 (mini (window-next-sibling root)))
1616 (+ (window-min-size root horizontal ignore pixelwise)
1617 (if (and mini (not horizontal))
1618 (window-min-size mini horizontal nil pixelwise)
1619 0))))
1620
1621 (defun window--max-delta-1 (window delta &optional horizontal ignore trail noup pixelwise)
1622 "Internal function of `window-max-delta'."
1623 (if (not (window-parent window))
1624 ;; Can't go up. Return DELTA.
1625 delta
1626 (let* ((parent (window-parent window))
1627 (sub (window-child parent)))
1628 (catch 'fixed
1629 (if (window-combined-p sub horizontal)
1630 ;; For an iso-combination calculate how much we can get from
1631 ;; other child windows.
1632 (let ((skip (eq trail 'after)))
1633 (while sub
1634 (cond
1635 ((eq sub window)
1636 (setq skip (eq trail 'before)))
1637 (skip)
1638 (t
1639 (setq delta
1640 (+ delta
1641 (max
1642 (- (window-size sub horizontal pixelwise 'floor)
1643 (window-min-size
1644 sub horizontal ignore pixelwise))
1645 0)))))
1646 (setq sub (window-right sub))))
1647 ;; For an ortho-combination throw DELTA when at least one
1648 ;; child window is fixed-size.
1649 (while sub
1650 (when (and (not (eq sub window))
1651 (window-size-fixed-p sub horizontal ignore))
1652 (throw 'fixed delta))
1653 (setq sub (window-right sub))))
1654 (if noup
1655 ;; When NOUP is nil, DELTA is all we can get.
1656 delta
1657 ;; Else try with parent of WINDOW, passing the DELTA we
1658 ;; recovered so far.
1659 (window--max-delta-1
1660 parent delta horizontal ignore trail nil pixelwise))))))
1661
1662 (defun window-max-delta (&optional window horizontal ignore trail noup nodown pixelwise)
1663 "Return maximum number of lines by which WINDOW can be enlarged.
1664 WINDOW must be a valid window and defaults to the selected one.
1665 The return value is zero if WINDOW cannot be enlarged.
1666
1667 Optional argument HORIZONTAL non-nil means return maximum number
1668 of columns by which WINDOW can be enlarged.
1669
1670 The optional argument IGNORE has the same meaning as for
1671 `window-resizable'. Optional argument TRAIL restricts the
1672 windows that can be enlarged. If its value is `before', only
1673 windows to the left of or above WINDOW can be enlarged. If it is
1674 `after', only windows to the right of or below WINDOW can be
1675 enlarged.
1676
1677 Optional argument NOUP non-nil means don't go up in the window
1678 tree but try to obtain the entire space from windows within
1679 WINDOW's combination. Optional argument NODOWN non-nil means do
1680 not check whether WINDOW itself (and its child windows) can be
1681 enlarged; check only whether other windows can be shrunk
1682 appropriately.
1683
1684 Optional argument PIXELWISE non-nil means return number of
1685 pixels by which WINDOW can be enlarged."
1686 (setq window (window-normalize-window window))
1687 (if (and (not nodown) (window-size-fixed-p window horizontal ignore))
1688 ;; With IGNORE and NOWDON nil return zero if WINDOW has fixed
1689 ;; size.
1690 0
1691 ;; WINDOW has no fixed size.
1692 (window--max-delta-1 window 0 horizontal ignore trail noup pixelwise)))
1693
1694 ;; Make NOUP also inhibit the min-size check.
1695 (defun window--resizable (window delta &optional horizontal ignore trail noup nodown pixelwise)
1696 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
1697 WINDOW must be a valid window and defaults to the selected one.
1698 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
1699 can be resized horizontally by DELTA columns. A return value of
1700 zero means that WINDOW is not resizable.
1701
1702 DELTA positive means WINDOW shall be enlarged by DELTA lines or
1703 columns. If WINDOW cannot be enlarged by DELTA lines or columns,
1704 return the maximum value in the range 0..DELTA by which WINDOW
1705 can be enlarged.
1706
1707 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
1708 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
1709 return the minimum value in the range DELTA..0 that can be used
1710 for shrinking WINDOW.
1711
1712 The optional argument IGNORE has the same meaning as for
1713 `window-resizable'. Optional argument TRAIL `before' means only
1714 windows to the left of or below WINDOW can be shrunk. Optional
1715 argument TRAIL `after' means only windows to the right of or
1716 above WINDOW can be shrunk.
1717
1718 Optional argument NOUP non-nil means don't go up in the window
1719 tree but check only whether space can be obtained from (or given
1720 to) WINDOW's siblings. Optional argument NODOWN non-nil means
1721 don't go down in the window tree. This means do not check
1722 whether resizing would violate size restrictions of WINDOW or its
1723 child windows.
1724
1725 Optional argument PIXELWISE non-nil means interpret DELTA as
1726 number of pixels."
1727 (setq window (window-normalize-window window))
1728 (cond
1729 ((< delta 0)
1730 (max (- (window-min-delta
1731 window horizontal ignore trail noup nodown pixelwise))
1732 delta))
1733 ((> delta 0)
1734 (min (window-max-delta
1735 window horizontal ignore trail noup nodown pixelwise)
1736 delta))
1737 (t 0)))
1738
1739 (defun window--resizable-p (window delta &optional horizontal ignore trail noup nodown pixelwise)
1740 "Return t if WINDOW can be resized vertically by DELTA lines.
1741 WINDOW must be a valid window and defaults to the selected one.
1742 For the meaning of the arguments of this function see the
1743 doc-string of `window--resizable'.
1744
1745 Optional argument PIXELWISE non-nil means interpret DELTA as
1746 pixels."
1747 (setq window (window-normalize-window window))
1748 (if (> delta 0)
1749 (>= (window--resizable
1750 window delta horizontal ignore trail noup nodown pixelwise)
1751 delta)
1752 (<= (window--resizable
1753 window delta horizontal ignore trail noup nodown pixelwise)
1754 delta)))
1755
1756 (defun window-resizable (window delta &optional horizontal ignore pixelwise)
1757 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
1758 WINDOW must be a valid window and defaults to the selected one.
1759 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
1760 can be resized horizontally by DELTA columns. A return value of
1761 zero means that WINDOW is not resizable.
1762
1763 DELTA positive means WINDOW shall be enlarged by DELTA lines or
1764 columns. If WINDOW cannot be enlarged by DELTA lines or columns
1765 return the maximum value in the range 0..DELTA by which WINDOW
1766 can be enlarged.
1767
1768 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
1769 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
1770 return the minimum value in the range DELTA..0 that can be used
1771 for shrinking WINDOW.
1772
1773 Optional argument IGNORE, if non-nil, means to ignore restraints
1774 induced by fixed size windows or the values of the variables
1775 `window-min-height' and `window-min-width'. The following values
1776 have special meanings: `safe' means that in addition live windows
1777 are allowed to get as small as `window-safe-min-height' lines and
1778 `window-safe-min-width' columns. `preserved' means to ignore
1779 only restrictions induced by `window-preserve-size'. If IGNORE
1780 is a window, then ignore restrictions for that window only.
1781
1782 Optional argument PIXELWISE non-nil means interpret DELTA as
1783 pixels."
1784 (setq window (window-normalize-window window))
1785 (window--resizable window delta horizontal ignore nil nil nil pixelwise))
1786
1787 (defun window-resizable-p (window delta &optional horizontal ignore pixelwise)
1788 "Return t if WINDOW can be resized vertically by DELTA lines.
1789 WINDOW must be a valid window and defaults to the selected one.
1790 For the meaning of the arguments of this function see the
1791 doc-string of `window-resizable'."
1792 (setq window (window-normalize-window window))
1793 (if (> delta 0)
1794 (>= (window--resizable
1795 window delta horizontal ignore nil nil nil pixelwise)
1796 delta)
1797 (<= (window--resizable
1798 window delta horizontal ignore nil nil nil pixelwise)
1799 delta)))
1800
1801 ;; Aliases of functions defined in window.c.
1802 (defalias 'window-height 'window-total-height)
1803 (defalias 'window-width 'window-body-width)
1804
1805 (defun window-full-height-p (&optional window)
1806 "Return t if WINDOW is as high as its containing frame.
1807 More precisely, return t if and only if the total height of
1808 WINDOW equals the total height of the root window of WINDOW's
1809 frame. WINDOW must be a valid window and defaults to the
1810 selected one."
1811 (setq window (window-normalize-window window))
1812 (if (window-minibuffer-p window)
1813 (eq window (frame-root-window (window-frame window)))
1814 (= (window-pixel-height window)
1815 (window-pixel-height (frame-root-window window)))))
1816
1817 (defun window-full-width-p (&optional window)
1818 "Return t if WINDOW is as wide as its containing frame.
1819 More precisely, return t if and only if the total width of WINDOW
1820 equals the total width of the root window of WINDOW's frame.
1821 WINDOW must be a valid window and defaults to the selected one."
1822 (setq window (window-normalize-window window))
1823 (= (window-pixel-width window)
1824 (window-pixel-width (frame-root-window window))))
1825
1826 (defun window-body-size (&optional window horizontal pixelwise)
1827 "Return the height or width of WINDOW's text area.
1828 WINDOW must be a live window and defaults to the selected one.
1829
1830 If HORIZONTAL is omitted or nil, return the height of the text
1831 area, like `window-body-height'. Otherwise, return the width of
1832 the text area, like `window-body-width'. In either case, the
1833 optional argument PIXELWISE is passed to the functions."
1834 (if horizontal
1835 (window-body-width window pixelwise)
1836 (window-body-height window pixelwise)))
1837
1838 (declare-function font-info "font.c" (name &optional frame))
1839
1840 (defun window-font-width (&optional window face)
1841 "Return average character width for the font of FACE used in WINDOW.
1842 WINDOW must be a live window and defaults to the selected one.
1843
1844 If FACE is nil or omitted, the default face is used. If FACE is
1845 remapped (see `face-remapping-alist'), the function returns the
1846 information for the remapped face."
1847 (with-selected-window (window-normalize-window window t)
1848 (if (display-multi-font-p)
1849 (let* ((face (if face face 'default))
1850 (info (font-info (face-font face)))
1851 (width (aref info 11)))
1852 (if (> width 0)
1853 width
1854 (aref info 10)))
1855 (frame-char-width))))
1856
1857 (defun window-font-height (&optional window face)
1858 "Return character height for the font of FACE used in WINDOW.
1859 WINDOW must be a live window and defaults to the selected one.
1860
1861 If FACE is nil or omitted, the default face is used. If FACE is
1862 remapped (see `face-remapping-alist'), the function returns the
1863 information for the remapped face."
1864 (with-selected-window (window-normalize-window window t)
1865 (if (display-multi-font-p)
1866 (let* ((face (if face face 'default))
1867 (info (font-info (face-font face))))
1868 (aref info 3))
1869 (frame-char-height))))
1870
1871 (defvar overflow-newline-into-fringe)
1872
1873 (defun window-max-chars-per-line (&optional window face)
1874 "Return the number of characters that can be displayed on one line in WINDOW.
1875 WINDOW must be a live window and defaults to the selected one.
1876
1877 The character width of FACE is used for the calculation. If FACE
1878 is nil or omitted, the default face is used. If FACE is
1879 remapped (see `face-remapping-alist'), the function uses the
1880 remapped face.
1881
1882 This function is different from `window-body-width' in two
1883 ways. First, it accounts for the portions of the line reserved
1884 for the continuation glyph. Second, it accounts for the size of
1885 the font."
1886 (with-selected-window (window-normalize-window window t)
1887 (let* ((window-width (window-body-width window t))
1888 (font-width (window-font-width window face))
1889 (ncols (/ window-width font-width)))
1890 (if (and (display-graphic-p)
1891 overflow-newline-into-fringe
1892 (/= (frame-parameter nil 'left-fringe) 0)
1893 (/= (frame-parameter nil 'right-fringe) 0))
1894 ncols
1895 (1- ncols)))))
1896
1897 (defun window-current-scroll-bars (&optional window)
1898 "Return the current scroll bar types for WINDOW.
1899 WINDOW must be a live window and defaults to the selected one.
1900
1901 The return value is a cons cell (VERTICAL . HORIZONTAL) where
1902 VERTICAL specifies the current location of the vertical scroll
1903 bar (`left', `right' or nil), and HORIZONTAL specifies the
1904 current location of the horizontal scroll bar (`bottom' or nil).
1905
1906 Unlike `window-scroll-bars', this function reports the scroll bar
1907 type actually used, once frame defaults and `scroll-bar-mode' are
1908 taken into account."
1909 (setq window (window-normalize-window window t))
1910 (let ((vertical (nth 2 (window-scroll-bars window)))
1911 (horizontal (nth 5 (window-scroll-bars window)))
1912 (inherited (frame-current-scroll-bars (window-frame window))))
1913 (when (eq vertical t)
1914 (setq vertical (car inherited)))
1915 (when (eq horizontal t)
1916 (setq horizontal (cdr inherited)))
1917 (cons vertical (and horizontal 'bottom))))
1918
1919 (defun walk-windows (fun &optional minibuf all-frames)
1920 "Cycle through all live windows, calling FUN for each one.
1921 FUN must specify a function with a window as its sole argument.
1922 The optional arguments MINIBUF and ALL-FRAMES specify the set of
1923 windows to include in the walk.
1924
1925 MINIBUF t means include the minibuffer window even if the
1926 minibuffer is not active. MINIBUF nil or omitted means include
1927 the minibuffer window only if the minibuffer is active. Any
1928 other value means do not include the minibuffer window even if
1929 the minibuffer is active.
1930
1931 ALL-FRAMES nil or omitted means consider all windows on the
1932 selected frame, plus the minibuffer window if specified by the
1933 MINIBUF argument. If the minibuffer counts, consider all windows
1934 on all frames that share that minibuffer too. The following
1935 non-nil values of ALL-FRAMES have special meanings:
1936
1937 - t means consider all windows on all existing frames.
1938
1939 - `visible' means consider all windows on all visible frames on
1940 the current terminal.
1941
1942 - 0 (the number zero) means consider all windows on all visible
1943 and iconified frames on the current terminal.
1944
1945 - A frame means consider all windows on that frame only.
1946
1947 Anything else means consider all windows on the selected frame
1948 and no others.
1949
1950 This function changes neither the order of recently selected
1951 windows nor the buffer list."
1952 ;; If we start from the minibuffer window, don't fail to come
1953 ;; back to it.
1954 (when (window-minibuffer-p)
1955 (setq minibuf t))
1956 ;; Make sure to not mess up the order of recently selected
1957 ;; windows. Use `save-selected-window' and `select-window'
1958 ;; with second argument non-nil for this purpose.
1959 (save-selected-window
1960 (when (framep all-frames)
1961 (select-window (frame-first-window all-frames) 'norecord))
1962 (dolist (walk-windows-window (window-list-1 nil minibuf all-frames))
1963 (funcall fun walk-windows-window))))
1964
1965 (defun window-at-side-p (&optional window side)
1966 "Return t if WINDOW is at SIDE of its containing frame.
1967 WINDOW must be a valid window and defaults to the selected one.
1968 SIDE can be any of the symbols `left', `top', `right' or
1969 `bottom'. The default value nil is handled like `bottom'."
1970 (setq window (window-normalize-window window))
1971 (let ((edge
1972 (cond
1973 ((eq side 'left) 0)
1974 ((eq side 'top) 1)
1975 ((eq side 'right) 2)
1976 ((memq side '(bottom nil)) 3))))
1977 (= (nth edge (window-pixel-edges window))
1978 (nth edge (window-pixel-edges (frame-root-window window))))))
1979
1980 (defun window-at-side-list (&optional frame side)
1981 "Return list of all windows on SIDE of FRAME.
1982 FRAME must be a live frame and defaults to the selected frame.
1983 SIDE can be any of the symbols `left', `top', `right' or
1984 `bottom'. The default value nil is handled like `bottom'."
1985 (setq frame (window-normalize-frame frame))
1986 (let (windows)
1987 (walk-window-tree
1988 (lambda (window)
1989 (when (window-at-side-p window side)
1990 (setq windows (cons window windows))))
1991 frame nil 'nomini)
1992 (nreverse windows)))
1993
1994 (defun window--in-direction-2 (window posn &optional horizontal)
1995 "Support function for `window-in-direction'."
1996 (if horizontal
1997 (let ((top (window-pixel-top window)))
1998 (if (> top posn)
1999 (- top posn)
2000 (- posn top (window-pixel-height window))))
2001 (let ((left (window-pixel-left window)))
2002 (if (> left posn)
2003 (- left posn)
2004 (- posn left (window-pixel-width window))))))
2005
2006 ;; Predecessors to the below have been devised by Julian Assange in
2007 ;; change-windows-intuitively.el and Hovav Shacham in windmove.el.
2008 ;; Neither of these allow one to selectively ignore specific windows
2009 ;; (windows whose `no-other-window' parameter is non-nil) as targets of
2010 ;; the movement.
2011 (defun window-in-direction (direction &optional window ignore sign wrap mini)
2012 "Return window in DIRECTION as seen from WINDOW.
2013 More precisely, return the nearest window in direction DIRECTION
2014 as seen from the position of `window-point' in window WINDOW.
2015 DIRECTION must be one of `above', `below', `left' or `right'.
2016 WINDOW must be a live window and defaults to the selected one.
2017
2018 Do not return a window whose `no-other-window' parameter is
2019 non-nil. If the nearest window's `no-other-window' parameter is
2020 non-nil, try to find another window in the indicated direction.
2021 If, however, the optional argument IGNORE is non-nil, return that
2022 window even if its `no-other-window' parameter is non-nil.
2023
2024 Optional argument SIGN a negative number means to use the right
2025 or bottom edge of WINDOW as reference position instead of
2026 `window-point'. SIGN a positive number means to use the left or
2027 top edge of WINDOW as reference position.
2028
2029 Optional argument WRAP non-nil means to wrap DIRECTION around
2030 frame borders. This means to return for WINDOW at the top of the
2031 frame and DIRECTION `above' the minibuffer window if the frame
2032 has one, and a window at the bottom of the frame otherwise.
2033
2034 Optional argument MINI nil means to return the minibuffer window
2035 if and only if it is currently active. MINI non-nil means to
2036 return the minibuffer window even when it's not active. However,
2037 if WRAP is non-nil, always act as if MINI were nil.
2038
2039 Return nil if no suitable window can be found."
2040 (setq window (window-normalize-window window t))
2041 (unless (memq direction '(above below left right))
2042 (error "Wrong direction %s" direction))
2043 (let* ((frame (window-frame window))
2044 (hor (memq direction '(left right)))
2045 (first (if hor
2046 (window-pixel-left window)
2047 (window-pixel-top window)))
2048 (last (+ first (window-size window hor t)))
2049 ;; The column / row value of `posn-at-point' can be nil for the
2050 ;; mini-window, guard against that.
2051 (posn
2052 (cond
2053 ((and (numberp sign) (< sign 0))
2054 (if hor
2055 (1- (+ (window-pixel-top window) (window-pixel-height window)))
2056 (1- (+ (window-pixel-left window) (window-pixel-width window)))))
2057 ((and (numberp sign) (> sign 0))
2058 (if hor
2059 (window-pixel-top window)
2060 (window-pixel-left window)))
2061 ((let ((posn-cons (nth 2 (posn-at-point (window-point window) window))))
2062 (if hor
2063 (+ (or (cdr posn-cons) 1) (window-pixel-top window))
2064 (+ (or (car posn-cons) 1) (window-pixel-left window)))))))
2065 (best-edge
2066 (cond
2067 ((eq direction 'below) (frame-pixel-height frame))
2068 ((eq direction 'right) (frame-pixel-width frame))
2069 (t -1)))
2070 (best-edge-2 best-edge)
2071 (best-diff-2 (if hor (frame-pixel-height frame) (frame-pixel-width frame)))
2072 best best-2 best-diff-2-new)
2073 (walk-window-tree
2074 (lambda (w)
2075 (let* ((w-top (window-pixel-top w))
2076 (w-left (window-pixel-left w)))
2077 (cond
2078 ((or (eq window w)
2079 ;; Ignore ourselves.
2080 (and (window-parameter w 'no-other-window)
2081 ;; Ignore W unless IGNORE is non-nil.
2082 (not ignore))))
2083 (hor
2084 (cond
2085 ((and (<= w-top posn)
2086 (< posn (+ w-top (window-pixel-height w))))
2087 ;; W is to the left or right of WINDOW and covers POSN.
2088 (when (or (and (eq direction 'left)
2089 (or (and (<= w-left first) (> w-left best-edge))
2090 (and wrap
2091 (window-at-side-p window 'left)
2092 (window-at-side-p w 'right))))
2093 (and (eq direction 'right)
2094 (or (and (>= w-left last) (< w-left best-edge))
2095 (and wrap
2096 (window-at-side-p window 'right)
2097 (window-at-side-p w 'left)))))
2098 (setq best-edge w-left)
2099 (setq best w)))
2100 ((and (or (and (eq direction 'left)
2101 (<= (+ w-left (window-pixel-width w)) first))
2102 (and (eq direction 'right) (<= last w-left)))
2103 ;; W is to the left or right of WINDOW but does not
2104 ;; cover POSN.
2105 (setq best-diff-2-new
2106 (window--in-direction-2 w posn hor))
2107 (or (< best-diff-2-new best-diff-2)
2108 (and (= best-diff-2-new best-diff-2)
2109 (if (eq direction 'left)
2110 (> w-left best-edge-2)
2111 (< w-left best-edge-2)))))
2112 (setq best-edge-2 w-left)
2113 (setq best-diff-2 best-diff-2-new)
2114 (setq best-2 w))))
2115 ((and (<= w-left posn)
2116 (< posn (+ w-left (window-pixel-width w))))
2117 ;; W is above or below WINDOW and covers POSN.
2118 (when (or (and (eq direction 'above)
2119 (or (and (<= w-top first) (> w-top best-edge))
2120 (and wrap
2121 (window-at-side-p window 'top)
2122 (if (active-minibuffer-window)
2123 (minibuffer-window-active-p w)
2124 (window-at-side-p w 'bottom)))))
2125 (and (eq direction 'below)
2126 (or (and (>= w-top first) (< w-top best-edge))
2127 (and wrap
2128 (if (active-minibuffer-window)
2129 (minibuffer-window-active-p window)
2130 (window-at-side-p window 'bottom))
2131 (window-at-side-p w 'top)))))
2132 (setq best-edge w-top)
2133 (setq best w)))
2134 ((and (or (and (eq direction 'above)
2135 (<= (+ w-top (window-pixel-height w)) first))
2136 (and (eq direction 'below) (<= last w-top)))
2137 ;; W is above or below WINDOW but does not cover POSN.
2138 (setq best-diff-2-new
2139 (window--in-direction-2 w posn hor))
2140 (or (< best-diff-2-new best-diff-2)
2141 (and (= best-diff-2-new best-diff-2)
2142 (if (eq direction 'above)
2143 (> w-top best-edge-2)
2144 (< w-top best-edge-2)))))
2145 (setq best-edge-2 w-top)
2146 (setq best-diff-2 best-diff-2-new)
2147 (setq best-2 w)))))
2148 frame nil (and mini t))
2149 (or best best-2)))
2150
2151 (defun get-window-with-predicate (predicate &optional minibuf all-frames default)
2152 "Return a live window satisfying PREDICATE.
2153 More precisely, cycle through all windows calling the function
2154 PREDICATE on each one of them with the window as its sole
2155 argument. Return the first window for which PREDICATE returns
2156 non-nil. Windows are scanned starting with the window following
2157 the selected window. If no window satisfies PREDICATE, return
2158 DEFAULT.
2159
2160 MINIBUF t means include the minibuffer window even if the
2161 minibuffer is not active. MINIBUF nil or omitted means include
2162 the minibuffer window only if the minibuffer is active. Any
2163 other value means do not include the minibuffer window even if
2164 the minibuffer is active.
2165
2166 ALL-FRAMES nil or omitted means consider all windows on the selected
2167 frame, plus the minibuffer window if specified by the MINIBUF
2168 argument. If the minibuffer counts, consider all windows on all
2169 frames that share that minibuffer too. The following non-nil
2170 values of ALL-FRAMES have special meanings:
2171
2172 - t means consider all windows on all existing frames.
2173
2174 - `visible' means consider all windows on all visible frames on
2175 the current terminal.
2176
2177 - 0 (the number zero) means consider all windows on all visible
2178 and iconified frames on the current terminal.
2179
2180 - A frame means consider all windows on that frame only.
2181
2182 Anything else means consider all windows on the selected frame
2183 and no others."
2184 (catch 'found
2185 (dolist (window (window-list-1
2186 (next-window nil minibuf all-frames)
2187 minibuf all-frames))
2188 (when (funcall predicate window)
2189 (throw 'found window)))
2190 default))
2191
2192 (defalias 'some-window 'get-window-with-predicate)
2193
2194 (defun get-lru-window (&optional all-frames dedicated not-selected)
2195 "Return the least recently used window on frames specified by ALL-FRAMES.
2196 Return a full-width window if possible. A minibuffer window is
2197 never a candidate. A dedicated window is never a candidate
2198 unless DEDICATED is non-nil, so if all windows are dedicated, the
2199 value is nil. Avoid returning the selected window if possible.
2200 Optional argument NOT-SELECTED non-nil means never return the
2201 selected window.
2202
2203 The following non-nil values of the optional argument ALL-FRAMES
2204 have special meanings:
2205
2206 - t means consider all windows on all existing frames.
2207
2208 - `visible' means consider all windows on all visible frames on
2209 the current terminal.
2210
2211 - 0 (the number zero) means consider all windows on all visible
2212 and iconified frames on the current terminal.
2213
2214 - A frame means consider all windows on that frame only.
2215
2216 Any other value of ALL-FRAMES means consider all windows on the
2217 selected frame and no others."
2218 (let (best-window best-time second-best-window second-best-time time)
2219 (dolist (window (window-list-1 nil 'nomini all-frames))
2220 (when (and (or dedicated (not (window-dedicated-p window)))
2221 (or (not not-selected) (not (eq window (selected-window)))))
2222 (setq time (window-use-time window))
2223 (if (or (eq window (selected-window))
2224 (not (window-full-width-p window)))
2225 (when (or (not second-best-time) (< time second-best-time))
2226 (setq second-best-time time)
2227 (setq second-best-window window))
2228 (when (or (not best-time) (< time best-time))
2229 (setq best-time time)
2230 (setq best-window window)))))
2231 (or best-window second-best-window)))
2232
2233 (defun get-mru-window (&optional all-frames dedicated not-selected)
2234 "Return the most recently used window on frames specified by ALL-FRAMES.
2235 A minibuffer window is never a candidate. A dedicated window is
2236 never a candidate unless DEDICATED is non-nil, so if all windows
2237 are dedicated, the value is nil. Optional argument NOT-SELECTED
2238 non-nil means never return the selected window.
2239
2240 The following non-nil values of the optional argument ALL-FRAMES
2241 have special meanings:
2242
2243 - t means consider all windows on all existing frames.
2244
2245 - `visible' means consider all windows on all visible frames on
2246 the current terminal.
2247
2248 - 0 (the number zero) means consider all windows on all visible
2249 and iconified frames on the current terminal.
2250
2251 - A frame means consider all windows on that frame only.
2252
2253 Any other value of ALL-FRAMES means consider all windows on the
2254 selected frame and no others."
2255 (let (best-window best-time time)
2256 (dolist (window (window-list-1 nil 'nomini all-frames))
2257 (setq time (window-use-time window))
2258 (when (and (or dedicated (not (window-dedicated-p window)))
2259 (or (not not-selected) (not (eq window (selected-window))))
2260 (or (not best-time) (> time best-time)))
2261 (setq best-time time)
2262 (setq best-window window)))
2263 best-window))
2264
2265 (defun get-largest-window (&optional all-frames dedicated not-selected)
2266 "Return the largest window on frames specified by ALL-FRAMES.
2267 A minibuffer window is never a candidate. A dedicated window is
2268 never a candidate unless DEDICATED is non-nil, so if all windows
2269 are dedicated, the value is nil. Optional argument NOT-SELECTED
2270 non-nil means never return the selected window.
2271
2272 The following non-nil values of the optional argument ALL-FRAMES
2273 have special meanings:
2274
2275 - t means consider all windows on all existing frames.
2276
2277 - `visible' means consider all windows on all visible frames on
2278 the current terminal.
2279
2280 - 0 (the number zero) means consider all windows on all visible
2281 and iconified frames on the current terminal.
2282
2283 - A frame means consider all windows on that frame only.
2284
2285 Any other value of ALL-FRAMES means consider all windows on the
2286 selected frame and no others."
2287 (let ((best-size 0)
2288 best-window size)
2289 (dolist (window (window-list-1 nil 'nomini all-frames))
2290 (when (and (or dedicated (not (window-dedicated-p window)))
2291 (or (not not-selected) (not (eq window (selected-window)))))
2292 (setq size (* (window-pixel-height window)
2293 (window-pixel-width window)))
2294 (when (> size best-size)
2295 (setq best-size size)
2296 (setq best-window window))))
2297 best-window))
2298
2299 (defun get-buffer-window-list (&optional buffer-or-name minibuf all-frames)
2300 "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
2301 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2302 and defaults to the current buffer. If the selected window displays
2303 BUFFER-OR-NAME, it will be the first in the resulting list.
2304
2305 MINIBUF t means include the minibuffer window even if the
2306 minibuffer is not active. MINIBUF nil or omitted means include
2307 the minibuffer window only if the minibuffer is active. Any
2308 other value means do not include the minibuffer window even if
2309 the minibuffer is active.
2310
2311 ALL-FRAMES nil or omitted means consider all windows on the
2312 selected frame, plus the minibuffer window if specified by the
2313 MINIBUF argument. If the minibuffer counts, consider all windows
2314 on all frames that share that minibuffer too. The following
2315 non-nil values of ALL-FRAMES have special meanings:
2316
2317 - t means consider all windows on all existing frames.
2318
2319 - `visible' means consider all windows on all visible frames on
2320 the current terminal.
2321
2322 - 0 (the number zero) means consider all windows on all visible
2323 and iconified frames on the current terminal.
2324
2325 - A frame means consider all windows on that frame only.
2326
2327 Anything else means consider all windows on the selected frame
2328 and no others."
2329 (let ((buffer (window-normalize-buffer buffer-or-name))
2330 windows)
2331 (dolist (window (window-list-1 (selected-window) minibuf all-frames))
2332 (when (eq (window-buffer window) buffer)
2333 (setq windows (cons window windows))))
2334 (nreverse windows)))
2335
2336 (defun minibuffer-window-active-p (window)
2337 "Return t if WINDOW is the currently active minibuffer window."
2338 (eq window (active-minibuffer-window)))
2339
2340 (defun count-windows (&optional minibuf)
2341 "Return the number of live windows on the selected frame.
2342 The optional argument MINIBUF specifies whether the minibuffer
2343 window shall be counted. See `walk-windows' for the precise
2344 meaning of this argument."
2345 (length (window-list-1 nil minibuf)))
2346 \f
2347 ;;; Resizing windows.
2348 (defun window--size-to-pixel (window size &optional horizontal pixelwise round-maybe)
2349 "For WINDOW convert SIZE lines to pixels.
2350 SIZE is supposed to specify a height of WINDOW in terms of text
2351 lines. The return value is the number of pixels specifying that
2352 height.
2353
2354 WINDOW must be a valid window. Optional argument HORIZONTAL
2355 non-nil means convert SIZE columns to pixels.
2356
2357 Optional argument PIXELWISE non-nil means SIZE already specifies
2358 pixels but may have to be adjusted to a multiple of the character
2359 size of WINDOW's frame. Optional argument ROUND-MAYBE non-nil
2360 means round to the nearest multiple of the character size of
2361 WINDOW's frame if the option `window-resize-pixelwise' is nil."
2362 (setq window (window-normalize-window window))
2363 (let ((char-size (frame-char-size window horizontal)))
2364 (if pixelwise
2365 (if (and round-maybe (not window-resize-pixelwise))
2366 (* (round size char-size) char-size)
2367 size)
2368 (* size char-size))))
2369
2370 (defun window--pixel-to-total-1 (window horizontal char-size)
2371 "Subroutine of `window--pixel-to-total'."
2372 (let ((child (window-child window)))
2373 (if (window-combination-p window horizontal)
2374 ;; In an iso-combination distribute sizes proportionally.
2375 (let ((remainder (window-new-total window))
2376 size best-child rem best-rem)
2377 ;; Initialize total sizes to each child's floor.
2378 (while child
2379 (setq size (max (/ (window-size child horizontal t) char-size) 1))
2380 (set-window-new-total child size)
2381 (setq remainder (- remainder size))
2382 (setq child (window-next-sibling child)))
2383 ;; Distribute remainder.
2384 (while (> remainder 0)
2385 (setq child (window-last-child window))
2386 (setq best-child nil)
2387 (setq best-rem 0)
2388 (while child
2389 (when (and (<= (window-new-total child)
2390 (/ (window-size child horizontal t) char-size))
2391 (> (setq rem (% (window-size child horizontal t)
2392 char-size))
2393 best-rem))
2394 (setq best-child child)
2395 (setq best-rem rem))
2396 (setq child (window-prev-sibling child)))
2397 ;; We MUST have a best-child here.
2398 (set-window-new-total best-child 1 t)
2399 (setq remainder (1- remainder)))
2400 ;; Recurse.
2401 (setq child (window-child window))
2402 (while child
2403 (window--pixel-to-total-1 child horizontal char-size)
2404 (setq child (window-next-sibling child))))
2405 ;; In an ortho-combination assign new sizes directly.
2406 (let ((size (window-new-total window)))
2407 (while child
2408 (set-window-new-total child size)
2409 (window--pixel-to-total-1 child horizontal char-size)
2410 (setq child (window-next-sibling child)))))))
2411
2412 (defun window--pixel-to-total (&optional frame horizontal)
2413 "On FRAME assign new total window heights from pixel heights.
2414 FRAME must be a live frame and defaults to the selected frame.
2415
2416 Optional argument HORIZONTAL non-nil means assign new total
2417 window widths from pixel widths."
2418 (setq frame (window-normalize-frame frame))
2419 (let* ((char-size (frame-char-size frame horizontal))
2420 (root (frame-root-window frame))
2421 (root-size (window-size root horizontal t))
2422 ;; We have to care about the minibuffer window only if it
2423 ;; appears together with the root window on this frame.
2424 (mini (let ((mini (minibuffer-window frame)))
2425 (and (eq (window-frame mini) frame)
2426 (not (eq mini root)) mini)))
2427 (mini-size (and mini (window-size mini horizontal t))))
2428 ;; We round the line/column sizes of windows here to the nearest
2429 ;; integer. In some cases this can make windows appear _larger_
2430 ;; than the containing frame (line/column-wise) because the latter's
2431 ;; sizes are not (yet) rounded. We might eventually fix that.
2432 (if (and mini (not horizontal))
2433 (let (lines)
2434 (set-window-new-total root (max (/ root-size char-size) 1))
2435 (set-window-new-total mini (max (/ mini-size char-size) 1))
2436 (setq lines (- (round (+ root-size mini-size) char-size)
2437 (+ (window-new-total root) (window-new-total mini))))
2438 (while (> lines 0)
2439 (if (>= (% root-size (window-new-total root))
2440 (% mini-size (window-new-total mini)))
2441 (set-window-new-total root 1 t)
2442 (set-window-new-total mini 1 t))
2443 (setq lines (1- lines))))
2444 (set-window-new-total root (round root-size char-size))
2445 (when mini
2446 ;; This is taken in the horizontal case only.
2447 (set-window-new-total mini (round mini-size char-size))))
2448 (unless (window-buffer root)
2449 (window--pixel-to-total-1 root horizontal char-size))
2450 ;; Apply the new sizes.
2451 (window-resize-apply-total frame horizontal)))
2452
2453 (defun window--resize-reset (&optional frame horizontal)
2454 "Reset resize values for all windows on FRAME.
2455 FRAME defaults to the selected frame.
2456
2457 This function stores the current value of `window-size' applied
2458 with argument HORIZONTAL in the new total size of all windows on
2459 FRAME. It also resets the new normal size of each of these
2460 windows."
2461 (window--resize-reset-1
2462 (frame-root-window (window-normalize-frame frame)) horizontal))
2463
2464 (defun window--resize-reset-1 (window horizontal)
2465 "Internal function of `window--resize-reset'."
2466 ;; Register old size in the new total size.
2467 (set-window-new-pixel window (window-size window horizontal t))
2468 (set-window-new-total window (window-size window horizontal))
2469 ;; Reset new normal size.
2470 (set-window-new-normal window)
2471 (when (window-child window)
2472 (window--resize-reset-1 (window-child window) horizontal))
2473 (when (window-right window)
2474 (window--resize-reset-1 (window-right window) horizontal)))
2475
2476 (defun window--resize-mini-window (window delta)
2477 "Resize minibuffer window WINDOW by DELTA pixels.
2478 If WINDOW cannot be resized by DELTA pixels make it as large (or
2479 as small) as possible, but don't signal an error."
2480 (when (window-minibuffer-p window)
2481 (let* ((frame (window-frame window))
2482 (root (frame-root-window frame))
2483 (height (window-pixel-height window))
2484 (min-delta
2485 (- (window-pixel-height root)
2486 (window-min-size root nil nil t))))
2487 ;; Sanitize DELTA.
2488 (cond
2489 ((<= (+ height delta) 0)
2490 (setq delta (- (frame-char-height (window-frame window)) height)))
2491 ((> delta min-delta)
2492 (setq delta min-delta)))
2493
2494 (unless (zerop delta)
2495 ;; Resize now.
2496 (window--resize-reset frame)
2497 ;; Ideally we should be able to resize just the last child of root
2498 ;; here. See the comment in `resize-root-window-vertically' for
2499 ;; why we do not do that.
2500 (window--resize-this-window root (- delta) nil nil t)
2501 (set-window-new-pixel window (+ height delta))
2502 ;; The following routine catches the case where we want to resize
2503 ;; a minibuffer-only frame.
2504 (when (resize-mini-window-internal window)
2505 (window--pixel-to-total frame)
2506 (run-window-configuration-change-hook frame))))))
2507
2508 (defun window--resize-apply-p (frame &optional horizontal)
2509 "Return t when a window on FRAME shall be resized vertically.
2510 Optional argument HORIZONTAL non-nil means return t when a window
2511 shall be resized horizontally."
2512 (catch 'apply
2513 (walk-window-tree
2514 (lambda (window)
2515 (unless (= (window-new-pixel window)
2516 (window-size window horizontal t))
2517 (throw 'apply t)))
2518 frame t)
2519 nil))
2520
2521 (defun window-resize (window delta &optional horizontal ignore pixelwise)
2522 "Resize WINDOW vertically by DELTA lines.
2523 WINDOW can be an arbitrary window and defaults to the selected
2524 one. An attempt to resize the root window of a frame will raise
2525 an error though.
2526
2527 DELTA a positive number means WINDOW shall be enlarged by DELTA
2528 lines. DELTA negative means WINDOW shall be shrunk by -DELTA
2529 lines.
2530
2531 Optional argument HORIZONTAL non-nil means resize WINDOW
2532 horizontally by DELTA columns. In this case a positive DELTA
2533 means enlarge WINDOW by DELTA columns. DELTA negative means
2534 WINDOW shall be shrunk by -DELTA columns.
2535
2536 Optional argument IGNORE, if non-nil, means to ignore restraints
2537 induced by fixed size windows or the values of the variables
2538 `window-min-height' and `window-min-width'. The following values
2539 have special meanings: `safe' means that in addition live windows
2540 are allowed to get as small as `window-safe-min-height' lines and
2541 `window-safe-min-width' columns. `preserved' means to ignore
2542 only restrictions induced by `window-preserve-size'. If IGNORE
2543 is a window, then ignore restrictions for that window only.
2544
2545 Optional argument PIXELWISE non-nil means resize WINDOW by DELTA
2546 pixels.
2547
2548 This function resizes other windows proportionally and never
2549 deletes any windows. If you want to move only the low (right)
2550 edge of WINDOW consider using `adjust-window-trailing-edge'
2551 instead."
2552 (setq window (window-normalize-window window))
2553 (let* ((frame (window-frame window))
2554 (minibuffer-window (minibuffer-window frame))
2555 sibling)
2556 (setq delta (window--size-to-pixel
2557 window delta horizontal pixelwise t))
2558 (cond
2559 ((eq window (frame-root-window frame))
2560 (error "Cannot resize the root window of a frame"))
2561 ((window-minibuffer-p window)
2562 (if horizontal
2563 (error "Cannot resize minibuffer window horizontally")
2564 (window--resize-mini-window window delta)))
2565 ((and (not horizontal)
2566 (window-full-height-p window)
2567 (eq (window-frame minibuffer-window) frame)
2568 (or (not resize-mini-windows)
2569 (eq minibuffer-window (active-minibuffer-window))))
2570 ;; If WINDOW is full height and either `resize-mini-windows' is
2571 ;; nil or the minibuffer window is active, resize the minibuffer
2572 ;; window.
2573 (window--resize-mini-window minibuffer-window (- delta)))
2574 ((or (window--resizable-p
2575 window delta horizontal ignore nil nil nil t)
2576 (and (not ignore)
2577 (setq ignore 'preserved)
2578 (window--resizable-p
2579 window delta horizontal ignore nil nil nil t)))
2580 (window--resize-reset frame horizontal)
2581 (window--resize-this-window window delta horizontal ignore t)
2582 (if (and (not window-combination-resize)
2583 (window-combined-p window horizontal)
2584 (setq sibling (or (window-right window) (window-left window)))
2585 (window-sizable-p
2586 sibling (- delta) horizontal ignore t))
2587 ;; If window-combination-resize is nil, WINDOW is part of an
2588 ;; iso-combination, and WINDOW's neighboring right or left
2589 ;; sibling can be resized as requested, resize that sibling.
2590 (let ((normal-delta
2591 (/ (float delta)
2592 (window-size (window-parent window) horizontal t))))
2593 (window--resize-this-window sibling (- delta) horizontal nil t)
2594 (set-window-new-normal
2595 window (+ (window-normal-size window horizontal)
2596 normal-delta))
2597 (set-window-new-normal
2598 sibling (- (window-normal-size sibling horizontal)
2599 normal-delta)))
2600 ;; Otherwise, resize all other windows in the same combination.
2601 (window--resize-siblings window delta horizontal ignore))
2602 (when (window--resize-apply-p frame horizontal)
2603 (if (window-resize-apply frame horizontal)
2604 (progn
2605 (window--pixel-to-total frame horizontal)
2606 (run-window-configuration-change-hook frame))
2607 (error "Failed to apply resizing %s" window))))
2608 (t
2609 (error "Cannot resize window %s" window)))))
2610
2611 (defun window-resize-no-error (window delta &optional horizontal ignore pixelwise)
2612 "Resize WINDOW vertically if it is resizable by DELTA lines.
2613 This function is like `window-resize' but does not signal an
2614 error when WINDOW cannot be resized. For the meaning of the
2615 optional arguments see the documentation of `window-resize'.
2616
2617 Optional argument PIXELWISE non-nil means interpret DELTA as
2618 pixels."
2619 (when (window--resizable-p
2620 window delta horizontal ignore nil nil nil pixelwise)
2621 (window-resize window delta horizontal ignore pixelwise)))
2622
2623 (defun window--resize-child-windows-skip-p (window)
2624 "Return non-nil if WINDOW shall be skipped by resizing routines."
2625 (memq (window-new-normal window) '(ignore stuck skip)))
2626
2627 (defun window--resize-child-windows-normal (parent horizontal window this-delta &optional trail other-delta)
2628 "Recursively set new normal height of child windows of window PARENT.
2629 HORIZONTAL non-nil means set the new normal width of these
2630 windows. WINDOW specifies a child window of PARENT that has been
2631 resized by THIS-DELTA lines (columns).
2632
2633 Optional argument TRAIL either `before' or `after' means set values
2634 only for windows before or after WINDOW. Optional argument
2635 OTHER-DELTA, a number, specifies that this many lines (columns)
2636 have been obtained from (or returned to) an ancestor window of
2637 PARENT in order to resize WINDOW."
2638 (let* ((delta-normal
2639 (if (and (= (- this-delta)
2640 (window-size window horizontal t))
2641 (zerop other-delta))
2642 ;; When WINDOW gets deleted and we can return its entire
2643 ;; space to its siblings, use WINDOW's normal size as the
2644 ;; normal delta.
2645 (- (window-normal-size window horizontal))
2646 ;; In any other case calculate the normal delta from the
2647 ;; relation of THIS-DELTA to the total size of PARENT.
2648 (/ (float this-delta)
2649 (window-size parent horizontal t))))
2650 (sub (window-child parent))
2651 (parent-normal 0.0)
2652 (skip (eq trail 'after)))
2653
2654 ;; Set parent-normal to the sum of the normal sizes of all child
2655 ;; windows of PARENT that shall be resized, excluding only WINDOW
2656 ;; and any windows specified by the optional TRAIL argument.
2657 (while sub
2658 (cond
2659 ((eq sub window)
2660 (setq skip (eq trail 'before)))
2661 (skip)
2662 (t
2663 (setq parent-normal
2664 (+ parent-normal (window-normal-size sub horizontal)))))
2665 (setq sub (window-right sub)))
2666
2667 ;; Set the new normal size of all child windows of PARENT from what
2668 ;; they should have contributed for recovering THIS-DELTA lines
2669 ;; (columns).
2670 (setq sub (window-child parent))
2671 (setq skip (eq trail 'after))
2672 (while sub
2673 (cond
2674 ((eq sub window)
2675 (setq skip (eq trail 'before)))
2676 (skip)
2677 (t
2678 (let ((old-normal (window-normal-size sub horizontal)))
2679 (set-window-new-normal
2680 sub (min 1.0 ; Don't get larger than 1.
2681 (max (- old-normal
2682 (* (/ old-normal parent-normal)
2683 delta-normal))
2684 ;; Don't drop below 0.
2685 0.0))))))
2686 (setq sub (window-right sub)))
2687
2688 (when (numberp other-delta)
2689 ;; Set the new normal size of windows from what they should have
2690 ;; contributed for recovering OTHER-DELTA lines (columns).
2691 (setq delta-normal (/ (float (window-size parent horizontal t))
2692 (+ (window-size parent horizontal t)
2693 other-delta)))
2694 (setq sub (window-child parent))
2695 (setq skip (eq trail 'after))
2696 (while sub
2697 (cond
2698 ((eq sub window)
2699 (setq skip (eq trail 'before)))
2700 (skip)
2701 (t
2702 (set-window-new-normal
2703 sub (min 1.0 ; Don't get larger than 1.
2704 (max (* (window-new-normal sub) delta-normal)
2705 ;; Don't drop below 0.
2706 0.0)))))
2707 (setq sub (window-right sub))))
2708
2709 ;; Set the new normal size of WINDOW to what is left by the sum of
2710 ;; the normal sizes of its siblings.
2711 (set-window-new-normal
2712 window
2713 (let ((sum 0))
2714 (setq sub (window-child parent))
2715 (while sub
2716 (cond
2717 ((eq sub window))
2718 ((not (numberp (window-new-normal sub)))
2719 (setq sum (+ sum (window-normal-size sub horizontal))))
2720 (t
2721 (setq sum (+ sum (window-new-normal sub)))))
2722 (setq sub (window-right sub)))
2723 ;; Don't get larger than 1 or smaller than 0.
2724 (min 1.0 (max (- 1.0 sum) 0.0))))))
2725
2726 (defun window--resize-child-windows (parent delta &optional horizontal window ignore trail edge char-size)
2727 "Resize child windows of window PARENT vertically by DELTA pixels.
2728 PARENT must be a vertically combined internal window.
2729
2730 Optional argument HORIZONTAL non-nil means resize child windows
2731 of PARENT horizontally by DELTA pixels. In this case PARENT must
2732 be a horizontally combined internal window.
2733
2734 WINDOW, if specified, must denote a child window of PARENT that
2735 is resized by DELTA pixels.
2736
2737 The optional argument IGNORE has the same meaning as for
2738 `window-resizable'.
2739
2740 Optional arguments TRAIL and EDGE, when non-nil, restrict the set
2741 of windows that shall be resized. If TRAIL equals `before',
2742 resize only windows on the left or above EDGE. If TRAIL equals
2743 `after', resize only windows on the right or below EDGE. Also,
2744 preferably only resize windows adjacent to EDGE.
2745
2746 If the optional argument CHAR-SIZE is a positive integer, it specifies
2747 the number of pixels by which windows are incrementally resized.
2748 If CHAR-SIZE is nil, this means to use the value of
2749 `frame-char-height' or `frame-char-width' of WINDOW's frame.
2750
2751 Return the symbol `normalized' if new normal sizes have been
2752 already set by this routine."
2753 (let* ((first (window-child parent))
2754 (last (window-last-child parent))
2755 (parent-total (+ (window-size parent horizontal t)
2756 delta))
2757 (char-size (or char-size
2758 (and window-resize-pixelwise 1)
2759 (frame-char-size window horizontal)))
2760 sub best-window best-value best-delta)
2761
2762 (if (and edge (memq trail '(before after))
2763 (progn
2764 (setq sub first)
2765 (while (and (window-right sub)
2766 (or (and (eq trail 'before)
2767 (not (window--resize-child-windows-skip-p
2768 (window-right sub))))
2769 (and (eq trail 'after)
2770 (window--resize-child-windows-skip-p sub))))
2771 (setq sub (window-right sub)))
2772 sub)
2773 (if horizontal
2774 (if (eq trail 'before)
2775 (= (+ (window-pixel-left sub) (window-pixel-width sub))
2776 edge)
2777 (= (window-pixel-left sub) edge))
2778 (if (eq trail 'before)
2779 (= (+ (window-pixel-top sub) (window-pixel-height sub))
2780 edge)
2781 (= (window-pixel-top sub) edge)))
2782 (window-sizable-p sub delta horizontal ignore t))
2783 ;; Resize only windows adjacent to EDGE.
2784 (progn
2785 (window--resize-this-window
2786 sub delta horizontal ignore t trail edge)
2787 (if (and window (eq (window-parent sub) parent))
2788 (progn
2789 ;; Assign new normal sizes.
2790 (set-window-new-normal
2791 sub (/ (float (window-new-pixel sub)) parent-total))
2792 (set-window-new-normal
2793 window (- (window-normal-size window horizontal)
2794 (- (window-new-normal sub)
2795 (window-normal-size sub horizontal)))))
2796 (window--resize-child-windows-normal
2797 parent horizontal sub 0 trail delta))
2798 ;; Return 'normalized to notify `window--resize-siblings' that
2799 ;; normal sizes have been already set.
2800 'normalized)
2801 ;; Resize all windows proportionally.
2802 (setq sub last)
2803 (while sub
2804 (cond
2805 ((or (window--resize-child-windows-skip-p sub)
2806 ;; Ignore windows to skip and fixed-size child windows -
2807 ;; in the latter case make it a window to skip.
2808 (and (not ignore)
2809 (window-size-fixed-p sub horizontal ignore)
2810 (set-window-new-normal sub 'ignore))))
2811 ((< delta 0)
2812 ;; When shrinking store the number of lines/cols we can get
2813 ;; from this window here together with the total/normal size
2814 ;; factor.
2815 (set-window-new-normal
2816 sub
2817 (cons
2818 ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
2819 (window-min-delta sub horizontal ignore trail t nil t)
2820 (- (/ (float (window-size sub horizontal t))
2821 parent-total)
2822 (window-normal-size sub horizontal)))))
2823 ((> delta 0)
2824 ;; When enlarging store the total/normal size factor only
2825 (set-window-new-normal
2826 sub
2827 (- (/ (float (window-size sub horizontal t))
2828 parent-total)
2829 (window-normal-size sub horizontal)))))
2830
2831 (setq sub (window-left sub)))
2832
2833 (cond
2834 ((< delta 0)
2835 ;; Shrink windows by delta.
2836 (setq best-window t)
2837 (while (and best-window (not (zerop delta)))
2838 (setq sub last)
2839 (setq best-window nil)
2840 (setq best-value most-negative-fixnum)
2841 (while sub
2842 (when (and (consp (window-new-normal sub))
2843 (not (<= (car (window-new-normal sub)) 0))
2844 (> (cdr (window-new-normal sub)) best-value))
2845 (setq best-window sub)
2846 (setq best-value (cdr (window-new-normal sub))))
2847
2848 (setq sub (window-left sub)))
2849
2850 (when best-window
2851 (setq best-delta (min (car (window-new-normal best-window))
2852 char-size (- delta)))
2853 (setq delta (+ delta best-delta))
2854 (set-window-new-pixel best-window (- best-delta) t)
2855 (set-window-new-normal
2856 best-window
2857 (if (= (car (window-new-normal best-window)) best-delta)
2858 'skip ; We can't shrink best-window any further.
2859 (cons (- (car (window-new-normal best-window)) best-delta)
2860 (- (/ (float (window-new-pixel best-window))
2861 parent-total)
2862 (window-normal-size best-window horizontal))))))))
2863 ((> delta 0)
2864 ;; Enlarge windows by delta.
2865 (setq best-window t)
2866 (while (and best-window (not (zerop delta)))
2867 (setq sub last)
2868 (setq best-window nil)
2869 (setq best-value most-positive-fixnum)
2870 (while sub
2871 (when (and (numberp (window-new-normal sub))
2872 (< (window-new-normal sub) best-value))
2873 (setq best-window sub)
2874 (setq best-value (window-new-normal sub)))
2875
2876 (setq sub (window-left sub)))
2877
2878 (when best-window
2879 (setq best-delta (min delta char-size))
2880 (setq delta (- delta best-delta))
2881 (set-window-new-pixel best-window best-delta t)
2882 (set-window-new-normal
2883 best-window
2884 (- (/ (float (window-new-pixel best-window))
2885 parent-total)
2886 (window-normal-size best-window horizontal)))))))
2887
2888 (when best-window
2889 (setq sub last)
2890 (while sub
2891 (when (or (consp (window-new-normal sub))
2892 (numberp (window-new-normal sub)))
2893 ;; Reset new normal size fields so `window-resize-apply'
2894 ;; won't use them to apply new sizes.
2895 (set-window-new-normal sub))
2896
2897 (unless (eq (window-new-normal sub) 'ignore)
2898 ;; Resize this window's child windows (back-engineering
2899 ;; delta from sub's old and new total sizes).
2900 (let ((delta (- (window-new-pixel sub)
2901 (window-size sub horizontal t))))
2902 (unless (and (zerop delta) (not trail))
2903 ;; For the TRAIL non-nil case we have to resize SUB
2904 ;; recursively even if it's size does not change.
2905 (window--resize-this-window
2906 sub delta horizontal ignore nil trail edge))))
2907 (setq sub (window-left sub)))))))
2908
2909 (defun window--resize-siblings (window delta &optional horizontal ignore trail edge char-size)
2910 "Resize other windows when WINDOW is resized vertically by DELTA pixels.
2911 Optional argument HORIZONTAL non-nil means resize other windows
2912 when WINDOW is resized horizontally by DELTA pixels. WINDOW
2913 itself is not resized by this function.
2914
2915 The optional argument IGNORE has the same meaning as for
2916 `window-resizable'.
2917
2918 Optional arguments TRAIL and EDGE, when non-nil, refine the set
2919 of windows that shall be resized. If TRAIL equals `before',
2920 resize only windows on the left or above EDGE. If TRAIL equals
2921 `after', resize only windows on the right or below EDGE. Also,
2922 preferably only resize windows adjacent to EDGE."
2923 (when (window-parent window)
2924 (let* ((parent (window-parent window))
2925 (sub (window-child parent)))
2926 (if (window-combined-p sub horizontal)
2927 ;; In an iso-combination try to extract DELTA from WINDOW's
2928 ;; siblings.
2929 (let ((skip (eq trail 'after))
2930 this-delta other-delta)
2931 ;; Decide which windows shall be left alone.
2932 (while sub
2933 (cond
2934 ((eq sub window)
2935 ;; Make sure WINDOW is left alone when
2936 ;; resizing its siblings.
2937 (set-window-new-normal sub 'ignore)
2938 (setq skip (eq trail 'before)))
2939 (skip
2940 ;; Make sure this sibling is left alone when
2941 ;; resizing its siblings.
2942 (set-window-new-normal sub 'ignore))
2943 ((not (window-size-fixed-p sub horizontal ignore))
2944 ;; Set this-delta to t to signal that we found a sibling
2945 ;; of WINDOW whose size is not fixed.
2946 (setq this-delta t)))
2947
2948 (setq sub (window-right sub)))
2949
2950 ;; Set this-delta to what we can get from WINDOW's siblings.
2951 (if (= (- delta) (window-size window horizontal t))
2952 ;; A deletion, presumably. We must handle this case
2953 ;; specially since `window--resizable' can't be used.
2954 (if this-delta
2955 ;; There's at least one resizable sibling we can
2956 ;; give WINDOW's size to.
2957 (setq this-delta delta)
2958 ;; No resizable sibling exists.
2959 (setq this-delta 0))
2960 ;; Any other form of resizing.
2961 (setq this-delta
2962 (window--resizable
2963 window delta horizontal ignore trail t nil t)))
2964
2965 ;; Set other-delta to what we still have to get from
2966 ;; ancestor windows of parent.
2967 (setq other-delta (- delta this-delta))
2968 (unless (zerop other-delta)
2969 ;; Unless we got everything from WINDOW's siblings, PARENT
2970 ;; must be resized by other-delta lines or columns.
2971 (set-window-new-pixel parent other-delta 'add))
2972
2973 (if (zerop this-delta)
2974 ;; We haven't got anything from WINDOW's siblings but we
2975 ;; must update the normal sizes to respect other-delta.
2976 (window--resize-child-windows-normal
2977 parent horizontal window this-delta trail other-delta)
2978 ;; We did get something from WINDOW's siblings which means
2979 ;; we have to resize their child windows.
2980 (unless (eq (window--resize-child-windows
2981 parent (- this-delta) horizontal
2982 window ignore trail edge char-size)
2983 ;; If `window--resize-child-windows' returns
2984 ;; 'normalized, this means it has set the
2985 ;; normal sizes already.
2986 'normalized)
2987 ;; Set the normal sizes.
2988 (window--resize-child-windows-normal
2989 parent horizontal window this-delta trail other-delta))
2990 ;; Set DELTA to what we still have to get from ancestor
2991 ;; windows.
2992 (setq delta other-delta)))
2993
2994 ;; In an ortho-combination all siblings of WINDOW must be
2995 ;; resized by DELTA.
2996 (set-window-new-pixel parent delta 'add)
2997 (while sub
2998 (unless (eq sub window)
2999 (window--resize-this-window
3000 sub delta horizontal ignore t))
3001 (setq sub (window-right sub))))
3002
3003 (unless (zerop delta)
3004 ;; "Go up."
3005 (window--resize-siblings
3006 parent delta horizontal ignore trail edge char-size)))))
3007
3008 (defun window--resize-this-window (window delta &optional horizontal ignore add trail edge char-size)
3009 "Resize WINDOW vertically by DELTA pixels.
3010 Optional argument HORIZONTAL non-nil means resize WINDOW
3011 horizontally by DELTA pixels.
3012
3013 The optional argument IGNORE has the same meaning as for
3014 `window-resizable'. Optional argument ADD non-nil means add
3015 DELTA to the new total size of WINDOW.
3016
3017 Optional arguments TRAIL and EDGE, when non-nil, refine the set
3018 of windows that shall be resized. If TRAIL equals `before',
3019 resize only windows on the left or above EDGE. If TRAIL equals
3020 `after', resize only windows on the right or below EDGE. Also,
3021 preferably only resize windows adjacent to EDGE.
3022
3023 If the optional argument CHAR-SIZE is a positive integer, it specifies
3024 the number of pixels by which windows are incrementally resized.
3025 If CHAR-SIZE is nil, this means to use the value of
3026 `frame-char-height' or `frame-char-width' of WINDOW's frame.
3027
3028 This function recursively resizes WINDOW's child windows to fit the
3029 new size. Make sure that WINDOW is `window--resizable' before
3030 calling this function. Note that this function does not resize
3031 siblings of WINDOW or WINDOW's parent window. You have to
3032 eventually call `window-resize-apply' in order to make resizing
3033 actually take effect."
3034 (when add
3035 ;; Add DELTA to the new total size of WINDOW.
3036 (set-window-new-pixel window delta t))
3037
3038 (let ((sub (window-child window)))
3039 (cond
3040 ((not sub))
3041 ((window-combined-p sub horizontal)
3042 ;; In an iso-combination resize child windows according to their
3043 ;; normal sizes.
3044 (window--resize-child-windows
3045 window delta horizontal nil ignore trail edge char-size))
3046 ;; In an ortho-combination resize each child window by DELTA.
3047 (t
3048 (while sub
3049 (window--resize-this-window
3050 sub delta horizontal ignore t trail edge char-size)
3051 (setq sub (window-right sub)))))))
3052
3053 (defun window--resize-root-window (window delta horizontal ignore pixelwise)
3054 "Resize root window WINDOW vertically by DELTA lines.
3055 HORIZONTAL non-nil means resize root window WINDOW horizontally
3056 by DELTA columns.
3057
3058 IGNORE non-nil means ignore any restrictions imposed by fixed
3059 size windows, `window-min-height' or `window-min-width' settings.
3060
3061 This function is only called by the frame resizing routines. It
3062 resizes windows proportionally and never deletes any windows."
3063 (when (and (windowp window) (numberp delta))
3064 (let ((pixel-delta
3065 (if pixelwise
3066 delta
3067 (window--size-to-pixel window delta horizontal))))
3068 (when (window-sizable-p window pixel-delta horizontal ignore t)
3069 (window--resize-reset (window-frame window) horizontal)
3070 (window--resize-this-window
3071 window pixel-delta horizontal ignore t)))))
3072
3073 (defun window--resize-root-window-vertically (window delta pixelwise)
3074 "Resize root window WINDOW vertically by DELTA lines.
3075 If DELTA is less than zero and we can't shrink WINDOW by DELTA
3076 lines, shrink it as much as possible. If DELTA is greater than
3077 zero, this function can resize fixed-size windows in order to
3078 recover the necessary lines. Return the number of lines that
3079 were recovered.
3080
3081 Third argument PIXELWISE non-nil means to interpret DELTA as
3082 pixels and return the number of pixels that were recovered.
3083
3084 This function is called by the minibuffer window resizing
3085 routines."
3086 (let* ((frame (window-frame window))
3087 (pixel-delta
3088 (cond
3089 (pixelwise
3090 delta)
3091 ((numberp delta)
3092 (* (frame-char-height frame) delta))
3093 (t 0)))
3094 ignore)
3095 (cond
3096 ((zerop pixel-delta))
3097 ((< pixel-delta 0)
3098 (setq pixel-delta (window-sizable window pixel-delta nil nil pixelwise))
3099 (window--resize-reset frame)
3100 ;; When shrinking the root window, emulate an edge drag in order
3101 ;; to not resize other windows if we can avoid it (Bug#12419).
3102 (window--resize-this-window
3103 window pixel-delta nil ignore t 'before
3104 (+ (window-pixel-top window) (window-pixel-height window)))
3105 ;; Don't record new normal sizes to make sure that shrinking back
3106 ;; proportionally works as intended.
3107 (walk-window-tree
3108 (lambda (window) (set-window-new-normal window 'ignore)) frame t))
3109 ((> pixel-delta 0)
3110 (window--resize-reset frame)
3111 (unless (window-sizable window pixel-delta nil nil pixelwise)
3112 (setq ignore t))
3113 ;; When growing the root window, resize proportionally. This
3114 ;; should give windows back their original sizes (hopefully).
3115 (window--resize-this-window
3116 window pixel-delta nil ignore t)))
3117 ;; Return the possibly adjusted DELTA.
3118 (if pixelwise
3119 pixel-delta
3120 (/ pixel-delta (frame-char-height frame)))))
3121
3122 (defun window--sanitize-window-sizes (frame horizontal)
3123 "Assert that all windows on FRAME are large enough.
3124 If necessary and possible, make sure that every window on frame
3125 FRAME has its minimum height. Optional argument HORIZONTAL
3126 non-nil means to make sure that every window on frame FRAME has
3127 its minimum width. The minimum height/width of a window is the
3128 respective value returned by `window-min-size' for that window.
3129
3130 Return t if all windows were resized appropriately. Return nil
3131 if at least one window could not be resized as requested, which
3132 may happen when the FRAME is not large enough to accommodate it."
3133 (let ((value t))
3134 (walk-window-tree
3135 (lambda (window)
3136 (let ((delta (- (window-min-size window horizontal nil t)
3137 (window-size window horizontal t))))
3138 (when (> delta 0)
3139 (if (window-resizable-p window delta horizontal nil t)
3140 (window-resize window delta horizontal nil t)
3141 (setq value nil))))))
3142 value))
3143
3144 (defun adjust-window-trailing-edge (window delta &optional horizontal pixelwise)
3145 "Move WINDOW's bottom edge by DELTA lines.
3146 Optional argument HORIZONTAL non-nil means move WINDOW's right
3147 edge by DELTA columns. WINDOW must be a valid window and
3148 defaults to the selected one.
3149
3150 Optional argument PIXELWISE non-nil means interpret DELTA as
3151 number of pixels.
3152
3153 If DELTA is greater than zero, move the edge downwards or to the
3154 right. If DELTA is less than zero, move the edge upwards or to
3155 the left. If the edge can't be moved by DELTA lines or columns,
3156 move it as far as possible in the desired direction."
3157 (setq window (window-normalize-window window))
3158 (let* ((frame (window-frame window))
3159 (minibuffer-window (minibuffer-window frame))
3160 (right window)
3161 left first-left first-right this-delta min-delta max-delta ignore)
3162
3163 (unless pixelwise
3164 (setq pixelwise t)
3165 (setq delta (* delta (frame-char-size window horizontal))))
3166
3167 ;; Find the edge we want to move.
3168 (while (and (or (not (window-combined-p right horizontal))
3169 (not (window-right right)))
3170 (setq right (window-parent right))))
3171 (cond
3172 ((and (not right) (not horizontal)
3173 ;; Resize the minibuffer window if it's on the same frame as
3174 ;; and immediately below WINDOW and it's either active or
3175 ;; `resize-mini-windows' is nil.
3176 (eq (window-frame minibuffer-window) frame)
3177 (= (nth 1 (window-pixel-edges minibuffer-window))
3178 (nth 3 (window-pixel-edges window)))
3179 (or (not resize-mini-windows)
3180 (eq minibuffer-window (active-minibuffer-window))))
3181 (window--resize-mini-window minibuffer-window (- delta)))
3182 ((or (not (setq left right)) (not (setq right (window-right right))))
3183 (if horizontal
3184 (user-error "No window on the right of this one")
3185 (user-error "No window below this one")))
3186 (t
3187 ;; Set LEFT to the first resizable window on the left. This step is
3188 ;; needed to handle fixed-size windows.
3189 (setq first-left left)
3190 (while (and left
3191 (or (window-size-fixed-p left horizontal)
3192 (and (< delta 0)
3193 (<= (window-size left horizontal t)
3194 (window-min-size left horizontal nil t)))))
3195 (setq left
3196 (or (window-left left)
3197 (progn
3198 (while (and (setq left (window-parent left))
3199 (not (window-combined-p left horizontal))))
3200 (window-left left)))))
3201 (unless left
3202 ;; We have to resize a size-preserved window. Start again with
3203 ;; the window initially on the left.
3204 (setq ignore 'preserved)
3205 (setq left first-left)
3206 (while (and left
3207 (or (window-size-fixed-p left horizontal 'preserved)
3208 (<= (window-size left horizontal t)
3209 (window-min-size left horizontal 'preserved t))))
3210 (setq left
3211 (or (window-left left)
3212 (progn
3213 (while (and (setq left (window-parent left))
3214 (not (window-combined-p left horizontal))))
3215 (window-left left)))))
3216
3217 (unless left
3218 (if horizontal
3219 (user-error "No resizable window on the left of this one")
3220 (user-error "No resizable window above this one"))))
3221
3222 ;; Set RIGHT to the first resizable window on the right. This step
3223 ;; is needed to handle fixed-size windows.
3224 (setq first-right right)
3225 (while (and right
3226 (or (window-size-fixed-p right horizontal)
3227 (and (> delta 0)
3228 (<= (window-size right horizontal t)
3229 (window-min-size right horizontal 'preserved t)))))
3230 (setq right
3231 (or (window-right right)
3232 (progn
3233 (while (and (setq right (window-parent right))
3234 (not (window-combined-p right horizontal))))
3235 (window-right right)))))
3236 (unless right
3237 ;; We have to resize a size-preserved window. Start again with
3238 ;; the window initially on the right.
3239 (setq ignore 'preserved)
3240 (setq right first-right)
3241 (while (and right
3242 (or (window-size-fixed-p right horizontal 'preserved)
3243 (<= (window-size right horizontal t)
3244 (window-min-size right horizontal 'preserved t))))
3245 (setq right
3246 (or (window-right right)
3247 (progn
3248 (while (and (setq right (window-parent right))
3249 (not (window-combined-p right horizontal))))
3250 (window-right right)))))
3251 (unless right
3252 (if horizontal
3253 (user-error "No resizable window on the right of this one")
3254 (user-error "No resizable window below this one"))))
3255
3256 ;; LEFT and RIGHT (which might be both internal windows) are now the
3257 ;; two windows we want to resize.
3258 (cond
3259 ((> delta 0)
3260 (setq max-delta
3261 (window--max-delta-1
3262 left 0 horizontal ignore 'after nil pixelwise))
3263 (setq min-delta
3264 (window--min-delta-1
3265 right (- delta) horizontal ignore 'before nil pixelwise))
3266 (when (or (< max-delta delta) (> min-delta (- delta)))
3267 ;; We can't get the whole DELTA - move as far as possible.
3268 (setq delta (min max-delta (- min-delta))))
3269 (unless (zerop delta)
3270 ;; Start resizing.
3271 (window--resize-reset frame horizontal)
3272 ;; Try to enlarge LEFT first.
3273 (setq this-delta (window--resizable
3274 left delta horizontal ignore 'after nil nil pixelwise))
3275 (unless (zerop this-delta)
3276 (window--resize-this-window
3277 left this-delta horizontal ignore t 'before
3278 (if horizontal
3279 (+ (window-pixel-left left) (window-pixel-width left))
3280 (+ (window-pixel-top left) (window-pixel-height left)))))
3281 ;; Shrink windows on right of LEFT.
3282 (window--resize-siblings
3283 left delta horizontal ignore 'after
3284 (if horizontal
3285 (window-pixel-left right)
3286 (window-pixel-top right)))))
3287 ((< delta 0)
3288 (setq max-delta
3289 (window--max-delta-1
3290 right 0 horizontal ignore 'before nil pixelwise))
3291 (setq min-delta
3292 (window--min-delta-1
3293 left delta horizontal ignore 'after nil pixelwise))
3294 (when (or (< max-delta (- delta)) (> min-delta delta))
3295 ;; We can't get the whole DELTA - move as far as possible.
3296 (setq delta (max (- max-delta) min-delta)))
3297 (unless (zerop delta)
3298 ;; Start resizing.
3299 (window--resize-reset frame horizontal)
3300 ;; Try to enlarge RIGHT.
3301 (setq this-delta
3302 (window--resizable
3303 right (- delta) horizontal ignore 'before nil nil pixelwise))
3304 (unless (zerop this-delta)
3305 (window--resize-this-window
3306 right this-delta horizontal ignore t 'after
3307 (if horizontal
3308 (window-pixel-left right)
3309 (window-pixel-top right))))
3310 ;; Shrink windows on left of RIGHT.
3311 (window--resize-siblings
3312 right (- delta) horizontal ignore 'before
3313 (if horizontal
3314 (+ (window-pixel-left left) (window-pixel-width left))
3315 (+ (window-pixel-top left) (window-pixel-height left)))))))
3316 (unless (zerop delta)
3317 ;; Don't report an error in the standard case.
3318 (when (window--resize-apply-p frame horizontal)
3319 (if (window-resize-apply frame horizontal)
3320 (progn
3321 (window--pixel-to-total frame horizontal)
3322 (run-window-configuration-change-hook frame))
3323 ;; But do report an error if applying the changes fails.
3324 (error "Failed adjusting window %s" window))))))))
3325
3326 (defun enlarge-window (delta &optional horizontal)
3327 "Make the selected window DELTA lines taller.
3328 Interactively, if no argument is given, make the selected window
3329 one line taller. If optional argument HORIZONTAL is non-nil,
3330 make selected window wider by DELTA columns. If DELTA is
3331 negative, shrink selected window by -DELTA lines or columns."
3332 (interactive "p")
3333 (let ((minibuffer-window (minibuffer-window)))
3334 (when (window-preserved-size nil horizontal)
3335 (window-preserve-size nil horizontal))
3336 (cond
3337 ((zerop delta))
3338 ((window-size-fixed-p nil horizontal)
3339 (user-error "Selected window has fixed size"))
3340 ((window-minibuffer-p)
3341 (if horizontal
3342 (user-error "Cannot resize minibuffer window horizontally")
3343 (window--resize-mini-window
3344 (selected-window) (* delta (frame-char-height)))))
3345 ((and (not horizontal)
3346 (window-full-height-p)
3347 (eq (window-frame minibuffer-window) (selected-frame))
3348 (not resize-mini-windows))
3349 ;; If the selected window is full height and `resize-mini-windows'
3350 ;; is nil, resize the minibuffer window.
3351 (window--resize-mini-window
3352 minibuffer-window (* (- delta) (frame-char-height))))
3353 ((window--resizable-p nil delta horizontal)
3354 (window-resize nil delta horizontal))
3355 ((window--resizable-p nil delta horizontal 'preserved)
3356 (window-resize nil delta horizontal 'preserved))
3357 ((eq this-command
3358 (if horizontal 'enlarge-window-horizontally 'enlarge-window))
3359 ;; For backward compatibility don't signal an error unless this
3360 ;; command is `enlarge-window(-horizontally)'.
3361 (user-error "Cannot enlarge selected window"))
3362 (t
3363 (window-resize
3364 nil (if (> delta 0)
3365 (window-max-delta nil horizontal)
3366 (- (window-min-delta nil horizontal)))
3367 horizontal)))))
3368
3369 (defun shrink-window (delta &optional horizontal)
3370 "Make the selected window DELTA lines smaller.
3371 Interactively, if no argument is given, make the selected window
3372 one line smaller. If optional argument HORIZONTAL is non-nil,
3373 make selected window narrower by DELTA columns. If DELTA is
3374 negative, enlarge selected window by -DELTA lines or columns."
3375 (interactive "p")
3376 (let ((minibuffer-window (minibuffer-window)))
3377 (when (window-preserved-size nil horizontal)
3378 (window-preserve-size nil horizontal))
3379 (cond
3380 ((zerop delta))
3381 ((window-size-fixed-p nil horizontal)
3382 (user-error "Selected window has fixed size"))
3383 ((window-minibuffer-p)
3384 (if horizontal
3385 (user-error "Cannot resize minibuffer window horizontally")
3386 (window--resize-mini-window
3387 (selected-window) (* (- delta) (frame-char-height)))))
3388 ((and (not horizontal)
3389 (window-full-height-p)
3390 (eq (window-frame minibuffer-window) (selected-frame))
3391 (not resize-mini-windows))
3392 ;; If the selected window is full height and `resize-mini-windows'
3393 ;; is nil, resize the minibuffer window.
3394 (window--resize-mini-window
3395 minibuffer-window (* delta (frame-char-height))))
3396 ((window--resizable-p nil (- delta) horizontal)
3397 (window-resize nil (- delta) horizontal))
3398 ((window--resizable-p nil (- delta) horizontal 'preserved)
3399 (window-resize nil (- delta) horizontal 'preserved))
3400 ((eq this-command
3401 (if horizontal 'shrink-window-horizontally 'shrink-window))
3402 ;; For backward compatibility don't signal an error unless this
3403 ;; command is `shrink-window(-horizontally)'.
3404 (user-error "Cannot shrink selected window"))
3405 (t
3406 (window-resize
3407 nil (if (> delta 0)
3408 (- (window-min-delta nil horizontal))
3409 (window-max-delta nil horizontal))
3410 horizontal)))))
3411
3412 (defun maximize-window (&optional window)
3413 "Maximize WINDOW.
3414 Make WINDOW as large as possible without deleting any windows.
3415 WINDOW must be a valid window and defaults to the selected one.
3416
3417 If the option `window-resize-pixelwise' is non-nil maximize
3418 WINDOW pixelwise."
3419 (interactive)
3420 (setq window (window-normalize-window window))
3421 (window-resize
3422 window (window-max-delta window nil nil nil nil nil window-resize-pixelwise)
3423 nil nil window-resize-pixelwise)
3424 (window-resize
3425 window (window-max-delta window t nil nil nil nil window-resize-pixelwise)
3426 t nil window-resize-pixelwise))
3427
3428 (defun minimize-window (&optional window)
3429 "Minimize WINDOW.
3430 Make WINDOW as small as possible without deleting any windows.
3431 WINDOW must be a valid window and defaults to the selected one.
3432
3433 If the option `window-resize-pixelwise' is non-nil minimize
3434 WINDOW pixelwise."
3435 (interactive)
3436 (setq window (window-normalize-window window))
3437 (window-resize
3438 window
3439 (- (window-min-delta window nil nil nil nil nil window-resize-pixelwise))
3440 nil nil window-resize-pixelwise)
3441 (window-resize
3442 window
3443 (- (window-min-delta window t nil nil nil nil window-resize-pixelwise))
3444 t nil window-resize-pixelwise))
3445 \f
3446 ;;; Window edges
3447 (defun window-edges (&optional window body absolute pixelwise)
3448 "Return a list of the edge distances of WINDOW.
3449 WINDOW must be a valid window and defaults to the selected one.
3450 The list returned has the form (LEFT TOP RIGHT BOTTOM).
3451
3452 If the optional argument BODY is nil, this means to return the
3453 edges corresponding to the total size of WINDOW. BODY non-nil
3454 means to return the edges of WINDOW's body (aka text area). If
3455 BODY is non-nil, WINDOW must specify a live window.
3456
3457 Optional argument ABSOLUTE nil means to return edges relative to
3458 the position of WINDOW's native frame. ABSOLUTE non-nil means to
3459 return coordinates relative to the origin - the position (0, 0) -
3460 of FRAME's display. On non-graphical systems this argument has
3461 no effect.
3462
3463 Optional argument PIXELWISE nil means to return the coordinates
3464 in terms of the canonical character width and height of WINDOW's
3465 frame, rounded if necessary. PIXELWISE non-nil means to return
3466 the coordinates in pixels where the values for RIGHT and BOTTOM
3467 are one more than the actual value of these edges. Note that if
3468 ABSOLUTE is non-nil, PIXELWISE is implicitly non-nil too."
3469 (let* ((window (window-normalize-window window body))
3470 (frame (window-frame window))
3471 (border-width (frame-border-width frame))
3472 (char-width (frame-char-width frame))
3473 (char-height (frame-char-height frame))
3474 (left (if pixelwise
3475 (+ (window-pixel-left window) border-width)
3476 (+ (window-left-column window)
3477 (/ border-width char-width))))
3478 (left-body
3479 (when body
3480 (+ (window-pixel-left window) border-width
3481 (if (eq (car (window-current-scroll-bars window)) 'left)
3482 (window-scroll-bar-width window)
3483 0)
3484 (nth 0 (window-fringes window))
3485 (* (or (nth 0 (window-margins window)) 0) char-width))))
3486 (top (if pixelwise
3487 (+ (window-pixel-top window) border-width)
3488 (+ (window-top-line window)
3489 (/ border-width char-height))))
3490 (top-body
3491 (when body
3492 (+ (window-pixel-top window) border-width
3493 (window-header-line-height window))))
3494 (right (+ left (if pixelwise
3495 (window-pixel-width window)
3496 (window-total-width window))))
3497 (right-body (and body (+ left-body (window-body-width window t))))
3498 (bottom (+ top (if pixelwise
3499 (window-pixel-height window)
3500 (window-total-height window))))
3501 (bottom-body (and body (+ top-body (window-body-height window t))))
3502 left-off right-off)
3503 (if absolute
3504 (let* ((native-edges (frame-edges frame 'native-edges))
3505 (left-off (nth 0 native-edges))
3506 (top-off (nth 1 native-edges)))
3507 (if body
3508 (list (+ left-body left-off) (+ top-body top-off)
3509 (+ right-body left-off) (+ bottom-body top-off))
3510 (list (+ left left-off) (+ top top-off)
3511 (+ right left-off) (+ bottom top-off))))
3512 (if body
3513 (if pixelwise
3514 (list left-body top-body right-body bottom-body)
3515 (list (/ left-body char-width) (/ top-body char-height)
3516 ;; Round up.
3517 (/ (+ right-body char-width -1) char-width)
3518 (/ (+ bottom-body char-height -1) char-height)))
3519 (list left top right bottom)))))
3520
3521 (defun window-body-edges (&optional window)
3522 "Return a list of the edge coordinates of WINDOW's body.
3523 The return value is that of `window-edges' called with argument
3524 BODY non-nil."
3525 (window-edges window t))
3526 (defalias 'window-inside-edges 'window-body-edges)
3527
3528 (defun window-pixel-edges (&optional window)
3529 "Return a list of the edge pixel coordinates of WINDOW.
3530 The return value is that of `window-edges' called with argument
3531 PIXELWISE non-nil."
3532 (window-edges window nil nil t))
3533
3534 (defun window-body-pixel-edges (&optional window)
3535 "Return a list of the edge pixel coordinates of WINDOW's body.
3536 The return value is that of `window-edges' called with arguments
3537 BODY and PIXELWISE non-nil."
3538 (window-edges window t nil t))
3539 (defalias 'window-inside-pixel-edges 'window-body-pixel-edges)
3540
3541 (defun window-absolute-pixel-edges (&optional window)
3542 "Return a list of the edge pixel coordinates of WINDOW.
3543 The return value is that of `window-edges' called with argument
3544 ABSOLUTE non-nil."
3545 (window-edges window nil t t))
3546
3547 (defun window-absolute-body-pixel-edges (&optional window)
3548 "Return a list of the edge pixel coordinates of WINDOW's text area.
3549 The return value is that of `window-edges' called with arguments
3550 BODY and ABSOLUTE non-nil."
3551 (window-edges window t t t))
3552 (defalias 'window-inside-absolute-pixel-edges 'window-absolute-body-pixel-edges)
3553
3554 (defun window-absolute-pixel-position (&optional position window)
3555 "Return display coordinates of POSITION in WINDOW.
3556 If the buffer position POSITION is visible in window WINDOW,
3557 return the display coordinates of the upper/left corner of the
3558 glyph at POSITION. The return value is a cons of the X- and
3559 Y-coordinates of that corner, relative to an origin at (0, 0) of
3560 WINDOW's display. Return nil if POSITION is not visible in
3561 WINDOW.
3562
3563 WINDOW must be a live window and defaults to the selected window.
3564 POSITION defaults to the value of `window-point' of WINDOW."
3565 (let* ((window (window-normalize-window window t))
3566 (pos-in-window
3567 (pos-visible-in-window-p
3568 (or position (window-point window)) window t)))
3569 (when pos-in-window
3570 (let ((edges (window-absolute-body-pixel-edges window)))
3571 (cons (+ (nth 0 edges) (nth 0 pos-in-window))
3572 (+ (nth 1 edges) (nth 1 pos-in-window)))))))
3573 \f
3574 (defun frame-root-window-p (window)
3575 "Return non-nil if WINDOW is the root window of its frame."
3576 (eq window (frame-root-window window)))
3577
3578 (defun window--subtree (window &optional next)
3579 "Return window subtree rooted at WINDOW.
3580 Optional argument NEXT non-nil means include WINDOW's right
3581 siblings in the return value.
3582
3583 See the documentation of `window-tree' for a description of the
3584 return value."
3585 (let (list)
3586 (while window
3587 (setq list
3588 (cons
3589 (cond
3590 ((window-top-child window)
3591 (cons t (cons (window-edges window)
3592 (window--subtree (window-top-child window) t))))
3593 ((window-left-child window)
3594 (cons nil (cons (window-edges window)
3595 (window--subtree (window-left-child window) t))))
3596 (t window))
3597 list))
3598 (setq window (when next (window-next-sibling window))))
3599 (nreverse list)))
3600
3601 (defun window-tree (&optional frame)
3602 "Return the window tree of frame FRAME.
3603 FRAME must be a live frame and defaults to the selected frame.
3604 The return value is a list of the form (ROOT MINI), where ROOT
3605 represents the window tree of the frame's root window, and MINI
3606 is the frame's minibuffer window.
3607
3608 If the root window is not split, ROOT is the root window itself.
3609 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
3610 for a horizontal split, and t for a vertical split. EDGES gives
3611 the combined size and position of the child windows in the split,
3612 and the rest of the elements are the child windows in the split.
3613 Each of the child windows may again be a window or a list
3614 representing a window split, and so on. EDGES is a list (LEFT
3615 TOP RIGHT BOTTOM) as returned by `window-edges'."
3616 (setq frame (window-normalize-frame frame))
3617 (window--subtree (frame-root-window frame) t))
3618 \f
3619 (defun other-window (count &optional all-frames)
3620 "Select another window in cyclic ordering of windows.
3621 COUNT specifies the number of windows to skip, starting with the
3622 selected window, before making the selection. If COUNT is
3623 positive, skip COUNT windows forwards. If COUNT is negative,
3624 skip -COUNT windows backwards. COUNT zero means do not skip any
3625 window, so select the selected window. In an interactive call,
3626 COUNT is the numeric prefix argument. Return nil.
3627
3628 If the `other-window' parameter of the selected window is a
3629 function and `ignore-window-parameters' is nil, call that
3630 function with the arguments COUNT and ALL-FRAMES.
3631
3632 This function does not select a window whose `no-other-window'
3633 window parameter is non-nil.
3634
3635 This function uses `next-window' for finding the window to
3636 select. The argument ALL-FRAMES has the same meaning as in
3637 `next-window', but the MINIBUF argument of `next-window' is
3638 always effectively nil."
3639 (interactive "p")
3640 (let* ((window (selected-window))
3641 (function (and (not ignore-window-parameters)
3642 (window-parameter window 'other-window)))
3643 old-window old-count)
3644 (if (functionp function)
3645 (funcall function count all-frames)
3646 ;; `next-window' and `previous-window' may return a window we are
3647 ;; not allowed to select. Hence we need an exit strategy in case
3648 ;; all windows are non-selectable.
3649 (catch 'exit
3650 (while (> count 0)
3651 (setq window (next-window window nil all-frames))
3652 (cond
3653 ((eq window old-window)
3654 (when (= count old-count)
3655 ;; Keep out of infinite loops. When COUNT has not changed
3656 ;; since we last looked at `window' we're probably in one.
3657 (throw 'exit nil)))
3658 ((window-parameter window 'no-other-window)
3659 (unless old-window
3660 ;; The first non-selectable window `next-window' got us:
3661 ;; Remember it and the current value of COUNT.
3662 (setq old-window window)
3663 (setq old-count count)))
3664 (t
3665 (setq count (1- count)))))
3666 (while (< count 0)
3667 (setq window (previous-window window nil all-frames))
3668 (cond
3669 ((eq window old-window)
3670 (when (= count old-count)
3671 ;; Keep out of infinite loops. When COUNT has not changed
3672 ;; since we last looked at `window' we're probably in one.
3673 (throw 'exit nil)))
3674 ((window-parameter window 'no-other-window)
3675 (unless old-window
3676 ;; The first non-selectable window `previous-window' got
3677 ;; us: Remember it and the current value of COUNT.
3678 (setq old-window window)
3679 (setq old-count count)))
3680 (t
3681 (setq count (1+ count)))))
3682
3683 (select-window window)
3684 ;; Always return nil.
3685 nil))))
3686
3687 ;; This should probably return non-nil when the selected window is part
3688 ;; of an atomic window whose root is the frame's root window.
3689 (defun one-window-p (&optional nomini all-frames)
3690 "Return non-nil if the selected window is the only window.
3691 Optional arg NOMINI non-nil means don't count the minibuffer
3692 even if it is active. Otherwise, the minibuffer is counted
3693 when it is active.
3694
3695 Optional argument ALL-FRAMES specifies the set of frames to
3696 consider, see also `next-window'. ALL-FRAMES nil or omitted
3697 means consider windows on the selected frame only, plus the
3698 minibuffer window if specified by the NOMINI argument. If the
3699 minibuffer counts, consider all windows on all frames that share
3700 that minibuffer too. The remaining non-nil values of ALL-FRAMES
3701 with a special meaning are:
3702
3703 - t means consider all windows on all existing frames.
3704
3705 - `visible' means consider all windows on all visible frames on
3706 the current terminal.
3707
3708 - 0 (the number zero) means consider all windows on all visible
3709 and iconified frames on the current terminal.
3710
3711 - A frame means consider all windows on that frame only.
3712
3713 Anything else means consider all windows on the selected frame
3714 and no others."
3715 (let ((base-window (selected-window)))
3716 (if (and nomini (eq base-window (minibuffer-window)))
3717 (setq base-window (next-window base-window)))
3718 (eq base-window
3719 (next-window base-window (if nomini 'arg) all-frames))))
3720 \f
3721 ;;; Deleting windows.
3722 (defun window-deletable-p (&optional window)
3723 "Return t if WINDOW can be safely deleted from its frame.
3724 WINDOW must be a valid window and defaults to the selected one.
3725 Return `frame' if deleting WINDOW should also delete its frame."
3726 (setq window (window-normalize-window window))
3727
3728 (unless (or ignore-window-parameters
3729 (eq (window-parameter window 'delete-window) t))
3730 ;; Handle atomicity.
3731 (when (window-parameter window 'window-atom)
3732 (setq window (window-atom-root window))))
3733
3734 (let ((frame (window-frame window)))
3735 (cond
3736 ((frame-root-window-p window)
3737 ;; WINDOW's frame can be deleted only if there are other frames
3738 ;; on the same terminal, and it does not contain the active
3739 ;; minibuffer.
3740 (unless (or (eq frame (next-frame frame 0))
3741 ;; We can delete our frame only if no other frame
3742 ;; currently uses our minibuffer window.
3743 (catch 'other
3744 (dolist (other (frame-list))
3745 (when (and (not (eq other frame))
3746 (eq (window-frame (minibuffer-window other))
3747 frame))
3748 (throw 'other t))))
3749 (let ((minibuf (active-minibuffer-window)))
3750 (and minibuf (eq frame (window-frame minibuf)))))
3751 'frame))
3752 ((or ignore-window-parameters
3753 (not (eq window (window--major-non-side-window frame))))
3754 ;; WINDOW can be deleted unless it is the major non-side window of
3755 ;; its frame.
3756 t))))
3757
3758 (defun window--in-subtree-p (window root)
3759 "Return t if WINDOW is either ROOT or a member of ROOT's subtree."
3760 (or (eq window root)
3761 (let ((parent (window-parent window)))
3762 (catch 'done
3763 (while parent
3764 (if (eq parent root)
3765 (throw 'done t)
3766 (setq parent (window-parent parent))))))))
3767
3768 (defun delete-window (&optional window)
3769 "Delete WINDOW.
3770 WINDOW must be a valid window and defaults to the selected one.
3771 Return nil.
3772
3773 If the variable `ignore-window-parameters' is non-nil or the
3774 `delete-window' parameter of WINDOW equals t, do not process any
3775 parameters of WINDOW. Otherwise, if the `delete-window'
3776 parameter of WINDOW specifies a function, call that function with
3777 WINDOW as its sole argument and return the value returned by that
3778 function.
3779
3780 Otherwise, if WINDOW is part of an atomic window, call
3781 `delete-window' with the root of the atomic window as its
3782 argument. Signal an error if WINDOW is either the only window on
3783 its frame, the last non-side window, or part of an atomic window
3784 that is its frame's root window."
3785 (interactive)
3786 (setq window (window-normalize-window window))
3787 (let* ((frame (window-frame window))
3788 (function (window-parameter window 'delete-window))
3789 (parent (window-parent window))
3790 atom-root)
3791 (window--check frame)
3792 (catch 'done
3793 ;; Handle window parameters.
3794 (cond
3795 ;; Ignore window parameters if `ignore-window-parameters' tells
3796 ;; us so or `delete-window' equals t.
3797 ((or ignore-window-parameters (eq function t)))
3798 ((functionp function)
3799 ;; The `delete-window' parameter specifies the function to call.
3800 ;; If that function is `ignore' nothing is done. It's up to the
3801 ;; function called here to avoid infinite recursion.
3802 (throw 'done (funcall function window)))
3803 ((and (window-parameter window 'window-atom)
3804 (setq atom-root (window-atom-root window))
3805 (not (eq atom-root window)))
3806 (if (eq atom-root (frame-root-window frame))
3807 (error "Root of atomic window is root window of its frame")
3808 (throw 'done (delete-window atom-root))))
3809 ((not parent)
3810 (error "Attempt to delete minibuffer or sole ordinary window"))
3811 ((eq window (window--major-non-side-window frame))
3812 (error "Attempt to delete last non-side window")))
3813
3814 (let* ((horizontal (window-left-child parent))
3815 (size (window-size window horizontal t))
3816 (frame-selected
3817 (window--in-subtree-p (frame-selected-window frame) window))
3818 ;; Emacs 23 preferably gives WINDOW's space to its left
3819 ;; sibling.
3820 (sibling (or (window-left window) (window-right window))))
3821 (window--resize-reset frame horizontal)
3822 (cond
3823 ((and (not window-combination-resize)
3824 sibling (window-sizable-p sibling size horizontal nil t))
3825 ;; Resize WINDOW's sibling.
3826 (window--resize-this-window sibling size horizontal nil t)
3827 (set-window-new-normal
3828 sibling (+ (window-normal-size sibling horizontal)
3829 (window-normal-size window horizontal))))
3830 ((window--resizable-p window (- size) horizontal nil nil nil t t)
3831 ;; Can do without resizing fixed-size windows.
3832 (window--resize-siblings window (- size) horizontal))
3833 (t
3834 ;; Can't do without resizing fixed-size windows.
3835 (window--resize-siblings window (- size) horizontal t)))
3836 ;; Actually delete WINDOW.
3837 (delete-window-internal window)
3838 (window--pixel-to-total frame horizontal)
3839 (when (and frame-selected
3840 (window-parameter
3841 (frame-selected-window frame) 'no-other-window))
3842 ;; `delete-window-internal' has selected a window that should
3843 ;; not be selected, fix this here.
3844 (other-window -1 frame))
3845 (run-window-configuration-change-hook frame)
3846 (window--check frame)
3847 ;; Always return nil.
3848 nil))))
3849
3850 (defun delete-other-windows (&optional window)
3851 "Make WINDOW fill its frame.
3852 WINDOW must be a valid window and defaults to the selected one.
3853 Return nil.
3854
3855 If the variable `ignore-window-parameters' is non-nil or the
3856 `delete-other-windows' parameter of WINDOW equals t, do not
3857 process any parameters of WINDOW. Otherwise, if the
3858 `delete-other-windows' parameter of WINDOW specifies a function,
3859 call that function with WINDOW as its sole argument and return
3860 the value returned by that function.
3861
3862 Otherwise, if WINDOW is part of an atomic window, call this
3863 function with the root of the atomic window as its argument. If
3864 WINDOW is a non-side window, make WINDOW the only non-side window
3865 on the frame. Side windows are not deleted. If WINDOW is a side
3866 window signal an error."
3867 (interactive)
3868 (setq window (window-normalize-window window))
3869 (let* ((frame (window-frame window))
3870 (function (window-parameter window 'delete-other-windows))
3871 (window-side (window-parameter window 'window-side))
3872 atom-root side-main)
3873 (window--check frame)
3874 (catch 'done
3875 (cond
3876 ;; Ignore window parameters if `ignore-window-parameters' is t or
3877 ;; `delete-other-windows' is t.
3878 ((or ignore-window-parameters (eq function t)))
3879 ((functionp function)
3880 ;; The `delete-other-windows' parameter specifies the function
3881 ;; to call. If the function is `ignore' no windows are deleted.
3882 ;; It's up to the function called to avoid infinite recursion.
3883 (throw 'done (funcall function window)))
3884 ((and (window-parameter window 'window-atom)
3885 (setq atom-root (window-atom-root window))
3886 (not (eq atom-root window)))
3887 (if (eq atom-root (frame-root-window frame))
3888 (error "Root of atomic window is root window of its frame")
3889 (throw 'done (delete-other-windows atom-root))))
3890 ((memq window-side window-sides)
3891 (error "Cannot make side window the only window"))
3892 ((and (window-minibuffer-p window)
3893 (not (eq window (frame-root-window window))))
3894 (error "Can't expand minibuffer to full frame")))
3895
3896 ;; If WINDOW is the major non-side window, do nothing.
3897 (if (window-with-parameter 'window-side)
3898 (setq side-main (window--major-non-side-window frame))
3899 (setq side-main (frame-root-window frame)))
3900 (unless (eq window side-main)
3901 (delete-other-windows-internal window side-main)
3902 (run-window-configuration-change-hook frame)
3903 (window--check frame))
3904 ;; Always return nil.
3905 nil)))
3906
3907 (defun delete-other-windows-vertically (&optional window)
3908 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
3909 This may be a useful alternative binding for \\[delete-other-windows]
3910 if you often split windows horizontally."
3911 (interactive)
3912 (let* ((window (or window (selected-window)))
3913 (edges (window-edges window))
3914 (w window) delenda)
3915 (while (not (eq (setq w (next-window w 1)) window))
3916 (let ((e (window-edges w)))
3917 (when (and (= (car e) (car edges))
3918 (= (nth 2 e) (nth 2 edges)))
3919 (push w delenda))))
3920 (mapc 'delete-window delenda)))
3921
3922 ;;; Windows and buffers.
3923
3924 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
3925 ;; for (1) determining which buffer to show in the window when its
3926 ;; buffer shall be buried or killed and (2) which buffer to show for
3927 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
3928
3929 ;; `prev-buffers' consists of <buffer, window-start, window-point>
3930 ;; triples. The entries on this list are ordered by the time their
3931 ;; buffer has been removed from the window, the most recently removed
3932 ;; buffer's entry being first. The window-start and window-point
3933 ;; components are `window-start' and `window-point' at the time the
3934 ;; buffer was removed from the window which implies that the entry must
3935 ;; be added when `set-window-buffer' removes the buffer from the window.
3936
3937 ;; `next-buffers' is the list of buffers that have been replaced
3938 ;; recently by `switch-to-prev-buffer'. These buffers are the least
3939 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
3940 ;; candidates of `switch-to-next-buffer' to switch to. This list is
3941 ;; reset to nil by any action changing the window's buffer with the
3942 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
3943 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
3944 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
3945
3946 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
3947 ;; if such a buffer was killed while the window was hidden within a
3948 ;; window configuration. Such killed buffers get removed whenever
3949 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
3950
3951 ;; The following function is called by `set-window-buffer' _before_ it
3952 ;; replaces the buffer of the argument window with the new buffer.
3953 (defun record-window-buffer (&optional window)
3954 "Record WINDOW's buffer.
3955 WINDOW must be a live window and defaults to the selected one."
3956 (let* ((window (window-normalize-window window t))
3957 (buffer (window-buffer window))
3958 (entry (assq buffer (window-prev-buffers window))))
3959 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
3960 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
3961 (set-window-next-buffers window nil)
3962
3963 (when entry
3964 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
3965 (set-window-prev-buffers
3966 window (assq-delete-all buffer (window-prev-buffers window))))
3967
3968 ;; Don't record insignificant buffers.
3969 (unless (eq (aref (buffer-name buffer) 0) ?\s)
3970 ;; Add an entry for buffer to WINDOW's previous buffers.
3971 (with-current-buffer buffer
3972 (let ((start (window-start window))
3973 (point (window-point window)))
3974 (setq entry
3975 (cons buffer
3976 (if entry
3977 ;; We have an entry, update marker positions.
3978 (list (set-marker (nth 1 entry) start)
3979 (set-marker (nth 2 entry) point))
3980 ;; Make new markers.
3981 (list (copy-marker start)
3982 (copy-marker
3983 ;; Preserve window-point-insertion-type
3984 ;; (Bug#12588).
3985 point window-point-insertion-type)))))
3986 (set-window-prev-buffers
3987 window (cons entry (window-prev-buffers window)))))
3988
3989 (run-hooks 'buffer-list-update-hook))))
3990
3991 (defun unrecord-window-buffer (&optional window buffer)
3992 "Unrecord BUFFER in WINDOW.
3993 WINDOW must be a live window and defaults to the selected one.
3994 BUFFER must be a live buffer and defaults to the buffer of
3995 WINDOW."
3996 (let* ((window (window-normalize-window window t))
3997 (buffer (or buffer (window-buffer window))))
3998 (set-window-prev-buffers
3999 window (assq-delete-all buffer (window-prev-buffers window)))
4000 (set-window-next-buffers
4001 window (delq buffer (window-next-buffers window)))))
4002
4003 (defun set-window-buffer-start-and-point (window buffer &optional start point)
4004 "Set WINDOW's buffer to BUFFER.
4005 WINDOW must be a live window and defaults to the selected one.
4006 Optional argument START non-nil means set WINDOW's start position
4007 to START. Optional argument POINT non-nil means set WINDOW's
4008 point to POINT. If WINDOW is selected this also sets BUFFER's
4009 `point' to POINT. If WINDOW is selected and the buffer it showed
4010 before was current this also makes BUFFER the current buffer."
4011 (setq window (window-normalize-window window t))
4012 (let ((selected (eq window (selected-window)))
4013 (current (eq (window-buffer window) (current-buffer))))
4014 (set-window-buffer window buffer)
4015 (when (and selected current)
4016 (set-buffer buffer))
4017 (when start
4018 ;; Don't force window-start here (even if POINT is nil).
4019 (set-window-start window start t))
4020 (when point
4021 (set-window-point window point))))
4022
4023 (defcustom switch-to-visible-buffer t
4024 "If non-nil, allow switching to an already visible buffer.
4025 If this variable is non-nil, `switch-to-prev-buffer' and
4026 `switch-to-next-buffer' may switch to an already visible buffer.
4027 If this variable is nil, `switch-to-prev-buffer' and
4028 `switch-to-next-buffer' always try to avoid switching to a buffer
4029 that is already visible in another window on the same frame."
4030 :type 'boolean
4031 :version "24.1"
4032 :group 'windows)
4033
4034 (defun switch-to-prev-buffer (&optional window bury-or-kill)
4035 "In WINDOW switch to previous buffer.
4036 WINDOW must be a live window and defaults to the selected one.
4037 Return the buffer switched to, nil if no suitable buffer could be
4038 found.
4039
4040 Optional argument BURY-OR-KILL non-nil means the buffer currently
4041 shown in WINDOW is about to be buried or killed and consequently
4042 shall not be switched to in future invocations of this command.
4043
4044 As a special case, if BURY-OR-KILL equals `append', this means to
4045 move the buffer to the end of WINDOW's previous buffers list so a
4046 future invocation of `switch-to-prev-buffer' less likely switches
4047 to it."
4048 (interactive)
4049 (let* ((window (window-normalize-window window t))
4050 (frame (window-frame window))
4051 (old-buffer (window-buffer window))
4052 ;; Save this since it's destroyed by `set-window-buffer'.
4053 (next-buffers (window-next-buffers window))
4054 (pred (frame-parameter frame 'buffer-predicate))
4055 entry new-buffer killed-buffers visible)
4056 (when (window-minibuffer-p window)
4057 ;; Don't switch in minibuffer window.
4058 (unless (setq window (minibuffer-selected-window))
4059 (error "Window %s is a minibuffer window" window)))
4060
4061 (when (window-dedicated-p window)
4062 ;; Don't switch in dedicated window.
4063 (error "Window %s is dedicated to buffer %s" window old-buffer))
4064
4065 (catch 'found
4066 ;; Scan WINDOW's previous buffers first, skipping entries of next
4067 ;; buffers.
4068 (dolist (entry (window-prev-buffers window))
4069 (when (and (setq new-buffer (car entry))
4070 (or (buffer-live-p new-buffer)
4071 (not (setq killed-buffers
4072 (cons new-buffer killed-buffers))))
4073 (not (eq new-buffer old-buffer))
4074 (or (null pred) (funcall pred new-buffer))
4075 ;; When BURY-OR-KILL is nil, avoid switching to a
4076 ;; buffer in WINDOW's next buffers list.
4077 (or bury-or-kill (not (memq new-buffer next-buffers))))
4078 (if (and (not switch-to-visible-buffer)
4079 (get-buffer-window new-buffer frame))
4080 ;; Try to avoid showing a buffer visible in some other
4081 ;; window.
4082 (setq visible new-buffer)
4083 (set-window-buffer-start-and-point
4084 window new-buffer (nth 1 entry) (nth 2 entry))
4085 (throw 'found t))))
4086 ;; Scan reverted buffer list of WINDOW's frame next, skipping
4087 ;; entries of next buffers. Note that when we bury or kill a
4088 ;; buffer we don't reverse the global buffer list to avoid showing
4089 ;; a buried buffer instead. Otherwise, we must reverse the global
4090 ;; buffer list in order to make sure that switching to the
4091 ;; previous/next buffer traverse it in opposite directions.
4092 (dolist (buffer (if bury-or-kill
4093 (buffer-list frame)
4094 (nreverse (buffer-list frame))))
4095 (when (and (buffer-live-p buffer)
4096 (not (eq buffer old-buffer))
4097 (or (null pred) (funcall pred buffer))
4098 (not (eq (aref (buffer-name buffer) 0) ?\s))
4099 (or bury-or-kill (not (memq buffer next-buffers))))
4100 (if (and (not switch-to-visible-buffer)
4101 (get-buffer-window buffer frame))
4102 ;; Try to avoid showing a buffer visible in some other window.
4103 (unless visible
4104 (setq visible buffer))
4105 (setq new-buffer buffer)
4106 (set-window-buffer-start-and-point window new-buffer)
4107 (throw 'found t))))
4108 (unless bury-or-kill
4109 ;; Scan reverted next buffers last (must not use nreverse
4110 ;; here!).
4111 (dolist (buffer (reverse next-buffers))
4112 ;; Actually, buffer _must_ be live here since otherwise it
4113 ;; would have been caught in the scan of previous buffers.
4114 (when (and (or (buffer-live-p buffer)
4115 (not (setq killed-buffers
4116 (cons buffer killed-buffers))))
4117 (not (eq buffer old-buffer))
4118 (or (null pred) (funcall pred buffer))
4119 (setq entry (assq buffer (window-prev-buffers window))))
4120 (setq new-buffer buffer)
4121 (set-window-buffer-start-and-point
4122 window new-buffer (nth 1 entry) (nth 2 entry))
4123 (throw 'found t))))
4124
4125 ;; Show a buffer visible in another window.
4126 (when visible
4127 (setq new-buffer visible)
4128 (set-window-buffer-start-and-point window new-buffer)))
4129
4130 (if bury-or-kill
4131 (let ((entry (and (eq bury-or-kill 'append)
4132 (assq old-buffer (window-prev-buffers window)))))
4133 ;; Remove `old-buffer' from WINDOW's previous and (restored list
4134 ;; of) next buffers.
4135 (set-window-prev-buffers
4136 window (assq-delete-all old-buffer (window-prev-buffers window)))
4137 (set-window-next-buffers window (delq old-buffer next-buffers))
4138 (when entry
4139 ;; Append old-buffer's entry to list of WINDOW's previous
4140 ;; buffers so it's less likely to get switched to soon but
4141 ;; `display-buffer-in-previous-window' can nevertheless find
4142 ;; it.
4143 (set-window-prev-buffers
4144 window (append (window-prev-buffers window) (list entry)))))
4145 ;; Move `old-buffer' to head of WINDOW's restored list of next
4146 ;; buffers.
4147 (set-window-next-buffers
4148 window (cons old-buffer (delq old-buffer next-buffers))))
4149
4150 ;; Remove killed buffers from WINDOW's previous and next buffers.
4151 (when killed-buffers
4152 (dolist (buffer killed-buffers)
4153 (set-window-prev-buffers
4154 window (assq-delete-all buffer (window-prev-buffers window)))
4155 (set-window-next-buffers
4156 window (delq buffer (window-next-buffers window)))))
4157
4158 ;; Return new-buffer.
4159 new-buffer))
4160
4161 (defun switch-to-next-buffer (&optional window)
4162 "In WINDOW switch to next buffer.
4163 WINDOW must be a live window and defaults to the selected one.
4164 Return the buffer switched to, nil if no suitable buffer could be
4165 found."
4166 (interactive)
4167 (let* ((window (window-normalize-window window t))
4168 (frame (window-frame window))
4169 (old-buffer (window-buffer window))
4170 (next-buffers (window-next-buffers window))
4171 (pred (frame-parameter frame 'buffer-predicate))
4172 new-buffer entry killed-buffers visible)
4173 (when (window-minibuffer-p window)
4174 ;; Don't switch in minibuffer window.
4175 (unless (setq window (minibuffer-selected-window))
4176 (error "Window %s is a minibuffer window" window)))
4177
4178 (when (window-dedicated-p window)
4179 ;; Don't switch in dedicated window.
4180 (error "Window %s is dedicated to buffer %s" window old-buffer))
4181
4182 (catch 'found
4183 ;; Scan WINDOW's next buffers first.
4184 (dolist (buffer next-buffers)
4185 (when (and (or (buffer-live-p buffer)
4186 (not (setq killed-buffers
4187 (cons buffer killed-buffers))))
4188 (not (eq buffer old-buffer))
4189 (or (null pred) (funcall pred buffer))
4190 (setq entry (assq buffer (window-prev-buffers window))))
4191 (setq new-buffer buffer)
4192 (set-window-buffer-start-and-point
4193 window new-buffer (nth 1 entry) (nth 2 entry))
4194 (throw 'found t)))
4195 ;; Scan the buffer list of WINDOW's frame next, skipping previous
4196 ;; buffers entries.
4197 (dolist (buffer (buffer-list frame))
4198 (when (and (buffer-live-p buffer)
4199 (not (eq buffer old-buffer))
4200 (or (null pred) (funcall pred buffer))
4201 (not (eq (aref (buffer-name buffer) 0) ?\s))
4202 (not (assq buffer (window-prev-buffers window))))
4203 (if (and (not switch-to-visible-buffer)
4204 (get-buffer-window buffer frame))
4205 ;; Try to avoid showing a buffer visible in some other window.
4206 (setq visible buffer)
4207 (setq new-buffer buffer)
4208 (set-window-buffer-start-and-point window new-buffer)
4209 (throw 'found t))))
4210 ;; Scan WINDOW's reverted previous buffers last (must not use
4211 ;; nreverse here!)
4212 (dolist (entry (reverse (window-prev-buffers window)))
4213 (when (and (setq new-buffer (car entry))
4214 (or (buffer-live-p new-buffer)
4215 (not (setq killed-buffers
4216 (cons new-buffer killed-buffers))))
4217 (not (eq new-buffer old-buffer))
4218 (or (null pred) (funcall pred new-buffer)))
4219 (if (and (not switch-to-visible-buffer)
4220 (get-buffer-window new-buffer frame))
4221 ;; Try to avoid showing a buffer visible in some other window.
4222 (unless visible
4223 (setq visible new-buffer))
4224 (set-window-buffer-start-and-point
4225 window new-buffer (nth 1 entry) (nth 2 entry))
4226 (throw 'found t))))
4227
4228 ;; Show a buffer visible in another window.
4229 (when visible
4230 (setq new-buffer visible)
4231 (set-window-buffer-start-and-point window new-buffer)))
4232
4233 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
4234 (set-window-next-buffers window (delq new-buffer next-buffers))
4235
4236 ;; Remove killed buffers from WINDOW's previous and next buffers.
4237 (when killed-buffers
4238 (dolist (buffer killed-buffers)
4239 (set-window-prev-buffers
4240 window (assq-delete-all buffer (window-prev-buffers window)))
4241 (set-window-next-buffers
4242 window (delq buffer (window-next-buffers window)))))
4243
4244 ;; Return new-buffer.
4245 new-buffer))
4246
4247 (defun get-next-valid-buffer (list &optional buffer visible-ok frame)
4248 "Search LIST for a valid buffer to display in FRAME.
4249 Return nil when all buffers in LIST are undesirable for display,
4250 otherwise return the first suitable buffer in LIST.
4251
4252 Buffers not visible in windows are preferred to visible buffers,
4253 unless VISIBLE-OK is non-nil.
4254 If the optional argument FRAME is nil, it defaults to the selected frame.
4255 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
4256 ;; This logic is more or less copied from other-buffer.
4257 (setq frame (or frame (selected-frame)))
4258 (let ((pred (frame-parameter frame 'buffer-predicate))
4259 found buf)
4260 (while (and (not found) list)
4261 (setq buf (car list))
4262 (if (and (not (eq buffer buf))
4263 (buffer-live-p buf)
4264 (or (null pred) (funcall pred buf))
4265 (not (eq (aref (buffer-name buf) 0) ?\s))
4266 (or visible-ok (null (get-buffer-window buf 'visible))))
4267 (setq found buf)
4268 (setq list (cdr list))))
4269 (car list)))
4270
4271 (defun last-buffer (&optional buffer visible-ok frame)
4272 "Return the last buffer in FRAME's buffer list.
4273 If BUFFER is the last buffer, return the preceding buffer
4274 instead. Buffers not visible in windows are preferred to visible
4275 buffers, unless optional argument VISIBLE-OK is non-nil.
4276 Optional third argument FRAME nil or omitted means use the
4277 selected frame's buffer list. If no such buffer exists, return
4278 the buffer `*scratch*', creating it if necessary."
4279 (setq frame (or frame (selected-frame)))
4280 (or (get-next-valid-buffer (nreverse (buffer-list frame))
4281 buffer visible-ok frame)
4282 (get-buffer "*scratch*")
4283 (let ((scratch (get-buffer-create "*scratch*")))
4284 (set-buffer-major-mode scratch)
4285 scratch)))
4286
4287 (defcustom frame-auto-hide-function #'iconify-frame
4288 "Function called to automatically hide frames.
4289 The function is called with one argument - a frame.
4290
4291 Functions affected by this option are those that bury a buffer
4292 shown in a separate frame like `quit-window' and `bury-buffer'."
4293 :type '(choice (const :tag "Iconify" iconify-frame)
4294 (const :tag "Delete" delete-frame)
4295 (const :tag "Do nothing" ignore)
4296 function)
4297 :group 'windows
4298 :group 'frames
4299 :version "24.1")
4300
4301 (defun window--delete (&optional window dedicated-only kill)
4302 "Delete WINDOW if possible.
4303 WINDOW must be a live window and defaults to the selected one.
4304 Optional argument DEDICATED-ONLY non-nil means to delete WINDOW
4305 only if it's dedicated to its buffer. Optional argument KILL
4306 means the buffer shown in window will be killed. Return non-nil
4307 if WINDOW gets deleted or its frame is auto-hidden."
4308 (setq window (window-normalize-window window t))
4309 (unless (and dedicated-only (not (window-dedicated-p window)))
4310 (let ((deletable (window-deletable-p window)))
4311 (cond
4312 ((eq deletable 'frame)
4313 (let ((frame (window-frame window)))
4314 (cond
4315 (kill
4316 (delete-frame frame))
4317 ((functionp frame-auto-hide-function)
4318 (funcall frame-auto-hide-function frame))))
4319 'frame)
4320 (deletable
4321 (delete-window window)
4322 t)))))
4323
4324 (defun bury-buffer (&optional buffer-or-name)
4325 "Put BUFFER-OR-NAME at the end of the list of all buffers.
4326 There it is the least likely candidate for `other-buffer' to
4327 return; thus, the least likely buffer for \\[switch-to-buffer] to
4328 select by default.
4329
4330 You can specify a buffer name as BUFFER-OR-NAME, or an actual
4331 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
4332 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
4333 remove the current buffer from the selected window if it is
4334 displayed there."
4335 (interactive)
4336 (let* ((buffer (window-normalize-buffer buffer-or-name)))
4337 ;; If `buffer-or-name' is not on the selected frame we unrecord it
4338 ;; although it's not "here" (call it a feature).
4339 (bury-buffer-internal buffer)
4340 ;; Handle case where `buffer-or-name' is nil and the current buffer
4341 ;; is shown in the selected window.
4342 (cond
4343 ((or buffer-or-name (not (eq buffer (window-buffer)))))
4344 ((window--delete nil t))
4345 (t
4346 ;; Switch to another buffer in window.
4347 (set-window-dedicated-p nil nil)
4348 (switch-to-prev-buffer nil 'bury)))
4349
4350 ;; Always return nil.
4351 nil))
4352
4353 (defun unbury-buffer ()
4354 "Switch to the last buffer in the buffer list."
4355 (interactive)
4356 (switch-to-buffer (last-buffer)))
4357
4358 (defun next-buffer ()
4359 "In selected window switch to next buffer."
4360 (interactive)
4361 (cond
4362 ((window-minibuffer-p)
4363 (error "Cannot switch buffers in minibuffer window"))
4364 ((eq (window-dedicated-p) t)
4365 (error "Window is strongly dedicated to its buffer"))
4366 (t
4367 (switch-to-next-buffer))))
4368
4369 (defun previous-buffer ()
4370 "In selected window switch to previous buffer."
4371 (interactive)
4372 (cond
4373 ((window-minibuffer-p)
4374 (error "Cannot switch buffers in minibuffer window"))
4375 ((eq (window-dedicated-p) t)
4376 (error "Window is strongly dedicated to its buffer"))
4377 (t
4378 (switch-to-prev-buffer))))
4379
4380 (defun delete-windows-on (&optional buffer-or-name frame)
4381 "Delete all windows showing BUFFER-OR-NAME.
4382 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
4383 and defaults to the current buffer.
4384
4385 The following non-nil values of the optional argument FRAME
4386 have special meanings:
4387
4388 - t means consider all windows on the selected frame only.
4389
4390 - `visible' means consider all windows on all visible frames on
4391 the current terminal.
4392
4393 - 0 (the number zero) means consider all windows on all visible
4394 and iconified frames on the current terminal.
4395
4396 - A frame means consider all windows on that frame only.
4397
4398 Any other value of FRAME means consider all windows on all
4399 frames.
4400
4401 When a window showing BUFFER-OR-NAME is dedicated and the only
4402 window of its frame, that frame is deleted when there are other
4403 frames left."
4404 (interactive "BDelete windows on (buffer):\nP")
4405 (let ((buffer (window-normalize-buffer buffer-or-name))
4406 ;; Handle the "inverted" meaning of the FRAME argument wrt other
4407 ;; `window-list-1' based function.
4408 (all-frames (cond ((not frame) t) ((eq frame t) nil) (t frame))))
4409 (dolist (window (window-list-1 nil nil all-frames))
4410 (if (eq (window-buffer window) buffer)
4411 (let ((deletable (window-deletable-p window)))
4412 (cond
4413 ((and (eq deletable 'frame) (window-dedicated-p window))
4414 ;; Delete frame if and only if window is dedicated.
4415 (delete-frame (window-frame window)))
4416 ((eq deletable t)
4417 ;; Delete window.
4418 (delete-window window))
4419 (t
4420 ;; In window switch to previous buffer.
4421 (set-window-dedicated-p window nil)
4422 (switch-to-prev-buffer window 'bury))))
4423 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
4424 (unrecord-window-buffer window buffer)))))
4425
4426 (defun replace-buffer-in-windows (&optional buffer-or-name)
4427 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
4428 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
4429 and defaults to the current buffer.
4430
4431 When a window showing BUFFER-OR-NAME is dedicated, that window is
4432 deleted. If that window is the only window on its frame, the
4433 frame is deleted too when there are other frames left. If there
4434 are no other frames left, some other buffer is displayed in that
4435 window.
4436
4437 This function removes the buffer denoted by BUFFER-OR-NAME from
4438 all window-local buffer lists."
4439 (interactive "bBuffer to replace: ")
4440 (let ((buffer (window-normalize-buffer buffer-or-name)))
4441 (dolist (window (window-list-1 nil nil t))
4442 (if (eq (window-buffer window) buffer)
4443 (unless (window--delete window t t)
4444 ;; Switch to another buffer in window.
4445 (set-window-dedicated-p window nil)
4446 (switch-to-prev-buffer window 'kill))
4447 ;; Unrecord BUFFER in WINDOW.
4448 (unrecord-window-buffer window buffer)))))
4449
4450 (defun quit-restore-window (&optional window bury-or-kill)
4451 "Quit WINDOW and deal with its buffer.
4452 WINDOW must be a live window and defaults to the selected one.
4453
4454 According to information stored in WINDOW's `quit-restore' window
4455 parameter either (1) delete WINDOW and its frame, (2) delete
4456 WINDOW, (3) restore the buffer previously displayed in WINDOW,
4457 or (4) make WINDOW display some other buffer than the present
4458 one. If non-nil, reset `quit-restore' parameter to nil.
4459
4460 Optional second argument BURY-OR-KILL tells how to proceed with
4461 the buffer of WINDOW. The following values are handled:
4462
4463 nil means to not handle the buffer in a particular way. This
4464 means that if WINDOW is not deleted by this function, invoking
4465 `switch-to-prev-buffer' will usually show the buffer again.
4466
4467 `append' means that if WINDOW is not deleted, move its buffer to
4468 the end of WINDOW's previous buffers so it's less likely that a
4469 future invocation of `switch-to-prev-buffer' will switch to it.
4470 Also, move the buffer to the end of the frame's buffer list.
4471
4472 `bury' means that if WINDOW is not deleted, remove its buffer
4473 from WINDOW'S list of previous buffers. Also, move the buffer
4474 to the end of the frame's buffer list. This value provides the
4475 most reliable remedy to not have `switch-to-prev-buffer' switch
4476 to this buffer again without killing the buffer.
4477
4478 `kill' means to kill WINDOW's buffer."
4479 (setq window (window-normalize-window window t))
4480 (let* ((buffer (window-buffer window))
4481 (quit-restore (window-parameter window 'quit-restore))
4482 (prev-buffer
4483 (let* ((prev-buffers (window-prev-buffers window))
4484 (prev-buffer (caar prev-buffers)))
4485 (and (or (not (eq prev-buffer buffer))
4486 (and (cdr prev-buffers)
4487 (not (eq (setq prev-buffer (cadr prev-buffers))
4488 buffer))))
4489 prev-buffer)))
4490 quad entry)
4491 (cond
4492 ((and (not prev-buffer)
4493 (or (eq (nth 1 quit-restore) 'frame)
4494 (and (eq (nth 1 quit-restore) 'window)
4495 ;; If the window has been created on an existing
4496 ;; frame and ended up as the sole window on that
4497 ;; frame, do not delete it (Bug#12764).
4498 (not (eq window (frame-root-window window)))))
4499 (eq (nth 3 quit-restore) buffer)
4500 ;; Delete WINDOW if possible.
4501 (window--delete window nil (eq bury-or-kill 'kill)))
4502 ;; If the previously selected window is still alive, select it.
4503 (when (window-live-p (nth 2 quit-restore))
4504 (select-window (nth 2 quit-restore))))
4505 ((and (listp (setq quad (nth 1 quit-restore)))
4506 (buffer-live-p (car quad))
4507 (eq (nth 3 quit-restore) buffer))
4508 ;; Show another buffer stored in quit-restore parameter.
4509 (when (and (integerp (nth 3 quad))
4510 (if (window-combined-p window)
4511 (/= (nth 3 quad) (window-total-height window))
4512 (/= (nth 3 quad) (window-total-width window))))
4513 ;; Try to resize WINDOW to its old height but don't signal an
4514 ;; error.
4515 (condition-case nil
4516 (window-resize
4517 window
4518 (- (nth 3 quad) (if (window-combined-p window)
4519 (window-total-height window)
4520 (window-total-width window)))
4521 (window-combined-p window t))
4522 (error nil)))
4523 (set-window-dedicated-p window nil)
4524 ;; Restore WINDOW's previous buffer, start and point position.
4525 (set-window-buffer-start-and-point
4526 window (nth 0 quad) (nth 1 quad) (nth 2 quad))
4527 ;; Deal with the buffer we just removed from WINDOW.
4528 (setq entry (and (eq bury-or-kill 'append)
4529 (assq buffer (window-prev-buffers window))))
4530 (when bury-or-kill
4531 ;; Remove buffer from WINDOW's previous and next buffers.
4532 (set-window-prev-buffers
4533 window (assq-delete-all buffer (window-prev-buffers window)))
4534 (set-window-next-buffers
4535 window (delq buffer (window-next-buffers window))))
4536 (when entry
4537 ;; Append old buffer's entry to list of WINDOW's previous
4538 ;; buffers so it's less likely to get switched to soon but
4539 ;; `display-buffer-in-previous-window' can nevertheless find it.
4540 (set-window-prev-buffers
4541 window (append (window-prev-buffers window) (list entry))))
4542 ;; Reset the quit-restore parameter.
4543 (set-window-parameter window 'quit-restore nil)
4544 ;; Select old window.
4545 (when (window-live-p (nth 2 quit-restore))
4546 (select-window (nth 2 quit-restore))))
4547 (t
4548 ;; Show some other buffer in WINDOW and reset the quit-restore
4549 ;; parameter.
4550 (set-window-parameter window 'quit-restore nil)
4551 ;; Make sure that WINDOW is no more dedicated.
4552 (set-window-dedicated-p window nil)
4553 (switch-to-prev-buffer window bury-or-kill)))
4554
4555 ;; Deal with the buffer.
4556 (cond
4557 ((not (buffer-live-p buffer)))
4558 ((eq bury-or-kill 'kill)
4559 (kill-buffer buffer))
4560 (bury-or-kill
4561 (bury-buffer-internal buffer)))))
4562
4563 (defun quit-window (&optional kill window)
4564 "Quit WINDOW and bury its buffer.
4565 WINDOW must be a live window and defaults to the selected one.
4566 With prefix argument KILL non-nil, kill the buffer instead of
4567 burying it.
4568
4569 According to information stored in WINDOW's `quit-restore' window
4570 parameter either (1) delete WINDOW and its frame, (2) delete
4571 WINDOW, (3) restore the buffer previously displayed in WINDOW,
4572 or (4) make WINDOW display some other buffer than the present
4573 one. If non-nil, reset `quit-restore' parameter to nil."
4574 (interactive "P")
4575 (quit-restore-window window (if kill 'kill 'bury)))
4576
4577 (defun quit-windows-on (&optional buffer-or-name kill frame)
4578 "Quit all windows showing BUFFER-OR-NAME.
4579 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
4580 and defaults to the current buffer. Optional argument KILL
4581 non-nil means to kill BUFFER-OR-NAME. KILL nil means to bury
4582 BUFFER-OR-NAME. Optional argument FRAME is handled as by
4583 `delete-windows-on'.
4584
4585 This function calls `quit-window' on all candidate windows
4586 showing BUFFER-OR-NAME."
4587 (interactive "BQuit windows on (buffer):\nP")
4588 (let ((buffer (window-normalize-buffer buffer-or-name))
4589 ;; Handle the "inverted" meaning of the FRAME argument wrt other
4590 ;; `window-list-1' based function.
4591 (all-frames (cond ((not frame) t) ((eq frame t) nil) (t frame))))
4592 (dolist (window (window-list-1 nil nil all-frames))
4593 (if (eq (window-buffer window) buffer)
4594 (quit-window kill window)
4595 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
4596 (unrecord-window-buffer window buffer)))))
4597 \f
4598 (defun split-window (&optional window size side pixelwise)
4599 "Make a new window adjacent to WINDOW.
4600 WINDOW must be a valid window and defaults to the selected one.
4601 Return the new window which is always a live window.
4602
4603 Optional argument SIZE a positive number means make WINDOW SIZE
4604 lines or columns tall. If SIZE is negative, make the new window
4605 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
4606 absolute value can be less than `window-min-height' or
4607 `window-min-width'; so this command can make a new window as
4608 small as one line or two columns. SIZE defaults to half of
4609 WINDOW's size.
4610
4611 Optional third argument SIDE nil (or `below') specifies that the
4612 new window shall be located below WINDOW. SIDE `above' means the
4613 new window shall be located above WINDOW. In both cases SIZE
4614 specifies the new number of lines for WINDOW (or the new window
4615 if SIZE is negative) including space reserved for the mode and/or
4616 header line.
4617
4618 SIDE t (or `right') specifies that the new window shall be
4619 located on the right side of WINDOW. SIDE `left' means the new
4620 window shall be located on the left of WINDOW. In both cases
4621 SIZE specifies the new number of columns for WINDOW (or the new
4622 window provided SIZE is negative) including space reserved for
4623 fringes and the scrollbar or a divider column. Any other non-nil
4624 value for SIDE is currently handled like t (or `right').
4625
4626 PIXELWISE, if non-nil, means to interpret SIZE pixelwise.
4627
4628 If the variable `ignore-window-parameters' is non-nil or the
4629 `split-window' parameter of WINDOW equals t, do not process any
4630 parameters of WINDOW. Otherwise, if the `split-window' parameter
4631 of WINDOW specifies a function, call that function with all three
4632 arguments and return the value returned by that function.
4633
4634 Otherwise, if WINDOW is part of an atomic window, \"split\" the
4635 root of that atomic window. The new window does not become a
4636 member of that atomic window.
4637
4638 If WINDOW is live, properties of the new window like margins and
4639 scrollbars are inherited from WINDOW. If WINDOW is an internal
4640 window, these properties as well as the buffer displayed in the
4641 new window are inherited from the window selected on WINDOW's
4642 frame. The selected window is not changed by this function."
4643 (setq window (window-normalize-window window))
4644 (let* ((side (cond
4645 ((not side) 'below)
4646 ((memq side '(below above right left)) side)
4647 (t 'right)))
4648 (horizontal (not (memq side '(below above))))
4649 (frame (window-frame window))
4650 (parent (window-parent window))
4651 (function (window-parameter window 'split-window))
4652 (window-side (window-parameter window 'window-side))
4653 ;; Rebind the following two variables since in some cases we
4654 ;; have to override their value.
4655 (window-combination-limit window-combination-limit)
4656 (window-combination-resize window-combination-resize)
4657 (char-size (frame-char-size window horizontal))
4658 (pixel-size
4659 (when (numberp size)
4660 (window--size-to-pixel window size horizontal pixelwise t)))
4661 (divider-width (if horizontal
4662 (frame-right-divider-width frame)
4663 (frame-bottom-divider-width frame)))
4664 atom-root ignore)
4665 (window--check frame)
4666 (catch 'done
4667 (cond
4668 ;; Ignore window parameters if either `ignore-window-parameters'
4669 ;; is t or the `split-window' parameter equals t.
4670 ((or ignore-window-parameters (eq function t)))
4671 ((functionp function)
4672 ;; The `split-window' parameter specifies the function to call.
4673 ;; If that function is `ignore', do nothing.
4674 (throw 'done (funcall function window size side)))
4675 ;; If WINDOW is part of an atomic window, split the root window
4676 ;; of that atomic window instead.
4677 ((and (window-parameter window 'window-atom)
4678 (setq atom-root (window-atom-root window))
4679 (not (eq atom-root window)))
4680 (throw 'done (split-window atom-root size side pixelwise)))
4681 ;; If WINDOW is a side window or its first or last child is a
4682 ;; side window, throw an error unless `window-combination-resize'
4683 ;; equals 'side.
4684 ((and (not (eq window-combination-resize 'side))
4685 (window--side-window-p window))
4686 (error "Cannot split side window or parent of side window"))
4687 ;; If `window-combination-resize' is 'side and window has a side
4688 ;; window sibling, bind `window-combination-limit' to t.
4689 ((and (not (eq window-combination-resize 'side))
4690 (or (and (window-prev-sibling window)
4691 (window-parameter
4692 (window-prev-sibling window) 'window-side))
4693 (and (window-next-sibling window)
4694 (window-parameter
4695 (window-next-sibling window) 'window-side))))
4696 (setq window-combination-limit t)))
4697
4698 ;; If `window-combination-resize' is t and SIZE is non-negative,
4699 ;; bind `window-combination-limit' to t.
4700 (when (and (eq window-combination-resize t)
4701 pixel-size (> pixel-size 0))
4702 (setq window-combination-limit t))
4703
4704 (let* ((parent-pixel-size
4705 ;; `parent-pixel-size' is the pixel size of WINDOW's
4706 ;; parent, provided it has one.
4707 (when parent (window-size parent horizontal t)))
4708 ;; `resize' non-nil means we are supposed to resize other
4709 ;; windows in WINDOW's combination.
4710 (resize
4711 (and window-combination-resize
4712 (or (window-parameter window 'window-side)
4713 (not (eq window-combination-resize 'side)))
4714 (not (eq window-combination-limit t))
4715 ;; Resize makes sense in iso-combinations only.
4716 (window-combined-p window horizontal)))
4717 ;; `old-pixel-size' is the current pixel size of WINDOW.
4718 (old-pixel-size (window-size window horizontal t))
4719 ;; `new-size' is the specified or calculated size of the
4720 ;; new window.
4721 new-pixel-size new-parent new-normal)
4722 (cond
4723 ((not pixel-size)
4724 (setq new-pixel-size
4725 (if resize
4726 ;; When resizing try to give the new window the
4727 ;; average size of a window in its combination.
4728 (max (min (- parent-pixel-size
4729 (window-min-size parent horizontal nil t))
4730 (/ parent-pixel-size
4731 (1+ (window-combinations parent horizontal))))
4732 (window-min-pixel-size))
4733 ;; Else try to give the new window half the size
4734 ;; of WINDOW (plus an eventual odd pixel).
4735 (/ old-pixel-size 2)))
4736 (unless window-resize-pixelwise
4737 ;; Round to nearest char-size multiple.
4738 (setq new-pixel-size
4739 (* char-size (round new-pixel-size char-size)))))
4740 ((>= pixel-size 0)
4741 ;; SIZE non-negative specifies the new size of WINDOW.
4742
4743 ;; Note: Specifying a non-negative SIZE is practically
4744 ;; always done as workaround for making the new window
4745 ;; appear above or on the left of the new window (the
4746 ;; ispell window is a typical example of that). In all
4747 ;; these cases the SIDE argument should be set to 'above
4748 ;; or 'left in order to support the 'resize option.
4749 ;; Here we have to nest the windows instead, see above.
4750 (setq new-pixel-size (- old-pixel-size pixel-size)))
4751 (t
4752 ;; SIZE negative specifies the size of the new window.
4753 (setq new-pixel-size (- pixel-size))))
4754
4755 ;; Check SIZE.
4756 (cond
4757 ((not pixel-size)
4758 (cond
4759 (resize
4760 ;; SIZE unspecified, resizing.
4761 (unless (or (window-sizable-p
4762 parent (- (+ new-pixel-size divider-width)) horizontal
4763 nil t)
4764 (window-sizable-p
4765 parent (- (+ new-pixel-size divider-width)) horizontal
4766 (setq ignore 'preserved) t))
4767 (error "Window %s too small for splitting (1)" parent)))
4768 ((and (> (+ new-pixel-size divider-width
4769 (window-min-size window horizontal nil t))
4770 old-pixel-size)
4771 (> (+ new-pixel-size divider-width
4772 (window-min-size
4773 window horizontal (setq ignore 'preserved) t))
4774 old-pixel-size))
4775 ;; SIZE unspecified, no resizing.
4776 (error "Window %s too small for splitting (2)" window))))
4777 ((and (>= pixel-size 0)
4778 (or (>= pixel-size old-pixel-size)
4779 (< new-pixel-size
4780 (window-safe-min-pixel-size window horizontal))))
4781 ;; SIZE specified as new size of old window. If the new size
4782 ;; is larger than the old size or the size of the new window
4783 ;; would be less than the safe minimum, signal an error.
4784 (error "Window %s too small for splitting (3)" window))
4785 (resize
4786 ;; SIZE specified, resizing.
4787 (unless (or (window-sizable-p
4788 parent (- (+ new-pixel-size divider-width)) horizontal
4789 nil t)
4790 (window-sizable-p
4791 parent (- (+ new-pixel-size divider-width)) horizontal
4792 (setq ignore 'preserved) t))
4793 ;; If we cannot resize the parent give up.
4794 (error "Window %s too small for splitting (4)" parent)))
4795 ((or (< new-pixel-size
4796 (window-safe-min-pixel-size window horizontal))
4797 (< (- old-pixel-size new-pixel-size)
4798 (window-safe-min-pixel-size window horizontal)))
4799 ;; SIZE specification violates minimum size restrictions.
4800 (error "Window %s too small for splitting (5)" window)))
4801
4802 (window--resize-reset frame horizontal)
4803
4804 (setq new-parent
4805 ;; Make new-parent non-nil if we need a new parent window;
4806 ;; either because we want to nest or because WINDOW is not
4807 ;; iso-combined.
4808 (or (eq window-combination-limit t)
4809 (not (window-combined-p window horizontal))))
4810 (setq new-normal
4811 ;; Make new-normal the normal size of the new window.
4812 (cond
4813 (pixel-size (/ (float new-pixel-size)
4814 (if new-parent old-pixel-size parent-pixel-size)))
4815 (new-parent 0.5)
4816 (resize (/ 1.0 (1+ (window-combinations parent horizontal))))
4817 (t (/ (window-normal-size window horizontal) 2.0))))
4818
4819 (if resize
4820 ;; Try to get space from OLD's siblings. We could go "up" and
4821 ;; try getting additional space from surrounding windows but
4822 ;; we won't be able to return space to those windows when we
4823 ;; delete the one we create here. Hence we do not go up.
4824 (progn
4825 (window--resize-child-windows
4826 parent (- new-pixel-size) horizontal nil ignore)
4827 (let* ((normal (- 1.0 new-normal))
4828 (sub (window-child parent)))
4829 (while sub
4830 (set-window-new-normal
4831 sub (* (window-normal-size sub horizontal) normal))
4832 (setq sub (window-right sub)))))
4833 ;; Get entire space from WINDOW.
4834 (set-window-new-pixel
4835 window (- old-pixel-size new-pixel-size))
4836 (window--resize-this-window
4837 window (- new-pixel-size) horizontal ignore)
4838 (set-window-new-normal
4839 window (- (if new-parent 1.0 (window-normal-size window horizontal))
4840 new-normal)))
4841
4842 (let* ((new (split-window-internal window new-pixel-size side new-normal)))
4843 (window--pixel-to-total frame horizontal)
4844 ;; Assign window-side parameters, if any.
4845 (cond
4846 ((eq window-combination-resize 'side)
4847 (let ((window-side
4848 (cond
4849 (window-side window-side)
4850 ((eq side 'above) 'top)
4851 ((eq side 'below) 'bottom)
4852 (t side))))
4853 ;; We made a new side window.
4854 (set-window-parameter new 'window-side window-side)
4855 (when (and new-parent (window-parameter window 'window-side))
4856 ;; We've been splitting a side root window. Give the
4857 ;; new parent the same window-side parameter.
4858 (set-window-parameter
4859 (window-parent new) 'window-side window-side))))
4860 ((eq window-combination-resize 'atom)
4861 ;; Make sure `window--check-frame' won't destroy an existing
4862 ;; atomic window in case the new window gets nested inside.
4863 (unless (window-parameter window 'window-atom)
4864 (set-window-parameter window 'window-atom t))
4865 (when new-parent
4866 (set-window-parameter (window-parent new) 'window-atom t))
4867 (set-window-parameter new 'window-atom t)))
4868
4869 ;; Sanitize sizes unless SIZE was specified.
4870 (unless size
4871 (window--sanitize-window-sizes frame horizontal))
4872
4873 (run-window-configuration-change-hook frame)
4874 (run-window-scroll-functions new)
4875 (window--check frame)
4876 ;; Always return the new window.
4877 new)))))
4878
4879 ;; I think this should be the default; I think people will prefer it--rms.
4880 (defcustom split-window-keep-point t
4881 "If non-nil, \\[split-window-below] preserves point in the new window.
4882 If nil, adjust point in the two windows to minimize redisplay.
4883 This option applies only to `split-window-below' and functions
4884 that call it. The low-level `split-window' function always keeps
4885 the original point in both windows."
4886 :type 'boolean
4887 :group 'windows)
4888
4889 (defun split-window-below (&optional size)
4890 "Split the selected window into two windows, one above the other.
4891 The selected window is above. The newly split-off window is
4892 below and displays the same buffer. Return the new window.
4893
4894 If optional argument SIZE is omitted or nil, both windows get the
4895 same height, or close to it. If SIZE is positive, the upper
4896 \(selected) window gets SIZE lines. If SIZE is negative, the
4897 lower (new) window gets -SIZE lines.
4898
4899 If the variable `split-window-keep-point' is non-nil, both
4900 windows get the same value of point as the selected window.
4901 Otherwise, the window starts are chosen so as to minimize the
4902 amount of redisplay; this is convenient on slow terminals."
4903 (interactive "P")
4904 (let ((old-window (selected-window))
4905 (old-point (window-point))
4906 (size (and size (prefix-numeric-value size)))
4907 moved-by-window-height moved new-window bottom)
4908 (when (and size (< size 0) (< (- size) window-min-height))
4909 ;; `split-window' would not signal an error here.
4910 (error "Size of new window too small"))
4911 (setq new-window (split-window nil size))
4912 (unless split-window-keep-point
4913 (with-current-buffer (window-buffer)
4914 ;; Use `save-excursion' around vertical movements below
4915 ;; (Bug#10971). Note: When the selected window's buffer has a
4916 ;; header line, up to two lines of the buffer may not show up
4917 ;; in the resulting configuration.
4918 (save-excursion
4919 (goto-char (window-start))
4920 (setq moved (vertical-motion (window-height)))
4921 (set-window-start new-window (point))
4922 (when (> (point) (window-point new-window))
4923 (set-window-point new-window (point)))
4924 (when (= moved (window-height))
4925 (setq moved-by-window-height t)
4926 (vertical-motion -1))
4927 (setq bottom (point)))
4928 (and moved-by-window-height
4929 (<= bottom (point))
4930 (set-window-point old-window (1- bottom)))
4931 (and moved-by-window-height
4932 (<= (window-start new-window) old-point)
4933 (set-window-point new-window old-point)
4934 (select-window new-window))))
4935 ;; Always copy quit-restore parameter in interactive use.
4936 (let ((quit-restore (window-parameter old-window 'quit-restore)))
4937 (when quit-restore
4938 (set-window-parameter new-window 'quit-restore quit-restore)))
4939 new-window))
4940
4941 (defalias 'split-window-vertically 'split-window-below)
4942
4943 (defun split-window-right (&optional size)
4944 "Split the selected window into two side-by-side windows.
4945 The selected window is on the left. The newly split-off window
4946 is on the right and displays the same buffer. Return the new
4947 window.
4948
4949 If optional argument SIZE is omitted or nil, both windows get the
4950 same width, or close to it. If SIZE is positive, the left-hand
4951 \(selected) window gets SIZE columns. If SIZE is negative, the
4952 right-hand (new) window gets -SIZE columns. Here, SIZE includes
4953 the width of the window's scroll bar; if there are no scroll
4954 bars, it includes the width of the divider column to the window's
4955 right, if any."
4956 (interactive "P")
4957 (let ((old-window (selected-window))
4958 (size (and size (prefix-numeric-value size)))
4959 new-window)
4960 (when (and size (< size 0) (< (- size) window-min-width))
4961 ;; `split-window' would not signal an error here.
4962 (error "Size of new window too small"))
4963 (setq new-window (split-window nil size t))
4964 ;; Always copy quit-restore parameter in interactive use.
4965 (let ((quit-restore (window-parameter old-window 'quit-restore)))
4966 (when quit-restore
4967 (set-window-parameter new-window 'quit-restore quit-restore)))
4968 new-window))
4969
4970 (defalias 'split-window-horizontally 'split-window-right)
4971 \f
4972 ;;; Balancing windows.
4973
4974 ;; The following routine uses the recycled code from an old version of
4975 ;; `window--resize-child-windows'. It's not very pretty, but coding it the way the
4976 ;; new `window--resize-child-windows' code does would hardly make it any shorter or
4977 ;; more readable (FWIW we'd need three loops - one to calculate the
4978 ;; minimum sizes per window, one to enlarge or shrink windows until the
4979 ;; new parent-size matches, and one where we shrink the largest/enlarge
4980 ;; the smallest window).
4981 (defun balance-windows-2 (window horizontal)
4982 "Subroutine of `balance-windows-1'.
4983 WINDOW must be a vertical combination (horizontal if HORIZONTAL
4984 is non-nil)."
4985 (let* ((char-size (if window-resize-pixelwise
4986 1
4987 (frame-char-size window horizontal)))
4988 (first (window-child window))
4989 (sub first)
4990 (number-of-children 0)
4991 (parent-size (window-new-pixel window))
4992 (total-sum parent-size)
4993 failed size sub-total sub-delta sub-amount rest)
4994 (while sub
4995 (setq number-of-children (1+ number-of-children))
4996 (when (window-size-fixed-p sub horizontal)
4997 (setq total-sum
4998 (- total-sum (window-size sub horizontal t)))
4999 (set-window-new-normal sub 'ignore))
5000 (setq sub (window-right sub)))
5001
5002 (setq failed t)
5003 (while (and failed (> number-of-children 0))
5004 (setq size (/ total-sum number-of-children))
5005 (setq failed nil)
5006 (setq sub first)
5007 (while (and sub (not failed))
5008 ;; Ignore child windows that should be ignored or are stuck.
5009 (unless (window--resize-child-windows-skip-p sub)
5010 (setq sub-total (window-size sub horizontal t))
5011 (setq sub-delta (- size sub-total))
5012 (setq sub-amount
5013 (window-sizable sub sub-delta horizontal nil t))
5014 ;; Register the new total size for this child window.
5015 (set-window-new-pixel sub (+ sub-total sub-amount))
5016 (unless (= sub-amount sub-delta)
5017 (setq total-sum (- total-sum sub-total sub-amount))
5018 (setq number-of-children (1- number-of-children))
5019 ;; We failed and need a new round.
5020 (setq failed t)
5021 (set-window-new-normal sub 'skip)))
5022 (setq sub (window-right sub))))
5023
5024 ;; How can we be sure that `number-of-children' is NOT zero here ?
5025 (setq rest (% total-sum number-of-children))
5026 ;; Fix rounding by trying to enlarge non-stuck windows by one line
5027 ;; (column) until `rest' is zero.
5028 (setq sub first)
5029 (while (and sub (> rest 0))
5030 (unless (window--resize-child-windows-skip-p window)
5031 (set-window-new-pixel sub (min rest char-size) t)
5032 (setq rest (- rest char-size)))
5033 (setq sub (window-right sub)))
5034
5035 ;; Fix rounding by trying to enlarge stuck windows by one line
5036 ;; (column) until `rest' equals zero.
5037 (setq sub first)
5038 (while (and sub (> rest 0))
5039 (unless (eq (window-new-normal sub) 'ignore)
5040 (set-window-new-pixel sub (min rest char-size) t)
5041 (setq rest (- rest char-size)))
5042 (setq sub (window-right sub)))
5043
5044 (setq sub first)
5045 (while sub
5046 ;; Record new normal sizes.
5047 (set-window-new-normal
5048 sub (/ (if (eq (window-new-normal sub) 'ignore)
5049 (window-size sub horizontal t)
5050 (window-new-pixel sub))
5051 (float parent-size)))
5052 ;; Recursively balance each window's child windows.
5053 (balance-windows-1 sub horizontal)
5054 (setq sub (window-right sub)))))
5055
5056 (defun balance-windows-1 (window &optional horizontal)
5057 "Subroutine of `balance-windows'."
5058 (if (window-child window)
5059 (let ((sub (window-child window)))
5060 (if (window-combined-p sub horizontal)
5061 (balance-windows-2 window horizontal)
5062 (let ((size (window-new-pixel window)))
5063 (while sub
5064 (set-window-new-pixel sub size)
5065 (balance-windows-1 sub horizontal)
5066 (setq sub (window-right sub))))))))
5067
5068 (defun balance-windows (&optional window-or-frame)
5069 "Balance the sizes of windows of WINDOW-OR-FRAME.
5070 WINDOW-OR-FRAME is optional and defaults to the selected frame.
5071 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
5072 windows of that frame. If WINDOW-OR-FRAME denotes a window,
5073 recursively balance the sizes of all child windows of that
5074 window."
5075 (interactive)
5076 (let* ((window
5077 (cond
5078 ((or (not window-or-frame)
5079 (frame-live-p window-or-frame))
5080 (frame-root-window window-or-frame))
5081 ((or (window-live-p window-or-frame)
5082 (window-child window-or-frame))
5083 window-or-frame)
5084 (t
5085 (error "Not a window or frame %s" window-or-frame))))
5086 (frame (window-frame window)))
5087 ;; Balance vertically.
5088 (window--resize-reset (window-frame window))
5089 (balance-windows-1 window)
5090 (when (window--resize-apply-p frame)
5091 (window-resize-apply frame)
5092 (window--pixel-to-total frame)
5093 (run-window-configuration-change-hook frame))
5094 ;; Balance horizontally.
5095 (window--resize-reset (window-frame window) t)
5096 (balance-windows-1 window t)
5097 (when (window--resize-apply-p frame t)
5098 (window-resize-apply frame t)
5099 (window--pixel-to-total frame t)
5100 (run-window-configuration-change-hook frame))))
5101
5102 (defun window-fixed-size-p (&optional window direction)
5103 "Return t if WINDOW cannot be resized in DIRECTION.
5104 WINDOW defaults to the selected window. DIRECTION can be
5105 nil (i.e. any), `height' or `width'."
5106 (with-current-buffer (window-buffer window)
5107 (when (and (boundp 'window-size-fixed) window-size-fixed)
5108 (not (and direction
5109 (member (cons direction window-size-fixed)
5110 '((height . width) (width . height))))))))
5111
5112 ;;; A different solution to balance-windows.
5113 (defvar window-area-factor 1
5114 "Factor by which the window area should be over-estimated.
5115 This is used by `balance-windows-area'.
5116 Changing this globally has no effect.")
5117 (make-variable-buffer-local 'window-area-factor)
5118
5119 (defun balance-windows-area-adjust (window delta horizontal pixelwise)
5120 "Wrapper around `window-resize' with error checking.
5121 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
5122 ;; `window-resize' may fail if delta is too large.
5123 (while (>= (abs delta) 1)
5124 (condition-case nil
5125 (progn
5126 ;; It was wrong to use `window-resize' here. Somehow
5127 ;; `balance-windows-area' depends on resizing windows
5128 ;; asymmetrically.
5129 (adjust-window-trailing-edge window delta horizontal pixelwise)
5130 (setq delta 0))
5131 (error
5132 ;;(message "adjust: %s" (error-message-string err))
5133 (setq delta (/ delta 2))))))
5134
5135 (defun balance-windows-area ()
5136 "Make all visible windows the same area (approximately).
5137 See also `window-area-factor' to change the relative size of
5138 specific buffers."
5139 (interactive)
5140 (let* ((unchanged 0) (carry 0) (round 0)
5141 ;; Remove fixed-size windows.
5142 (wins (delq nil (mapcar (lambda (win)
5143 (if (not (window-fixed-size-p win)) win))
5144 (window-list nil 'nomini))))
5145 (changelog nil)
5146 (pixelwise window-resize-pixelwise)
5147 next)
5148 ;; Resizing a window changes the size of surrounding windows in complex
5149 ;; ways, so it's difficult to balance them all. The introduction of
5150 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
5151 ;; very difficult to do. `balance-window' above takes an off-line
5152 ;; approach: get the whole window tree, then balance it, then try to
5153 ;; adjust the windows so they fit the result.
5154 ;; Here, instead, we take a "local optimization" approach, where we just
5155 ;; go through all the windows several times until nothing needs to be
5156 ;; changed. The main problem with this approach is that it's difficult
5157 ;; to make sure it terminates, so we use some heuristic to try and break
5158 ;; off infinite loops.
5159 ;; After a round without any change, we allow a second, to give a chance
5160 ;; to the carry to propagate a minor imbalance from the end back to
5161 ;; the beginning.
5162 (while (< unchanged 2)
5163 ;; (message "New round")
5164 (setq unchanged (1+ unchanged) round (1+ round))
5165 (dolist (win wins)
5166 (setq next win)
5167 (while (progn (setq next (next-window next))
5168 (window-fixed-size-p next)))
5169 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
5170 (let* ((horiz
5171 (< (car (window-pixel-edges win)) (car (window-pixel-edges next))))
5172 (areadiff (/ (- (* (window-size next nil pixelwise)
5173 (window-size next t pixelwise)
5174 (buffer-local-value 'window-area-factor
5175 (window-buffer next)))
5176 (* (window-size win nil pixelwise)
5177 (window-size win t pixelwise)
5178 (buffer-local-value 'window-area-factor
5179 (window-buffer win))))
5180 (max (buffer-local-value 'window-area-factor
5181 (window-buffer win))
5182 (buffer-local-value 'window-area-factor
5183 (window-buffer next)))))
5184 (edgesize (if horiz
5185 (+ (window-size win nil pixelwise)
5186 (window-size next nil pixelwise))
5187 (+ (window-size win t pixelwise)
5188 (window-size next t pixelwise))))
5189 (diff (/ areadiff edgesize)))
5190 (when (zerop diff)
5191 ;; Maybe diff is actually closer to 1 than to 0.
5192 (setq diff (/ (* 3 areadiff) (* 2 edgesize))))
5193 (when (and (zerop diff) (not (zerop areadiff)))
5194 (setq diff (/ (+ areadiff carry) edgesize))
5195 ;; Change things smoothly.
5196 (if (or (> diff 1) (< diff -1)) (setq diff (/ diff 2))))
5197 (if (zerop diff)
5198 ;; Make sure negligible differences don't accumulate to
5199 ;; become significant.
5200 (setq carry (+ carry areadiff))
5201 ;; This used `adjust-window-trailing-edge' before and uses
5202 ;; `window-resize' now. Error wrapping is still needed.
5203 (balance-windows-area-adjust win diff horiz pixelwise)
5204 ;; (sit-for 0.5)
5205 (let ((change (cons win (window-pixel-edges win))))
5206 ;; If the same change has been seen already for this window,
5207 ;; we're most likely in an endless loop, so don't count it as
5208 ;; a change.
5209 (unless (member change changelog)
5210 (push change changelog)
5211 (setq unchanged 0 carry 0)))))))
5212 ;; We've now basically balanced all the windows.
5213 ;; But there may be some minor off-by-one imbalance left over,
5214 ;; so let's do some fine tuning.
5215 ;; (bw-finetune wins)
5216 ;; (message "Done in %d rounds" round)
5217 ))
5218
5219 ;;; Window states, how to get them and how to put them in a window.
5220 (defun window--state-get-1 (window &optional writable)
5221 "Helper function for `window-state-get'."
5222 (let* ((type
5223 (cond
5224 ((window-top-child window) 'vc)
5225 ((window-left-child window) 'hc)
5226 (t 'leaf)))
5227 (buffer (window-buffer window))
5228 (selected (eq window (selected-window)))
5229 (head
5230 `(,type
5231 ,@(unless (window-next-sibling window) `((last . t)))
5232 (pixel-width . ,(window-pixel-width window))
5233 (pixel-height . ,(window-pixel-height window))
5234 (total-width . ,(window-total-width window))
5235 (total-height . ,(window-total-height window))
5236 (normal-height . ,(window-normal-size window))
5237 (normal-width . ,(window-normal-size window t))
5238 ,@(unless (window-live-p window)
5239 `((combination-limit . ,(window-combination-limit window))))
5240 ,@(let ((parameters (window-parameters window))
5241 list)
5242 ;; Make copies of those window parameters whose
5243 ;; persistence property is `writable' if WRITABLE is
5244 ;; non-nil and non-nil if WRITABLE is nil.
5245 (dolist (par parameters)
5246 (let ((pers (cdr (assq (car par)
5247 window-persistent-parameters))))
5248 (when (and pers (or (not writable) (eq pers 'writable)))
5249 (setq list (cons (cons (car par) (cdr par)) list)))))
5250 ;; Add `clone-of' parameter if necessary.
5251 (let ((pers (cdr (assq 'clone-of
5252 window-persistent-parameters))))
5253 (when (and pers (or (not writable) (eq pers 'writable))
5254 (not (assq 'clone-of list)))
5255 (setq list (cons (cons 'clone-of window) list))))
5256 (when list
5257 `((parameters . ,list))))
5258 ,@(when buffer
5259 ;; All buffer related things go in here.
5260 (let ((point (window-point window))
5261 (start (window-start window)))
5262 `((buffer
5263 ,(buffer-name buffer)
5264 (selected . ,selected)
5265 (hscroll . ,(window-hscroll window))
5266 (fringes . ,(window-fringes window))
5267 (margins . ,(window-margins window))
5268 (scroll-bars . ,(window-scroll-bars window))
5269 (vscroll . ,(window-vscroll window))
5270 (dedicated . ,(window-dedicated-p window))
5271 (point . ,(if writable point
5272 (copy-marker point
5273 (buffer-local-value
5274 'window-point-insertion-type
5275 buffer))))
5276 (start . ,(if writable start (copy-marker start)))))))))
5277 (tail
5278 (when (memq type '(vc hc))
5279 (let (list)
5280 (setq window (window-child window))
5281 (while window
5282 (setq list (cons (window--state-get-1 window writable) list))
5283 (setq window (window-right window)))
5284 (nreverse list)))))
5285 (append head tail)))
5286
5287 (defun window-state-get (&optional window writable)
5288 "Return state of WINDOW as a Lisp object.
5289 WINDOW can be any window and defaults to the root window of the
5290 selected frame.
5291
5292 Optional argument WRITABLE non-nil means do not use markers for
5293 sampling `window-point' and `window-start'. Together, WRITABLE
5294 and the variable `window-persistent-parameters' specify which
5295 window parameters are saved by this function. WRITABLE should be
5296 non-nil when the return value shall be written to a file and read
5297 back in another session. Otherwise, an application may run into
5298 an `invalid-read-syntax' error while attempting to read back the
5299 value from file.
5300
5301 The return value can be used as argument for `window-state-put'
5302 to put the state recorded here into an arbitrary window. The
5303 value can be also stored on disk and read back in a new session."
5304 (setq window
5305 (if window
5306 (if (window-valid-p window)
5307 window
5308 (error "%s is not a live or internal window" window))
5309 (frame-root-window)))
5310 ;; The return value is a cons whose car specifies some constraints on
5311 ;; the size of WINDOW. The cdr lists the states of the child windows
5312 ;; of WINDOW.
5313 (cons
5314 ;; Frame related things would go into a function, say `frame-state',
5315 ;; calling `window-state-get' to insert the frame's root window.
5316 `((min-height . ,(window-min-size window))
5317 (min-width . ,(window-min-size window t))
5318 (min-height-ignore . ,(window-min-size window nil t))
5319 (min-width-ignore . ,(window-min-size window t t))
5320 (min-height-safe . ,(window-min-size window nil 'safe))
5321 (min-width-safe . ,(window-min-size window t 'safe))
5322 (min-pixel-height . ,(window-min-size window nil nil t))
5323 (min-pixel-width . ,(window-min-size window t nil t))
5324 (min-pixel-height-ignore . ,(window-min-size window nil t t))
5325 (min-pixel-width-ignore . ,(window-min-size window t t t))
5326 (min-pixel-height-safe . ,(window-min-size window nil 'safe t))
5327 (min-pixel-width-safe . ,(window-min-size window t 'safe t)))
5328 (window--state-get-1 window writable)))
5329
5330 (defvar window-state-put-list nil
5331 "Helper variable for `window-state-put'.")
5332
5333 (defvar window-state-put-stale-windows nil
5334 "Helper variable for `window-state-put'.")
5335
5336 (defun window--state-put-1 (state &optional window ignore totals pixelwise)
5337 "Helper function for `window-state-put'."
5338 (let ((type (car state)))
5339 (setq state (cdr state))
5340 (cond
5341 ((eq type 'leaf)
5342 ;; For a leaf window just add unprocessed entries to
5343 ;; `window-state-put-list'.
5344 (push (cons window state) window-state-put-list))
5345 ((memq type '(vc hc))
5346 (let* ((horizontal (eq type 'hc))
5347 (total (window-size window horizontal pixelwise))
5348 (first t)
5349 size new)
5350 (dolist (item state)
5351 ;; Find the next child window. WINDOW always points to the
5352 ;; real window that we want to fill with what we find here.
5353 (when (memq (car item) '(leaf vc hc))
5354 (if (assq 'last item)
5355 ;; The last child window. Below `window--state-put-1'
5356 ;; will put into it whatever ITEM has in store.
5357 (setq new nil)
5358 ;; Not the last child window, prepare for splitting
5359 ;; WINDOW. SIZE is the new (and final) size of the old
5360 ;; window.
5361 (setq size
5362 (if totals
5363 ;; Use total size.
5364 (if pixelwise
5365 (cdr (assq (if horizontal
5366 'pixel-width
5367 'pixel-height)
5368 item))
5369 (cdr (assq (if horizontal
5370 'total-width
5371 'total-height)
5372 item)))
5373 ;; Use normalized size and round.
5374 (round
5375 (* total
5376 (cdr (assq (if horizontal 'normal-width 'normal-height)
5377 item))))))
5378
5379 ;; Use safe sizes, we try to resize later.
5380 (setq size (max size
5381 (if horizontal
5382 (* window-safe-min-width
5383 (if pixelwise
5384 (frame-char-width (window-frame window))
5385 1))
5386 (* window-safe-min-height
5387 (if pixelwise
5388 (frame-char-height (window-frame window))
5389 1)))))
5390 (if (window-sizable-p window (- size) horizontal 'safe pixelwise)
5391 (let* ((window-combination-limit
5392 (assq 'combination-limit item)))
5393 ;; We must inherit the combination limit, otherwise
5394 ;; we might mess up handling of atomic and side
5395 ;; window.
5396 (setq new (split-window window size horizontal pixelwise)))
5397 ;; Give up if we can't resize window down to safe sizes.
5398 (error "Cannot resize window %s" window))
5399
5400 (when first
5401 (setq first nil)
5402 ;; When creating the first child window add for parent
5403 ;; unprocessed entries to `window-state-put-list'.
5404 (setq window-state-put-list
5405 (cons (cons (window-parent window) state)
5406 window-state-put-list))))
5407
5408 ;; Now process the current window (either the one we've just
5409 ;; split or the last child of its parent).
5410 (window--state-put-1 item window ignore totals)
5411 ;; Continue with the last window split off.
5412 (setq window new))))))))
5413
5414 (defun window--state-put-2 (ignore pixelwise)
5415 "Helper function for `window-state-put'."
5416 (dolist (item window-state-put-list)
5417 (let ((window (car item))
5418 (combination-limit (cdr (assq 'combination-limit item)))
5419 (parameters (cdr (assq 'parameters item)))
5420 (state (cdr (assq 'buffer item))))
5421 (when combination-limit
5422 (set-window-combination-limit window combination-limit))
5423 ;; Reset window's parameters and assign saved ones (we might want
5424 ;; a `remove-window-parameters' function here).
5425 (dolist (parameter (window-parameters window))
5426 (set-window-parameter window (car parameter) nil))
5427 (when parameters
5428 (dolist (parameter parameters)
5429 (set-window-parameter window (car parameter) (cdr parameter))))
5430 ;; Process buffer related state.
5431 (when state
5432 (let ((buffer (get-buffer (car state))))
5433 (if buffer
5434 (with-current-buffer buffer
5435 (set-window-buffer window buffer)
5436 (set-window-hscroll window (cdr (assq 'hscroll state)))
5437 (apply 'set-window-fringes
5438 (cons window (cdr (assq 'fringes state))))
5439 (let ((margins (cdr (assq 'margins state))))
5440 (set-window-margins window (car margins) (cdr margins)))
5441 (let ((scroll-bars (cdr (assq 'scroll-bars state))))
5442 (set-window-scroll-bars
5443 window (car scroll-bars) (nth 2 scroll-bars)
5444 (nth 3 scroll-bars) (nth 5 scroll-bars)))
5445 (set-window-vscroll window (cdr (assq 'vscroll state)))
5446 ;; Adjust vertically.
5447 (if (memq window-size-fixed '(t height))
5448 ;; A fixed height window, try to restore the
5449 ;; original size.
5450 (let ((delta
5451 (- (cdr (assq
5452 (if pixelwise 'pixel-height 'total-height)
5453 item))
5454 (window-size window nil pixelwise)))
5455 window-size-fixed)
5456 (when (window--resizable-p
5457 window delta nil nil nil nil nil pixelwise)
5458 (window-resize window delta nil nil pixelwise)))
5459 ;; Else check whether the window is not high enough.
5460 (let* ((min-size
5461 (window-min-size window nil ignore pixelwise))
5462 (delta
5463 (- min-size (window-size window nil pixelwise))))
5464 (when (and (> delta 0)
5465 (window--resizable-p
5466 window delta nil ignore nil nil nil pixelwise))
5467 (window-resize window delta nil ignore pixelwise))))
5468 ;; Adjust horizontally.
5469 (if (memq window-size-fixed '(t width))
5470 ;; A fixed width window, try to restore the original
5471 ;; size.
5472 (let ((delta
5473 (- (cdr (assq
5474 (if pixelwise 'pixel-width 'total-width)
5475 item))
5476 (window-size window t pixelwise)))
5477 window-size-fixed)
5478 (when (window--resizable-p
5479 window delta nil nil nil nil nil pixelwise)
5480 (window-resize window delta nil nil pixelwise)))
5481 ;; Else check whether the window is not wide enough.
5482 (let* ((min-size (window-min-size window t ignore pixelwise))
5483 (delta (- min-size (window-size window t pixelwise))))
5484 (when (and (> delta 0)
5485 (window--resizable-p
5486 window delta t ignore nil nil nil pixelwise))
5487 (window-resize window delta t ignore pixelwise))))
5488 ;; Set dedicated status.
5489 (set-window-dedicated-p window (cdr (assq 'dedicated state)))
5490 ;; Install positions (maybe we should do this after all
5491 ;; windows have been created and sized).
5492 (ignore-errors
5493 (set-window-start window (cdr (assq 'start state)))
5494 (set-window-point window (cdr (assq 'point state))))
5495 ;; Select window if it's the selected one.
5496 (when (cdr (assq 'selected state))
5497 (select-window window)))
5498 ;; We don't want to raise an error in case the buffer does
5499 ;; not exist anymore, so we switch to a previous one and
5500 ;; save the window with the intention of deleting it later
5501 ;; if possible.
5502 (switch-to-prev-buffer window)
5503 (push window window-state-put-stale-windows)))))))
5504
5505 (defun window-state-put (state &optional window ignore)
5506 "Put window state STATE into WINDOW.
5507 STATE should be the state of a window returned by an earlier
5508 invocation of `window-state-get'. Optional argument WINDOW must
5509 specify a valid window and defaults to the selected one. If
5510 WINDOW is not live, replace WINDOW by a live one before putting
5511 STATE into it.
5512
5513 Optional argument IGNORE non-nil means ignore minimum window
5514 sizes and fixed size restrictions. IGNORE equal `safe' means
5515 windows can get as small as `window-safe-min-height' and
5516 `window-safe-min-width'."
5517 (setq window-state-put-stale-windows nil)
5518 (setq window (window-normalize-window window))
5519
5520 ;; When WINDOW is internal, reduce it to a live one to put STATE into,
5521 ;; see Bug#16793.
5522 (unless (window-live-p window)
5523 (let ((root (frame-root-window window)))
5524 (if (eq window root)
5525 (setq window (frame-first-window root))
5526 (setq root window)
5527 (setq window (catch 'live
5528 (walk-window-subtree
5529 (lambda (window)
5530 (when (window-live-p window)
5531 (throw 'live window)))
5532 root))))
5533 (delete-other-windows-internal window root)))
5534
5535 (set-window-dedicated-p window nil)
5536
5537 (let* ((frame (window-frame window))
5538 (head (car state))
5539 ;; We check here (1) whether the total sizes of root window of
5540 ;; STATE and that of WINDOW are equal so we can avoid
5541 ;; calculating new sizes, and (2) if we do have to resize
5542 ;; whether we can do so without violating size restrictions.
5543 (pixelwise (and (cdr (assq 'pixel-width state))
5544 (cdr (assq 'pixel-height state))))
5545 (totals (or (and pixelwise
5546 (= (window-pixel-width window)
5547 (cdr (assq 'pixel-width state)))
5548 (= (window-pixel-height window)
5549 (cdr (assq 'pixel-height state))))
5550 (and (= (window-total-width window)
5551 (cdr (assq 'total-width state)))
5552 (= (window-total-height window)
5553 (cdr (assq 'total-height state))))))
5554 (min-height (cdr (assq
5555 (if pixelwise 'min-pixel-height 'min-height)
5556 head)))
5557 (min-width (cdr (assq
5558 (if pixelwise 'min-pixel-width 'min-weight)
5559 head))))
5560 (if (and (not totals)
5561 (or (> min-height (window-size window nil pixelwise))
5562 (> min-width (window-size window t pixelwise)))
5563 (or (not ignore)
5564 (and (setq min-height
5565 (cdr (assq
5566 (if pixelwise
5567 'min-pixel-height-ignore
5568 'min-height-ignore)
5569 head)))
5570 (setq min-width
5571 (cdr (assq
5572 (if pixelwise
5573 'min-pixel-width-ignore
5574 'min-width-ignore)
5575 head)))
5576 (or (> min-height
5577 (window-size window nil pixelwise))
5578 (> min-width
5579 (window-size window t pixelwise)))
5580 (or (not (eq ignore 'safe))
5581 (and (setq min-height
5582 (cdr (assq
5583 (if pixelwise
5584 'min-pixel-height-safe
5585 'min-height-safe)
5586 head)))
5587 (setq min-width
5588 (cdr (assq
5589 (if pixelwise
5590 'min-pixel-width-safe
5591 'min-width-safe)
5592 head)))
5593 (or (> min-height
5594 (window-size window nil pixelwise))
5595 (> min-width
5596 (window-size window t pixelwise))))))))
5597 ;; The check above might not catch all errors due to rounding
5598 ;; issues - so IGNORE equal 'safe might not always produce the
5599 ;; minimum possible state. But such configurations hardly make
5600 ;; sense anyway.
5601 (error "Window %s too small to accommodate state" window)
5602 (setq state (cdr state))
5603 (setq window-state-put-list nil)
5604 ;; Work on the windows of a temporary buffer to make sure that
5605 ;; splitting proceeds regardless of any buffer local values of
5606 ;; `window-size-fixed'. Release that buffer after the buffers of
5607 ;; all live windows have been set by `window--state-put-2'.
5608 (with-temp-buffer
5609 (set-window-buffer window (current-buffer))
5610 (window--state-put-1 state window nil totals pixelwise)
5611 (window--state-put-2 ignore pixelwise))
5612 (while window-state-put-stale-windows
5613 (let ((window (pop window-state-put-stale-windows)))
5614 (when (eq (window-deletable-p window) t)
5615 (delete-window window))))
5616 (window--check frame))))
5617 \f
5618 (defun display-buffer-record-window (type window buffer)
5619 "Record information for window used by `display-buffer'.
5620 TYPE specifies the type of the calling operation and must be one
5621 of the symbols `reuse' (when WINDOW existed already and was
5622 reused for displaying BUFFER), `window' (when WINDOW was created
5623 on an already existing frame), or `frame' (when WINDOW was
5624 created on a new frame). WINDOW is the window used for or created
5625 by the `display-buffer' routines. BUFFER is the buffer that
5626 shall be displayed.
5627
5628 This function installs or updates the quit-restore parameter of
5629 WINDOW. The quit-restore parameter is a list of four elements:
5630 The first element is one of the symbols `window', `frame', `same' or
5631 `other'. The second element is either one of the symbols `window'
5632 or `frame' or a list whose elements are the buffer previously
5633 shown in the window, that buffer's window start and window point,
5634 and the window's height. The third element is the window
5635 selected at the time the parameter was created. The fourth
5636 element is BUFFER."
5637 (cond
5638 ((eq type 'reuse)
5639 (if (eq (window-buffer window) buffer)
5640 ;; WINDOW shows BUFFER already. Update WINDOW's quit-restore
5641 ;; parameter, if any.
5642 (let ((quit-restore (window-parameter window 'quit-restore)))
5643 (when (consp quit-restore)
5644 (setcar quit-restore 'same)
5645 ;; The selected-window might have changed in
5646 ;; between (Bug#20353).
5647 (unless (or (eq window (selected-window))
5648 (eq window (nth 2 quit-restore)))
5649 (setcar (cddr quit-restore) (selected-window)))))
5650 ;; WINDOW shows another buffer.
5651 (with-current-buffer (window-buffer window)
5652 (set-window-parameter
5653 window 'quit-restore
5654 (list 'other
5655 ;; A quadruple of WINDOW's buffer, start, point and height.
5656 (list (current-buffer) (window-start window)
5657 ;; Preserve window-point-insertion-type (Bug#12588).
5658 (copy-marker
5659 (window-point window) window-point-insertion-type)
5660 (if (window-combined-p window)
5661 (window-total-height window)
5662 (window-total-width window)))
5663 (selected-window) buffer)))))
5664 ((eq type 'window)
5665 ;; WINDOW has been created on an existing frame.
5666 (set-window-parameter
5667 window 'quit-restore
5668 (list 'window 'window (selected-window) buffer)))
5669 ((eq type 'frame)
5670 ;; WINDOW has been created on a new frame.
5671 (set-window-parameter
5672 window 'quit-restore
5673 (list 'frame 'frame (selected-window) buffer)))))
5674
5675 (defcustom display-buffer-function nil
5676 "If non-nil, function to call to handle `display-buffer'.
5677 It will receive two args, the buffer and a flag which if non-nil
5678 means that the currently selected window is not acceptable. It
5679 should choose or create a window, display the specified buffer in
5680 it, and return the window.
5681
5682 The specified function should call `display-buffer-record-window'
5683 with corresponding arguments to set up the quit-restore parameter
5684 of the window used."
5685 :type '(choice
5686 (const nil)
5687 (function :tag "function"))
5688 :group 'windows)
5689
5690 (make-obsolete-variable 'display-buffer-function
5691 'display-buffer-alist "24.3")
5692
5693 ;; Eventually, we want to turn this into a defvar; instead of
5694 ;; customizing this, the user should use a `pop-up-frame-parameters'
5695 ;; alist entry in `display-buffer-base-action'.
5696 (defcustom pop-up-frame-alist nil
5697 "Alist of parameters for automatically generated new frames.
5698 If non-nil, the value you specify here is used by the default
5699 `pop-up-frame-function' for the creation of new frames.
5700
5701 Since `pop-up-frame-function' is used by `display-buffer' for
5702 making new frames, any value specified here by default affects
5703 the automatic generation of new frames via `display-buffer' and
5704 all functions based on it. The behavior of `make-frame' is not
5705 affected by this variable."
5706 :type '(repeat (cons :format "%v"
5707 (symbol :tag "Parameter")
5708 (sexp :tag "Value")))
5709 :group 'frames)
5710
5711 (defcustom pop-up-frame-function
5712 (lambda () (make-frame pop-up-frame-alist))
5713 "Function used by `display-buffer' for creating a new frame.
5714 This function is called with no arguments and should return a new
5715 frame. The default value calls `make-frame' with the argument
5716 `pop-up-frame-alist'."
5717 :type 'function
5718 :group 'frames)
5719
5720 (defcustom special-display-buffer-names nil
5721 "List of names of buffers that should be displayed specially.
5722 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
5723 its name is in this list, displays the buffer in a way specified
5724 by `special-display-function'. `special-display-popup-frame'
5725 \(the default for `special-display-function') usually displays
5726 the buffer in a separate frame made with the parameters specified
5727 by `special-display-frame-alist'. If `special-display-function'
5728 has been set to some other function, that function is called with
5729 the buffer as first, and nil as second argument.
5730
5731 Alternatively, an element of this list can be specified as
5732 \(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
5733 name and FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
5734 `special-display-popup-frame' will interpret such pairs as frame
5735 parameters when it creates a special frame, overriding the
5736 corresponding values from `special-display-frame-alist'.
5737
5738 As a special case, if FRAME-PARAMETERS contains (same-window . t)
5739 `special-display-popup-frame' displays that buffer in the
5740 selected window. If FRAME-PARAMETERS contains (same-frame . t),
5741 it displays that buffer in a window on the selected frame.
5742
5743 If `special-display-function' specifies some other function than
5744 `special-display-popup-frame', that function is called with the
5745 buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
5746 argument.
5747
5748 Finally, an element of this list can be also specified as
5749 \(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
5750 `special-display-popup-frame' will call FUNCTION with the buffer
5751 named BUFFER-NAME as first argument, and OTHER-ARGS as the
5752 second.
5753
5754 Any alternative function specified here is responsible for
5755 setting up the quit-restore parameter of the window used.
5756
5757 If this variable appears \"not to work\", because you added a
5758 name to it but the corresponding buffer is displayed in the
5759 selected window, look at the values of `same-window-buffer-names'
5760 and `same-window-regexps'. Those variables take precedence over
5761 this one.
5762
5763 See also `special-display-regexps'."
5764 :type '(repeat
5765 (choice :tag "Buffer"
5766 :value ""
5767 (string :format "%v")
5768 (cons :tag "With parameters"
5769 :format "%v"
5770 :value ("" . nil)
5771 (string :format "%v")
5772 (repeat :tag "Parameters"
5773 (cons :format "%v"
5774 (symbol :tag "Parameter")
5775 (sexp :tag "Value"))))
5776 (list :tag "With function"
5777 :format "%v"
5778 :value ("" . nil)
5779 (string :format "%v")
5780 (function :tag "Function")
5781 (repeat :tag "Arguments" (sexp)))))
5782 :group 'windows
5783 :group 'frames)
5784 (make-obsolete-variable 'special-display-buffer-names 'display-buffer-alist "24.3")
5785 (put 'special-display-buffer-names 'risky-local-variable t)
5786
5787 (defcustom special-display-regexps nil
5788 "List of regexps saying which buffers should be displayed specially.
5789 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
5790 any regexp in this list matches its name, displays it specially
5791 using `special-display-function'. `special-display-popup-frame'
5792 \(the default for `special-display-function') usually displays
5793 the buffer in a separate frame made with the parameters specified
5794 by `special-display-frame-alist'. If `special-display-function'
5795 has been set to some other function, that function is called with
5796 the buffer as first, and nil as second argument.
5797
5798 Alternatively, an element of this list can be specified as
5799 \(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
5800 FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
5801 `special-display-popup-frame' will then interpret these pairs as
5802 frame parameters when creating a special frame for a buffer whose
5803 name matches REGEXP, overriding the corresponding values from
5804 `special-display-frame-alist'.
5805
5806 As a special case, if FRAME-PARAMETERS contains (same-window . t)
5807 `special-display-popup-frame' displays buffers matching REGEXP in
5808 the selected window. (same-frame . t) in FRAME-PARAMETERS means
5809 to display such buffers in a window on the selected frame.
5810
5811 If `special-display-function' specifies some other function than
5812 `special-display-popup-frame', that function is called with the
5813 buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
5814 as second argument.
5815
5816 Finally, an element of this list can be also specified as
5817 \(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
5818 will then call FUNCTION with the buffer whose name matched
5819 REGEXP as first, and OTHER-ARGS as second argument.
5820
5821 Any alternative function specified here is responsible for
5822 setting up the quit-restore parameter of the window used.
5823
5824 If this variable appears \"not to work\", because you added a
5825 name to it but the corresponding buffer is displayed in the
5826 selected window, look at the values of `same-window-buffer-names'
5827 and `same-window-regexps'. Those variables take precedence over
5828 this one.
5829
5830 See also `special-display-buffer-names'."
5831 :type '(repeat
5832 (choice :tag "Buffer"
5833 :value ""
5834 (regexp :format "%v")
5835 (cons :tag "With parameters"
5836 :format "%v"
5837 :value ("" . nil)
5838 (regexp :format "%v")
5839 (repeat :tag "Parameters"
5840 (cons :format "%v"
5841 (symbol :tag "Parameter")
5842 (sexp :tag "Value"))))
5843 (list :tag "With function"
5844 :format "%v"
5845 :value ("" . nil)
5846 (regexp :format "%v")
5847 (function :tag "Function")
5848 (repeat :tag "Arguments" (sexp)))))
5849 :group 'windows
5850 :group 'frames)
5851 (make-obsolete-variable 'special-display-regexps 'display-buffer-alist "24.3")
5852 (put 'special-display-regexps 'risky-local-variable t)
5853
5854 (defun special-display-p (buffer-name)
5855 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
5856 More precisely, return t if `special-display-buffer-names' or
5857 `special-display-regexps' contain a string entry equaling or
5858 matching BUFFER-NAME. If `special-display-buffer-names' or
5859 `special-display-regexps' contain a list entry whose car equals
5860 or matches BUFFER-NAME, the return value is the cdr of that
5861 entry."
5862 (let (tmp)
5863 (cond
5864 ((member buffer-name special-display-buffer-names)
5865 t)
5866 ((setq tmp (assoc buffer-name special-display-buffer-names))
5867 (cdr tmp))
5868 ((catch 'found
5869 (dolist (regexp special-display-regexps)
5870 (cond
5871 ((stringp regexp)
5872 (when (string-match-p regexp buffer-name)
5873 (throw 'found t)))
5874 ((and (consp regexp) (stringp (car regexp))
5875 (string-match-p (car regexp) buffer-name))
5876 (throw 'found (cdr regexp))))))))))
5877
5878 (defcustom special-display-frame-alist
5879 '((height . 14) (width . 80) (unsplittable . t))
5880 "Alist of parameters for special frames.
5881 Special frames are used for buffers whose names are listed in
5882 `special-display-buffer-names' and for buffers whose names match
5883 one of the regular expressions in `special-display-regexps'.
5884
5885 This variable can be set in your init file, like this:
5886
5887 (setq special-display-frame-alist \\='((width . 80) (height . 20)))
5888
5889 These supersede the values given in `default-frame-alist'."
5890 :type '(repeat (cons :format "%v"
5891 (symbol :tag "Parameter")
5892 (sexp :tag "Value")))
5893 :group 'frames)
5894 (make-obsolete-variable 'special-display-frame-alist 'display-buffer-alist "24.3")
5895
5896 (defun special-display-popup-frame (buffer &optional args)
5897 "Pop up a frame displaying BUFFER and return its window.
5898 If BUFFER is already displayed in a visible or iconified frame,
5899 raise that frame. Otherwise, display BUFFER in a new frame.
5900
5901 Optional argument ARGS is a list specifying additional
5902 information.
5903
5904 If ARGS is an alist, use it as a list of frame parameters. If
5905 these parameters contain (same-window . t), display BUFFER in
5906 the selected window. If they contain (same-frame . t), display
5907 BUFFER in a window of the selected frame.
5908
5909 If ARGS is a list whose car is a symbol, use (car ARGS) as a
5910 function to do the work. Pass it BUFFER as first argument, and
5911 pass the elements of (cdr ARGS) as the remaining arguments."
5912 (if (and args (symbolp (car args)))
5913 (apply (car args) buffer (cdr args))
5914 (let ((window (get-buffer-window buffer 0)))
5915 (or
5916 ;; If we have a window already, make it visible.
5917 (when window
5918 (let ((frame (window-frame window)))
5919 (make-frame-visible frame)
5920 (raise-frame frame)
5921 (display-buffer-record-window 'reuse window buffer)
5922 window))
5923 ;; Reuse the current window if the user requested it.
5924 (when (cdr (assq 'same-window args))
5925 (condition-case nil
5926 (progn (switch-to-buffer buffer nil t) (selected-window))
5927 (error nil)))
5928 ;; Stay on the same frame if requested.
5929 (when (or (cdr (assq 'same-frame args)) (cdr (assq 'same-window args)))
5930 (let* ((pop-up-windows t)
5931 pop-up-frames
5932 special-display-buffer-names special-display-regexps)
5933 (display-buffer buffer)))
5934 ;; If no window yet, make one in a new frame.
5935 (let* ((frame
5936 (with-current-buffer buffer
5937 (make-frame (append args special-display-frame-alist))))
5938 (window (frame-selected-window frame)))
5939 (display-buffer-record-window 'frame window buffer)
5940 (unless (eq buffer (window-buffer window))
5941 (set-window-buffer window buffer)
5942 (set-window-prev-buffers window nil))
5943 (set-window-dedicated-p window t)
5944 window)))))
5945
5946 (defcustom special-display-function 'special-display-popup-frame
5947 "Function to call for displaying special buffers.
5948 This function is called with two arguments - the buffer and,
5949 optionally, a list - and should return a window displaying that
5950 buffer. The default value usually makes a separate frame for the
5951 buffer using `special-display-frame-alist' to specify the frame
5952 parameters. See the definition of `special-display-popup-frame'
5953 for how to specify such a function.
5954
5955 A buffer is special when its name is either listed in
5956 `special-display-buffer-names' or matches a regexp in
5957 `special-display-regexps'.
5958
5959 The specified function should call `display-buffer-record-window'
5960 with corresponding arguments to set up the quit-restore parameter
5961 of the window used."
5962 :type 'function
5963 :group 'frames)
5964 (make-obsolete-variable 'special-display-function 'display-buffer-alist "24.3")
5965
5966 (defcustom same-window-buffer-names nil
5967 "List of names of buffers that should appear in the \"same\" window.
5968 `display-buffer' and `pop-to-buffer' show a buffer whose name is
5969 on this list in the selected rather than some other window.
5970
5971 An element of this list can be a cons cell instead of just a
5972 string. In that case, the cell's car must be a string specifying
5973 the buffer name. This is for compatibility with
5974 `special-display-buffer-names'; the cdr of the cons cell is
5975 ignored.
5976
5977 See also `same-window-regexps'."
5978 :type '(repeat (string :format "%v"))
5979 :group 'windows)
5980
5981 (defcustom same-window-regexps nil
5982 "List of regexps saying which buffers should appear in the \"same\" window.
5983 `display-buffer' and `pop-to-buffer' show a buffer whose name
5984 matches a regexp on this list in the selected rather than some
5985 other window.
5986
5987 An element of this list can be a cons cell instead of just a
5988 string. In that case, the cell's car must be a regexp matching
5989 the buffer name. This is for compatibility with
5990 `special-display-regexps'; the cdr of the cons cell is ignored.
5991
5992 See also `same-window-buffer-names'."
5993 :type '(repeat (regexp :format "%v"))
5994 :group 'windows)
5995
5996 (defun same-window-p (buffer-name)
5997 "Return non-nil if a buffer named BUFFER-NAME would be shown in the \"same\" window.
5998 This function returns non-nil if `display-buffer' or
5999 `pop-to-buffer' would show a buffer named BUFFER-NAME in the
6000 selected rather than (as usual) some other window. See
6001 `same-window-buffer-names' and `same-window-regexps'."
6002 (cond
6003 ((not (stringp buffer-name)))
6004 ;; The elements of `same-window-buffer-names' can be buffer
6005 ;; names or cons cells whose cars are buffer names.
6006 ((member buffer-name same-window-buffer-names))
6007 ((assoc buffer-name same-window-buffer-names))
6008 ((catch 'found
6009 (dolist (regexp same-window-regexps)
6010 ;; The elements of `same-window-regexps' can be regexps
6011 ;; or cons cells whose cars are regexps.
6012 (when (or (and (stringp regexp)
6013 (string-match-p regexp buffer-name))
6014 (and (consp regexp) (stringp (car regexp))
6015 (string-match-p (car regexp) buffer-name)))
6016 (throw 'found t)))))))
6017
6018 (defcustom pop-up-frames nil
6019 "Whether `display-buffer' should make a separate frame.
6020 If nil, never make a separate frame.
6021 If the value is `graphic-only', make a separate frame
6022 on graphic displays only.
6023 Any other non-nil value means always make a separate frame."
6024 :type '(choice
6025 (const :tag "Never" nil)
6026 (const :tag "On graphic displays only" graphic-only)
6027 (const :tag "Always" t))
6028 :group 'windows)
6029
6030 (defcustom display-buffer-reuse-frames nil
6031 "Non-nil means `display-buffer' should reuse frames.
6032 If the buffer in question is already displayed in a frame, raise
6033 that frame."
6034 :type 'boolean
6035 :version "21.1"
6036 :group 'windows)
6037
6038 (make-obsolete-variable
6039 'display-buffer-reuse-frames
6040 "use a `reusable-frames' alist entry in `display-buffer-alist'."
6041 "24.3")
6042
6043 (defcustom pop-up-windows t
6044 "Non-nil means `display-buffer' should make a new window."
6045 :type 'boolean
6046 :group 'windows)
6047
6048 (defcustom split-window-preferred-function 'split-window-sensibly
6049 "Function called by `display-buffer' routines to split a window.
6050 This function is called with a window as single argument and is
6051 supposed to split that window and return the new window. If the
6052 window can (or shall) not be split, it is supposed to return nil.
6053 The default is to call the function `split-window-sensibly' which
6054 tries to split the window in a way which seems most suitable.
6055 You can customize the options `split-height-threshold' and/or
6056 `split-width-threshold' in order to have `split-window-sensibly'
6057 prefer either vertical or horizontal splitting.
6058
6059 If you set this to any other function, bear in mind that the
6060 `display-buffer' routines may call this function two times. The
6061 argument of the first call is the largest window on its frame.
6062 If that call fails to return a live window, the function is
6063 called again with the least recently used window as argument. If
6064 that call fails too, `display-buffer' will use an existing window
6065 to display its buffer.
6066
6067 The window selected at the time `display-buffer' was invoked is
6068 still selected when this function is called. Hence you can
6069 compare the window argument with the value of `selected-window'
6070 if you intend to split the selected window instead or if you do
6071 not want to split the selected window."
6072 :type 'function
6073 :version "23.1"
6074 :group 'windows)
6075
6076 (defcustom split-height-threshold 80
6077 "Minimum height for splitting windows sensibly.
6078 If this is an integer, `split-window-sensibly' may split a window
6079 vertically only if it has at least this many lines. If this is
6080 nil, `split-window-sensibly' is not allowed to split a window
6081 vertically. If, however, a window is the only window on its
6082 frame, `split-window-sensibly' may split it vertically
6083 disregarding the value of this variable."
6084 :type '(choice (const nil) (integer :tag "lines"))
6085 :version "23.1"
6086 :group 'windows)
6087
6088 (defcustom split-width-threshold 160
6089 "Minimum width for splitting windows sensibly.
6090 If this is an integer, `split-window-sensibly' may split a window
6091 horizontally only if it has at least this many columns. If this
6092 is nil, `split-window-sensibly' is not allowed to split a window
6093 horizontally."
6094 :type '(choice (const nil) (integer :tag "columns"))
6095 :version "23.1"
6096 :group 'windows)
6097
6098 (defun window-splittable-p (window &optional horizontal)
6099 "Return non-nil if `split-window-sensibly' may split WINDOW.
6100 Optional argument HORIZONTAL nil or omitted means check whether
6101 `split-window-sensibly' may split WINDOW vertically. HORIZONTAL
6102 non-nil means check whether WINDOW may be split horizontally.
6103
6104 WINDOW may be split vertically when the following conditions
6105 hold:
6106 - `window-size-fixed' is either nil or equals `width' for the
6107 buffer of WINDOW.
6108 - `split-height-threshold' is an integer and WINDOW is at least as
6109 high as `split-height-threshold'.
6110 - When WINDOW is split evenly, the emanating windows are at least
6111 `window-min-height' lines tall and can accommodate at least one
6112 line plus - if WINDOW has one - a mode line.
6113
6114 WINDOW may be split horizontally when the following conditions
6115 hold:
6116 - `window-size-fixed' is either nil or equals `height' for the
6117 buffer of WINDOW.
6118 - `split-width-threshold' is an integer and WINDOW is at least as
6119 wide as `split-width-threshold'.
6120 - When WINDOW is split evenly, the emanating windows are at least
6121 `window-min-width' or two (whichever is larger) columns wide."
6122 (when (and (window-live-p window) (not (window--side-window-p window)))
6123 (with-current-buffer (window-buffer window)
6124 (if horizontal
6125 ;; A window can be split horizontally when its width is not
6126 ;; fixed, it is at least `split-width-threshold' columns wide
6127 ;; and at least twice as wide as `window-min-width' and 2 (the
6128 ;; latter value is hardcoded).
6129 (and (memq window-size-fixed '(nil height))
6130 ;; Testing `window-full-width-p' here hardly makes any
6131 ;; sense nowadays. This can be done more intuitively by
6132 ;; setting up `split-width-threshold' appropriately.
6133 (numberp split-width-threshold)
6134 (>= (window-width window)
6135 (max split-width-threshold
6136 (* 2 (max window-min-width 2)))))
6137 ;; A window can be split vertically when its height is not
6138 ;; fixed, it is at least `split-height-threshold' lines high,
6139 ;; and it is at least twice as high as `window-min-height' and 2
6140 ;; if it has a mode line or 1.
6141 (and (memq window-size-fixed '(nil width))
6142 (numberp split-height-threshold)
6143 (>= (window-height window)
6144 (max split-height-threshold
6145 (* 2 (max window-min-height
6146 (if mode-line-format 2 1))))))))))
6147
6148 (defun split-window-sensibly (&optional window)
6149 "Split WINDOW in a way suitable for `display-buffer'.
6150 WINDOW defaults to the currently selected window.
6151 If `split-height-threshold' specifies an integer, WINDOW is at
6152 least `split-height-threshold' lines tall and can be split
6153 vertically, split WINDOW into two windows one above the other and
6154 return the lower window. Otherwise, if `split-width-threshold'
6155 specifies an integer, WINDOW is at least `split-width-threshold'
6156 columns wide and can be split horizontally, split WINDOW into two
6157 windows side by side and return the window on the right. If this
6158 can't be done either and WINDOW is the only window on its frame,
6159 try to split WINDOW vertically disregarding any value specified
6160 by `split-height-threshold'. If that succeeds, return the lower
6161 window. Return nil otherwise.
6162
6163 By default `display-buffer' routines call this function to split
6164 the largest or least recently used window. To change the default
6165 customize the option `split-window-preferred-function'.
6166
6167 You can enforce this function to not split WINDOW horizontally,
6168 by setting (or binding) the variable `split-width-threshold' to
6169 nil. If, in addition, you set `split-height-threshold' to zero,
6170 chances increase that this function does split WINDOW vertically.
6171
6172 In order to not split WINDOW vertically, set (or bind) the
6173 variable `split-height-threshold' to nil. Additionally, you can
6174 set `split-width-threshold' to zero to make a horizontal split
6175 more likely to occur.
6176
6177 Have a look at the function `window-splittable-p' if you want to
6178 know how `split-window-sensibly' determines whether WINDOW can be
6179 split."
6180 (let ((window (or window (selected-window))))
6181 (or (and (window-splittable-p window)
6182 ;; Split window vertically.
6183 (with-selected-window window
6184 (split-window-below)))
6185 (and (window-splittable-p window t)
6186 ;; Split window horizontally.
6187 (with-selected-window window
6188 (split-window-right)))
6189 (and (eq window (frame-root-window (window-frame window)))
6190 (not (window-minibuffer-p window))
6191 ;; If WINDOW is the only window on its frame and is not the
6192 ;; minibuffer window, try to split it vertically disregarding
6193 ;; the value of `split-height-threshold'.
6194 (let ((split-height-threshold 0))
6195 (when (window-splittable-p window)
6196 (with-selected-window window
6197 (split-window-below))))))))
6198
6199 (defun window--try-to-split-window (window &optional alist)
6200 "Try to split WINDOW.
6201 Return value returned by `split-window-preferred-function' if it
6202 represents a live window, nil otherwise."
6203 (and (window-live-p window)
6204 (not (frame-parameter (window-frame window) 'unsplittable))
6205 (let* ((window-combination-limit
6206 ;; When `window-combination-limit' equals
6207 ;; `display-buffer' or equals `resize-window' and a
6208 ;; `window-height' or `window-width' alist entry are
6209 ;; present, bind it to t so resizing steals space
6210 ;; preferably from the window that was split.
6211 (if (or (eq window-combination-limit 'display-buffer)
6212 (and (eq window-combination-limit 'window-size)
6213 (or (cdr (assq 'window-height alist))
6214 (cdr (assq 'window-width alist)))))
6215 t
6216 window-combination-limit))
6217 (new-window
6218 ;; Since `split-window-preferred-function' might
6219 ;; throw an error use `condition-case'.
6220 (condition-case nil
6221 (funcall split-window-preferred-function window)
6222 (error nil))))
6223 (and (window-live-p new-window) new-window))))
6224
6225 (defun window--frame-usable-p (frame)
6226 "Return FRAME if it can be used to display a buffer."
6227 (when (frame-live-p frame)
6228 (let ((window (frame-root-window frame)))
6229 ;; `frame-root-window' may be an internal window which is considered
6230 ;; "dead" by `window-live-p'. Hence if `window' is not live we
6231 ;; implicitly know that `frame' has a visible window we can use.
6232 (unless (and (window-live-p window)
6233 (or (window-minibuffer-p window)
6234 ;; If the window is soft-dedicated, the frame is usable.
6235 ;; Actually, even if the window is really dedicated,
6236 ;; the frame is still usable by splitting it.
6237 ;; At least Emacs-22 allowed it, and it is desirable
6238 ;; when displaying same-frame windows.
6239 nil ; (eq t (window-dedicated-p window))
6240 ))
6241 frame))))
6242
6243 (defcustom even-window-sizes t
6244 "If non-nil `display-buffer' will try to even window sizes.
6245 Otherwise `display-buffer' will leave the window configuration
6246 alone. Special values are `height-only' to even heights only and
6247 `width-only' to even widths only. Any other value means to even
6248 any of them."
6249 :type '(choice
6250 (const :tag "Never" nil)
6251 (const :tag "Side-by-side windows only" width-only)
6252 (const :tag "Windows above or below only" height-only)
6253 (const :tag "Always" t))
6254 :version "25.1"
6255 :group 'windows)
6256 (defvaralias 'even-window-heights 'even-window-sizes)
6257
6258 (defun window--even-window-sizes (window)
6259 "Even sizes of WINDOW and selected window.
6260 Even only if these windows are the only children of their parent,
6261 `even-window-sizes' has the appropriate value and the selected
6262 window is larger than WINDOW."
6263 (when (and (= (window-child-count (window-parent window)) 2)
6264 (eq (window-parent) (window-parent window)))
6265 (cond
6266 ((and (not (memq even-window-sizes '(nil height-only)))
6267 (window-combined-p window t)
6268 (> (window-total-width) (window-total-width window)))
6269 (condition-case nil
6270 (enlarge-window
6271 (/ (- (window-total-width window) (window-total-width)) 2) t)
6272 (error nil)))
6273 ((and (not (memq even-window-sizes '(nil width-only)))
6274 (window-combined-p window)
6275 (> (window-total-height) (window-total-height window)))
6276 (condition-case nil
6277 (enlarge-window
6278 (/ (- (window-total-height window) (window-total-height)) 2))
6279 (error nil))))))
6280
6281 (defun window--display-buffer (buffer window type &optional alist dedicated)
6282 "Display BUFFER in WINDOW.
6283 TYPE must be one of the symbols `reuse', `window' or `frame' and
6284 is passed unaltered to `display-buffer-record-window'. ALIST is
6285 the alist argument of `display-buffer'. Set `window-dedicated-p'
6286 to DEDICATED if non-nil. Return WINDOW if BUFFER and WINDOW are
6287 live."
6288 (when (and (buffer-live-p buffer) (window-live-p window))
6289 (display-buffer-record-window type window buffer)
6290 (unless (eq buffer (window-buffer window))
6291 (set-window-dedicated-p window nil)
6292 (set-window-buffer window buffer)
6293 (when dedicated
6294 (set-window-dedicated-p window dedicated))
6295 (when (memq type '(window frame))
6296 (set-window-prev-buffers window nil)))
6297 (let ((parameter (window-parameter window 'quit-restore))
6298 (height (cdr (assq 'window-height alist)))
6299 (width (cdr (assq 'window-width alist)))
6300 (size (cdr (assq 'window-size alist)))
6301 (preserve-size (cdr (assq 'preserve-size alist))))
6302 (cond
6303 ((or (eq type 'frame)
6304 (and (eq (car parameter) 'same)
6305 (eq (nth 1 parameter) 'frame)))
6306 ;; Adjust size of frame if asked for.
6307 (cond
6308 ((not size))
6309 ((consp size)
6310 (let ((width (car size))
6311 (height (cdr size))
6312 (frame (window-frame window)))
6313 (when (and (numberp width) (numberp height))
6314 (set-frame-height
6315 frame (+ (frame-height frame)
6316 (- height (window-total-height window))))
6317 (set-frame-width
6318 frame (+ (frame-width frame)
6319 (- width (window-total-width window)))))))
6320 ((functionp size)
6321 (ignore-errors (funcall size window)))))
6322 ((or (eq type 'window)
6323 (and (eq (car parameter) 'same)
6324 (eq (nth 1 parameter) 'window)))
6325 ;; Adjust height of window if asked for.
6326 (cond
6327 ((not height))
6328 ((numberp height)
6329 (let* ((new-height
6330 (if (integerp height)
6331 height
6332 (round
6333 (* (window-total-height (frame-root-window window))
6334 height))))
6335 (delta (- new-height (window-total-height window))))
6336 (when (and (window--resizable-p window delta nil 'safe)
6337 (window-combined-p window))
6338 (window-resize window delta nil 'safe))))
6339 ((functionp height)
6340 (ignore-errors (funcall height window))))
6341 ;; Adjust width of window if asked for.
6342 (cond
6343 ((not width))
6344 ((numberp width)
6345 (let* ((new-width
6346 (if (integerp width)
6347 width
6348 (round
6349 (* (window-total-width (frame-root-window window))
6350 width))))
6351 (delta (- new-width (window-total-width window))))
6352 (when (and (window--resizable-p window delta t 'safe)
6353 (window-combined-p window t))
6354 (window-resize window delta t 'safe))))
6355 ((functionp width)
6356 (ignore-errors (funcall width window))))
6357 ;; Preserve window size if asked for.
6358 (when (consp preserve-size)
6359 (window-preserve-size window t (car preserve-size))
6360 (window-preserve-size window nil (cdr preserve-size))))))
6361
6362 window))
6363
6364 (defun window--maybe-raise-frame (frame)
6365 (let ((visible (frame-visible-p frame)))
6366 (unless (or (not visible)
6367 ;; Assume the selected frame is already visible enough.
6368 (eq frame (selected-frame))
6369 ;; Assume the frame from which we invoked the
6370 ;; minibuffer is visible.
6371 (and (minibuffer-window-active-p (selected-window))
6372 (eq frame (window-frame (minibuffer-selected-window)))))
6373 (raise-frame frame))))
6374
6375 ;; FIXME: Not implemented.
6376 ;; FIXME: By the way, there could be more levels of dedication:
6377 ;; - `barely' dedicated doesn't prevent reuse of the window, only records that
6378 ;; the window hasn't been used for something else yet.
6379 ;; - `soft' (`softly') dedicated only allows reuse when asked explicitly.
6380 ;; - `strongly' never allows reuse.
6381 (defvar display-buffer-mark-dedicated nil
6382 "If non-nil, `display-buffer' marks the windows it creates as dedicated.
6383 The actual non-nil value of this variable will be copied to the
6384 `window-dedicated-p' flag.")
6385
6386 (defconst display-buffer--action-function-custom-type
6387 '(choice :tag "Function"
6388 (const :tag "--" ignore) ; default for insertion
6389 (const display-buffer-reuse-window)
6390 (const display-buffer-pop-up-window)
6391 (const display-buffer-same-window)
6392 (const display-buffer-pop-up-frame)
6393 (const display-buffer-below-selected)
6394 (const display-buffer-at-bottom)
6395 (const display-buffer-in-previous-window)
6396 (const display-buffer-use-some-window)
6397 (const display-buffer-use-some-frame)
6398 (function :tag "Other function"))
6399 "Custom type for `display-buffer' action functions.")
6400
6401 (defconst display-buffer--action-custom-type
6402 `(cons :tag "Action"
6403 (choice :tag "Action functions"
6404 ,display-buffer--action-function-custom-type
6405 (repeat
6406 :tag "List of functions"
6407 ,display-buffer--action-function-custom-type))
6408 (alist :tag "Action arguments"
6409 :key-type symbol
6410 :value-type (sexp :tag "Value")))
6411 "Custom type for `display-buffer' actions.")
6412
6413 (defvar display-buffer-overriding-action '(nil . nil)
6414 "Overriding action to perform to display a buffer.
6415 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
6416 function or a list of functions. Each function should accept two
6417 arguments: a buffer to display and an alist similar to ALIST.
6418 See `display-buffer' for details.")
6419 (put 'display-buffer-overriding-action 'risky-local-variable t)
6420
6421 (defcustom display-buffer-alist nil
6422 "Alist of conditional actions for `display-buffer'.
6423 This is a list of elements (CONDITION . ACTION), where:
6424
6425 CONDITION is either a regexp matching buffer names, or a
6426 function that takes two arguments - a buffer name and the
6427 ACTION argument of `display-buffer' - and returns a boolean.
6428
6429 ACTION is a cons cell (FUNCTION . ALIST), where FUNCTION is a
6430 function or a list of functions. Each such function should
6431 accept two arguments: a buffer to display and an alist of the
6432 same form as ALIST. See `display-buffer' for details.
6433
6434 `display-buffer' scans this alist until it either finds a
6435 matching regular expression or the function specified by a
6436 condition returns non-nil. In any of these cases, it adds the
6437 associated action to the list of actions it will try."
6438 :type `(alist :key-type
6439 (choice :tag "Condition"
6440 regexp
6441 (function :tag "Matcher function"))
6442 :value-type ,display-buffer--action-custom-type)
6443 :risky t
6444 :version "24.1"
6445 :group 'windows)
6446
6447 (defcustom display-buffer-base-action '(nil . nil)
6448 "User-specified default action for `display-buffer'.
6449 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
6450 function or a list of functions. Each function should accept two
6451 arguments: a buffer to display and an alist similar to ALIST.
6452 See `display-buffer' for details."
6453 :type display-buffer--action-custom-type
6454 :risky t
6455 :version "24.1"
6456 :group 'windows)
6457
6458 (defconst display-buffer-fallback-action
6459 '((display-buffer--maybe-same-window ;FIXME: why isn't this redundant?
6460 display-buffer-reuse-window
6461 display-buffer--maybe-pop-up-frame-or-window
6462 display-buffer-in-previous-window
6463 display-buffer-use-some-window
6464 ;; If all else fails, pop up a new frame.
6465 display-buffer-pop-up-frame))
6466 "Default fallback action for `display-buffer'.
6467 This is the action used by `display-buffer' if no other actions
6468 specified, e.g. by the user options `display-buffer-alist' or
6469 `display-buffer-base-action'. See `display-buffer'.")
6470 (put 'display-buffer-fallback-action 'risky-local-variable t)
6471
6472 (defun display-buffer-assq-regexp (buffer-name alist action)
6473 "Retrieve ALIST entry corresponding to BUFFER-NAME.
6474 ACTION is the action argument passed to `display-buffer'."
6475 (catch 'match
6476 (dolist (entry alist)
6477 (let ((key (car entry)))
6478 (when (or (and (stringp key)
6479 (string-match-p key buffer-name))
6480 (and (functionp key)
6481 (funcall key buffer-name action)))
6482 (throw 'match (cdr entry)))))))
6483
6484 (defvar display-buffer--same-window-action
6485 '(display-buffer-same-window
6486 (inhibit-same-window . nil))
6487 "A `display-buffer' action for displaying in the same window.")
6488 (put 'display-buffer--same-window-action 'risky-local-variable t)
6489
6490 (defvar display-buffer--other-frame-action
6491 '((display-buffer-reuse-window
6492 display-buffer-pop-up-frame)
6493 (reusable-frames . 0)
6494 (inhibit-same-window . t))
6495 "A `display-buffer' action for displaying in another frame.")
6496 (put 'display-buffer--other-frame-action 'risky-local-variable t)
6497
6498 (defun display-buffer (buffer-or-name &optional action frame)
6499 "Display BUFFER-OR-NAME in some window, without selecting it.
6500 BUFFER-OR-NAME must be a buffer or the name of an existing
6501 buffer. Return the window chosen for displaying BUFFER-OR-NAME,
6502 or nil if no such window is found.
6503
6504 Optional argument ACTION, if non-nil, should specify a display
6505 action. Its form is described below.
6506
6507 Optional argument FRAME, if non-nil, acts like an additional
6508 ALIST entry (reusable-frames . FRAME) to the action list of ACTION,
6509 specifying the frame(s) to search for a window that is already
6510 displaying the buffer. See `display-buffer-reuse-window'.
6511
6512 If ACTION is non-nil, it should have the form (FUNCTION . ALIST),
6513 where FUNCTION is either a function or a list of functions, and
6514 ALIST is an arbitrary association list (alist).
6515
6516 Each such FUNCTION should accept two arguments: the buffer to
6517 display and an alist. Based on those arguments, it should
6518 display the buffer and return the window. If the caller is
6519 prepared to handle the case of not displaying the buffer
6520 and returning nil from `display-buffer' it should pass
6521 \(allow-no-window . t) as an element of the ALIST.
6522
6523 The `display-buffer' function builds a function list and an alist
6524 by combining the functions and alists specified in
6525 `display-buffer-overriding-action', `display-buffer-alist', the
6526 ACTION argument, `display-buffer-base-action', and
6527 `display-buffer-fallback-action' (in order). Then it calls each
6528 function in the combined function list in turn, passing the
6529 buffer as the first argument and the combined alist as the second
6530 argument, until one of the functions returns non-nil.
6531
6532 If ACTION is nil, the function list and the alist are built using
6533 only the other variables mentioned above.
6534
6535 Available action functions include:
6536 `display-buffer-same-window'
6537 `display-buffer-reuse-window'
6538 `display-buffer-pop-up-frame'
6539 `display-buffer-pop-up-window'
6540 `display-buffer-in-previous-window'
6541 `display-buffer-use-some-window'
6542 `display-buffer-use-some-frame'
6543
6544 Recognized alist entries include:
6545
6546 `inhibit-same-window' -- A non-nil value prevents the same
6547 window from being used for display.
6548
6549 `inhibit-switch-frame' -- A non-nil value prevents any other
6550 frame from being raised or selected,
6551 even if the window is displayed there.
6552
6553 `reusable-frames' -- Value specifies frame(s) to search for a
6554 window that already displays the buffer.
6555 See `display-buffer-reuse-window'.
6556
6557 `pop-up-frame-parameters' -- Value specifies an alist of frame
6558 parameters to give a new frame, if
6559 one is created.
6560
6561 `window-height' -- Value specifies either an integer (the number
6562 of lines of a new window), a floating point number (the
6563 fraction of a new window with respect to the height of the
6564 frame's root window) or a function to be called with one
6565 argument - a new window. The function is supposed to adjust
6566 the height of the window; its return value is ignored.
6567 Suitable functions are `shrink-window-if-larger-than-buffer'
6568 and `fit-window-to-buffer'.
6569
6570 `window-width' -- Value specifies either an integer (the number
6571 of columns of a new window), a floating point number (the
6572 fraction of a new window with respect to the width of the
6573 frame's root window) or a function to be called with one
6574 argument - a new window. The function is supposed to adjust
6575 the width of the window; its return value is ignored.
6576
6577 `allow-no-window' -- A non-nil value indicates readiness for the case
6578 of not displaying the buffer and FUNCTION can safely return
6579 a non-window value to suppress displaying.
6580
6581 `preserve-size' -- Value should be either (t . nil) to
6582 preserve the width of the window, (nil . t) to preserve its
6583 height or (t . t) to preserve both.
6584
6585 The ACTION argument to `display-buffer' can also have a non-nil
6586 and non-list value. This means to display the buffer in a window
6587 other than the selected one, even if it is already displayed in
6588 the selected window. If called interactively with a prefix
6589 argument, ACTION is t."
6590 (interactive (list (read-buffer "Display buffer: " (other-buffer))
6591 (if current-prefix-arg t)))
6592 (let ((buffer (if (bufferp buffer-or-name)
6593 buffer-or-name
6594 (get-buffer buffer-or-name)))
6595 ;; Make sure that when we split windows the old window keeps
6596 ;; point, bug#14829.
6597 (split-window-keep-point t)
6598 ;; Handle the old form of the first argument.
6599 (inhibit-same-window (and action (not (listp action)))))
6600 (unless (listp action) (setq action nil))
6601 (if display-buffer-function
6602 ;; If `display-buffer-function' is defined, let it do the job.
6603 (funcall display-buffer-function buffer inhibit-same-window)
6604 ;; Otherwise, use the defined actions.
6605 (let* ((user-action
6606 (display-buffer-assq-regexp
6607 (buffer-name buffer) display-buffer-alist action))
6608 (special-action (display-buffer--special-action buffer))
6609 ;; Extra actions from the arguments to this function:
6610 (extra-action
6611 (cons nil (append (if inhibit-same-window
6612 '((inhibit-same-window . t)))
6613 (if frame
6614 `((reusable-frames . ,frame))))))
6615 ;; Construct action function list and action alist.
6616 (actions (list display-buffer-overriding-action
6617 user-action special-action action extra-action
6618 display-buffer-base-action
6619 display-buffer-fallback-action))
6620 (functions (apply 'append
6621 (mapcar (lambda (x)
6622 (setq x (car x))
6623 (if (functionp x) (list x) x))
6624 actions)))
6625 (alist (apply 'append (mapcar 'cdr actions)))
6626 window)
6627 (unless (buffer-live-p buffer)
6628 (error "Invalid buffer"))
6629 (while (and functions (not window))
6630 (setq window (funcall (car functions) buffer alist)
6631 functions (cdr functions)))
6632 (and (windowp window) window)))))
6633
6634 (defun display-buffer-other-frame (buffer)
6635 "Display buffer BUFFER preferably in another frame.
6636 This uses the function `display-buffer' as a subroutine; see
6637 its documentation for additional customization information."
6638 (interactive "BDisplay buffer in other frame: ")
6639 (display-buffer buffer display-buffer--other-frame-action t))
6640
6641 ;;; `display-buffer' action functions:
6642
6643 (defun display-buffer-use-some-frame (buffer alist)
6644 "Display BUFFER in an existing frame that meets a predicate
6645 \(by default any frame other than the current frame). If
6646 successful, return the window used; otherwise return nil.
6647
6648 If ALIST has a non-nil `inhibit-switch-frame' entry, avoid
6649 raising the frame.
6650
6651 If ALIST has a non-nil `frame-predicate' entry, its value is a
6652 function taking one argument (a frame), returning non-nil if the
6653 frame is a candidate; this function replaces the default
6654 predicate.
6655
6656 If ALIST has a non-nil `inhibit-same-window' entry, avoid using
6657 the currently selected window (only useful with a frame-predicate
6658 that allows the selected frame)."
6659 (let* ((predicate (or (cdr (assq 'frame-predicate alist))
6660 (lambda (frame)
6661 (and
6662 (not (eq frame (selected-frame)))
6663 (not (window-dedicated-p
6664 (or
6665 (get-lru-window frame)
6666 (frame-first-window frame)))))
6667 )))
6668 (frame (car (filtered-frame-list predicate)))
6669 (window (and frame (get-lru-window frame nil (cdr (assq 'inhibit-same-window alist))))))
6670 (when window
6671 (prog1
6672 (window--display-buffer
6673 buffer window 'frame alist display-buffer-mark-dedicated)
6674 (unless (cdr (assq 'inhibit-switch-frame alist))
6675 (window--maybe-raise-frame frame))))
6676 ))
6677
6678 (defun display-buffer-same-window (buffer alist)
6679 "Display BUFFER in the selected window.
6680 This fails if ALIST has a non-nil `inhibit-same-window' entry, or
6681 if the selected window is a minibuffer window or is dedicated to
6682 another buffer; in that case, return nil. Otherwise, return the
6683 selected window."
6684 (unless (or (cdr (assq 'inhibit-same-window alist))
6685 (window-minibuffer-p)
6686 (window-dedicated-p))
6687 (window--display-buffer buffer (selected-window) 'reuse alist)))
6688
6689 (defun display-buffer--maybe-same-window (buffer alist)
6690 "Conditionally display BUFFER in the selected window.
6691 If `same-window-p' returns non-nil for BUFFER's name, call
6692 `display-buffer-same-window' and return its value. Otherwise,
6693 return nil."
6694 (and (same-window-p (buffer-name buffer))
6695 (display-buffer-same-window buffer alist)))
6696
6697 (defun display-buffer-reuse-window (buffer alist)
6698 "Return a window that is already displaying BUFFER.
6699 Return nil if no usable window is found.
6700
6701 If ALIST has a non-nil `inhibit-same-window' entry, the selected
6702 window is not eligible for reuse.
6703
6704 If ALIST contains a `reusable-frames' entry, its value determines
6705 which frames to search for a reusable window:
6706 nil -- the selected frame (actually the last non-minibuffer frame)
6707 A frame -- just that frame
6708 `visible' -- all visible frames
6709 0 -- all frames on the current terminal
6710 t -- all frames.
6711
6712 If ALIST contains no `reusable-frames' entry, search just the
6713 selected frame if `display-buffer-reuse-frames' and
6714 `pop-up-frames' are both nil; search all frames on the current
6715 terminal if either of those variables is non-nil.
6716
6717 If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
6718 event that a window on another frame is chosen, avoid raising
6719 that frame."
6720 (let* ((alist-entry (assq 'reusable-frames alist))
6721 (frames (cond (alist-entry (cdr alist-entry))
6722 ((if (eq pop-up-frames 'graphic-only)
6723 (display-graphic-p)
6724 pop-up-frames)
6725 0)
6726 (display-buffer-reuse-frames 0)
6727 (t (last-nonminibuffer-frame))))
6728 (window (if (and (eq buffer (window-buffer))
6729 (not (cdr (assq 'inhibit-same-window alist))))
6730 (selected-window)
6731 (car (delq (selected-window)
6732 (get-buffer-window-list buffer 'nomini
6733 frames))))))
6734 (when (window-live-p window)
6735 (prog1 (window--display-buffer buffer window 'reuse alist)
6736 (unless (cdr (assq 'inhibit-switch-frame alist))
6737 (window--maybe-raise-frame (window-frame window)))))))
6738
6739 (defun display-buffer-reuse-mode-window (buffer alist)
6740 "Return a window based on the mode of the buffer it displays.
6741 Display BUFFER in the returned window. Return nil if no usable
6742 window is found.
6743
6744 If ALIST contains a `mode' entry, its value is a major mode (a
6745 symbol) or a list of modes. A window is a candidate if it
6746 displays a buffer that derives from one of the given modes. When
6747 ALIST contains no `mode' entry, the current major mode of BUFFER
6748 is used.
6749
6750 The behaviour is also controlled by entries for
6751 `inhibit-same-window', `reusable-frames' and
6752 `inhibit-switch-frame' as is done in the function
6753 `display-buffer-reuse-window'."
6754 (let* ((alist-entry (assq 'reusable-frames alist))
6755 (alist-mode-entry (assq 'mode alist))
6756 (frames (cond (alist-entry (cdr alist-entry))
6757 ((if (eq pop-up-frames 'graphic-only)
6758 (display-graphic-p)
6759 pop-up-frames)
6760 0)
6761 (display-buffer-reuse-frames 0)
6762 (t (last-nonminibuffer-frame))))
6763 (inhibit-same-window-p (cdr (assq 'inhibit-same-window alist)))
6764 (windows (window-list-1 nil 'nomini frames))
6765 (buffer-mode (with-current-buffer buffer major-mode))
6766 (allowed-modes (if alist-mode-entry
6767 (cdr alist-mode-entry)
6768 buffer-mode))
6769 (curwin (selected-window))
6770 (curframe (selected-frame)))
6771 (unless (listp allowed-modes)
6772 (setq allowed-modes (list allowed-modes)))
6773 (let (same-mode-same-frame
6774 same-mode-other-frame
6775 derived-mode-same-frame
6776 derived-mode-other-frame)
6777 (dolist (window windows)
6778 (let (mode? frame?)
6779 (with-current-buffer (window-buffer window)
6780 (setq mode?
6781 (cond ((memq major-mode allowed-modes)
6782 'same)
6783 ((derived-mode-p allowed-modes)
6784 'derived))))
6785 (when (and mode?
6786 (not (and inhibit-same-window-p
6787 (eq window curwin))))
6788 (if (eq curframe (window-frame window))
6789 (if (eq mode? 'same)
6790 (push window same-mode-same-frame)
6791 (push window derived-mode-same-frame))
6792 (if (eq mode? 'same)
6793 (push window same-mode-other-frame)
6794 (push window derived-mode-other-frame))))))
6795 (let ((window (car (nconc same-mode-same-frame
6796 same-mode-other-frame
6797 derived-mode-same-frame
6798 derived-mode-other-frame))))
6799 (when (window-live-p window)
6800 (prog1 (window--display-buffer buffer window 'reuse alist)
6801 (unless (cdr (assq 'inhibit-switch-frame alist))
6802 (window--maybe-raise-frame (window-frame window)))))))))
6803
6804 (defun display-buffer--special-action (buffer)
6805 "Return special display action for BUFFER, if any.
6806 If `special-display-p' returns non-nil for BUFFER, return an
6807 appropriate display action involving `special-display-function'.
6808 See `display-buffer' for the format of display actions."
6809 (and special-display-function
6810 ;; `special-display-p' returns either t or a list of frame
6811 ;; parameters to pass to `special-display-function'.
6812 (let ((pars (special-display-p (buffer-name buffer))))
6813 (when pars
6814 (list (list #'display-buffer-reuse-window
6815 `(lambda (buffer _alist)
6816 (funcall special-display-function
6817 buffer ',(if (listp pars) pars)))))))))
6818
6819 (defun display-buffer-pop-up-frame (buffer alist)
6820 "Display BUFFER in a new frame.
6821 This works by calling `pop-up-frame-function'. If successful,
6822 return the window used; otherwise return nil.
6823
6824 If ALIST has a non-nil `inhibit-switch-frame' entry, avoid
6825 raising the new frame.
6826
6827 If ALIST has a non-nil `pop-up-frame-parameters' entry, the
6828 corresponding value is an alist of frame parameters to give the
6829 new frame."
6830 (let* ((params (cdr (assq 'pop-up-frame-parameters alist)))
6831 (pop-up-frame-alist (append params pop-up-frame-alist))
6832 (fun pop-up-frame-function)
6833 frame window)
6834 (when (and fun
6835 ;; Make BUFFER current so `make-frame' will use it as the
6836 ;; new frame's buffer (Bug#15133).
6837 (with-current-buffer buffer
6838 (setq frame (funcall fun)))
6839 (setq window (frame-selected-window frame)))
6840 (prog1 (window--display-buffer
6841 buffer window 'frame alist display-buffer-mark-dedicated)
6842 (unless (cdr (assq 'inhibit-switch-frame alist))
6843 (window--maybe-raise-frame frame))))))
6844
6845 (defun display-buffer-pop-up-window (buffer alist)
6846 "Display BUFFER by popping up a new window.
6847 The new window is created on the selected frame, or in
6848 `last-nonminibuffer-frame' if no windows can be created there.
6849 If successful, return the new window; otherwise return nil.
6850
6851 If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
6852 event that the new window is created on another frame, avoid
6853 raising the frame."
6854 (let ((frame (or (window--frame-usable-p (selected-frame))
6855 (window--frame-usable-p (last-nonminibuffer-frame))))
6856 window)
6857 (when (and (or (not (frame-parameter frame 'unsplittable))
6858 ;; If the selected frame cannot be split, look at
6859 ;; `last-nonminibuffer-frame'.
6860 (and (eq frame (selected-frame))
6861 (setq frame (last-nonminibuffer-frame))
6862 (window--frame-usable-p frame)
6863 (not (frame-parameter frame 'unsplittable))))
6864 ;; Attempt to split largest or least recently used window.
6865 (setq window (or (window--try-to-split-window
6866 (get-largest-window frame t) alist)
6867 (window--try-to-split-window
6868 (get-lru-window frame t) alist))))
6869 (prog1 (window--display-buffer
6870 buffer window 'window alist display-buffer-mark-dedicated)
6871 (unless (cdr (assq 'inhibit-switch-frame alist))
6872 (window--maybe-raise-frame (window-frame window)))))))
6873
6874 (defun display-buffer--maybe-pop-up-frame-or-window (buffer alist)
6875 "Try displaying BUFFER based on `pop-up-frames' or `pop-up-windows'.
6876
6877 If `pop-up-frames' is non-nil (and not `graphic-only' on a
6878 text-only terminal), try with `display-buffer-pop-up-frame'.
6879
6880 If that cannot be done, and `pop-up-windows' is non-nil, try
6881 again with `display-buffer-pop-up-window'."
6882 (or (and (if (eq pop-up-frames 'graphic-only)
6883 (display-graphic-p)
6884 pop-up-frames)
6885 (display-buffer-pop-up-frame buffer alist))
6886 (and pop-up-windows
6887 (display-buffer-pop-up-window buffer alist))))
6888
6889 (defun display-buffer-below-selected (buffer alist)
6890 "Try displaying BUFFER in a window below the selected window.
6891 This either splits the selected window or reuses the window below
6892 the selected one."
6893 (let (window)
6894 (or (and (setq window (window-in-direction 'below))
6895 (eq buffer (window-buffer window))
6896 (window--display-buffer buffer window 'reuse alist))
6897 (and (not (frame-parameter nil 'unsplittable))
6898 (let ((split-height-threshold 0)
6899 split-width-threshold)
6900 (setq window (window--try-to-split-window (selected-window) alist)))
6901 (window--display-buffer
6902 buffer window 'window alist display-buffer-mark-dedicated))
6903 (and (setq window (window-in-direction 'below))
6904 (not (window-dedicated-p window))
6905 (window--display-buffer
6906 buffer window 'reuse alist display-buffer-mark-dedicated)))))
6907
6908 (defun display-buffer-at-bottom (buffer alist)
6909 "Try displaying BUFFER in a window at the bottom of the selected frame.
6910 This either reuses such a window provided it shows BUFFER
6911 already, splits a window at the bottom of the frame or the
6912 frame's root window, or reuses some window at the bottom of the
6913 selected frame."
6914 (let (bottom-window bottom-window-shows-buffer window)
6915 (walk-window-tree
6916 (lambda (window)
6917 (cond
6918 ((window-in-direction 'below window))
6919 ((and (not bottom-window-shows-buffer)
6920 (eq buffer (window-buffer window)))
6921 (setq bottom-window-shows-buffer t)
6922 (setq bottom-window window))
6923 ((not bottom-window)
6924 (setq bottom-window window)))
6925 nil nil 'nomini))
6926 (or (and bottom-window-shows-buffer
6927 (window--display-buffer
6928 buffer bottom-window 'reuse alist display-buffer-mark-dedicated))
6929 (and (not (frame-parameter nil 'unsplittable))
6930 (let (split-width-threshold)
6931 (setq window (window--try-to-split-window bottom-window alist)))
6932 (window--display-buffer
6933 buffer window 'window alist display-buffer-mark-dedicated))
6934 (and (not (frame-parameter nil 'unsplittable))
6935 (setq window
6936 (condition-case nil
6937 (split-window (window--major-non-side-window))
6938 (error nil)))
6939 (window--display-buffer
6940 buffer window 'window alist display-buffer-mark-dedicated))
6941 (and (setq window bottom-window)
6942 (not (window-dedicated-p window))
6943 (window--display-buffer
6944 buffer window 'reuse alist display-buffer-mark-dedicated)))))
6945
6946 (defun display-buffer-in-previous-window (buffer alist)
6947 "Display BUFFER in a window previously showing it.
6948 If ALIST has a non-nil `inhibit-same-window' entry, the selected
6949 window is not eligible for reuse.
6950
6951 If ALIST contains a `reusable-frames' entry, its value determines
6952 which frames to search for a reusable window:
6953 nil -- the selected frame (actually the last non-minibuffer frame)
6954 A frame -- just that frame
6955 `visible' -- all visible frames
6956 0 -- all frames on the current terminal
6957 t -- all frames.
6958
6959 If ALIST contains no `reusable-frames' entry, search just the
6960 selected frame if `display-buffer-reuse-frames' and
6961 `pop-up-frames' are both nil; search all frames on the current
6962 terminal if either of those variables is non-nil.
6963
6964 If ALIST has a `previous-window' entry, the window specified by
6965 that entry will override any other window found by the methods
6966 above, even if that window never showed BUFFER before."
6967 (let* ((alist-entry (assq 'reusable-frames alist))
6968 (inhibit-same-window
6969 (cdr (assq 'inhibit-same-window alist)))
6970 (frames (cond
6971 (alist-entry (cdr alist-entry))
6972 ((if (eq pop-up-frames 'graphic-only)
6973 (display-graphic-p)
6974 pop-up-frames)
6975 0)
6976 (display-buffer-reuse-frames 0)
6977 (t (last-nonminibuffer-frame))))
6978 best-window second-best-window window)
6979 ;; Scan windows whether they have shown the buffer recently.
6980 (catch 'best
6981 (dolist (window (window-list-1 (frame-first-window) 'nomini frames))
6982 (when (and (assq buffer (window-prev-buffers window))
6983 (not (window-dedicated-p window)))
6984 (if (eq window (selected-window))
6985 (unless inhibit-same-window
6986 (setq second-best-window window))
6987 (setq best-window window)
6988 (throw 'best t)))))
6989 ;; When ALIST has a `previous-window' entry, that entry may override
6990 ;; anything we found so far.
6991 (when (and (setq window (cdr (assq 'previous-window alist)))
6992 (window-live-p window)
6993 (not (window-dedicated-p window)))
6994 (if (eq window (selected-window))
6995 (unless inhibit-same-window
6996 (setq second-best-window window))
6997 (setq best-window window)))
6998 ;; Return best or second best window found.
6999 (when (setq window (or best-window second-best-window))
7000 (window--display-buffer buffer window 'reuse alist))))
7001
7002 (defun display-buffer-use-some-window (buffer alist)
7003 "Display BUFFER in an existing window.
7004 Search for a usable window, set that window to the buffer, and
7005 return the window. If no suitable window is found, return nil.
7006
7007 If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
7008 event that a window in another frame is chosen, avoid raising
7009 that frame."
7010 (let* ((not-this-window (cdr (assq 'inhibit-same-window alist)))
7011 (frame (or (window--frame-usable-p (selected-frame))
7012 (window--frame-usable-p (last-nonminibuffer-frame))))
7013 (window
7014 ;; Reuse an existing window.
7015 (or (get-lru-window frame nil not-this-window)
7016 (let ((window (get-buffer-window buffer 'visible)))
7017 (unless (and not-this-window
7018 (eq window (selected-window)))
7019 window))
7020 (get-largest-window 'visible nil not-this-window)
7021 (let ((window (get-buffer-window buffer 0)))
7022 (unless (and not-this-window
7023 (eq window (selected-window)))
7024 window))
7025 (get-largest-window 0 nil not-this-window)))
7026 (quit-restore (and (window-live-p window)
7027 (window-parameter window 'quit-restore)))
7028 (quad (nth 1 quit-restore)))
7029 (when (window-live-p window)
7030 ;; If the window was used by `display-buffer' before, try to
7031 ;; resize it to its old height but don't signal an error.
7032 (when (and (listp quad)
7033 (integerp (nth 3 quad))
7034 (> (nth 3 quad) (window-total-height window)))
7035 (condition-case nil
7036 (window-resize window (- (nth 3 quad) (window-total-height window)))
7037 (error nil)))
7038
7039 (prog1
7040 (window--display-buffer buffer window 'reuse alist)
7041 (window--even-window-sizes window)
7042 (unless (cdr (assq 'inhibit-switch-frame alist))
7043 (window--maybe-raise-frame (window-frame window)))))))
7044
7045 (defun display-buffer-no-window (_buffer alist)
7046 "Display BUFFER in no window.
7047 If ALIST has a non-nil `allow-no-window' entry, then don't display
7048 a window at all. This makes possible to override the default action
7049 and avoid displaying the buffer. It is assumed that when the caller
7050 specifies a non-nil `allow-no-window' then it can handle a nil value
7051 returned from `display-buffer' in this case."
7052 (when (cdr (assq 'allow-no-window alist))
7053 'fail))
7054
7055 ;;; Display + selection commands:
7056 (defun pop-to-buffer (buffer &optional action norecord)
7057 "Select buffer BUFFER in some window, preferably a different one.
7058 BUFFER may be a buffer, a string (a buffer name), or nil. If it
7059 is a string not naming an existent buffer, create a buffer with
7060 that name. If BUFFER is nil, choose some other buffer. Return
7061 the buffer.
7062
7063 This uses `display-buffer' as a subroutine. The optional ACTION
7064 argument is passed to `display-buffer' as its ACTION argument.
7065 See `display-buffer' for more information. ACTION is t if called
7066 interactively with a prefix argument, which means to pop to a
7067 window other than the selected one even if the buffer is already
7068 displayed in the selected window.
7069
7070 If the window to show BUFFER is not on the selected
7071 frame, raise that window's frame and give it input focus.
7072
7073 Optional third arg NORECORD non-nil means do not put this buffer
7074 at the front of the list of recently selected ones."
7075 (interactive (list (read-buffer "Pop to buffer: " (other-buffer))
7076 (if current-prefix-arg t)))
7077 (setq buffer (window-normalize-buffer-to-switch-to buffer))
7078 ;; This should be done by `select-window' below.
7079 ;; (set-buffer buffer)
7080 (let* ((old-frame (selected-frame))
7081 (window (display-buffer buffer action))
7082 (frame (window-frame window)))
7083 ;; If we chose another frame, make sure it gets input focus.
7084 (unless (eq frame old-frame)
7085 (select-frame-set-input-focus frame norecord))
7086 ;; Make sure new window is selected (Bug#8615), (Bug#6954).
7087 (select-window window norecord)
7088 buffer))
7089
7090 (defun pop-to-buffer-same-window (buffer &optional norecord)
7091 "Select buffer BUFFER in some window, preferably the same one.
7092 BUFFER may be a buffer, a string (a buffer name), or nil. If it
7093 is a string not naming an existent buffer, create a buffer with
7094 that name. If BUFFER is nil, choose some other buffer. Return
7095 the buffer.
7096
7097 Optional argument NORECORD, if non-nil means do not put this
7098 buffer at the front of the list of recently selected ones.
7099
7100 Unlike `pop-to-buffer', this function prefers using the selected
7101 window over popping up a new window or frame."
7102 (pop-to-buffer buffer display-buffer--same-window-action norecord))
7103
7104 (defun read-buffer-to-switch (prompt)
7105 "Read the name of a buffer to switch to, prompting with PROMPT.
7106 Return the name of the buffer as a string.
7107
7108 This function is intended for the `switch-to-buffer' family of
7109 commands since these need to omit the name of the current buffer
7110 from the list of completions and default values."
7111 (let ((rbts-completion-table (internal-complete-buffer-except)))
7112 (minibuffer-with-setup-hook
7113 (lambda ()
7114 (setq minibuffer-completion-table rbts-completion-table)
7115 ;; Since rbts-completion-table is built dynamically, we
7116 ;; can't just add it to the default value of
7117 ;; icomplete-with-completion-tables, so we add it
7118 ;; here manually.
7119 (if (and (boundp 'icomplete-with-completion-tables)
7120 (listp icomplete-with-completion-tables))
7121 (set (make-local-variable 'icomplete-with-completion-tables)
7122 (cons rbts-completion-table
7123 icomplete-with-completion-tables))))
7124 (read-buffer prompt (other-buffer (current-buffer))
7125 (confirm-nonexistent-file-or-buffer)))))
7126
7127 (defun window-normalize-buffer-to-switch-to (buffer-or-name)
7128 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
7129 If BUFFER-OR-NAME is nil, return the buffer returned by
7130 `other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
7131 exists, return that buffer. If no such buffer exists, create a
7132 buffer with the name BUFFER-OR-NAME and return that buffer."
7133 (if buffer-or-name
7134 (or (get-buffer buffer-or-name)
7135 (let ((buffer (get-buffer-create buffer-or-name)))
7136 (set-buffer-major-mode buffer)
7137 buffer))
7138 (other-buffer)))
7139
7140 (defcustom switch-to-buffer-preserve-window-point nil
7141 "If non-nil, `switch-to-buffer' tries to preserve `window-point'.
7142 If this is nil, `switch-to-buffer' displays the buffer at that
7143 buffer's `point'. If this is `already-displayed', it tries to
7144 display the buffer at its previous position in the selected
7145 window, provided the buffer is currently displayed in some other
7146 window on any visible or iconified frame. If this is t, it
7147 unconditionally tries to display the buffer at its previous
7148 position in the selected window.
7149
7150 This variable is ignored if the buffer is already displayed in
7151 the selected window or never appeared in it before, or if
7152 `switch-to-buffer' calls `pop-to-buffer' to display the buffer."
7153 :type '(choice
7154 (const :tag "Never" nil)
7155 (const :tag "If already displayed elsewhere" already-displayed)
7156 (const :tag "Always" t))
7157 :group 'windows
7158 :version "24.3")
7159
7160 (defcustom switch-to-buffer-in-dedicated-window nil
7161 "Allow switching to buffer in strongly dedicated windows.
7162 If non-nil, allow `switch-to-buffer' to proceed when called
7163 interactively and the selected window is strongly dedicated to
7164 its buffer.
7165
7166 The following values are recognized:
7167
7168 nil - disallow switching; signal an error
7169
7170 prompt - prompt user whether to allow switching
7171
7172 pop - perform `pop-to-buffer' instead
7173
7174 t - undedicate selected window and switch
7175
7176 When called non-interactively, `switch-to-buffer' always signals
7177 an error when the selected window is dedicated to its buffer and
7178 FORCE-SAME-WINDOW is non-nil."
7179 :type '(choice
7180 (const :tag "Disallow" nil)
7181 (const :tag "Prompt" prompt)
7182 (const :tag "Pop" pop)
7183 (const :tag "Allow" t))
7184 :group 'windows
7185 :version "25.1")
7186
7187 (defun switch-to-buffer (buffer-or-name &optional norecord force-same-window)
7188 "Display buffer BUFFER-OR-NAME in the selected window.
7189
7190 WARNING: This is NOT the way to work on another buffer temporarily
7191 within a Lisp program! Use `set-buffer' instead. That avoids
7192 messing with the window-buffer correspondences.
7193
7194 If the selected window cannot display the specified buffer
7195 because it is a minibuffer window or strongly dedicated to
7196 another buffer, call `pop-to-buffer' to select the buffer in
7197 another window. In interactive use, if the selected window is
7198 strongly dedicated to its buffer, the value of the option
7199 `switch-to-buffer-in-dedicated-window' specifies how to proceed.
7200
7201 If called interactively, read the buffer name using the
7202 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
7203 determines whether to request confirmation before creating a new
7204 buffer.
7205
7206 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or nil.
7207 If BUFFER-OR-NAME is a string that does not identify an existing
7208 buffer, create a buffer with that name. If BUFFER-OR-NAME is
7209 nil, switch to the buffer returned by `other-buffer'.
7210
7211 If optional argument NORECORD is non-nil, do not put the buffer
7212 at the front of the buffer list, and do not make the window
7213 displaying it the most recently selected one.
7214
7215 If optional argument FORCE-SAME-WINDOW is non-nil, the buffer
7216 must be displayed in the selected window when called
7217 non-interactively; if that is impossible, signal an error rather
7218 than calling `pop-to-buffer'.
7219
7220 The option `switch-to-buffer-preserve-window-point' can be used
7221 to make the buffer appear at its last position in the selected
7222 window.
7223
7224 Return the buffer switched to."
7225 (interactive
7226 (let ((force-same-window
7227 (cond
7228 ((window-minibuffer-p) nil)
7229 ((not (eq (window-dedicated-p) t)) 'force-same-window)
7230 ((pcase switch-to-buffer-in-dedicated-window
7231 (`nil (user-error
7232 "Cannot switch buffers in a dedicated window"))
7233 (`prompt
7234 (if (y-or-n-p
7235 (format "Window is dedicated to %s; undedicate it"
7236 (window-buffer)))
7237 (progn
7238 (set-window-dedicated-p nil nil)
7239 'force-same-window)
7240 (user-error
7241 "Cannot switch buffers in a dedicated window")))
7242 (`pop nil)
7243 (_ (set-window-dedicated-p nil nil) 'force-same-window))))))
7244 (list (read-buffer-to-switch "Switch to buffer: ") nil force-same-window)))
7245 (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name)))
7246 (cond
7247 ;; Don't call set-window-buffer if it's not needed since it
7248 ;; might signal an error (e.g. if the window is dedicated).
7249 ((eq buffer (window-buffer)))
7250 ((window-minibuffer-p)
7251 (if force-same-window
7252 (user-error "Cannot switch buffers in minibuffer window")
7253 (pop-to-buffer buffer norecord)))
7254 ((eq (window-dedicated-p) t)
7255 (if force-same-window
7256 (user-error "Cannot switch buffers in a dedicated window")
7257 (pop-to-buffer buffer norecord)))
7258 (t
7259 (let* ((entry (assq buffer (window-prev-buffers)))
7260 (displayed (and (eq switch-to-buffer-preserve-window-point
7261 'already-displayed)
7262 (get-buffer-window buffer 0))))
7263 (set-window-buffer nil buffer)
7264 (when (and entry
7265 (or (eq switch-to-buffer-preserve-window-point t)
7266 displayed))
7267 ;; Try to restore start and point of buffer in the selected
7268 ;; window (Bug#4041).
7269 (set-window-start (selected-window) (nth 1 entry) t)
7270 (set-window-point nil (nth 2 entry))))))
7271
7272 (unless norecord
7273 (select-window (selected-window)))
7274 (set-buffer buffer)))
7275
7276 (defun switch-to-buffer-other-window (buffer-or-name &optional norecord)
7277 "Select the buffer specified by BUFFER-OR-NAME in another window.
7278 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
7279 nil. Return the buffer switched to.
7280
7281 If called interactively, prompt for the buffer name using the
7282 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
7283 determines whether to request confirmation before creating a new
7284 buffer.
7285
7286 If BUFFER-OR-NAME is a string and does not identify an existing
7287 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
7288 nil, switch to the buffer returned by `other-buffer'.
7289
7290 Optional second argument NORECORD non-nil means do not put this
7291 buffer at the front of the list of recently selected ones.
7292
7293 This uses the function `display-buffer' as a subroutine; see its
7294 documentation for additional customization information."
7295 (interactive
7296 (list (read-buffer-to-switch "Switch to buffer in other window: ")))
7297 (let ((pop-up-windows t))
7298 (pop-to-buffer buffer-or-name t norecord)))
7299
7300 (defun switch-to-buffer-other-frame (buffer-or-name &optional norecord)
7301 "Switch to buffer BUFFER-OR-NAME in another frame.
7302 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
7303 nil. Return the buffer switched to.
7304
7305 If called interactively, prompt for the buffer name using the
7306 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
7307 determines whether to request confirmation before creating a new
7308 buffer.
7309
7310 If BUFFER-OR-NAME is a string and does not identify an existing
7311 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
7312 nil, switch to the buffer returned by `other-buffer'.
7313
7314 Optional second arg NORECORD non-nil means do not put this
7315 buffer at the front of the list of recently selected ones.
7316
7317 This uses the function `display-buffer' as a subroutine; see its
7318 documentation for additional customization information."
7319 (interactive
7320 (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
7321 (pop-to-buffer buffer-or-name display-buffer--other-frame-action norecord))
7322 \f
7323 (defun set-window-text-height (window height)
7324 "Set the height in lines of the text display area of WINDOW to HEIGHT.
7325 WINDOW must be a live window and defaults to the selected one.
7326 HEIGHT doesn't include the mode line or header line, if any, or
7327 any partial-height lines in the text display area.
7328
7329 Note that the current implementation of this function cannot
7330 always set the height exactly, but attempts to be conservative,
7331 by allocating more lines than are actually needed in the case
7332 where some error may be present."
7333 (setq window (window-normalize-window window t))
7334 (let ((delta (- height (window-text-height window))))
7335 (unless (zerop delta)
7336 ;; Setting window-min-height to a value like 1 can lead to very
7337 ;; bizarre displays because it also allows Emacs to make *other*
7338 ;; windows one line tall, which means that there's no more space
7339 ;; for the mode line.
7340 (let ((window-min-height (min 2 height)))
7341 (window-resize window delta)))))
7342
7343 (defun enlarge-window-horizontally (delta)
7344 "Make selected window DELTA columns wider.
7345 Interactively, if no argument is given, make selected window one
7346 column wider."
7347 (interactive "p")
7348 (enlarge-window delta t))
7349
7350 (defun shrink-window-horizontally (delta)
7351 "Make selected window DELTA columns narrower.
7352 Interactively, if no argument is given, make selected window one
7353 column narrower."
7354 (interactive "p")
7355 (shrink-window delta t))
7356
7357 (defun count-screen-lines (&optional beg end count-final-newline window)
7358 "Return the number of screen lines in the region.
7359 The number of screen lines may be different from the number of actual lines,
7360 due to line breaking, display table, etc.
7361
7362 Optional arguments BEG and END default to `point-min' and `point-max'
7363 respectively.
7364
7365 If region ends with a newline, ignore it unless optional third argument
7366 COUNT-FINAL-NEWLINE is non-nil.
7367
7368 The optional fourth argument WINDOW specifies the window used for obtaining
7369 parameters such as width, horizontal scrolling, and so on. The default is
7370 to use the selected window's parameters.
7371
7372 Like `vertical-motion', `count-screen-lines' always uses the current buffer,
7373 regardless of which buffer is displayed in WINDOW. This makes possible to use
7374 `count-screen-lines' in any buffer, whether or not it is currently displayed
7375 in some window."
7376 (unless beg
7377 (setq beg (point-min)))
7378 (unless end
7379 (setq end (point-max)))
7380 (if (= beg end)
7381 0
7382 (save-excursion
7383 (save-restriction
7384 (widen)
7385 (narrow-to-region (min beg end)
7386 (if (and (not count-final-newline)
7387 (= ?\n (char-before (max beg end))))
7388 (1- (max beg end))
7389 (max beg end)))
7390 (goto-char (point-min))
7391 (1+ (vertical-motion (buffer-size) window))))))
7392
7393 (defun window-buffer-height (window)
7394 "Return the height (in screen lines) of the buffer that WINDOW is displaying.
7395 WINDOW must be a live window and defaults to the selected one."
7396 (setq window (window-normalize-window window t))
7397 (with-current-buffer (window-buffer window)
7398 (max 1
7399 (count-screen-lines (point-min) (point-max)
7400 ;; If buffer ends with a newline, ignore it when
7401 ;; counting height unless point is after it.
7402 (eobp)
7403 window))))
7404
7405 ;;; Resizing windows and frames to fit their contents exactly.
7406 (defcustom fit-window-to-buffer-horizontally nil
7407 "Non-nil means `fit-window-to-buffer' can resize windows horizontally.
7408 If this is nil, `fit-window-to-buffer' never resizes windows
7409 horizontally. If this is `only', it can resize windows
7410 horizontally only. Any other value means `fit-window-to-buffer'
7411 can resize windows in both dimensions."
7412 :type 'boolean
7413 :version "24.4"
7414 :group 'help)
7415
7416 ;; `fit-frame-to-buffer' eventually wants to know the real frame sizes
7417 ;; counting title bar and outer borders.
7418 (defcustom fit-frame-to-buffer nil
7419 "Non-nil means `fit-window-to-buffer' can fit a frame to its buffer.
7420 A frame is fit if and only if its root window is a live window
7421 and this option is non-nil. If this is `horizontally', frames
7422 are resized horizontally only. If this is `vertically', frames
7423 are resized vertically only. Any other non-nil value means
7424 frames can be resized in both dimensions."
7425 :type 'boolean
7426 :version "24.4"
7427 :group 'help)
7428
7429 (defcustom fit-frame-to-buffer-margins '(nil nil nil nil)
7430 "Margins around frame for `fit-frame-to-buffer'.
7431 This specifies the numbers of pixels to be left free on the left,
7432 above, on the right, and below a frame fitted to its buffer. Set
7433 this to avoid obscuring other desktop objects like the taskbar.
7434 The default is nil for each side, which means to not add margins.
7435
7436 The value specified here can be overridden for a specific frame
7437 by that frame's `fit-frame-to-buffer-margins' parameter, if
7438 present. See also `fit-frame-to-buffer-sizes'."
7439 :version "24.4"
7440 :type '(list
7441 (choice
7442 :tag "Left"
7443 :value nil
7444 :format "%[LeftMargin%] %v "
7445 (const :tag "None" :format "%t" nil)
7446 (integer :tag "Pixels" :size 5))
7447 (choice
7448 :tag "Top"
7449 :value nil
7450 :format "%[TopMargin%] %v "
7451 (const :tag "None" :format "%t" nil)
7452 (integer :tag "Pixels" :size 5))
7453 (choice
7454 :tag "Right"
7455 :value nil
7456 :format "%[RightMargin%] %v "
7457 (const :tag "None" :format "%t" nil)
7458 (integer :tag "Pixels" :size 5))
7459 (choice
7460 :tag "Bottom"
7461 :value nil
7462 :format "%[BottomMargin%] %v "
7463 (const :tag "None" :format "%t" nil)
7464 (integer :tag "Pixels" :size 5)))
7465 :group 'help)
7466
7467 (defcustom fit-frame-to-buffer-sizes '(nil nil nil nil)
7468 "Size boundaries of frame for `fit-frame-to-buffer'.
7469 This list specifies the total maximum and minimum lines and
7470 maximum and minimum columns of the root window of any frame that
7471 shall be fit to its buffer. If any of these values is non-nil,
7472 it overrides the corresponding argument of `fit-frame-to-buffer'.
7473
7474 On window systems where the menubar can wrap, fitting a frame to
7475 its buffer may swallow the last line(s). Specifying an
7476 appropriate minimum width value here can avoid such wrapping.
7477
7478 See also `fit-frame-to-buffer-margins'."
7479 :version "24.4"
7480 :type '(list
7481 (choice
7482 :tag "Maximum Height"
7483 :value nil
7484 :format "%[MaxHeight%] %v "
7485 (const :tag "None" :format "%t" nil)
7486 (integer :tag "Lines" :size 5))
7487 (choice
7488 :tag "Minimum Height"
7489 :value nil
7490 :format "%[MinHeight%] %v "
7491 (const :tag "None" :format "%t" nil)
7492 (integer :tag "Lines" :size 5))
7493 (choice
7494 :tag "Maximum Width"
7495 :value nil
7496 :format "%[MaxWidth%] %v "
7497 (const :tag "None" :format "%t" nil)
7498 (integer :tag "Columns" :size 5))
7499 (choice
7500 :tag "Minimum Width"
7501 :value nil
7502 :format "%[MinWidth%] %v\n"
7503 (const :tag "None" :format "%t" nil)
7504 (integer :tag "Columns" :size 5)))
7505 :group 'help)
7506
7507 (declare-function x-display-pixel-height "xfns.c" (&optional terminal))
7508
7509 (defun window--sanitize-margin (margin left right)
7510 "Return MARGIN if it's a number between LEFT and RIGHT."
7511 (when (and (numberp margin)
7512 (<= left (- right margin)) (<= margin right))
7513 margin))
7514
7515 (declare-function tool-bar-height "xdisp.c" (&optional frame pixelwise))
7516
7517 (defun fit-frame-to-buffer (&optional frame max-height min-height max-width min-width only)
7518 "Adjust size of FRAME to display the contents of its buffer exactly.
7519 FRAME can be any live frame and defaults to the selected one.
7520 Fit only if FRAME's root window is live. MAX-HEIGHT, MIN-HEIGHT,
7521 MAX-WIDTH and MIN-WIDTH specify bounds on the new total size of
7522 FRAME's root window. MIN-HEIGHT and MIN-WIDTH default to the values of
7523 `window-min-height' and `window-min-width' respectively.
7524
7525 If the optional argument ONLY is `vertically', resize the frame
7526 vertically only. If ONLY is `horizontally', resize the frame
7527 horizontally only.
7528
7529 The new position and size of FRAME can be additionally determined
7530 by customizing the options `fit-frame-to-buffer-sizes' and
7531 `fit-frame-to-buffer-margins' or the corresponding parameters of
7532 FRAME."
7533 (interactive)
7534 (unless (and (fboundp 'x-display-pixel-height)
7535 ;; We need the respective sizes now.
7536 (fboundp 'display-monitor-attributes-list))
7537 (user-error "Cannot resize frame in non-graphic Emacs"))
7538 (setq frame (window-normalize-frame frame))
7539 (when (window-live-p (frame-root-window frame))
7540 (with-selected-window (frame-root-window frame)
7541 (let* ((window (frame-root-window frame))
7542 (char-width (frame-char-width))
7543 (char-height (frame-char-height))
7544 (monitor-attributes (car (display-monitor-attributes-list
7545 (frame-parameter frame 'display))))
7546 (geometry (cdr (assq 'geometry monitor-attributes)))
7547 (display-width (- (nth 2 geometry) (nth 0 geometry)))
7548 (display-height (- (nth 3 geometry) (nth 1 geometry)))
7549 (workarea (cdr (assq 'workarea monitor-attributes)))
7550 ;; Handle margins.
7551 (margins (or (frame-parameter frame 'fit-frame-to-buffer-margins)
7552 fit-frame-to-buffer-margins))
7553 (left-margin (if (nth 0 margins)
7554 (or (window--sanitize-margin
7555 (nth 0 margins) 0 display-width)
7556 0)
7557 (nth 0 workarea)))
7558 (top-margin (if (nth 1 margins)
7559 (or (window--sanitize-margin
7560 (nth 1 margins) 0 display-height)
7561 0)
7562 (nth 1 workarea)))
7563 (workarea-width (nth 2 workarea))
7564 (right-margin (if (nth 2 margins)
7565 (- display-width
7566 (or (window--sanitize-margin
7567 (nth 2 margins) left-margin display-width)
7568 0))
7569 (nth 2 workarea)))
7570 (workarea-height (nth 3 workarea))
7571 (bottom-margin (if (nth 3 margins)
7572 (- display-height
7573 (or (window--sanitize-margin
7574 (nth 3 margins) top-margin display-height)
7575 0))
7576 (nth 3 workarea)))
7577 ;; The pixel width of FRAME (which does not include the
7578 ;; window manager's decorations).
7579 (frame-width (frame-pixel-width))
7580 ;; The pixel width of the body of FRAME's root window.
7581 (window-body-width (window-body-width nil t))
7582 ;; The difference in pixels between total and body width of
7583 ;; FRAME's window.
7584 (window-extra-width (- (window-pixel-width) window-body-width))
7585 ;; The difference in pixels between the frame's pixel width
7586 ;; and the window's body width. This is the space we can't
7587 ;; use for fitting.
7588 (extra-width (- frame-width window-body-width))
7589 ;; The maximum width we can use for fitting.
7590 (fit-width (- workarea-width extra-width))
7591 ;; The pixel position of FRAME's left border. We usually
7592 ;; try to leave this alone.
7593 (left
7594 (let ((left (frame-parameter nil 'left)))
7595 (if (consp left)
7596 (funcall (car left) (cadr left))
7597 left)))
7598 ;; The pixel height of FRAME (which does not include title
7599 ;; line, decorations, and sometimes neither the menu nor
7600 ;; the toolbar).
7601 (frame-height (frame-pixel-height))
7602 ;; The pixel height of FRAME's root window (we don't care
7603 ;; about the window's body height since the return value of
7604 ;; `window-text-pixel-size' includes header and mode line).
7605 (window-height (window-pixel-height))
7606 ;; The difference in pixels between the frame's pixel
7607 ;; height and the window's height.
7608 (extra-height (- frame-height window-height))
7609 ;; When tool-bar-mode is enabled and we just created a new
7610 ;; frame, reserve lines for toolbar resizing. Needed
7611 ;; because for reasons unknown to me Emacs (1) reserves one
7612 ;; line for the toolbar when making the initial frame and
7613 ;; toolbars are enabled, and (2) later adds the remaining
7614 ;; lines needed. Our code runs IN BETWEEN (1) and (2).
7615 ;; YMMV when you're on a system that behaves differently.
7616 (toolbar-extra-height
7617 (let ((quit-restore (window-parameter window 'quit-restore))
7618 ;; This may have to change when we allow arbitrary
7619 ;; pixel height toolbars.
7620 (lines (tool-bar-height)))
7621 (* char-height
7622 (if (and quit-restore (eq (car quit-restore) 'frame)
7623 (not (zerop lines)))
7624 (1- lines)
7625 0))))
7626 ;; The pixel position of FRAME's top border.
7627 (top
7628 (let ((top (frame-parameter nil 'top)))
7629 (if (consp top)
7630 (funcall (car top) (cadr top))
7631 top)))
7632 ;; Sanitize minimum and maximum sizes.
7633 (sizes (or (frame-parameter frame 'fit-frame-to-buffer-sizes)
7634 fit-frame-to-buffer-sizes))
7635 (max-height
7636 (cond
7637 ((numberp (nth 0 sizes)) (* (nth 0 sizes) char-height))
7638 ((numberp max-height) (* max-height char-height))
7639 (t display-height)))
7640 (min-height
7641 (cond
7642 ((numberp (nth 1 sizes)) (* (nth 1 sizes) char-height))
7643 ((numberp min-height) (* min-height char-height))
7644 (t (* window-min-height char-height))))
7645 (max-width
7646 (cond
7647 ((numberp (nth 2 sizes))
7648 (- (* (nth 2 sizes) char-width) window-extra-width))
7649 ((numberp max-width)
7650 (- (* max-width char-width) window-extra-width))
7651 (t display-width)))
7652 (min-width
7653 (cond
7654 ((numberp (nth 3 sizes))
7655 (- (* (nth 3 sizes) char-width) window-extra-width))
7656 ((numberp min-width)
7657 (- (* min-width char-width) window-extra-width))
7658 (t (* window-min-width char-width))))
7659 ;; Note: Currently, for a new frame the sizes of the header
7660 ;; and mode line may be estimated incorrectly
7661 (value (window-text-pixel-size
7662 nil t t workarea-width workarea-height t))
7663 (width (+ (car value) (window-right-divider-width)))
7664 (height
7665 (+ (cdr value)
7666 (window-bottom-divider-width)
7667 (window-scroll-bar-height))))
7668 ;; Don't change height or width when the window's size is fixed
7669 ;; in either direction or ONLY forbids it.
7670 (cond
7671 ((or (eq window-size-fixed 'width) (eq only 'vertically))
7672 (setq width nil))
7673 ((or (eq window-size-fixed 'height) (eq only 'horizontally))
7674 (setq height nil)))
7675 ;; Fit width to constraints.
7676 (when width
7677 (unless frame-resize-pixelwise
7678 ;; Round to character sizes.
7679 (setq width (* (/ (+ width char-width -1) char-width)
7680 char-width)))
7681 ;; Fit to maximum and minimum widths.
7682 (setq width (max (min width max-width) min-width))
7683 ;; Add extra width.
7684 (setq width (+ width extra-width))
7685 ;; Preserve margins.
7686 (let ((right (+ left width)))
7687 (cond
7688 ((> right right-margin)
7689 ;; Move frame to left (we don't know its real width).
7690 (setq left (max left-margin (- left (- right right-margin)))))
7691 ((< left left-margin)
7692 ;; Move frame to right.
7693 (setq left left-margin)))))
7694 ;; Fit height to constraints.
7695 (when height
7696 (unless frame-resize-pixelwise
7697 (setq height (* (/ (+ height char-height -1) char-height)
7698 char-height)))
7699 ;; Fit to maximum and minimum heights.
7700 (setq height (max (min height max-height) min-height))
7701 ;; Add extra height.
7702 (setq height (+ height extra-height))
7703 ;; Preserve margins.
7704 (let ((bottom (+ top height)))
7705 (cond
7706 ((> bottom bottom-margin)
7707 ;; Move frame up (we don't know its real height).
7708 (setq top (max top-margin (- top (- bottom bottom-margin)))))
7709 ((< top top-margin)
7710 ;; Move frame down.
7711 (setq top top-margin)))))
7712 ;; Apply changes.
7713 (set-frame-position frame left top)
7714 ;; Clumsily try to translate our calculations to what
7715 ;; `set-frame-size' wants.
7716 (when width
7717 (setq width (- (+ (frame-text-width) width)
7718 extra-width window-body-width)))
7719 (when height
7720 (setq height (- (+ (frame-text-height) height)
7721 extra-height window-height)))
7722 (set-frame-size
7723 frame
7724 (if width
7725 (if frame-resize-pixelwise
7726 width
7727 (/ width char-width))
7728 (frame-text-width))
7729 (if height
7730 (if frame-resize-pixelwise
7731 height
7732 (/ height char-height))
7733 (frame-text-height))
7734 frame-resize-pixelwise)))))
7735
7736 (defun fit-window-to-buffer (&optional window max-height min-height max-width min-width preserve-size)
7737 "Adjust size of WINDOW to display its buffer's contents exactly.
7738 WINDOW must be a live window and defaults to the selected one.
7739
7740 If WINDOW is part of a vertical combination, adjust WINDOW's
7741 height. The new height is calculated from the actual height of
7742 the accessible portion of its buffer. The optional argument
7743 MAX-HEIGHT specifies a maximum height and defaults to the height
7744 of WINDOW's frame. The optional argument MIN-HEIGHT specifies a
7745 minimum height and defaults to `window-min-height'. Both
7746 MAX-HEIGHT and MIN-HEIGHT are specified in lines and include mode
7747 and header line and a bottom divider, if any.
7748
7749 If WINDOW is part of a horizontal combination and the value of
7750 the option `fit-window-to-buffer-horizontally' is non-nil, adjust
7751 WINDOW's width. The new width of WINDOW is calculated from the
7752 maximum length of its buffer's lines that follow the current
7753 start position of WINDOW. The optional argument MAX-WIDTH
7754 specifies a maximum width and defaults to the width of WINDOW's
7755 frame. The optional argument MIN-WIDTH specifies a minimum width
7756 and defaults to `window-min-width'. Both MAX-WIDTH and MIN-WIDTH
7757 are specified in columns and include fringes, margins, a
7758 scrollbar and a vertical divider, if any.
7759
7760 If the optional argument `preserve-size' is non-nil, preserve the
7761 size of WINDOW (see `window-preserve-size').
7762
7763 Fit pixelwise if the option `window-resize-pixelwise' is non-nil.
7764 If WINDOW is its frame's root window and the option
7765 `fit-frame-to-buffer' is non-nil, call `fit-frame-to-buffer' to
7766 adjust the frame's size.
7767
7768 Note that even if this function makes WINDOW large enough to show
7769 _all_ parts of its buffer you might not see the first part when
7770 WINDOW was scrolled. If WINDOW is resized horizontally, you will
7771 not see the top of its buffer unless WINDOW starts at its minimum
7772 accessible position."
7773 (interactive)
7774 (setq window (window-normalize-window window t))
7775 (if (eq window (frame-root-window window))
7776 (when fit-frame-to-buffer
7777 ;; Fit WINDOW's frame to buffer.
7778 (fit-frame-to-buffer
7779 (window-frame window)
7780 max-height min-height max-width min-width
7781 (and (memq fit-frame-to-buffer '(vertically horizontally))
7782 fit-frame-to-buffer)))
7783 (with-selected-window window
7784 (let* ((pixelwise window-resize-pixelwise)
7785 (char-height (frame-char-height))
7786 (char-width (frame-char-width))
7787 (total-height (window-size window nil pixelwise))
7788 (body-height (window-body-height window pixelwise))
7789 (body-width (window-body-width window pixelwise))
7790 (min-height
7791 ;; Sanitize MIN-HEIGHT.
7792 (if (numberp min-height)
7793 ;; Can't get smaller than `window-safe-min-height'.
7794 (max (if pixelwise
7795 (* char-height min-height)
7796 min-height)
7797 (if pixelwise
7798 (window-safe-min-pixel-height window)
7799 window-safe-min-height))
7800 ;; Preserve header and mode line if present.
7801 (max (if pixelwise
7802 (* char-height window-min-height)
7803 window-min-height)
7804 (window-min-size window nil window pixelwise))))
7805 (max-height
7806 ;; Sanitize MAX-HEIGHT.
7807 (if (numberp max-height)
7808 (min
7809 (+ total-height
7810 (window-max-delta
7811 window nil window nil nil nil pixelwise))
7812 (if pixelwise
7813 (* char-height max-height)
7814 max-height))
7815 (+ total-height (window-max-delta
7816 window nil window nil nil nil pixelwise))))
7817 height)
7818 (cond
7819 ;; If WINDOW is vertically combined, try to resize it
7820 ;; vertically.
7821 ((and (not (eq fit-window-to-buffer-horizontally 'only))
7822 (not (window-size-fixed-p window 'preserved))
7823 (window-combined-p))
7824 ;; Vertically we always want to fit the entire buffer.
7825 ;; WINDOW'S height can't get larger than its frame's pixel
7826 ;; height. Its width remains fixed.
7827 (setq height (+ (cdr (window-text-pixel-size
7828 nil nil t nil (frame-pixel-height) t))
7829 (window-scroll-bar-height window)
7830 (window-bottom-divider-width)))
7831 ;; Round height.
7832 (unless pixelwise
7833 (setq height (/ (+ height char-height -1) char-height)))
7834 (unless (= height total-height)
7835 (window-preserve-size window)
7836 (window-resize-no-error
7837 window
7838 (- (max min-height (min max-height height)) total-height)
7839 nil window pixelwise)
7840 (when preserve-size
7841 (window-preserve-size window nil t))))
7842 ;; If WINDOW is horizontally combined, try to resize it
7843 ;; horizontally.
7844 ((and fit-window-to-buffer-horizontally
7845 (not (window-size-fixed-p window t 'preserved))
7846 (window-combined-p nil t))
7847 (let* ((total-width (window-size window t pixelwise))
7848 (min-width
7849 ;; Sanitize MIN-WIDTH.
7850 (if (numberp min-width)
7851 ;; Can't get smaller than `window-safe-min-width'.
7852 (max (if pixelwise
7853 (* char-width min-width)
7854 min-width)
7855 (if pixelwise
7856 (window-safe-min-pixel-width)
7857 window-safe-min-width))
7858 ;; Preserve fringes, margins, scrollbars if present.
7859 (max (if pixelwise
7860 (* char-width window-min-width)
7861 window-min-width)
7862 (window-min-size nil nil window pixelwise))))
7863 (max-width
7864 ;; Sanitize MAX-WIDTH.
7865 (if (numberp max-width)
7866 (min (+ total-width
7867 (window-max-delta
7868 window t window nil nil nil pixelwise))
7869 (if pixelwise
7870 (* char-width max-width)
7871 max-width))
7872 (+ total-width (window-max-delta
7873 window t window nil nil nil pixelwise))))
7874 ;; When fitting horizontally, assume that WINDOW's
7875 ;; start position remains unaltered. WINDOW can't get
7876 ;; wider than its frame's pixel width, its height
7877 ;; remains unaltered.
7878 (width (+ (car (window-text-pixel-size
7879 nil (window-start) (point-max)
7880 (frame-pixel-width)
7881 ;; Add one char-height to assure that
7882 ;; we're on the safe side. This
7883 ;; overshoots when the first line below
7884 ;; the bottom is wider than the window.
7885 (* body-height
7886 (if pixelwise 1 char-height))))
7887 (window-right-divider-width))))
7888 (unless pixelwise
7889 (setq width (/ (+ width char-width -1) char-width)))
7890 (unless (= width body-width)
7891 (window-preserve-size window t)
7892 (window-resize-no-error
7893 window
7894 (- (max min-width
7895 (min max-width
7896 (+ total-width (- width body-width))))
7897 total-width)
7898 t window pixelwise)
7899 (when preserve-size
7900 (window-preserve-size window t t))))))))))
7901
7902 (defun window-safely-shrinkable-p (&optional window)
7903 "Return t if WINDOW can be shrunk without shrinking other windows.
7904 WINDOW defaults to the selected window."
7905 (with-selected-window (or window (selected-window))
7906 (let ((edges (window-edges)))
7907 (or (= (nth 2 edges) (nth 2 (window-edges (previous-window))))
7908 (= (nth 0 edges) (nth 0 (window-edges (next-window))))))))
7909
7910 (defun shrink-window-if-larger-than-buffer (&optional window)
7911 "Shrink height of WINDOW if its buffer doesn't need so many lines.
7912 More precisely, shrink WINDOW vertically to be as small as
7913 possible, while still showing the full contents of its buffer.
7914 WINDOW must be a live window and defaults to the selected one.
7915
7916 Do not shrink WINDOW to less than `window-min-height' lines. Do
7917 nothing if the buffer contains more lines than the present window
7918 height, or if some of the window's contents are scrolled out of
7919 view, or if shrinking this window would also shrink another
7920 window, or if the window is the only window of its frame.
7921
7922 Return non-nil if the window was shrunk, nil otherwise."
7923 (interactive)
7924 (setq window (window-normalize-window window t))
7925 ;; Make sure that WINDOW is vertically combined and `point-min' is
7926 ;; visible (for whatever reason that's needed). The remaining issues
7927 ;; should be taken care of by `fit-window-to-buffer'.
7928 (when (and (window-combined-p window)
7929 (pos-visible-in-window-p (point-min) window))
7930 (fit-window-to-buffer window (window-total-height window))))
7931 \f
7932 (defun kill-buffer-and-window ()
7933 "Kill the current buffer and delete the selected window."
7934 (interactive)
7935 (let ((window-to-delete (selected-window))
7936 (buffer-to-kill (current-buffer))
7937 (delete-window-hook (lambda () (ignore-errors (delete-window)))))
7938 (unwind-protect
7939 (progn
7940 (add-hook 'kill-buffer-hook delete-window-hook t t)
7941 (if (kill-buffer (current-buffer))
7942 ;; If `delete-window' failed before, we rerun it to regenerate
7943 ;; the error so it can be seen in the echo area.
7944 (when (eq (selected-window) window-to-delete)
7945 (delete-window))))
7946 ;; If the buffer is not dead for some reason (probably because
7947 ;; of a `quit' signal), remove the hook again.
7948 (ignore-errors
7949 (with-current-buffer buffer-to-kill
7950 (remove-hook 'kill-buffer-hook delete-window-hook t))))))
7951
7952 \f
7953 ;;;
7954 ;; Groups of windows (Follow Mode).
7955 ;;
7956 ;; This section of functions extends the functionality of some window
7957 ;; manipulating commands to groups of windows cooperatively
7958 ;; displaying a buffer, typically with Follow Mode.
7959 ;;
7960 ;; The xxx-function variables are permanent locals so that their local
7961 ;; status is undone only when explicitly programmed, not when a buffer
7962 ;; is reverted or a mode function is called.
7963
7964 (defvar window-group-start-function nil)
7965 (make-variable-buffer-local 'window-group-start-function)
7966 (put 'window-group-start-function 'permanent-local t)
7967 (defun window-group-start (&optional window)
7968 "Return position at which display currently starts in the group of
7969 windows containing WINDOW. When a grouping mode (such as Follow Mode)
7970 is not active, this function is identical to `window-start'.
7971
7972 WINDOW must be a live window and defaults to the selected one.
7973 This is updated by redisplay or by calling `set-window*-start'."
7974 (if (functionp window-group-start-function)
7975 (funcall window-group-start-function window)
7976 (window-start window)))
7977
7978 (defvar window-group-end-function nil)
7979 (make-variable-buffer-local 'window-group-end-function)
7980 (put 'window-group-end-function 'permanent-local t)
7981 (defun window-group-end (&optional window update)
7982 "Return position at which display currently ends in the group of
7983 windows containing WINDOW. When a grouping mode (such as Follow Mode)
7984 is not active, this function is identical to `window-end'.
7985
7986 WINDOW must be a live window and defaults to the selected one.
7987 This is updated by redisplay, when it runs to completion.
7988 Simply changing the buffer text or setting `window-group-start'
7989 does not update this value.
7990 Return nil if there is no recorded value. (This can happen if the
7991 last redisplay of WINDOW was preempted, and did not finish.)
7992 If UPDATE is non-nil, compute the up-to-date position
7993 if it isn't already recorded."
7994 (if (functionp window-group-end-function)
7995 (funcall window-group-end-function window update)
7996 (window-end window update)))
7997
7998 (defvar set-window-group-start-function nil)
7999 (make-variable-buffer-local 'set-window-group-start-function)
8000 (put 'set-window-group-start-function 'permanent-local t)
8001 (defun set-window-group-start (window pos &optional noforce)
8002 "Make display in the group of windows containing WINDOW start at
8003 position POS in WINDOW's buffer. When a grouping mode (such as Follow
8004 Mode) is not active, this function is identical to `set-window-start'.
8005
8006 WINDOW must be a live window and defaults to the selected one. Return
8007 POS. Optional third arg NOFORCE non-nil inhibits next redisplay from
8008 overriding motion of point in order to display at this exact start."
8009 (if (functionp set-window-group-start-function)
8010 (funcall set-window-group-start-function window pos noforce)
8011 (set-window-start window pos noforce)))
8012
8013 (defvar recenter-window-group-function nil)
8014 (make-variable-buffer-local 'recenter-window-group-function)
8015 (put 'recenter-window-group-function 'permanent-local t)
8016 (defun recenter-window-group (&optional arg)
8017 "Center point in the group of windows containing the selected window
8018 and maybe redisplay frame. When a grouping mode (such as Follow Mode)
8019 is not active, this function is identical to `recenter'.
8020
8021 With a numeric prefix argument ARG, recenter putting point on screen line ARG
8022 relative to the first window in the selected window group. If ARG is
8023 negative, it counts up from the bottom of the last window in the
8024 group. (ARG should be less than the total height of the window group.)
8025
8026 If ARG is omitted or nil, then recenter with point on the middle line of
8027 the selected window group; if the variable `recenter-redisplay' is
8028 non-nil, also erase the entire frame and redraw it (when
8029 `auto-resize-tool-bars' is set to `grow-only', this resets the
8030 tool-bar's height to the minimum height needed); if
8031 `recenter-redisplay' has the special value `tty', then only tty frames
8032 are redrawn.
8033
8034 Just C-u as prefix means put point in the center of the window
8035 and redisplay normally--don't erase and redraw the frame."
8036 (if (functionp recenter-window-group-function)
8037 (funcall recenter-window-group-function arg)
8038 (recenter arg)))
8039
8040 (defvar pos-visible-in-window-group-p-function nil)
8041 (make-variable-buffer-local 'pos-visible-in-window-group-p-function)
8042 (put 'pos-visible-in-window-group-p-function 'permanent-local t)
8043 (defun pos-visible-in-window-group-p (&optional pos window partially)
8044 "Return non-nil if position POS is currently on the frame in the
8045 window group containing WINDOW. When a grouping mode (such as Follow
8046 Mode) is not active, this function is identical to
8047 `pos-visible-in-window-p'.
8048
8049 WINDOW must be a live window and defaults to the selected one.
8050
8051 Return nil if that position is scrolled vertically out of view. If a
8052 character is only partially visible, nil is returned, unless the
8053 optional argument PARTIALLY is non-nil. If POS is only out of view
8054 because of horizontal scrolling, return non-nil. If POS is t, it
8055 specifies the position of the last visible glyph in the window group.
8056 POS defaults to point in WINDOW; WINDOW defaults to the selected
8057 window.
8058
8059 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
8060 the return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
8061 where X and Y are the pixel coordinates relative to the top left corner
8062 of the window. The remaining elements are omitted if the character after
8063 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
8064 off-window at the top and bottom of the screen line (\"row\") containing
8065 POS, ROWH is the visible height of that row, and VPOS is the row number
8066 \(zero-based)."
8067 (if (functionp pos-visible-in-window-group-p-function)
8068 (funcall pos-visible-in-window-group-p-function pos window partially)
8069 (pos-visible-in-window-p pos window partially)))
8070
8071 (defvar selected-window-group-function nil)
8072 (make-variable-buffer-local 'selected-window-group-function)
8073 (put 'selected-window-group-function 'permanent-local t)
8074 (defun selected-window-group ()
8075 "Return the list of windows in the group containing the selected window.
8076 When a grouping mode (such as Follow Mode) is not active, the
8077 result is a list containing only the selected window."
8078 (if (functionp selected-window-group-function)
8079 (funcall selected-window-group-function)
8080 (list (selected-window))))
8081
8082 (defvar move-to-window-group-line-function nil)
8083 (make-variable-buffer-local 'move-to-window-group-line-function)
8084 (put 'move-to-window-group-line-function 'permanent-local t)
8085 (defun move-to-window-group-line (arg)
8086 "Position point relative to the the current group of windows.
8087 When a grouping mode (such as Follow Mode) is not active, this
8088 function is identical to `move-to-window-line'.
8089
8090 ARG nil means position point at center of the window group.
8091 Else, ARG specifies the vertical position within the window
8092 group; zero means top of first window in the group, negative
8093 means relative to the bottom of the last window in the group."
8094 (if (functionp move-to-window-group-line-function)
8095 (funcall move-to-window-group-line-function arg)
8096 (move-to-window-line arg)))
8097
8098 \f
8099 (defvar recenter-last-op nil
8100 "Indicates the last recenter operation performed.
8101 Possible values: `top', `middle', `bottom', integer or float numbers.
8102 It can also be nil, which means the first value in `recenter-positions'.")
8103
8104 (defcustom recenter-positions '(middle top bottom)
8105 "Cycling order for `recenter-top-bottom'.
8106 A list of elements with possible values `top', `middle', `bottom',
8107 integer or float numbers that define the cycling order for
8108 the command `recenter-top-bottom'.
8109
8110 Top and bottom destinations are `scroll-margin' lines from the true
8111 window top and bottom. Middle redraws the frame and centers point
8112 vertically within the window. Integer number moves current line to
8113 the specified absolute window-line. Float number between 0.0 and 1.0
8114 means the percentage of the screen space from the top. The default
8115 cycling order is middle -> top -> bottom."
8116 :type '(repeat (choice
8117 (const :tag "Top" top)
8118 (const :tag "Middle" middle)
8119 (const :tag "Bottom" bottom)
8120 (integer :tag "Line number")
8121 (float :tag "Percentage")))
8122 :version "23.2"
8123 :group 'windows)
8124
8125 (defun recenter-top-bottom (&optional arg)
8126 "Move current buffer line to the specified window line.
8127 With no prefix argument, successive calls place point according
8128 to the cycling order defined by `recenter-positions'.
8129
8130 A prefix argument is handled like `recenter':
8131 With numeric prefix ARG, move current line to window-line ARG.
8132 With plain `C-u', move current line to window center."
8133 (interactive "P")
8134 (cond
8135 (arg (recenter arg)) ; Always respect ARG.
8136 (t
8137 (setq recenter-last-op
8138 (if (eq this-command last-command)
8139 (car (or (cdr (member recenter-last-op recenter-positions))
8140 recenter-positions))
8141 (car recenter-positions)))
8142 (let ((this-scroll-margin
8143 (min (max 0 scroll-margin)
8144 (truncate (/ (window-body-height) 4.0)))))
8145 (cond ((eq recenter-last-op 'middle)
8146 (recenter))
8147 ((eq recenter-last-op 'top)
8148 (recenter this-scroll-margin))
8149 ((eq recenter-last-op 'bottom)
8150 (recenter (- -1 this-scroll-margin)))
8151 ((integerp recenter-last-op)
8152 (recenter recenter-last-op))
8153 ((floatp recenter-last-op)
8154 (recenter (round (* recenter-last-op (window-height))))))))))
8155
8156 (define-key global-map [?\C-l] 'recenter-top-bottom)
8157
8158 (defun move-to-window-line-top-bottom (&optional arg)
8159 "Position point relative to window.
8160
8161 With a prefix argument ARG, acts like `move-to-window-line'.
8162
8163 With no argument, positions point at center of window.
8164 Successive calls position point at positions defined
8165 by `recenter-positions'."
8166 (interactive "P")
8167 (cond
8168 (arg (move-to-window-line arg)) ; Always respect ARG.
8169 (t
8170 (setq recenter-last-op
8171 (if (eq this-command last-command)
8172 (car (or (cdr (member recenter-last-op recenter-positions))
8173 recenter-positions))
8174 (car recenter-positions)))
8175 (let ((this-scroll-margin
8176 (min (max 0 scroll-margin)
8177 (truncate (/ (window-body-height) 4.0)))))
8178 (cond ((eq recenter-last-op 'middle)
8179 (call-interactively 'move-to-window-line))
8180 ((eq recenter-last-op 'top)
8181 (move-to-window-line this-scroll-margin))
8182 ((eq recenter-last-op 'bottom)
8183 (move-to-window-line (- -1 this-scroll-margin)))
8184 ((integerp recenter-last-op)
8185 (move-to-window-line recenter-last-op))
8186 ((floatp recenter-last-op)
8187 (move-to-window-line (round (* recenter-last-op (window-height))))))))))
8188
8189 (define-key global-map [?\M-r] 'move-to-window-line-top-bottom)
8190 \f
8191 ;;; Scrolling commands.
8192
8193 ;;; Scrolling commands which do not signal errors at top/bottom
8194 ;;; of buffer at first key-press (instead move to top/bottom
8195 ;;; of buffer).
8196
8197 (defcustom scroll-error-top-bottom nil
8198 "Move point to top/bottom of buffer before signaling a scrolling error.
8199 A value of nil means just signal an error if no more scrolling possible.
8200 A value of t means point moves to the beginning or the end of the buffer
8201 \(depending on scrolling direction) when no more scrolling possible.
8202 When point is already on that position, then signal an error."
8203 :type 'boolean
8204 :group 'windows
8205 :version "24.1")
8206
8207 (defun scroll-up-command (&optional arg)
8208 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
8209 If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
8210 scroll window further, move cursor to the bottom line.
8211 When point is already on that position, then signal an error.
8212 A near full screen is `next-screen-context-lines' less than a full screen.
8213 Negative ARG means scroll downward.
8214 If ARG is the atom `-', scroll downward by nearly full screen."
8215 (interactive "^P")
8216 (cond
8217 ((null scroll-error-top-bottom)
8218 (scroll-up arg))
8219 ((eq arg '-)
8220 (scroll-down-command nil))
8221 ((< (prefix-numeric-value arg) 0)
8222 (scroll-down-command (- (prefix-numeric-value arg))))
8223 ((eobp)
8224 (scroll-up arg)) ; signal error
8225 (t
8226 (condition-case nil
8227 (scroll-up arg)
8228 (end-of-buffer
8229 (if arg
8230 ;; When scrolling by ARG lines can't be done,
8231 ;; move by ARG lines instead.
8232 (forward-line arg)
8233 ;; When ARG is nil for full-screen scrolling,
8234 ;; move to the bottom of the buffer.
8235 (goto-char (point-max))))))))
8236
8237 (put 'scroll-up-command 'scroll-command t)
8238
8239 (defun scroll-down-command (&optional arg)
8240 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
8241 If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
8242 scroll window further, move cursor to the top line.
8243 When point is already on that position, then signal an error.
8244 A near full screen is `next-screen-context-lines' less than a full screen.
8245 Negative ARG means scroll upward.
8246 If ARG is the atom `-', scroll upward by nearly full screen."
8247 (interactive "^P")
8248 (cond
8249 ((null scroll-error-top-bottom)
8250 (scroll-down arg))
8251 ((eq arg '-)
8252 (scroll-up-command nil))
8253 ((< (prefix-numeric-value arg) 0)
8254 (scroll-up-command (- (prefix-numeric-value arg))))
8255 ((bobp)
8256 (scroll-down arg)) ; signal error
8257 (t
8258 (condition-case nil
8259 (scroll-down arg)
8260 (beginning-of-buffer
8261 (if arg
8262 ;; When scrolling by ARG lines can't be done,
8263 ;; move by ARG lines instead.
8264 (forward-line (- arg))
8265 ;; When ARG is nil for full-screen scrolling,
8266 ;; move to the top of the buffer.
8267 (goto-char (point-min))))))))
8268
8269 (put 'scroll-down-command 'scroll-command t)
8270
8271 ;;; Scrolling commands which scroll a line instead of full screen.
8272
8273 (defun scroll-up-line (&optional arg)
8274 "Scroll text of selected window upward ARG lines; or one line if no ARG.
8275 If ARG is omitted or nil, scroll upward by one line.
8276 This is different from `scroll-up-command' that scrolls a full screen."
8277 (interactive "p")
8278 (scroll-up (or arg 1)))
8279
8280 (put 'scroll-up-line 'scroll-command t)
8281
8282 (defun scroll-down-line (&optional arg)
8283 "Scroll text of selected window down ARG lines; or one line if no ARG.
8284 If ARG is omitted or nil, scroll down by one line.
8285 This is different from `scroll-down-command' that scrolls a full screen."
8286 (interactive "p")
8287 (scroll-down (or arg 1)))
8288
8289 (put 'scroll-down-line 'scroll-command t)
8290
8291 \f
8292 (defun scroll-other-window-down (&optional lines)
8293 "Scroll the \"other window\" down.
8294 For more details, see the documentation for `scroll-other-window'."
8295 (interactive "P")
8296 (scroll-other-window
8297 ;; Just invert the argument's meaning.
8298 ;; We can do that without knowing which window it will be.
8299 (if (eq lines '-) nil
8300 (if (null lines) '-
8301 (- (prefix-numeric-value lines))))))
8302
8303 (defun beginning-of-buffer-other-window (arg)
8304 "Move point to the beginning of the buffer in the other window.
8305 Leave mark at previous position.
8306 With arg N, put point N/10 of the way from the true beginning."
8307 (interactive "P")
8308 (let ((orig-window (selected-window))
8309 (window (other-window-for-scrolling)))
8310 ;; We use unwind-protect rather than save-window-excursion
8311 ;; because the latter would preserve the things we want to change.
8312 (unwind-protect
8313 (progn
8314 (select-window window)
8315 ;; Set point and mark in that window's buffer.
8316 (with-no-warnings
8317 (beginning-of-buffer arg))
8318 ;; Set point accordingly.
8319 (recenter '(t)))
8320 (select-window orig-window))))
8321
8322 (defun end-of-buffer-other-window (arg)
8323 "Move point to the end of the buffer in the other window.
8324 Leave mark at previous position.
8325 With arg N, put point N/10 of the way from the true end."
8326 (interactive "P")
8327 ;; See beginning-of-buffer-other-window for comments.
8328 (let ((orig-window (selected-window))
8329 (window (other-window-for-scrolling)))
8330 (unwind-protect
8331 (progn
8332 (select-window window)
8333 (with-no-warnings
8334 (end-of-buffer arg))
8335 (recenter '(t)))
8336 (select-window orig-window))))
8337 \f
8338 (defvar mouse-autoselect-window-timer nil
8339 "Timer used by delayed window autoselection.")
8340
8341 (defvar mouse-autoselect-window-position-1 nil
8342 "First mouse position recorded by delayed window autoselection.")
8343
8344 (defvar mouse-autoselect-window-position nil
8345 "Last mouse position recorded by delayed window autoselection.")
8346
8347 (defvar mouse-autoselect-window-window nil
8348 "Last window recorded by delayed window autoselection.")
8349
8350 (defvar mouse-autoselect-window-state nil
8351 "When non-nil, special state of delayed window autoselection.
8352 Possible values are `suspend' (suspend autoselection after a menu or
8353 scrollbar interaction) and `select' (the next invocation of
8354 `handle-select-window' shall select the window immediately).")
8355
8356 (defun mouse-autoselect-window-cancel (&optional force)
8357 "Cancel delayed window autoselection.
8358 Optional argument FORCE means cancel unconditionally."
8359 (unless (and (not force)
8360 ;; Don't cancel for select-window or select-frame events
8361 ;; or when the user drags a scroll bar.
8362 (or (memq this-command
8363 '(handle-select-window handle-switch-frame))
8364 (and (eq this-command 'scroll-bar-toolkit-scroll)
8365 (memq (nth 4 (event-end last-input-event))
8366 '(handle end-scroll)))))
8367 (setq mouse-autoselect-window-state nil)
8368 (setq mouse-autoselect-window-position-1 nil)
8369 (when (timerp mouse-autoselect-window-timer)
8370 (cancel-timer mouse-autoselect-window-timer))
8371 (remove-hook 'pre-command-hook 'mouse-autoselect-window-cancel)))
8372
8373 (defun mouse-autoselect-window-start (mouse-position &optional window suspend)
8374 "Start delayed window autoselection.
8375 MOUSE-POSITION is the last position where the mouse was seen as returned
8376 by `mouse-position'. Optional argument WINDOW non-nil denotes the
8377 window where the mouse was seen. Optional argument SUSPEND non-nil
8378 means suspend autoselection."
8379 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
8380 (setq mouse-autoselect-window-position mouse-position)
8381 (when window (setq mouse-autoselect-window-window window))
8382 (setq mouse-autoselect-window-state (when suspend 'suspend))
8383 ;; Install timer which runs `mouse-autoselect-window-select' after
8384 ;; `mouse-autoselect-window' seconds.
8385 (setq mouse-autoselect-window-timer
8386 (run-at-time
8387 (abs mouse-autoselect-window) nil 'mouse-autoselect-window-select)))
8388
8389 (defun mouse-autoselect-window-select ()
8390 "Select window with delayed window autoselection.
8391 If the mouse position has stabilized in a non-selected window, select
8392 that window. The minibuffer window is selected only if the minibuffer
8393 is active. This function is run by `mouse-autoselect-window-timer'."
8394 (ignore-errors
8395 (let* ((mouse-position (mouse-position))
8396 (window
8397 (ignore-errors
8398 (window-at (cadr mouse-position) (cddr mouse-position)
8399 (car mouse-position)))))
8400 (cond
8401 ((or (and (fboundp 'menu-or-popup-active-p) (menu-or-popup-active-p))
8402 (and window
8403 (let ((coords (coordinates-in-window-p
8404 (cdr mouse-position) window)))
8405 (and (not (consp coords))
8406 (not (memq coords '(left-margin right-margin)))))))
8407 ;; A menu / popup dialog is active or the mouse is not on the
8408 ;; text region of WINDOW: Suspend autoselection temporarily.
8409 (mouse-autoselect-window-start mouse-position nil t))
8410 ((or (eq mouse-autoselect-window-state 'suspend)
8411 ;; When the mouse is at its first recorded position, restart
8412 ;; delayed autoselection. This works around a scenario with
8413 ;; two two-window frames with identical dimensions: select the
8414 ;; first window of the first frame, switch to the second
8415 ;; frame, move the mouse to its second window, minimize the
8416 ;; second frame. Now the second window of the first frame
8417 ;; gets selected although the mouse never really "moved" into
8418 ;; that window.
8419 (and (numberp mouse-autoselect-window)
8420 (equal (mouse-position) mouse-autoselect-window-position-1)))
8421 ;; Delayed autoselection was temporarily suspended, reenable it.
8422 (mouse-autoselect-window-start mouse-position))
8423 ((and window (not (eq window (selected-window)))
8424 (or (not (numberp mouse-autoselect-window))
8425 (and (>= mouse-autoselect-window 0)
8426 ;; If `mouse-autoselect-window' is non-negative,
8427 ;; select window if it's the same as before.
8428 (eq window mouse-autoselect-window-window))
8429 ;; Otherwise select window iff the mouse is at the same
8430 ;; position as before. Observe that the first test
8431 ;; after starting autoselection usually fails since the
8432 ;; value of `mouse-autoselect-window-position' recorded
8433 ;; there is the position where the mouse has entered the
8434 ;; new window and not necessarily where the mouse has
8435 ;; stopped moving.
8436 (equal mouse-position mouse-autoselect-window-position))
8437 ;; The minibuffer is a candidate window if it's active.
8438 (or (not (window-minibuffer-p window))
8439 (eq window (active-minibuffer-window))))
8440 ;; Mouse position has stabilized in non-selected window: Cancel
8441 ;; delayed autoselection and try to select that window.
8442 (mouse-autoselect-window-cancel t)
8443 ;; Select window where mouse appears unless the selected window is the
8444 ;; minibuffer. Use `unread-command-events' in order to execute pre-
8445 ;; and post-command hooks and trigger idle timers. To avoid delaying
8446 ;; autoselection again, set `mouse-autoselect-window-state'."
8447 (unless (window-minibuffer-p)
8448 (setq mouse-autoselect-window-state 'select)
8449 (setq unread-command-events
8450 (cons (list 'select-window (list window))
8451 unread-command-events))))
8452 ((or (and window (eq window (selected-window)))
8453 (not (numberp mouse-autoselect-window))
8454 (equal mouse-position mouse-autoselect-window-position))
8455 ;; Mouse position has either stabilized in the selected window or at
8456 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
8457 (mouse-autoselect-window-cancel t))
8458 (t
8459 ;; Mouse position has not stabilized yet, resume delayed
8460 ;; autoselection.
8461 (mouse-autoselect-window-start mouse-position window))))))
8462
8463 (defun handle-select-window (event)
8464 "Handle select-window events."
8465 (interactive "^e")
8466 (let ((window (posn-window (event-start event))))
8467 (unless (or (not (window-live-p window))
8468 ;; Don't switch if we're currently in the minibuffer.
8469 ;; This tries to work around problems where the
8470 ;; minibuffer gets unselected unexpectedly, and where
8471 ;; you then have to move your mouse all the way down to
8472 ;; the minibuffer to select it.
8473 (window-minibuffer-p)
8474 ;; Don't switch to minibuffer window unless it's active.
8475 (and (window-minibuffer-p window)
8476 (not (minibuffer-window-active-p window)))
8477 ;; Don't switch when autoselection shall be delayed.
8478 (and (numberp mouse-autoselect-window)
8479 (not (eq mouse-autoselect-window-state 'select))
8480 (let ((position (mouse-position)))
8481 ;; Cancel any delayed autoselection.
8482 (mouse-autoselect-window-cancel t)
8483 ;; Start delayed autoselection from current mouse
8484 ;; position and window.
8485 (setq mouse-autoselect-window-position-1 position)
8486 (mouse-autoselect-window-start position window)
8487 ;; Executing a command cancels delayed autoselection.
8488 (add-hook
8489 'pre-command-hook 'mouse-autoselect-window-cancel))))
8490 (when mouse-autoselect-window
8491 ;; Reset state of delayed autoselection.
8492 (setq mouse-autoselect-window-state nil)
8493 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
8494 (run-hooks 'mouse-leave-buffer-hook))
8495 ;; Clear echo area.
8496 (message nil)
8497 (select-window window))))
8498
8499 (defun truncated-partial-width-window-p (&optional window)
8500 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
8501 WINDOW must be a live window and defaults to the selected one.
8502 Return nil if WINDOW is not a partial-width window
8503 (regardless of the value of `truncate-lines').
8504 Otherwise, consult the value of `truncate-partial-width-windows'
8505 for the buffer shown in WINDOW."
8506 (setq window (window-normalize-window window t))
8507 (unless (window-full-width-p window)
8508 (let ((t-p-w-w (buffer-local-value 'truncate-partial-width-windows
8509 (window-buffer window))))
8510 (if (integerp t-p-w-w)
8511 (< (window-width window) t-p-w-w)
8512 t-p-w-w))))
8513
8514 \f
8515 ;; Automatically inform subprocesses of changes to window size.
8516
8517 (defcustom window-adjust-process-window-size-function
8518 'window-adjust-process-window-size-smallest
8519 "Control how Emacs chooses inferior process window sizes.
8520 Emacs uses this function to tell processes the space they have
8521 available for displaying their output. After each window
8522 configuration change, Emacs calls the value of
8523 `window-adjust-process-window-size-function' for each process
8524 with a buffer being displayed in at least one window.
8525 This function is responsible for combining the sizes of the
8526 displayed windows and returning a cons (WIDTH . HEIGHT)
8527 describing the width and height with which Emacs will call
8528 `set-process-window-size' for that process. If the function
8529 returns nil, Emacs does not call `set-process-window-size'.
8530
8531 This function is called with the process buffer as the current
8532 buffer and with two arguments: the process and a list of windows
8533 displaying process. Modes can make this variable buffer-local;
8534 additionally, the `adjust-window-size-function' process property
8535 overrides the global or buffer-local value of
8536 `window-adjust-process-window-size-function'."
8537 :type '(choice
8538 (const :tag "Minimum area of any window"
8539 window-adjust-process-window-size-smallest)
8540 (const :tag "Maximum area of any window"
8541 window-adjust-process-window-size-largest)
8542 (const :tag "Do not adjust process window sizes" ignore)
8543 function)
8544 :group 'windows
8545 :version "25.1")
8546
8547 (defun window-adjust-process-window-size (reducer process windows)
8548 "Adjust the process window size of PROCESS.
8549 WINDOWS is a list of windows associated with PROCESS. REDUCER is
8550 a two-argument function used to combine the widths and heights of
8551 the given windows."
8552 (when windows
8553 (let ((width (window-body-width (car windows)))
8554 (height (window-body-height (car windows))))
8555 (dolist (window (cdr windows))
8556 (setf width (funcall reducer width (window-body-width window)))
8557 (setf height (funcall reducer height (window-body-height window))))
8558 (cons width height))))
8559
8560 (defun window-adjust-process-window-size-smallest (process windows)
8561 "Adjust the process window size of PROCESS.
8562 WINDOWS is a list of windows associated with PROCESS. Choose the
8563 smallest area available for displaying PROCESS's output."
8564 (window-adjust-process-window-size #'min process windows))
8565
8566 (defun window-adjust-process-window-size-largest (process windows)
8567 "Adjust the process window size of PROCESS.
8568 WINDOWS is a list of windows associated with PROCESS. Choose the
8569 largest area available for displaying PROCESS's output."
8570 (window-adjust-process-window-size #'max process windows))
8571
8572 (defun window--process-window-list ()
8573 "Return an alist mapping processes to associated windows.
8574 A window is associated with a process if that window is
8575 displaying that processes's buffer."
8576 (let ((processes (process-list))
8577 (process-windows nil))
8578 (walk-windows
8579 (lambda (window)
8580 (let ((buffer (window-buffer window))
8581 (iter processes))
8582 (while (let ((process (car iter)))
8583 (if (and (process-live-p process)
8584 (eq buffer (process-buffer process)))
8585 (let ((procwin (assq process process-windows)))
8586 ;; Add this window to the list of windows
8587 ;; displaying process.
8588 (if procwin
8589 (push window (cdr procwin))
8590 (push (list process window) process-windows))
8591 ;; We found our process for this window, so
8592 ;; stop iterating over the process list.
8593 nil)
8594 (setf iter (cdr iter)))))))
8595 1 t)
8596 process-windows))
8597
8598 (defun window--adjust-process-windows ()
8599 "Update process window sizes to match the current window configuration."
8600 (dolist (procwin (window--process-window-list))
8601 (let ((process (car procwin)))
8602 (with-demoted-errors "Error adjusting window size: %S"
8603 (with-current-buffer (process-buffer process)
8604 (let ((size (funcall
8605 (or (process-get process 'adjust-window-size-function)
8606 window-adjust-process-window-size-function)
8607 process (cdr procwin))))
8608 (when size
8609 (set-process-window-size process (cdr size) (car size)))))))))
8610
8611 (add-hook 'window-configuration-change-hook 'window--adjust-process-windows)
8612
8613 \f
8614 ;; Some of these are in tutorial--default-keys, so update that if you
8615 ;; change these.
8616 (define-key ctl-x-map "0" 'delete-window)
8617 (define-key ctl-x-map "1" 'delete-other-windows)
8618 (define-key ctl-x-map "2" 'split-window-below)
8619 (define-key ctl-x-map "3" 'split-window-right)
8620 (define-key ctl-x-map "o" 'other-window)
8621 (define-key ctl-x-map "^" 'enlarge-window)
8622 (define-key ctl-x-map "}" 'enlarge-window-horizontally)
8623 (define-key ctl-x-map "{" 'shrink-window-horizontally)
8624 (define-key ctl-x-map "-" 'shrink-window-if-larger-than-buffer)
8625 (define-key ctl-x-map "+" 'balance-windows)
8626 (define-key ctl-x-4-map "0" 'kill-buffer-and-window)
8627
8628 ;;; window.el ends here