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