b33c46acf93821a25555a8dea3d5a99bae11a424
[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 (defcustom frame-auto-delete 'automatic
2262 "If non-nil, quitting a window can delete its frame.
2263 If this variable is nil, functions that quit a window never
2264 delete the associated frame. If this variable's value is the
2265 symbol `automatic', a frame is deleted only if the window is
2266 dedicated or was created by `display-buffer'. If this variable
2267 is t, a frame can be always deleted, even if it was created by
2268 `make-frame-command'. Other values should not be used.
2269
2270 Note that a frame will be effectively deleted if and only if
2271 another frame still exists.
2272
2273 Functions quitting a window and consequently affected by this
2274 variable are `switch-to-prev-buffer', `delete-windows-on',
2275 `replace-buffer-in-windows' and `quit-window'."
2276 :type '(choice
2277 (const :tag "Never" nil)
2278 (const :tag "Automatic" automatic)
2279 (const :tag "Always" t))
2280 :group 'windows
2281 :group 'frames)
2282
2283 (defun window-deletable-p (&optional window)
2284 "Return t if WINDOW can be safely deleted from its frame.
2285 Return `frame' if deleting WINDOW should also delete its
2286 frame."
2287 (setq window (window-normalize-any-window window))
2288 (unless ignore-window-parameters
2289 ;; Handle atomicity.
2290 (when (window-parameter window 'window-atom)
2291 (setq window (window-atom-root window))))
2292 (let ((parent (window-parent window))
2293 (frame (window-frame window))
2294 (dedicated (and (window-buffer window) (window-dedicated-p window)))
2295 (quit-restore (window-parameter window 'quit-restore)))
2296 (cond
2297 ((frame-root-window-p window)
2298 (when (and (or (eq frame-auto-delete t)
2299 (and (eq frame-auto-delete 'automatic)
2300 (or dedicated
2301 (and (eq (car-safe quit-restore) 'new-frame)
2302 (eq (nth 1 quit-restore)
2303 (window-buffer window))))))
2304 (other-visible-frames-p frame))
2305 ;; WINDOW is the root window of its frame. Return `frame' but
2306 ;; only if WINDOW is (1) either dedicated or quit-restore's car
2307 ;; is `new-frame' and the window still displays the same buffer
2308 ;; and (2) there are other frames left.
2309 'frame))
2310 ((and (not ignore-window-parameters)
2311 (eq (window-parameter window 'window-side) 'none)
2312 (or (not parent)
2313 (not (eq (window-parameter parent 'window-side) 'none))))
2314 ;; Can't delete last main window.
2315 nil)
2316 (t))))
2317
2318 (defun window-or-subwindow-p (subwindow window)
2319 "Return t if SUBWINDOW is either WINDOW or a subwindow of WINDOW."
2320 (or (eq subwindow window)
2321 (let ((parent (window-parent subwindow)))
2322 (catch 'done
2323 (while parent
2324 (if (eq parent window)
2325 (throw 'done t)
2326 (setq parent (window-parent parent))))))))
2327
2328 (defun delete-window (&optional window)
2329 "Delete WINDOW.
2330 WINDOW can be an arbitrary window and defaults to the selected
2331 one. Return nil.
2332
2333 If the variable `ignore-window-parameters' is non-nil or the
2334 `delete-window' parameter of WINDOW equals t, do not process any
2335 parameters of WINDOW. Otherwise, if the `delete-window'
2336 parameter of WINDOW specifies a function, call that function with
2337 WINDOW as its sole argument and return the value returned by that
2338 function.
2339
2340 Otherwise, if WINDOW is part of an atomic window, call
2341 `delete-window' with the root of the atomic window as its
2342 argument. If WINDOW is the only window on its frame or the last
2343 non-side window, signal an error."
2344 (interactive)
2345 (setq window (window-normalize-any-window window))
2346 (let* ((frame (window-frame window))
2347 (function (window-parameter window 'delete-window))
2348 (parent (window-parent window))
2349 atom-root)
2350 (window-check frame)
2351 (catch 'done
2352 ;; Handle window parameters.
2353 (cond
2354 ;; Ignore window parameters if `ignore-window-parameters' tells
2355 ;; us so or `delete-window' equals t.
2356 ((or ignore-window-parameters (eq function t)))
2357 ((functionp function)
2358 ;; The `delete-window' parameter specifies the function to call.
2359 ;; If that function is `ignore' nothing is done. It's up to the
2360 ;; function called here to avoid infinite recursion.
2361 (throw 'done (funcall function window)))
2362 ((and (window-parameter window 'window-atom)
2363 (setq atom-root (window-atom-root window))
2364 (not (eq atom-root window)))
2365 (throw 'done (delete-window atom-root)))
2366 ((and (eq (window-parameter window 'window-side) 'none)
2367 (or (not parent)
2368 (not (eq (window-parameter parent 'window-side) 'none))))
2369 (error "Attempt to delete last non-side window"))
2370 ((not parent)
2371 (error "Attempt to delete minibuffer or sole ordinary window")))
2372
2373 (let* ((horizontal (window-left-child parent))
2374 (size (window-total-size window horizontal))
2375 (frame-selected
2376 (window-or-subwindow-p (frame-selected-window frame) window))
2377 ;; Emacs 23 preferably gives WINDOW's space to its left
2378 ;; sibling.
2379 (sibling (or (window-left window) (window-right window))))
2380 (window--resize-reset frame horizontal)
2381 (cond
2382 ((and (not (window-splits window))
2383 sibling (window-sizable-p sibling size))
2384 ;; Resize WINDOW's sibling.
2385 (window--resize-this-window sibling size horizontal nil t)
2386 (set-window-new-normal
2387 sibling (+ (window-normal-size sibling horizontal)
2388 (window-normal-size window horizontal))))
2389 ((window-resizable-p window (- size) horizontal nil nil nil t)
2390 ;; Can do without resizing fixed-size windows.
2391 (window--resize-siblings window (- size) horizontal))
2392 (t
2393 ;; Can't do without resizing fixed-size windows.
2394 (window--resize-siblings window (- size) horizontal t)))
2395 ;; Actually delete WINDOW.
2396 (delete-window-internal window)
2397 (when (and frame-selected
2398 (window-parameter
2399 (frame-selected-window frame) 'no-other-window))
2400 ;; `delete-window-internal' has selected a window that should
2401 ;; not be selected, fix this here.
2402 (other-window -1 frame))
2403 (run-window-configuration-change-hook frame)
2404 (window-check frame)
2405 ;; Always return nil.
2406 nil))))
2407
2408 (defun delete-other-windows (&optional window)
2409 "Make WINDOW fill its frame.
2410 WINDOW may be any window and defaults to the selected one.
2411 Return nil.
2412
2413 If the variable `ignore-window-parameters' is non-nil or the
2414 `delete-other-windows' parameter of WINDOW equals t, do not
2415 process any parameters of WINDOW. Otherwise, if the
2416 `delete-other-windows' parameter of WINDOW specifies a function,
2417 call that function with WINDOW as its sole argument and return
2418 the value returned by that function.
2419
2420 Otherwise, if WINDOW is part of an atomic window, call this
2421 function with the root of the atomic window as its argument. If
2422 WINDOW is a non-side window, make WINDOW the only non-side window
2423 on the frame. Side windows are not deleted. If WINDOW is a side
2424 window signal an error."
2425 (interactive)
2426 (setq window (window-normalize-any-window window))
2427 (let* ((frame (window-frame window))
2428 (function (window-parameter window 'delete-other-windows))
2429 (window-side (window-parameter window 'window-side))
2430 atom-root side-main)
2431 (window-check frame)
2432 (catch 'done
2433 (cond
2434 ;; Ignore window parameters if `ignore-window-parameters' is t or
2435 ;; `delete-other-windows' is t.
2436 ((or ignore-window-parameters (eq function t)))
2437 ((functionp function)
2438 ;; The `delete-other-windows' parameter specifies the function
2439 ;; to call. If the function is `ignore' no windows are deleted.
2440 ;; It's up to the function called to avoid infinite recursion.
2441 (throw 'done (funcall function window)))
2442 ((and (window-parameter window 'window-atom)
2443 (setq atom-root (window-atom-root window))
2444 (not (eq atom-root window)))
2445 (throw 'done (delete-other-windows atom-root)))
2446 ((eq window-side 'none)
2447 ;; Set side-main to the major non-side window.
2448 (setq side-main (window-with-parameter 'window-side 'none nil t)))
2449 ((memq window-side window-sides)
2450 (error "Cannot make side window the only window")))
2451 ;; If WINDOW is the main non-side window, do nothing.
2452 (unless (eq window side-main)
2453 (delete-other-windows-internal window side-main)
2454 (run-window-configuration-change-hook frame)
2455 (window-check frame))
2456 ;; Always return nil.
2457 nil)))
2458
2459 (defun delete-other-windows-vertically (&optional window)
2460 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
2461 This may be a useful alternative binding for \\[delete-other-windows]
2462 if you often split windows horizontally."
2463 (interactive)
2464 (let* ((window (or window (selected-window)))
2465 (edges (window-edges window))
2466 (w window) delenda)
2467 (while (not (eq (setq w (next-window w 1)) window))
2468 (let ((e (window-edges w)))
2469 (when (and (= (car e) (car edges))
2470 (= (caddr e) (caddr edges)))
2471 (push w delenda))))
2472 (mapc 'delete-window delenda)))
2473
2474 ;;; Windows and buffers.
2475
2476 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
2477 ;; for (1) determining which buffer to show in the window when its
2478 ;; buffer shall be buried or killed and (2) which buffer to show for
2479 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2480
2481 ;; `prev-buffers' consists of <buffer, window-start, window-point>
2482 ;; triples. The entries on this list are ordered by the time their
2483 ;; buffer has been removed from the window, the most recently removed
2484 ;; buffer's entry being first. The window-start and window-point
2485 ;; components are `window-start' and `window-point' at the time the
2486 ;; buffer was removed from the window which implies that the entry must
2487 ;; be added when `set-window-buffer' removes the buffer from the window.
2488
2489 ;; `next-buffers' is the list of buffers that have been replaced
2490 ;; recently by `switch-to-prev-buffer'. These buffers are the least
2491 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
2492 ;; candidates of `switch-to-next-buffer' to switch to. This list is
2493 ;; reset to nil by any action changing the window's buffer with the
2494 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
2495 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
2496 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
2497
2498 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
2499 ;; if such a buffer was killed while the window was hidden within a
2500 ;; window configuration. Such killed buffers get removed whenever
2501 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
2502
2503 ;; The following function is called by `set-window-buffer' _before_ it
2504 ;; replaces the buffer of the argument window with the new buffer.
2505 (defun record-window-buffer (&optional window)
2506 "Record WINDOW's buffer.
2507 WINDOW must be a live window and defaults to the selected one."
2508 (let* ((window (window-normalize-live-window window))
2509 (buffer (window-buffer window))
2510 (entry (assq buffer (window-prev-buffers window))))
2511 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
2512 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2513 (set-window-next-buffers window nil)
2514
2515 (when entry
2516 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
2517 (set-window-prev-buffers
2518 window (assq-delete-all buffer (window-prev-buffers window))))
2519
2520 ;; Don't record insignificant buffers.
2521 (unless (eq (aref (buffer-name buffer) 0) ?\s)
2522 ;; Add an entry for buffer to WINDOW's previous buffers.
2523 (with-current-buffer buffer
2524 (let ((start (window-start window))
2525 (point (window-point window)))
2526 (setq entry
2527 (cons buffer
2528 (if entry
2529 ;; We have an entry, update marker positions.
2530 (list (set-marker (nth 1 entry) start)
2531 (set-marker (nth 2 entry) point))
2532 ;; Make new markers.
2533 (list (copy-marker start)
2534 (copy-marker point)))))
2535
2536 (set-window-prev-buffers
2537 window (cons entry (window-prev-buffers window))))))))
2538
2539 (defun unrecord-window-buffer (&optional window buffer)
2540 "Unrecord BUFFER in WINDOW.
2541 WINDOW must be a live window and defaults to the selected one.
2542 BUFFER must be a live buffer and defaults to the buffer of
2543 WINDOW."
2544 (let* ((window (window-normalize-live-window window))
2545 (buffer (or buffer (window-buffer window))))
2546 (set-window-prev-buffers
2547 window (assq-delete-all buffer (window-prev-buffers window)))
2548 (set-window-next-buffers
2549 window (delq buffer (window-next-buffers window)))))
2550
2551 (defun set-window-buffer-start-and-point (window buffer &optional start point)
2552 "Set WINDOW's buffer to BUFFER.
2553 Optional argument START non-nil means set WINDOW's start position
2554 to START. Optional argument POINT non-nil means set WINDOW's
2555 point to POINT. If WINDOW is selected this also sets BUFFER's
2556 `point' to POINT. If WINDOW is selected and the buffer it showed
2557 before was current this also makes BUFFER the current buffer."
2558 (let ((selected (eq window (selected-window)))
2559 (current (eq (window-buffer window) (current-buffer))))
2560 (set-window-buffer window buffer)
2561 (when (and selected current)
2562 (set-buffer buffer))
2563 (when start
2564 (set-window-start window start))
2565 (when point
2566 (if selected
2567 (with-current-buffer buffer
2568 (goto-char point))
2569 (set-window-point window point)))))
2570
2571 (defun switch-to-prev-buffer (&optional window bury-or-kill)
2572 "In WINDOW switch to previous buffer.
2573 WINDOW must be a live window and defaults to the selected one.
2574
2575 Optional argument BURY-OR-KILL non-nil means the buffer currently
2576 shown in WINDOW is about to be buried or killed and consequently
2577 shall not be switched to in future invocations of this command."
2578 (interactive)
2579 (let* ((window (window-normalize-live-window window))
2580 (old-buffer (window-buffer window))
2581 ;; Save this since it's destroyed by `set-window-buffer'.
2582 (next-buffers (window-next-buffers window))
2583 entry new-buffer killed-buffers deletable visible)
2584 (cond
2585 ;; When BURY-OR-KILL is non-nil, there's no previous buffer for
2586 ;; this window, and we can delete the window (or the frame) do
2587 ;; that.
2588 ((and bury-or-kill
2589 (or (not (window-prev-buffers window))
2590 (and (eq (caar (window-prev-buffers window)) old-buffer)
2591 (not (cdr (car (window-prev-buffers window))))))
2592 (setq deletable (window-deletable-p window)))
2593 (if (eq deletable 'frame)
2594 (delete-frame (window-frame window))
2595 (delete-window window)))
2596 ((window-dedicated-p window)
2597 (error "Window %s is dedicated to buffer %s" window old-buffer)))
2598
2599 (unless deletable
2600 (catch 'found
2601 ;; Scan WINDOW's previous buffers first, skipping entries of next
2602 ;; buffers.
2603 (dolist (entry (window-prev-buffers window))
2604 (when (and (setq new-buffer (car entry))
2605 (or (buffer-live-p new-buffer)
2606 (not (setq killed-buffers
2607 (cons new-buffer killed-buffers))))
2608 (not (eq new-buffer old-buffer))
2609 (or bury-or-kill
2610 (not (memq new-buffer next-buffers))))
2611 (set-window-buffer-start-and-point
2612 window new-buffer (nth 1 entry) (nth 2 entry))
2613 (throw 'found t)))
2614 ;; Scan reverted buffer list of WINDOW's frame next, skipping
2615 ;; entries of next buffers. Note that when we bury or kill a
2616 ;; buffer we don't reverse the global buffer list to avoid showing
2617 ;; a buried buffer instead. Otherwise, we must reverse the global
2618 ;; buffer list in order to make sure that switching to the
2619 ;; previous/next buffer traverse it in opposite directions.
2620 (dolist (buffer (if bury-or-kill
2621 (buffer-list (window-frame window))
2622 (nreverse (buffer-list (window-frame window)))))
2623 (when (and (buffer-live-p buffer)
2624 (not (eq buffer old-buffer))
2625 (not (eq (aref (buffer-name buffer) 0) ?\s))
2626 (or bury-or-kill (not (memq buffer next-buffers))))
2627 (if (get-buffer-window buffer)
2628 ;; Try to avoid showing a buffer visible in some other window.
2629 (setq visible buffer)
2630 (setq new-buffer buffer)
2631 (set-window-buffer-start-and-point window new-buffer)
2632 (throw 'found t))))
2633 (unless bury-or-kill
2634 ;; Scan reverted next buffers last (must not use nreverse
2635 ;; here!).
2636 (dolist (buffer (reverse next-buffers))
2637 ;; Actually, buffer _must_ be live here since otherwise it
2638 ;; would have been caught in the scan of previous buffers.
2639 (when (and (or (buffer-live-p buffer)
2640 (not (setq killed-buffers
2641 (cons buffer killed-buffers))))
2642 (not (eq buffer old-buffer))
2643 (setq entry (assq buffer (window-prev-buffers window))))
2644 (setq new-buffer buffer)
2645 (set-window-buffer-start-and-point
2646 window new-buffer (nth 1 entry) (nth 2 entry))
2647 (throw 'found t))))
2648
2649 ;; Show a buffer visible in another window.
2650 (when visible
2651 (setq new-buffer visible)
2652 (set-window-buffer-start-and-point window new-buffer)))
2653
2654 (if bury-or-kill
2655 ;; Remove `old-buffer' from WINDOW's previous and (restored list
2656 ;; of) next buffers.
2657 (progn
2658 (set-window-prev-buffers
2659 window (assq-delete-all old-buffer (window-prev-buffers window)))
2660 (set-window-next-buffers window (delq old-buffer next-buffers)))
2661 ;; Move `old-buffer' to head of WINDOW's restored list of next
2662 ;; buffers.
2663 (set-window-next-buffers
2664 window (cons old-buffer (delq old-buffer next-buffers)))))
2665
2666 ;; Remove killed buffers from WINDOW's previous and next buffers.
2667 (when killed-buffers
2668 (dolist (buffer killed-buffers)
2669 (set-window-prev-buffers
2670 window (assq-delete-all buffer (window-prev-buffers window)))
2671 (set-window-next-buffers
2672 window (delq buffer (window-next-buffers window)))))
2673
2674 ;; Return new-buffer.
2675 new-buffer))
2676
2677 (defun switch-to-next-buffer (&optional window)
2678 "In WINDOW switch to next buffer.
2679 WINDOW must be a live window and defaults to the selected one."
2680 (interactive)
2681 (let* ((window (window-normalize-live-window window))
2682 (old-buffer (window-buffer window))
2683 (next-buffers (window-next-buffers window))
2684 new-buffer entry killed-buffers visible)
2685 (when (window-dedicated-p window)
2686 (error "Window %s is dedicated to buffer %s" window old-buffer))
2687
2688 (catch 'found
2689 ;; Scan WINDOW's next buffers first.
2690 (dolist (buffer next-buffers)
2691 (when (and (or (buffer-live-p buffer)
2692 (not (setq killed-buffers
2693 (cons buffer killed-buffers))))
2694 (not (eq buffer old-buffer))
2695 (setq entry (assq buffer (window-prev-buffers window))))
2696 (setq new-buffer buffer)
2697 (set-window-buffer-start-and-point
2698 window new-buffer (nth 1 entry) (nth 2 entry))
2699 (throw 'found t)))
2700 ;; Scan the buffer list of WINDOW's frame next, skipping previous
2701 ;; buffers entries.
2702 (dolist (buffer (buffer-list (window-frame window)))
2703 (when (and (buffer-live-p buffer) (not (eq buffer old-buffer))
2704 (not (eq (aref (buffer-name buffer) 0) ?\s))
2705 (not (assq buffer (window-prev-buffers window))))
2706 (if (get-buffer-window buffer)
2707 ;; Try to avoid showing a buffer visible in some other window.
2708 (setq visible buffer)
2709 (setq new-buffer buffer)
2710 (set-window-buffer-start-and-point window new-buffer)
2711 (throw 'found t))))
2712 ;; Scan WINDOW's reverted previous buffers last (must not use
2713 ;; nreverse here!)
2714 (dolist (entry (reverse (window-prev-buffers window)))
2715 (when (and (setq new-buffer (car entry))
2716 (or (buffer-live-p new-buffer)
2717 (not (setq killed-buffers
2718 (cons new-buffer killed-buffers))))
2719 (not (eq new-buffer old-buffer)))
2720 (set-window-buffer-start-and-point
2721 window new-buffer (nth 1 entry) (nth 2 entry))
2722 (throw 'found t)))
2723
2724 ;; Show a buffer visible in another window.
2725 (when visible
2726 (setq new-buffer visible)
2727 (set-window-buffer-start-and-point window new-buffer)))
2728
2729 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
2730 (set-window-next-buffers window (delq new-buffer next-buffers))
2731
2732 ;; Remove killed buffers from WINDOW's previous and next buffers.
2733 (when killed-buffers
2734 (dolist (buffer killed-buffers)
2735 (set-window-prev-buffers
2736 window (assq-delete-all buffer (window-prev-buffers window)))
2737 (set-window-next-buffers
2738 window (delq buffer (window-next-buffers window)))))
2739
2740 ;; Return new-buffer.
2741 new-buffer))
2742
2743 (defun get-next-valid-buffer (list &optional buffer visible-ok frame)
2744 "Search LIST for a valid buffer to display in FRAME.
2745 Return nil when all buffers in LIST are undesirable for display,
2746 otherwise return the first suitable buffer in LIST.
2747
2748 Buffers not visible in windows are preferred to visible buffers,
2749 unless VISIBLE-OK is non-nil.
2750 If the optional argument FRAME is nil, it defaults to the selected frame.
2751 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
2752 ;; This logic is more or less copied from other-buffer.
2753 (setq frame (or frame (selected-frame)))
2754 (let ((pred (frame-parameter frame 'buffer-predicate))
2755 found buf)
2756 (while (and (not found) list)
2757 (setq buf (car list))
2758 (if (and (not (eq buffer buf))
2759 (buffer-live-p buf)
2760 (or (null pred) (funcall pred buf))
2761 (not (eq (aref (buffer-name buf) 0) ?\s))
2762 (or visible-ok (null (get-buffer-window buf 'visible))))
2763 (setq found buf)
2764 (setq list (cdr list))))
2765 (car list)))
2766
2767 (defun last-buffer (&optional buffer visible-ok frame)
2768 "Return the last buffer in FRAME's buffer list.
2769 If BUFFER is the last buffer, return the preceding buffer
2770 instead. Buffers not visible in windows are preferred to visible
2771 buffers, unless optional argument VISIBLE-OK is non-nil.
2772 Optional third argument FRAME nil or omitted means use the
2773 selected frame's buffer list. If no such buffer exists, return
2774 the buffer `*scratch*', creating it if necessary."
2775 (setq frame (or frame (selected-frame)))
2776 (or (get-next-valid-buffer (nreverse (buffer-list frame))
2777 buffer visible-ok frame)
2778 (get-buffer "*scratch*")
2779 (let ((scratch (get-buffer-create "*scratch*")))
2780 (set-buffer-major-mode scratch)
2781 scratch)))
2782
2783 (defun bury-buffer (&optional buffer-or-name)
2784 "Put BUFFER-OR-NAME at the end of the list of all buffers.
2785 There it is the least likely candidate for `other-buffer' to
2786 return; thus, the least likely buffer for \\[switch-to-buffer] to
2787 select by default.
2788
2789 You can specify a buffer name as BUFFER-OR-NAME, or an actual
2790 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
2791 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
2792 remove the current buffer from the selected window if it is
2793 displayed there."
2794 (interactive)
2795 (let* ((buffer (window-normalize-buffer buffer-or-name)))
2796 ;; If `buffer-or-name' is not on the selected frame we unrecord it
2797 ;; although it's not "here" (call it a feature).
2798 (bury-buffer-internal buffer)
2799 ;; Handle case where `buffer-or-name' is nil and the current buffer
2800 ;; is shown in the selected window.
2801 (cond
2802 ((or buffer-or-name (not (eq buffer (window-buffer)))))
2803 ((not (window-dedicated-p))
2804 (switch-to-prev-buffer nil 'bury))
2805 ((and (frame-root-window-p (selected-window))
2806 ;; Don't iconify if it's the only frame.
2807 (not (eq (next-frame nil 0) (selected-frame))))
2808 (iconify-frame (window-frame (selected-window))))
2809 ((window-deletable-p)
2810 (delete-window)))
2811 ;; Always return nil.
2812 nil))
2813
2814 (defun unbury-buffer ()
2815 "Switch to the last buffer in the buffer list."
2816 (interactive)
2817 (switch-to-buffer (last-buffer)))
2818
2819 (defun next-buffer ()
2820 "In selected window switch to next buffer."
2821 (interactive)
2822 (if (window-minibuffer-p)
2823 (error "Cannot switch buffers in minibuffer window"))
2824 (switch-to-next-buffer))
2825
2826 (defun previous-buffer ()
2827 "In selected window switch to previous buffer."
2828 (interactive)
2829 (if (window-minibuffer-p)
2830 (error "Cannot switch buffers in minibuffer window"))
2831 (switch-to-prev-buffer))
2832
2833 (defun delete-windows-on (&optional buffer-or-name frame)
2834 "Delete all windows showing BUFFER-OR-NAME.
2835 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2836 and defaults to the current buffer.
2837
2838 The following non-nil values of the optional argument FRAME
2839 have special meanings:
2840
2841 - t means consider all windows on the selected frame only.
2842
2843 - `visible' means consider all windows on all visible frames on
2844 the current terminal.
2845
2846 - 0 (the number zero) means consider all windows on all visible
2847 and iconified frames on the current terminal.
2848
2849 - A frame means consider all windows on that frame only.
2850
2851 Any other value of FRAME means consider all windows on all
2852 frames.
2853
2854 When a window showing BUFFER-OR-NAME is dedicated and the only
2855 window of its frame, that frame is deleted when there are other
2856 frames left."
2857 (interactive "BDelete windows on (buffer):\nP")
2858 (let ((buffer (window-normalize-buffer buffer-or-name))
2859 ;; Handle the "inverted" meaning of the FRAME argument wrt other
2860 ;; `window-list-1' based function.
2861 (all-frames (cond ((not frame) t) ((eq frame t) nil) (t frame))))
2862 (dolist (window (window-list-1 nil nil all-frames))
2863 (if (eq (window-buffer window) buffer)
2864 (let ((deletable (window-deletable-p window)))
2865 (cond
2866 ((eq deletable 'frame)
2867 ;; Delete frame.
2868 (delete-frame (window-frame window)))
2869 (deletable
2870 ;; Delete window only.
2871 (delete-window window))
2872 (t
2873 ;; In window switch to previous buffer.
2874 (set-window-dedicated-p window nil)
2875 (switch-to-prev-buffer window 'bury))))
2876 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
2877 (unrecord-window-buffer window buffer)))))
2878
2879 (defun replace-buffer-in-windows (&optional buffer-or-name)
2880 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
2881 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2882 and defaults to the current buffer.
2883
2884 When a window showing BUFFER-OR-NAME is either dedicated, or the
2885 window has no previous buffer, that window is deleted. If that
2886 window is the only window on its frame, the frame is deleted too
2887 when there are other frames left. If there are no other frames
2888 left, some other buffer is displayed in that window.
2889
2890 This function removes the buffer denoted by BUFFER-OR-NAME from
2891 all window-local buffer lists."
2892 (let ((buffer (window-normalize-buffer buffer-or-name)))
2893 (dolist (window (window-list-1 nil nil t))
2894 (if (eq (window-buffer window) buffer)
2895 (let ((deletable (window-deletable-p window)))
2896 (cond
2897 ((eq deletable 'frame)
2898 ;; Delete frame.
2899 (delete-frame (window-frame window)))
2900 ((and (window-dedicated-p window) deletable)
2901 ;; Delete window.
2902 (delete-window window))
2903 (t
2904 ;; Switch to another buffer in window.
2905 (set-window-dedicated-p window nil)
2906 (switch-to-prev-buffer window 'kill))))
2907 ;; Unrecord BUFFER in WINDOW.
2908 (unrecord-window-buffer window buffer)))))
2909
2910 (defun quit-window (&optional kill window)
2911 "Quit WINDOW and bury its buffer.
2912 WINDOW defaults to the selected window.
2913 With a prefix argument, kill the buffer instead.
2914
2915 According to information stored in WINDOW's `quit-restore' window
2916 parameter either \(1) delete WINDOW and its frame, \(2) delete
2917 WINDOW, \(3) restore the buffer previously displayed in WINDOW,
2918 or \(4) make WINDOW display some other buffer than the present
2919 one. If non-nil, reset `quit-restore' parameter to nil."
2920 (interactive "P")
2921 (setq window (window-normalize-live-window window))
2922 (let ((buffer (window-buffer window))
2923 (quit-restore (window-parameter window 'quit-restore))
2924 deletable resize)
2925 (cond
2926 ((and (or (and (memq (car-safe quit-restore) '(new-window new-frame))
2927 ;; Check that WINDOW's buffer is still the same.
2928 (eq (window-buffer window) (nth 1 quit-restore)))
2929 (window-dedicated-p window))
2930 (setq deletable (window-deletable-p window)))
2931 ;; Check if WINDOW's frame can be deleted.
2932 (if (eq deletable 'frame)
2933 (delete-frame (window-frame window))
2934 (delete-window window))
2935 ;; If the previously selected window is still alive, select it.
2936 (when (window-live-p (nth 2 quit-restore))
2937 (select-window (nth 2 quit-restore))))
2938 ((and (buffer-live-p (nth 0 quit-restore))
2939 ;; The buffer currently shown in WINDOW must still be the
2940 ;; buffer shown when its `quit-restore' parameter was created
2941 ;; in the first place.
2942 (eq (window-buffer window) (nth 3 quit-restore)))
2943 (setq resize (with-current-buffer buffer temp-buffer-resize-mode))
2944 (unrecord-window-buffer window buffer)
2945 ;; Display buffer stored in the quit-restore parameter.
2946 (set-window-dedicated-p window nil)
2947 (set-window-buffer window (nth 0 quit-restore))
2948 (set-window-start window (nth 1 quit-restore))
2949 (set-window-point window (nth 2 quit-restore))
2950 (and resize
2951 (/= (nth 4 quit-restore) (window-total-size window))
2952 (window-resize window
2953 (- (nth 4 quit-restore)
2954 (window-total-size window))))
2955 ;; Reset the quit-restore parameter.
2956 (set-window-parameter window 'quit-restore nil)
2957 (when (window-live-p (nth 5 quit-restore))
2958 (select-window (nth 5 quit-restore))))
2959 (t
2960 ;; Otherwise, show another buffer in WINDOW and reset the
2961 ;; quit-restore parameter.
2962 (set-window-parameter window 'quit-restore nil)
2963 (switch-to-prev-buffer window 'bury-or-kill)))
2964
2965 ;; Kill WINDOW's old-buffer if requested
2966 (if kill
2967 (kill-buffer buffer)
2968 (bury-buffer-internal buffer))))
2969 \f
2970 ;;; Splitting windows.
2971 (defsubst window-split-min-size (&optional horizontal)
2972 "Return minimum height of any window when splitting windows.
2973 Optional argument HORIZONTAL non-nil means return minimum width."
2974 (if horizontal
2975 (max window-min-width window-safe-min-width)
2976 (max window-min-height window-safe-min-height)))
2977
2978 (defun split-window (&optional window size side)
2979 "Make a new window adjacent to WINDOW.
2980 WINDOW can be any window and defaults to the selected one.
2981 Return the new window which is always a live window.
2982
2983 Optional argument SIZE a positive number means make WINDOW SIZE
2984 lines or columns tall. If SIZE is negative, make the new window
2985 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
2986 absolute value can be less than `window-min-height' or
2987 `window-min-width'; so this command can make a new window as
2988 small as one line or two columns. SIZE defaults to half of
2989 WINDOW's size. Interactively, SIZE is the prefix argument.
2990
2991 Optional third argument SIDE nil (or `below') specifies that the
2992 new window shall be located below WINDOW. SIDE `above' means the
2993 new window shall be located above WINDOW. In both cases SIZE
2994 specifies the new number of lines for WINDOW \(or the new window
2995 if SIZE is negative) including space reserved for the mode and/or
2996 header line.
2997
2998 SIDE t (or `right') specifies that the new window shall be
2999 located on the right side of WINDOW. SIDE `left' means the new
3000 window shall be located on the left of WINDOW. In both cases
3001 SIZE specifies the new number of columns for WINDOW \(or the new
3002 window provided SIZE is negative) including space reserved for
3003 fringes and the scrollbar or a divider column. Any other non-nil
3004 value for SIDE is currently handled like t (or `right').
3005
3006 If the variable `ignore-window-parameters' is non-nil or the
3007 `split-window' parameter of WINDOW equals t, do not process any
3008 parameters of WINDOW. Otherwise, if the `split-window' parameter
3009 of WINDOW specifies a function, call that function with all three
3010 arguments and return the value returned by that function.
3011
3012 Otherwise, if WINDOW is part of an atomic window, \"split\" the
3013 root of that atomic window. The new window does not become a
3014 member of that atomic window.
3015
3016 If WINDOW is live, properties of the new window like margins and
3017 scrollbars are inherited from WINDOW. If WINDOW is an internal
3018 window, these properties as well as the buffer displayed in the
3019 new window are inherited from the window selected on WINDOW's
3020 frame. The selected window is not changed by this function."
3021 (interactive "i")
3022 (setq window (window-normalize-any-window window))
3023 (let* ((side (cond
3024 ((not side) 'below)
3025 ((memq side '(below above right left)) side)
3026 (t 'right)))
3027 (horizontal (not (memq side '(nil below above))))
3028 (frame (window-frame window))
3029 (parent (window-parent window))
3030 (function (window-parameter window 'split-window))
3031 (window-side (window-parameter window 'window-side))
3032 ;; Rebind `window-nest' since in some cases we may have to
3033 ;; override its value.
3034 (window-nest window-nest)
3035 atom-root)
3036
3037 (window-check frame)
3038 (catch 'done
3039 (cond
3040 ;; Ignore window parameters if either `ignore-window-parameters'
3041 ;; is t or the `split-window' parameter equals t.
3042 ((or ignore-window-parameters (eq function t)))
3043 ((functionp function)
3044 ;; The `split-window' parameter specifies the function to call.
3045 ;; If that function is `ignore', do nothing.
3046 (throw 'done (funcall function window size side)))
3047 ;; If WINDOW is a subwindow of an atomic window, split the root
3048 ;; window of that atomic window instead.
3049 ((and (window-parameter window 'window-atom)
3050 (setq atom-root (window-atom-root window))
3051 (not (eq atom-root window)))
3052 (throw 'done (split-window atom-root size side))))
3053
3054 (when (and window-side
3055 (or (not parent)
3056 (not (window-parameter parent 'window-side))))
3057 ;; WINDOW is a side root window. To make sure that a new parent
3058 ;; window gets created set `window-nest' to t.
3059 (setq window-nest t))
3060
3061 (when (and window-splits size (> size 0))
3062 ;; If `window-splits' is non-nil and SIZE is a non-negative
3063 ;; integer, we cannot reasonably resize other windows. Rather
3064 ;; bind `window-nest' to t to make sure that subsequent window
3065 ;; deletions are handled correctly.
3066 (setq window-nest t))
3067
3068 (let* ((parent-size
3069 ;; `parent-size' is the size of WINDOW's parent, provided
3070 ;; it has one.
3071 (when parent (window-total-size parent horizontal)))
3072 ;; `resize' non-nil means we are supposed to resize other
3073 ;; windows in WINDOW's combination.
3074 (resize
3075 (and window-splits (not window-nest)
3076 ;; Resize makes sense in iso-combinations only.
3077 (window-iso-combined-p window horizontal)))
3078 ;; `old-size' is the current size of WINDOW.
3079 (old-size (window-total-size window horizontal))
3080 ;; `new-size' is the specified or calculated size of the
3081 ;; new window.
3082 (new-size
3083 (cond
3084 ((not size)
3085 (max (window-split-min-size horizontal)
3086 (if resize
3087 ;; When resizing try to give the new window the
3088 ;; average size of a window in its combination.
3089 (min (- parent-size
3090 (window-min-size parent horizontal))
3091 (/ parent-size
3092 (1+ (window-iso-combinations
3093 parent horizontal))))
3094 ;; Else try to give the new window half the size
3095 ;; of WINDOW (plus an eventual odd line).
3096 (+ (/ old-size 2) (% old-size 2)))))
3097 ((>= size 0)
3098 ;; SIZE non-negative specifies the new size of WINDOW.
3099
3100 ;; Note: Specifying a non-negative SIZE is practically
3101 ;; always done as workaround for making the new window
3102 ;; appear above or on the left of the new window (the
3103 ;; ispell window is a typical example of that). In all
3104 ;; these cases the SIDE argument should be set to 'above
3105 ;; or 'left in order to support the 'resize option.
3106 ;; Here we have to nest the windows instead, see above.
3107 (- old-size size))
3108 (t
3109 ;; SIZE negative specifies the size of the new window.
3110 (- size))))
3111 new-parent new-normal)
3112
3113 ;; Check SIZE.
3114 (cond
3115 ((not size)
3116 (cond
3117 (resize
3118 ;; SIZE unspecified, resizing.
3119 (when (and (not (window-sizable-p parent (- new-size) horizontal))
3120 ;; Try again with minimum split size.
3121 (setq new-size
3122 (max new-size (window-split-min-size horizontal)))
3123 (not (window-sizable-p parent (- new-size) horizontal)))
3124 (error "Window %s too small for splitting" parent)))
3125 ((> (+ new-size (window-min-size window horizontal)) old-size)
3126 ;; SIZE unspecified, no resizing.
3127 (error "Window %s too small for splitting" window))))
3128 ((and (>= size 0)
3129 (or (>= size old-size)
3130 (< new-size (if horizontal
3131 window-safe-min-width
3132 window-safe-min-width))))
3133 ;; SIZE specified as new size of old window. If the new size
3134 ;; is larger than the old size or the size of the new window
3135 ;; would be less than the safe minimum, signal an error.
3136 (error "Window %s too small for splitting" window))
3137 (resize
3138 ;; SIZE specified, resizing.
3139 (unless (window-sizable-p parent (- new-size) horizontal)
3140 ;; If we cannot resize the parent give up.
3141 (error "Window %s too small for splitting" parent)))
3142 ((or (< new-size
3143 (if horizontal window-safe-min-width window-safe-min-height))
3144 (< (- old-size new-size)
3145 (if horizontal window-safe-min-width window-safe-min-height)))
3146 ;; SIZE specification violates minimum size restrictions.
3147 (error "Window %s too small for splitting" window)))
3148
3149 (window--resize-reset frame horizontal)
3150
3151 (setq new-parent
3152 ;; Make new-parent non-nil if we need a new parent window;
3153 ;; either because we want to nest or because WINDOW is not
3154 ;; iso-combined.
3155 (or window-nest (not (window-iso-combined-p window horizontal))))
3156 (setq new-normal
3157 ;; Make new-normal the normal size of the new window.
3158 (cond
3159 (size (/ (float new-size) (if new-parent old-size parent-size)))
3160 (new-parent 0.5)
3161 (resize (/ 1.0 (1+ (window-iso-combinations parent horizontal))))
3162 (t (/ (window-normal-size window horizontal) 2.0))))
3163
3164 (if resize
3165 ;; Try to get space from OLD's siblings. We could go "up" and
3166 ;; try getting additional space from surrounding windows but
3167 ;; we won't be able to return space to those windows when we
3168 ;; delete the one we create here. Hence we do not go up.
3169 (progn
3170 (window--resize-subwindows parent (- new-size) horizontal)
3171 (let* ((normal (- 1.0 new-normal))
3172 (sub (window-child parent)))
3173 (while sub
3174 (set-window-new-normal
3175 sub (* (window-normal-size sub horizontal) normal))
3176 (setq sub (window-right sub)))))
3177 ;; Get entire space from WINDOW.
3178 (set-window-new-total window (- old-size new-size))
3179 (window--resize-this-window window (- new-size) horizontal)
3180 (set-window-new-normal
3181 window (- (if new-parent 1.0 (window-normal-size window horizontal))
3182 new-normal)))
3183
3184 (let* ((new (split-window-internal window new-size side new-normal)))
3185 ;; Inherit window-side parameters, if any.
3186 (when (and window-side new-parent)
3187 (set-window-parameter (window-parent new) 'window-side window-side)
3188 (set-window-parameter new 'window-side window-side))
3189
3190 (run-window-configuration-change-hook frame)
3191 (window-check frame)
3192 ;; Always return the new window.
3193 new)))))
3194
3195 ;; I think this should be the default; I think people will prefer it--rms.
3196 (defcustom split-window-keep-point t
3197 "If non-nil, \\[split-window-above-each-other] keeps the original point \
3198 in both children.
3199 This is often more convenient for editing.
3200 If nil, adjust point in each of the two windows to minimize redisplay.
3201 This is convenient on slow terminals, but point can move strangely.
3202
3203 This option applies only to `split-window-above-each-other' and
3204 functions that call it. `split-window' always keeps the original
3205 point in both children."
3206 :type 'boolean
3207 :group 'windows)
3208
3209 (defun split-window-above-each-other (&optional size)
3210 "Split selected window into two windows, one above the other.
3211 The upper window gets SIZE lines and the lower one gets the rest.
3212 SIZE negative means the lower window gets -SIZE lines and the
3213 upper one the rest. With no argument, split windows equally or
3214 close to it. Both windows display the same buffer, now current.
3215
3216 If the variable `split-window-keep-point' is non-nil, both new
3217 windows will get the same value of point as the selected window.
3218 This is often more convenient for editing. The upper window is
3219 the selected window.
3220
3221 Otherwise, we choose window starts so as to minimize the amount of
3222 redisplay; this is convenient on slow terminals. The new selected
3223 window is the one that the current value of point appears in. The
3224 value of point can change if the text around point is hidden by the
3225 new mode line.
3226
3227 Regardless of the value of `split-window-keep-point', the upper
3228 window is the original one and the return value is the new, lower
3229 window."
3230 (interactive "P")
3231 (let ((old-window (selected-window))
3232 (old-point (point))
3233 (size (and size (prefix-numeric-value size)))
3234 moved-by-window-height moved new-window bottom)
3235 (when (and size (< size 0) (< (- size) window-min-height))
3236 ;; `split-window' would not signal an error here.
3237 (error "Size of new window too small"))
3238 (setq new-window (split-window nil size))
3239 (unless split-window-keep-point
3240 (with-current-buffer (window-buffer)
3241 (goto-char (window-start))
3242 (setq moved (vertical-motion (window-height)))
3243 (set-window-start new-window (point))
3244 (when (> (point) (window-point new-window))
3245 (set-window-point new-window (point)))
3246 (when (= moved (window-height))
3247 (setq moved-by-window-height t)
3248 (vertical-motion -1))
3249 (setq bottom (point)))
3250 (and moved-by-window-height
3251 (<= bottom (point))
3252 (set-window-point old-window (1- bottom)))
3253 (and moved-by-window-height
3254 (<= (window-start new-window) old-point)
3255 (set-window-point new-window old-point)
3256 (select-window new-window)))
3257 ;; Always copy quit-restore parameter in interactive use.
3258 (let ((quit-restore (window-parameter old-window 'quit-restore)))
3259 (when quit-restore
3260 (set-window-parameter new-window 'quit-restore quit-restore)))
3261 new-window))
3262
3263 (defalias 'split-window-vertically 'split-window-above-each-other)
3264
3265 (defun split-window-side-by-side (&optional size)
3266 "Split selected window into two windows side by side.
3267 The selected window becomes the left one and gets SIZE columns.
3268 SIZE negative means the right window gets -SIZE columns.
3269
3270 SIZE includes the width of the window's scroll bar; if there are
3271 no scroll bars, it includes the width of the divider column to
3272 the window's right, if any. SIZE omitted or nil means split
3273 window equally.
3274
3275 The selected window remains selected. Return the new window."
3276 (interactive "P")
3277 (let ((old-window (selected-window))
3278 (size (and size (prefix-numeric-value size)))
3279 new-window)
3280 (when (and size (< size 0) (< (- size) window-min-width))
3281 ;; `split-window' would not signal an error here.
3282 (error "Size of new window too small"))
3283 (setq new-window (split-window nil size t))
3284 ;; Always copy quit-restore parameter in interactive use.
3285 (let ((quit-restore (window-parameter old-window 'quit-restore)))
3286 (when quit-restore
3287 (set-window-parameter new-window 'quit-restore quit-restore)))
3288 new-window))
3289
3290 (defalias 'split-window-horizontally 'split-window-side-by-side)
3291 \f
3292 ;;; Balancing windows.
3293
3294 ;; The following routine uses the recycled code from an old version of
3295 ;; `window--resize-subwindows'. It's not very pretty, but coding it the way the
3296 ;; new `window--resize-subwindows' code does would hardly make it any shorter or
3297 ;; more readable (FWIW we'd need three loops - one to calculate the
3298 ;; minimum sizes per window, one to enlarge or shrink windows until the
3299 ;; new parent-size matches, and one where we shrink the largest/enlarge
3300 ;; the smallest window).
3301 (defun balance-windows-2 (window horizontal)
3302 "Subroutine of `balance-windows-1'.
3303 WINDOW must be an iso-combination."
3304 (let* ((first (window-child window))
3305 (sub first)
3306 (number-of-children 0)
3307 (parent-size (window-new-total window))
3308 (total-sum parent-size)
3309 found failed size sub-total sub-delta sub-amount rest)
3310 (while sub
3311 (setq number-of-children (1+ number-of-children))
3312 (when (window-size-fixed-p sub horizontal)
3313 (setq total-sum
3314 (- total-sum (window-total-size sub horizontal)))
3315 (set-window-new-normal sub 'ignore))
3316 (setq sub (window-right sub)))
3317
3318 (setq failed t)
3319 (while (and failed (> number-of-children 0))
3320 (setq size (/ total-sum number-of-children))
3321 (setq failed nil)
3322 (setq sub first)
3323 (while (and sub (not failed))
3324 ;; Ignore subwindows that should be ignored or are stuck.
3325 (unless (window--resize-subwindows-skip-p sub)
3326 (setq found t)
3327 (setq sub-total (window-total-size sub horizontal))
3328 (setq sub-delta (- size sub-total))
3329 (setq sub-amount
3330 (window-sizable sub sub-delta horizontal))
3331 ;; Register the new total size for this subwindow.
3332 (set-window-new-total sub (+ sub-total sub-amount))
3333 (unless (= sub-amount sub-delta)
3334 (setq total-sum (- total-sum sub-total sub-amount))
3335 (setq number-of-children (1- number-of-children))
3336 ;; We failed and need a new round.
3337 (setq failed t)
3338 (set-window-new-normal sub 'skip)))
3339 (setq sub (window-right sub))))
3340
3341 (setq rest (% total-sum number-of-children))
3342 ;; Fix rounding by trying to enlarge non-stuck windows by one line
3343 ;; (column) until `rest' is zero.
3344 (setq sub first)
3345 (while (and sub (> rest 0))
3346 (unless (window--resize-subwindows-skip-p window)
3347 (set-window-new-total sub 1 t)
3348 (setq rest (1- rest)))
3349 (setq sub (window-right sub)))
3350
3351 ;; Fix rounding by trying to enlarge stuck windows by one line
3352 ;; (column) until `rest' equals zero.
3353 (setq sub first)
3354 (while (and sub (> rest 0))
3355 (unless (eq (window-new-normal sub) 'ignore)
3356 (set-window-new-total sub 1 t)
3357 (setq rest (1- rest)))
3358 (setq sub (window-right sub)))
3359
3360 (setq sub first)
3361 (while sub
3362 ;; Record new normal sizes.
3363 (set-window-new-normal
3364 sub (/ (if (eq (window-new-normal sub) 'ignore)
3365 (window-total-size sub horizontal)
3366 (window-new-total sub))
3367 (float parent-size)))
3368 ;; Recursively balance each subwindow's subwindows.
3369 (balance-windows-1 sub horizontal)
3370 (setq sub (window-right sub)))))
3371
3372 (defun balance-windows-1 (window &optional horizontal)
3373 "Subroutine of `balance-windows'."
3374 (if (window-child window)
3375 (let ((sub (window-child window)))
3376 (if (window-iso-combined-p sub horizontal)
3377 (balance-windows-2 window horizontal)
3378 (let ((size (window-new-total window)))
3379 (while sub
3380 (set-window-new-total sub size)
3381 (balance-windows-1 sub horizontal)
3382 (setq sub (window-right sub))))))))
3383
3384 (defun balance-windows (&optional window-or-frame)
3385 "Balance the sizes of subwindows of WINDOW-OR-FRAME.
3386 WINDOW-OR-FRAME is optional and defaults to the selected frame.
3387 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
3388 subwindows of that frame's root window. If WINDOW-OR-FRAME
3389 denots a window, balance the sizes of all subwindows of that
3390 window."
3391 (interactive)
3392 (let* ((window
3393 (cond
3394 ((or (not window-or-frame)
3395 (frame-live-p window-or-frame))
3396 (frame-root-window window-or-frame))
3397 ((or (window-live-p window-or-frame)
3398 (window-child window-or-frame))
3399 window-or-frame)
3400 (t
3401 (error "Not a window or frame %s" window-or-frame))))
3402 (frame (window-frame window)))
3403 ;; Balance vertically.
3404 (window--resize-reset (window-frame window))
3405 (balance-windows-1 window)
3406 (window-resize-apply frame)
3407 ;; Balance horizontally.
3408 (window--resize-reset (window-frame window) t)
3409 (balance-windows-1 window t)
3410 (window-resize-apply frame t)))
3411
3412 (defun window-fixed-size-p (&optional window direction)
3413 "Return t if WINDOW cannot be resized in DIRECTION.
3414 WINDOW defaults to the selected window. DIRECTION can be
3415 nil (i.e. any), `height' or `width'."
3416 (with-current-buffer (window-buffer window)
3417 (when (and (boundp 'window-size-fixed) window-size-fixed)
3418 (not (and direction
3419 (member (cons direction window-size-fixed)
3420 '((height . width) (width . height))))))))
3421
3422 ;;; A different solution to balance-windows.
3423 (defvar window-area-factor 1
3424 "Factor by which the window area should be over-estimated.
3425 This is used by `balance-windows-area'.
3426 Changing this globally has no effect.")
3427 (make-variable-buffer-local 'window-area-factor)
3428
3429 (defun balance-windows-area-adjust (window delta horizontal)
3430 "Wrapper around `window-resize' with error checking.
3431 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
3432 ;; `window-resize' may fail if delta is too large.
3433 (while (>= (abs delta) 1)
3434 (condition-case nil
3435 (progn
3436 (window-resize window delta horizontal)
3437 (setq delta 0))
3438 (error
3439 ;;(message "adjust: %s" (error-message-string err))
3440 (setq delta (/ delta 2))))))
3441
3442 (defun balance-windows-area ()
3443 "Make all visible windows the same area (approximately).
3444 See also `window-area-factor' to change the relative size of
3445 specific buffers."
3446 (interactive)
3447 (let* ((unchanged 0) (carry 0) (round 0)
3448 ;; Remove fixed-size windows.
3449 (wins (delq nil (mapcar (lambda (win)
3450 (if (not (window-fixed-size-p win)) win))
3451 (window-list nil 'nomini))))
3452 (changelog nil)
3453 next)
3454 ;; Resizing a window changes the size of surrounding windows in complex
3455 ;; ways, so it's difficult to balance them all. The introduction of
3456 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
3457 ;; very difficult to do. `balance-window' above takes an off-line
3458 ;; approach: get the whole window tree, then balance it, then try to
3459 ;; adjust the windows so they fit the result.
3460 ;; Here, instead, we take a "local optimization" approach, where we just
3461 ;; go through all the windows several times until nothing needs to be
3462 ;; changed. The main problem with this approach is that it's difficult
3463 ;; to make sure it terminates, so we use some heuristic to try and break
3464 ;; off infinite loops.
3465 ;; After a round without any change, we allow a second, to give a chance
3466 ;; to the carry to propagate a minor imbalance from the end back to
3467 ;; the beginning.
3468 (while (< unchanged 2)
3469 ;; (message "New round")
3470 (setq unchanged (1+ unchanged) round (1+ round))
3471 (dolist (win wins)
3472 (setq next win)
3473 (while (progn (setq next (next-window next))
3474 (window-fixed-size-p next)))
3475 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
3476 (let* ((horiz
3477 (< (car (window-edges win)) (car (window-edges next))))
3478 (areadiff (/ (- (* (window-height next) (window-width next)
3479 (buffer-local-value 'window-area-factor
3480 (window-buffer next)))
3481 (* (window-height win) (window-width win)
3482 (buffer-local-value 'window-area-factor
3483 (window-buffer win))))
3484 (max (buffer-local-value 'window-area-factor
3485 (window-buffer win))
3486 (buffer-local-value 'window-area-factor
3487 (window-buffer next)))))
3488 (edgesize (if horiz
3489 (+ (window-height win) (window-height next))
3490 (+ (window-width win) (window-width next))))
3491 (diff (/ areadiff edgesize)))
3492 (when (zerop diff)
3493 ;; Maybe diff is actually closer to 1 than to 0.
3494 (setq diff (/ (* 3 areadiff) (* 2 edgesize))))
3495 (when (and (zerop diff) (not (zerop areadiff)))
3496 (setq diff (/ (+ areadiff carry) edgesize))
3497 ;; Change things smoothly.
3498 (if (or (> diff 1) (< diff -1)) (setq diff (/ diff 2))))
3499 (if (zerop diff)
3500 ;; Make sure negligible differences don't accumulate to
3501 ;; become significant.
3502 (setq carry (+ carry areadiff))
3503 ;; This used `adjust-window-trailing-edge' before and uses
3504 ;; `window-resize' now. Error wrapping is still needed.
3505 (balance-windows-area-adjust win diff horiz)
3506 ;; (sit-for 0.5)
3507 (let ((change (cons win (window-edges win))))
3508 ;; If the same change has been seen already for this window,
3509 ;; we're most likely in an endless loop, so don't count it as
3510 ;; a change.
3511 (unless (member change changelog)
3512 (push change changelog)
3513 (setq unchanged 0 carry 0)))))))
3514 ;; We've now basically balanced all the windows.
3515 ;; But there may be some minor off-by-one imbalance left over,
3516 ;; so let's do some fine tuning.
3517 ;; (bw-finetune wins)
3518 ;; (message "Done in %d rounds" round)
3519 ))
3520
3521 ;;; Window states, how to get them and how to put them in a window.
3522 (defsubst window-list-no-nils (&rest args)
3523 "Like LIST but do not add nil elements of ARGS."
3524 (delq nil (apply 'list args)))
3525
3526 (defvar window-state-ignored-parameters '(quit-restore)
3527 "List of window parameters ignored by `window-state-get'.")
3528
3529 (defun window-state-get-1 (window &optional markers)
3530 "Helper function for `window-state-get'."
3531 (let* ((type
3532 (cond
3533 ((window-top-child window) 'vc)
3534 ((window-left-child window) 'hc)
3535 (t 'leaf)))
3536 (buffer (window-buffer window))
3537 (selected (eq window (selected-window)))
3538 (head
3539 (window-list-no-nils
3540 type
3541 (unless (window-next-sibling window) (cons 'last t))
3542 (cons 'total-height (window-total-size window))
3543 (cons 'total-width (window-total-size window t))
3544 (cons 'normal-height (window-normal-size window))
3545 (cons 'normal-width (window-normal-size window t))
3546 (cons 'splits (window-splits window))
3547 (cons 'nest (window-nest window))
3548 (let (list)
3549 (dolist (parameter (window-parameters window))
3550 (unless (memq (car parameter)
3551 window-state-ignored-parameters)
3552 (setq list (cons parameter list))))
3553 (unless (window-parameter window 'clone-of)
3554 ;; Make a clone-of parameter.
3555 (setq list (cons (cons 'clone-of window) list)))
3556 (when list
3557 (cons 'parameters list)))
3558 (when buffer
3559 ;; All buffer related things go in here - make the buffer
3560 ;; current when retrieving `point' and `mark'.
3561 (with-current-buffer (window-buffer window)
3562 (let ((point (if selected (point) (window-point window)))
3563 (start (window-start window))
3564 (mark (mark)))
3565 (window-list-no-nils
3566 'buffer (buffer-name buffer)
3567 (cons 'selected selected)
3568 (when window-size-fixed (cons 'size-fixed window-size-fixed))
3569 (cons 'hscroll (window-hscroll window))
3570 (cons 'fringes (window-fringes window))
3571 (cons 'margins (window-margins window))
3572 (cons 'scroll-bars (window-scroll-bars window))
3573 (cons 'vscroll (window-vscroll window))
3574 (cons 'dedicated (window-dedicated-p window))
3575 (cons 'point (if markers (copy-marker point) point))
3576 (cons 'start (if markers (copy-marker start) start))
3577 (when mark
3578 (cons 'mark (if markers (copy-marker mark) mark)))))))))
3579 (tail
3580 (when (memq type '(vc hc))
3581 (let (list)
3582 (setq window (window-child window))
3583 (while window
3584 (setq list (cons (window-state-get-1 window markers) list))
3585 (setq window (window-right window)))
3586 (nreverse list)))))
3587 (append head tail)))
3588
3589 (defun window-state-get (&optional window markers)
3590 "Return state of WINDOW as a Lisp object.
3591 WINDOW can be any window and defaults to the root window of the
3592 selected frame.
3593
3594 Optional argument MARKERS non-nil means use markers for sampling
3595 positions like `window-point' or `window-start'. MARKERS should
3596 be non-nil only if the value is used for putting the state back
3597 in the same session (note that markers slow down processing).
3598
3599 The return value can be used as argument for `window-state-put'
3600 to put the state recorded here into an arbitrary window. The
3601 value can be also stored on disk and read back in a new session."
3602 (setq window
3603 (if window
3604 (if (window-any-p window)
3605 window
3606 (error "%s is not a live or internal window" window))
3607 (frame-root-window)))
3608 ;; The return value is a cons whose car specifies some constraints on
3609 ;; the size of WINDOW. The cdr lists the states of the subwindows of
3610 ;; WINDOW.
3611 (cons
3612 ;; Frame related things would go into a function, say `frame-state',
3613 ;; calling `window-state-get' to insert the frame's root window.
3614 (window-list-no-nils
3615 (cons 'min-height (window-min-size window))
3616 (cons 'min-width (window-min-size window t))
3617 (cons 'min-height-ignore (window-min-size window nil t))
3618 (cons 'min-width-ignore (window-min-size window t t))
3619 (cons 'min-height-safe (window-min-size window nil 'safe))
3620 (cons 'min-width-safe (window-min-size window t 'safe))
3621 ;; These are probably not needed.
3622 (when (window-size-fixed-p window) (cons 'fixed-height t))
3623 (when (window-size-fixed-p window t) (cons 'fixed-width t)))
3624 (window-state-get-1 window markers)))
3625
3626 (defvar window-state-put-list nil
3627 "Helper variable for `window-state-put'.")
3628
3629 (defun window-state-put-1 (state &optional window ignore totals)
3630 "Helper function for `window-state-put'."
3631 (let ((type (car state)))
3632 (setq state (cdr state))
3633 (cond
3634 ((eq type 'leaf)
3635 ;; For a leaf window just add unprocessed entries to
3636 ;; `window-state-put-list'.
3637 (setq window-state-put-list
3638 (cons (cons window state) window-state-put-list)))
3639 ((memq type '(vc hc))
3640 (let* ((horizontal (eq type 'hc))
3641 (total (window-total-size window horizontal))
3642 (first t)
3643 size new)
3644 (dolist (item state)
3645 ;; Find the next child window. WINDOW always points to the
3646 ;; real window that we want to fill with what we find here.
3647 (when (memq (car item) '(leaf vc hc))
3648 (if (assq 'last item)
3649 ;; The last child window. Below `window-state-put-1'
3650 ;; will put into it whatever ITEM has in store.
3651 (setq new nil)
3652 ;; Not the last child window, prepare for splitting
3653 ;; WINDOW. SIZE is the new (and final) size of the old
3654 ;; window.
3655 (setq size
3656 (if totals
3657 ;; Use total size.
3658 (cdr (assq (if horizontal 'total-width 'total-height) item))
3659 ;; Use normalized size and round.
3660 (round (* total
3661 (cdr (assq
3662 (if horizontal 'normal-width 'normal-height)
3663 item))))))
3664
3665 ;; Use safe sizes, we try to resize later.
3666 (setq size (max size (if horizontal
3667 window-safe-min-height
3668 window-safe-min-width)))
3669
3670 (if (window-sizable-p window (- size) horizontal 'safe)
3671 (let* ((window-nest (assq 'nest item)))
3672 ;; We must inherit the nesting, otherwise we might mess
3673 ;; up handling of atomic and side window.
3674 (setq new (split-window window size horizontal)))
3675 ;; Give up if we can't resize window down to safe sizes.
3676 (error "Cannot resize window %s" window))
3677
3678 (when first
3679 (setq first nil)
3680 ;; When creating the first child window add for parent
3681 ;; unprocessed entries to `window-state-put-list'.
3682 (setq window-state-put-list
3683 (cons (cons (window-parent window) state)
3684 window-state-put-list))))
3685
3686 ;; Now process the current window (either the one we've just
3687 ;; split or the last child of its parent).
3688 (window-state-put-1 item window ignore totals)
3689 ;; Continue with the last window split off.
3690 (setq window new))))))))
3691
3692 (defun window-state-put-2 (ignore)
3693 "Helper function for `window-state-put'."
3694 (dolist (item window-state-put-list)
3695 (let ((window (car item))
3696 (splits (cdr (assq 'splits item)))
3697 (nest (cdr (assq 'nest item)))
3698 (parameters (cdr (assq 'parameters item)))
3699 (state (cdr (assq 'buffer item))))
3700 (when splits (set-window-splits window splits))
3701 (when nest (set-window-nest window nest))
3702 ;; Process parameters.
3703 (when parameters
3704 (dolist (parameter parameters)
3705 (set-window-parameter window (car parameter) (cdr parameter))))
3706 ;; Process buffer related state.
3707 (when state
3708 ;; We don't want to raise an error here so we create a buffer if
3709 ;; there's none.
3710 (set-window-buffer window (get-buffer-create (car state)))
3711 (with-current-buffer (window-buffer window)
3712 (set-window-hscroll window (cdr (assq 'hscroll state)))
3713 (apply 'set-window-fringes
3714 (cons window (cdr (assq 'fringes state))))
3715 (let ((margins (cdr (assq 'margins state))))
3716 (set-window-margins window (car margins) (cdr margins)))
3717 (let ((scroll-bars (cdr (assq 'scroll-bars state))))
3718 (set-window-scroll-bars
3719 window (car scroll-bars) (nth 2 scroll-bars) (nth 3 scroll-bars)))
3720 (set-window-vscroll window (cdr (assq 'vscroll state)))
3721 ;; Adjust vertically.
3722 (if (memq window-size-fixed '(t height))
3723 ;; A fixed height window, try to restore the original size.
3724 (let ((delta (- (cdr (assq 'total-height item))
3725 (window-total-height window)))
3726 window-size-fixed)
3727 (when (window-resizable-p window delta)
3728 (window-resize window delta)))
3729 ;; Else check whether the window is not high enough.
3730 (let* ((min-size (window-min-size window nil ignore))
3731 (delta (- min-size (window-total-size window))))
3732 (when (and (> delta 0)
3733 (window-resizable-p window delta nil ignore))
3734 (window-resize window delta nil ignore))))
3735 ;; Adjust horizontally.
3736 (if (memq window-size-fixed '(t width))
3737 ;; A fixed width window, try to restore the original size.
3738 (let ((delta (- (cdr (assq 'total-width item))
3739 (window-total-width window)))
3740 window-size-fixed)
3741 (when (window-resizable-p window delta)
3742 (window-resize window delta)))
3743 ;; Else check whether the window is not wide enough.
3744 (let* ((min-size (window-min-size window t ignore))
3745 (delta (- min-size (window-total-size window t))))
3746 (when (and (> delta 0)
3747 (window-resizable-p window delta t ignore))
3748 (window-resize window delta t ignore))))
3749 ;; Set dedicated status.
3750 (set-window-dedicated-p window (cdr (assq 'dedicated state)))
3751 ;; Install positions (maybe we should do this after all windows
3752 ;; have been created and sized).
3753 (ignore-errors
3754 (set-window-start window (cdr (assq 'start state)))
3755 (set-window-point window (cdr (assq 'point state)))
3756 ;; I'm not sure whether we should set the mark here, but maybe
3757 ;; it can be used.
3758 (let ((mark (cdr (assq 'mark state))))
3759 (when mark (set-mark mark))))
3760 ;; Select window if it's the selected one.
3761 (when (cdr (assq 'selected state))
3762 (select-window window)))))))
3763
3764 (defun window-state-put (state &optional window ignore)
3765 "Put window state STATE into WINDOW.
3766 STATE should be the state of a window returned by an earlier
3767 invocation of `window-state-get'. Optional argument WINDOW must
3768 specify a live window and defaults to the selected one.
3769
3770 Optional argument IGNORE non-nil means ignore minimum window
3771 sizes and fixed size restrictions. IGNORE equal `safe' means
3772 subwindows can get as small as `window-safe-min-height' and
3773 `window-safe-min-width'."
3774 (setq window (window-normalize-live-window window))
3775 (let* ((frame (window-frame window))
3776 (head (car state))
3777 ;; We check here (1) whether the total sizes of root window of
3778 ;; STATE and that of WINDOW are equal so we can avoid
3779 ;; calculating new sizes, and (2) if we do have to resize
3780 ;; whether we can do so without violating size restrictions.
3781 (totals
3782 (and (= (window-total-size window)
3783 (cdr (assq 'total-height state)))
3784 (= (window-total-size window t)
3785 (cdr (assq 'total-width state)))))
3786 (min-height (cdr (assq 'min-height head)))
3787 (min-width (cdr (assq 'min-width head)))
3788 window-splits selected)
3789 (if (and (not totals)
3790 (or (> min-height (window-total-size window))
3791 (> min-width (window-total-size window t)))
3792 (or (not ignore)
3793 (and (setq min-height
3794 (cdr (assq 'min-height-ignore head)))
3795 (setq min-width
3796 (cdr (assq 'min-width-ignore head)))
3797 (or (> min-height (window-total-size window))
3798 (> min-width (window-total-size window t)))
3799 (or (not (eq ignore 'safe))
3800 (and (setq min-height
3801 (cdr (assq 'min-height-safe head)))
3802 (setq min-width
3803 (cdr (assq 'min-width-safe head)))
3804 (or (> min-height
3805 (window-total-size window))
3806 (> min-width
3807 (window-total-size window t))))))))
3808 ;; The check above might not catch all errors due to rounding
3809 ;; issues - so IGNORE equal 'safe might not always produce the
3810 ;; minimum possible state. But such configurations hardly make
3811 ;; sense anyway.
3812 (error "Window %s too small to accomodate state" window)
3813 (setq state (cdr state))
3814 (setq window-state-put-list nil)
3815 ;; Work on the windows of a temporary buffer to make sure that
3816 ;; splitting proceeds regardless of any buffer local values of
3817 ;; `window-size-fixed'. Release that buffer after the buffers of
3818 ;; all live windows have been set by `window-state-put-2'.
3819 (with-temp-buffer
3820 (set-window-buffer window (current-buffer))
3821 (window-state-put-1 state window nil totals)
3822 (window-state-put-2 ignore))
3823 (window-check frame))))
3824 \f
3825 (defvar display-buffer-window nil
3826 "Window used by `display-buffer' and related information.
3827 After `display-buffer' displays a buffer in some window this
3828 variable is a cons cell whose car denotes the window used to
3829 display the buffer. The cdr is supposed to be one of the symbols
3830 `reuse-buffer-window', `reuse-other-window', `new-window' or
3831 `new-frame'.
3832
3833 See the function `display-buffer-record-window' for how this
3834 variable can be assigned a value.")
3835
3836 (defun display-buffer-record-window (type window buffer)
3837 "Record information for window used by `display-buffer'.
3838 TYPE must be one of the symbols reuse-window, pop-up-window, or
3839 pop-up-frame. WINDOW is the window used for or created by the
3840 `display-buffer' routines. BUFFER is the buffer that shall be
3841 displayed."
3842 (cond
3843 ((eq type 'reuse-window)
3844 ;; In `display-buffer-window' record whether we used a window on the
3845 ;; same buffer or another one.
3846 (if (eq (window-buffer window) buffer)
3847 (setq display-buffer-window
3848 (cons window 'reuse-buffer-window))
3849 (setq display-buffer-window
3850 (cons window 'reuse-other-window)))
3851 ;; In quit-restore parameter record information about the old buffer
3852 ;; unless such information exists already.
3853 (unless (window-parameter window 'quit-restore)
3854 (set-window-parameter
3855 window 'quit-restore
3856 (list (window-buffer window) (window-start window)
3857 (window-point window) buffer
3858 (window-total-size window) (selected-window)))))
3859 ((eq type 'pop-up-window)
3860 ;; In `display-buffer-window' record window as new.
3861 (setq display-buffer-window (cons window 'new-window))
3862 ;; In `quit-restore' parameter record that we popped up this window,
3863 ;; its buffer, and which window was selected before.
3864 (set-window-parameter
3865 window 'quit-restore (list 'new-window buffer (selected-window))))
3866 ((eq type 'pop-up-frame)
3867 ;; In `display-buffer-window' record window as on new frame.
3868 (setq display-buffer-window (cons window 'new-frame))
3869 ;; In `quit-restore' parameter record that we popped up this window
3870 ;; on a new frame, the buffer, and which window was selected before.
3871 (set-window-parameter
3872 window 'quit-restore (list 'new-frame buffer (selected-window))))))
3873
3874 (defcustom display-buffer-function nil
3875 "If non-nil, function to call to handle `display-buffer'.
3876 It will receive two args, the buffer and a flag which if non-nil
3877 means that the currently selected window is not acceptable. It
3878 should choose or create a window, display the specified buffer in
3879 it, and return the window.
3880
3881 The function specified here is responsible for setting the value
3882 of `display-buffer-window' and the quit-restore parameter of the
3883 window used."
3884 :type '(choice
3885 (const nil)
3886 (function :tag "function"))
3887 :group 'windows)
3888
3889 (defcustom pop-up-frame-alist nil
3890 "Alist of parameters for automatically generated new frames.
3891 You can set this in your init file; for example,
3892
3893 (setq pop-up-frame-alist '((width . 80) (height . 20)))
3894
3895 If non-nil, the value you specify here is used by the default
3896 `pop-up-frame-function' for the creation of new frames.
3897
3898 Since `pop-up-frame-function' is used by `display-buffer' for
3899 making new frames, any value specified here by default affects
3900 the automatic generation of new frames via `display-buffer' and
3901 all functions based on it. The behavior of `make-frame' is not
3902 affected by this variable."
3903 :type '(repeat (cons :format "%v"
3904 (symbol :tag "Parameter")
3905 (sexp :tag "Value")))
3906 :group 'frames)
3907
3908 (defcustom pop-up-frame-function
3909 (lambda () (make-frame pop-up-frame-alist))
3910 "Function used by `display-buffer' for creating a new frame.
3911 This function is called with no arguments and should return a new
3912 frame. The default value calls `make-frame' with the argument
3913 `pop-up-frame-alist'."
3914 :type 'function
3915 :group 'frames)
3916
3917 (defcustom special-display-buffer-names nil
3918 "List of names of buffers that should be displayed specially.
3919 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
3920 its name is in this list, displays the buffer in a way specified
3921 by `special-display-function'. `special-display-popup-frame'
3922 \(the default for `special-display-function') usually displays
3923 the buffer in a separate frame made with the parameters specified
3924 by `special-display-frame-alist'. If `special-display-function'
3925 has been set to some other function, that function is called with
3926 the buffer as first, and nil as second argument.
3927
3928 Alternatively, an element of this list can be specified as
3929 \(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
3930 name and FRAME-PARAMETERS an alist of \(PARAMETER . VALUE) pairs.
3931 `special-display-popup-frame' will interpret such pairs as frame
3932 parameters when it creates a special frame, overriding the
3933 corresponding values from `special-display-frame-alist'.
3934
3935 As a special case, if FRAME-PARAMETERS contains (same-window . t)
3936 `special-display-popup-frame' displays that buffer in the
3937 selected window. If FRAME-PARAMETERS contains (same-frame . t),
3938 it displays that buffer in a window on the selected frame.
3939
3940 If `special-display-function' specifies some other function than
3941 `special-display-popup-frame', that function is called with the
3942 buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
3943 argument.
3944
3945 Finally, an element of this list can be also specified as
3946 \(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
3947 `special-display-popup-frame' will call FUNCTION with the buffer
3948 named BUFFER-NAME as first argument, and OTHER-ARGS as the
3949 second. If `special-display-function' specifies some other
3950 function, that function is called with the buffer named
3951 BUFFER-NAME as first, and the element's cdr as second argument.
3952 In any case, that function is responsible for setting the value
3953 of `display-buffer-window' and the quit-restore parameter of the
3954 window used.
3955
3956 If this variable appears \"not to work\", because you added a
3957 name to it but the corresponding buffer is displayed in the
3958 selected window, look at the values of `same-window-buffer-names'
3959 and `same-window-regexps'. Those variables take precedence over
3960 this one.
3961
3962 See also `special-display-regexps'."
3963 :type '(repeat
3964 (choice :tag "Buffer"
3965 :value ""
3966 (string :format "%v")
3967 (cons :tag "With parameters"
3968 :format "%v"
3969 :value ("" . nil)
3970 (string :format "%v")
3971 (repeat :tag "Parameters"
3972 (cons :format "%v"
3973 (symbol :tag "Parameter")
3974 (sexp :tag "Value"))))
3975 (list :tag "With function"
3976 :format "%v"
3977 :value ("" . nil)
3978 (string :format "%v")
3979 (function :tag "Function")
3980 (repeat :tag "Arguments" (sexp)))))
3981 :group 'windows
3982 :group 'frames)
3983
3984 ;;;###autoload
3985 (put 'special-display-buffer-names 'risky-local-variable t)
3986
3987 (defcustom special-display-regexps nil
3988 "List of regexps saying which buffers should be displayed specially.
3989 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
3990 any regexp in this list matches its name, displays it specially
3991 using `special-display-function'. `special-display-popup-frame'
3992 \(the default for `special-display-function') usually displays
3993 the buffer in a separate frame made with the parameters specified
3994 by `special-display-frame-alist'. If `special-display-function'
3995 has been set to some other function, that function is called with
3996 the buffer as first, and nil as second argument.
3997
3998 Alternatively, an element of this list can be specified as
3999 \(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
4000 FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
4001 `special-display-popup-frame' will then interpret these pairs as
4002 frame parameters when creating a special frame for a buffer whose
4003 name matches REGEXP, overriding the corresponding values from
4004 `special-display-frame-alist'.
4005
4006 As a special case, if FRAME-PARAMETERS contains (same-window . t)
4007 `special-display-popup-frame' displays buffers matching REGEXP in
4008 the selected window. \(same-frame . t) in FRAME-PARAMETERS means
4009 to display such buffers in a window on the selected frame.
4010
4011 If `special-display-function' specifies some other function than
4012 `special-display-popup-frame', that function is called with the
4013 buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
4014 as second argument.
4015
4016 Finally, an element of this list can be also specified as
4017 \(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
4018 will then call FUNCTION with the buffer whose name matched
4019 REGEXP as first, and OTHER-ARGS as second argument. If
4020 `special-display-function' specifies some other function, that
4021 function is called with the buffer whose name matched REGEXP
4022 as first, and the element's cdr as second argument.
4023
4024 If this variable appears \"not to work\", because you added a
4025 name to it but the corresponding buffer is displayed in the
4026 selected window, look at the values of `same-window-buffer-names'
4027 and `same-window-regexps'. Those variables take precedence over
4028 this one.
4029
4030 See also `special-display-buffer-names'."
4031 :type '(repeat
4032 (choice :tag "Buffer"
4033 :value ""
4034 (regexp :format "%v")
4035 (cons :tag "With parameters"
4036 :format "%v"
4037 :value ("" . nil)
4038 (regexp :format "%v")
4039 (repeat :tag "Parameters"
4040 (cons :format "%v"
4041 (symbol :tag "Parameter")
4042 (sexp :tag "Value"))))
4043 (list :tag "With function"
4044 :format "%v"
4045 :value ("" . nil)
4046 (regexp :format "%v")
4047 (function :tag "Function")
4048 (repeat :tag "Arguments" (sexp)))))
4049 :group 'windows
4050 :group 'frames)
4051
4052 (defun special-display-p (buffer-name)
4053 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
4054 More precisely, return t if `special-display-buffer-names' or
4055 `special-display-regexps' contain a string entry equaling or
4056 matching BUFFER-NAME. If `special-display-buffer-names' or
4057 `special-display-regexps' contain a list entry whose car equals
4058 or matches BUFFER-NAME, the return value is the cdr of that
4059 entry."
4060 (let (tmp)
4061 (cond
4062 ((not (stringp buffer-name)))
4063 ((member buffer-name special-display-buffer-names)
4064 t)
4065 ((setq tmp (assoc buffer-name special-display-buffer-names))
4066 (cdr tmp))
4067 ((catch 'found
4068 (dolist (regexp special-display-regexps)
4069 (cond
4070 ((stringp regexp)
4071 (when (string-match-p regexp buffer-name)
4072 (throw 'found t)))
4073 ((and (consp regexp) (stringp (car regexp))
4074 (string-match-p (car regexp) buffer-name))
4075 (throw 'found (cdr regexp))))))))))
4076
4077 (defcustom special-display-frame-alist
4078 '((height . 14) (width . 80) (unsplittable . t))
4079 "Alist of parameters for special frames.
4080 Special frames are used for buffers whose names are listed in
4081 `special-display-buffer-names' and for buffers whose names match
4082 one of the regular expressions in `special-display-regexps'.
4083
4084 This variable can be set in your init file, like this:
4085
4086 (setq special-display-frame-alist '((width . 80) (height . 20)))
4087
4088 These supersede the values given in `default-frame-alist'."
4089 :type '(repeat (cons :format "%v"
4090 (symbol :tag "Parameter")
4091 (sexp :tag "Value")))
4092 :group 'frames)
4093
4094 (defun special-display-popup-frame (buffer &optional args)
4095 "Display BUFFER and return the window chosen.
4096 If BUFFER is already displayed in a visible or iconified frame,
4097 raise that frame. Otherwise, display BUFFER in a new frame.
4098
4099 Optional argument ARGS is a list specifying additional
4100 information.
4101
4102 If ARGS is an alist, use it as a list of frame parameters. If
4103 these parameters contain \(same-window . t), display BUFFER in
4104 the selected window. If they contain \(same-frame . t), display
4105 BUFFER in a window of the selected frame.
4106
4107 If ARGS is a list whose car is a symbol, use (car ARGS) as a
4108 function to do the work. Pass it BUFFER as first argument,
4109 and (cdr ARGS) as second."
4110 (if (and args (symbolp (car args)))
4111 (apply (car args) buffer (cdr args))
4112 (let ((window (get-buffer-window buffer 0)))
4113 (or
4114 ;; If we have a window already, make it visible.
4115 (when window
4116 (let ((frame (window-frame window)))
4117 (make-frame-visible frame)
4118 (raise-frame frame)
4119 (display-buffer-record-window 'reuse-window window buffer)
4120 window))
4121 ;; Reuse the current window if the user requested it.
4122 (when (cdr (assq 'same-window args))
4123 (condition-case nil
4124 (progn (switch-to-buffer buffer nil t) (selected-window))
4125 (error nil)))
4126 ;; Stay on the same frame if requested.
4127 (when (or (cdr (assq 'same-frame args)) (cdr (assq 'same-window args)))
4128 (let* ((pop-up-windows t)
4129 pop-up-frames
4130 special-display-buffer-names special-display-regexps)
4131 (display-buffer buffer)))
4132 ;; If no window yet, make one in a new frame.
4133 (let ((frame
4134 (with-current-buffer buffer
4135 (make-frame (append args special-display-frame-alist)))))
4136 (display-buffer-record-window
4137 'pop-up-frame (frame-selected-window frame) buffer)
4138 (set-window-buffer (frame-selected-window frame) buffer)
4139 (set-window-dedicated-p (frame-selected-window frame) t)
4140 (frame-selected-window frame))))))
4141
4142 (defcustom special-display-function 'special-display-popup-frame
4143 "Function to call for displaying special buffers.
4144 This function is called with two arguments - the buffer and,
4145 optionally, a list - and should return a window displaying that
4146 buffer. The default value usually makes a separate frame for the
4147 buffer using `special-display-frame-alist' to specify the frame
4148 parameters. See the definition of `special-display-popup-frame'
4149 for how to specify such a function.
4150
4151 A buffer is special when its name is either listed in
4152 `special-display-buffer-names' or matches a regexp in
4153 `special-display-regexps'.
4154
4155 The function specified here is responsible for setting the value
4156 of `display-buffer-window' and the quit-restore parameter of the
4157 window used."
4158 :type 'function
4159 :group 'frames)
4160
4161 (defcustom same-window-buffer-names nil
4162 "List of names of buffers that should appear in the \"same\" window.
4163 `display-buffer' and `pop-to-buffer' show a buffer whose name is
4164 on this list in the selected rather than some other window.
4165
4166 An element of this list can be a cons cell instead of just a
4167 string. In that case, the cell's car must be a string specifying
4168 the buffer name. This is for compatibility with
4169 `special-display-buffer-names'; the cdr of the cons cell is
4170 ignored.
4171
4172 See also `same-window-regexps'."
4173 :type '(repeat (string :format "%v"))
4174 :group 'windows)
4175
4176 (defcustom same-window-regexps nil
4177 "List of regexps saying which buffers should appear in the \"same\" window.
4178 `display-buffer' and `pop-to-buffer' show a buffer whose name
4179 matches a regexp on this list in the selected rather than some
4180 other window.
4181
4182 An element of this list can be a cons cell instead of just a
4183 string. In that case, the cell's car must be a regexp matching
4184 the buffer name. This is for compatibility with
4185 `special-display-regexps'; the cdr of the cons cell is ignored.
4186
4187 See also `same-window-buffer-names'."
4188 :type '(repeat (regexp :format "%v"))
4189 :group 'windows)
4190
4191 (defun same-window-p (buffer-name)
4192 "Return non-nil if a buffer named BUFFER-NAME would be shown in the \"same\" window.
4193 This function returns non-nil if `display-buffer' or
4194 `pop-to-buffer' would show a buffer named BUFFER-NAME in the
4195 selected rather than \(as usual\) some other window. See
4196 `same-window-buffer-names' and `same-window-regexps'."
4197 (cond
4198 ((not (stringp buffer-name)))
4199 ;; The elements of `same-window-buffer-names' can be buffer
4200 ;; names or cons cells whose cars are buffer names.
4201 ((member buffer-name same-window-buffer-names))
4202 ((assoc buffer-name same-window-buffer-names))
4203 ((catch 'found
4204 (dolist (regexp same-window-regexps)
4205 ;; The elements of `same-window-regexps' can be regexps
4206 ;; or cons cells whose cars are regexps.
4207 (when (or (and (stringp regexp)
4208 (string-match regexp buffer-name))
4209 (and (consp regexp) (stringp (car regexp))
4210 (string-match-p (car regexp) buffer-name)))
4211 (throw 'found t)))))))
4212
4213 (defcustom pop-up-frames nil
4214 "Whether `display-buffer' should make a separate frame.
4215 If nil, never make a separate frame.
4216 If the value is `graphic-only', make a separate frame
4217 on graphic displays only.
4218 Any other non-nil value means always make a separate frame."
4219 :type '(choice
4220 (const :tag "Never" nil)
4221 (const :tag "On graphic displays only" graphic-only)
4222 (const :tag "Always" t))
4223 :group 'windows)
4224
4225 (defcustom display-buffer-reuse-frames nil
4226 "Non-nil means `display-buffer' should reuse frames.
4227 If the buffer in question is already displayed in a frame, raise
4228 that frame."
4229 :type 'boolean
4230 :version "21.1"
4231 :group 'windows)
4232
4233 (defcustom pop-up-windows t
4234 "Non-nil means `display-buffer' should make a new window."
4235 :type 'boolean
4236 :group 'windows)
4237
4238 (defcustom split-window-preferred-function 'split-window-sensibly
4239 "Function called by `display-buffer' routines to split a window.
4240 This function is called with a window as single argument and is
4241 supposed to split that window and return the new window. If the
4242 window can (or shall) not be split, it is supposed to return nil.
4243 The default is to call the function `split-window-sensibly' which
4244 tries to split the window in a way which seems most suitable.
4245 You can customize the options `split-height-threshold' and/or
4246 `split-width-threshold' in order to have `split-window-sensibly'
4247 prefer either vertical or horizontal splitting.
4248
4249 If you set this to any other function, bear in mind that the
4250 `display-buffer' routines may call this function two times. The
4251 argument of the first call is the largest window on its frame.
4252 If that call fails to return a live window, the function is
4253 called again with the least recently used window as argument. If
4254 that call fails too, `display-buffer' will use an existing window
4255 to display its buffer.
4256
4257 The window selected at the time `display-buffer' was invoked is
4258 still selected when this function is called. Hence you can
4259 compare the window argument with the value of `selected-window'
4260 if you intend to split the selected window instead or if you do
4261 not want to split the selected window."
4262 :type 'function
4263 :version "23.1"
4264 :group 'windows)
4265
4266 (defcustom split-height-threshold 80
4267 "Minimum height for splitting windows sensibly.
4268 If this is an integer, `split-window-sensibly' may split a window
4269 vertically only if it has at least this many lines. If this is
4270 nil, `split-window-sensibly' is not allowed to split a window
4271 vertically. If, however, a window is the only window on its
4272 frame, `split-window-sensibly' may split it vertically
4273 disregarding the value of this variable."
4274 :type '(choice (const nil) (integer :tag "lines"))
4275 :version "23.1"
4276 :group 'windows)
4277
4278 (defcustom split-width-threshold 160
4279 "Minimum width for splitting windows sensibly.
4280 If this is an integer, `split-window-sensibly' may split a window
4281 horizontally only if it has at least this many columns. If this
4282 is nil, `split-window-sensibly' is not allowed to split a window
4283 horizontally."
4284 :type '(choice (const nil) (integer :tag "columns"))
4285 :version "23.1"
4286 :group 'windows)
4287
4288 (defun window-splittable-p (window &optional horizontal)
4289 "Return non-nil if `split-window-sensibly' may split WINDOW.
4290 Optional argument HORIZONTAL nil or omitted means check whether
4291 `split-window-sensibly' may split WINDOW vertically. HORIZONTAL
4292 non-nil means check whether WINDOW may be split horizontally.
4293
4294 WINDOW may be split vertically when the following conditions
4295 hold:
4296 - `window-size-fixed' is either nil or equals `width' for the
4297 buffer of WINDOW.
4298 - `split-height-threshold' is an integer and WINDOW is at least as
4299 high as `split-height-threshold'.
4300 - When WINDOW is split evenly, the emanating windows are at least
4301 `window-min-height' lines tall and can accommodate at least one
4302 line plus - if WINDOW has one - a mode line.
4303
4304 WINDOW may be split horizontally when the following conditions
4305 hold:
4306 - `window-size-fixed' is either nil or equals `height' for the
4307 buffer of WINDOW.
4308 - `split-width-threshold' is an integer and WINDOW is at least as
4309 wide as `split-width-threshold'.
4310 - When WINDOW is split evenly, the emanating windows are at least
4311 `window-min-width' or two (whichever is larger) columns wide."
4312 (when (window-live-p window)
4313 (with-current-buffer (window-buffer window)
4314 (if horizontal
4315 ;; A window can be split horizontally when its width is not
4316 ;; fixed, it is at least `split-width-threshold' columns wide
4317 ;; and at least twice as wide as `window-min-width' and 2 (the
4318 ;; latter value is hardcoded).
4319 (and (memq window-size-fixed '(nil height))
4320 ;; Testing `window-full-width-p' here hardly makes any
4321 ;; sense nowadays. This can be done more intuitively by
4322 ;; setting up `split-width-threshold' appropriately.
4323 (numberp split-width-threshold)
4324 (>= (window-width window)
4325 (max split-width-threshold
4326 (* 2 (max window-min-width 2)))))
4327 ;; A window can be split vertically when its height is not
4328 ;; fixed, it is at least `split-height-threshold' lines high,
4329 ;; and it is at least twice as high as `window-min-height' and 2
4330 ;; if it has a modeline or 1.
4331 (and (memq window-size-fixed '(nil width))
4332 (numberp split-height-threshold)
4333 (>= (window-height window)
4334 (max split-height-threshold
4335 (* 2 (max window-min-height
4336 (if mode-line-format 2 1))))))))))
4337
4338 (defun split-window-sensibly (window)
4339 "Split WINDOW in a way suitable for `display-buffer'.
4340 If `split-height-threshold' specifies an integer, WINDOW is at
4341 least `split-height-threshold' lines tall and can be split
4342 vertically, split WINDOW into two windows one above the other and
4343 return the lower window. Otherwise, if `split-width-threshold'
4344 specifies an integer, WINDOW is at least `split-width-threshold'
4345 columns wide and can be split horizontally, split WINDOW into two
4346 windows side by side and return the window on the right. If this
4347 can't be done either and WINDOW is the only window on its frame,
4348 try to split WINDOW vertically disregarding any value specified
4349 by `split-height-threshold'. If that succeeds, return the lower
4350 window. Return nil otherwise.
4351
4352 By default `display-buffer' routines call this function to split
4353 the largest or least recently used window. To change the default
4354 customize the option `split-window-preferred-function'.
4355
4356 You can enforce this function to not split WINDOW horizontally,
4357 by setting \(or binding) the variable `split-width-threshold' to
4358 nil. If, in addition, you set `split-height-threshold' to zero,
4359 chances increase that this function does split WINDOW vertically.
4360
4361 In order to not split WINDOW vertically, set \(or bind) the
4362 variable `split-height-threshold' to nil. Additionally, you can
4363 set `split-width-threshold' to zero to make a horizontal split
4364 more likely to occur.
4365
4366 Have a look at the function `window-splittable-p' if you want to
4367 know how `split-window-sensibly' determines whether WINDOW can be
4368 split."
4369 (or (and (window-splittable-p window)
4370 ;; Split window vertically.
4371 (with-selected-window window
4372 (split-window-vertically)))
4373 (and (window-splittable-p window t)
4374 ;; Split window horizontally.
4375 (with-selected-window window
4376 (split-window-horizontally)))
4377 (and (eq window (frame-root-window (window-frame window)))
4378 (not (window-minibuffer-p window))
4379 ;; If WINDOW is the only window on its frame and is not the
4380 ;; minibuffer window, try to split it vertically disregarding
4381 ;; the value of `split-height-threshold'.
4382 (let ((split-height-threshold 0))
4383 (when (window-splittable-p window)
4384 (with-selected-window window
4385 (split-window-vertically)))))))
4386
4387 (defun window--try-to-split-window (window)
4388 "Try to split WINDOW.
4389 Return value returned by `split-window-preferred-function' if it
4390 represents a live window, nil otherwise."
4391 (and (window-live-p window)
4392 (not (frame-parameter (window-frame window) 'unsplittable))
4393 (let ((new-window
4394 ;; Since `split-window-preferred-function' might
4395 ;; throw an error use `condition-case'.
4396 (condition-case nil
4397 (funcall split-window-preferred-function window)
4398 (error nil))))
4399 (and (window-live-p new-window) new-window))))
4400
4401 (defun window--frame-usable-p (frame)
4402 "Return FRAME if it can be used to display a buffer."
4403 (when (frame-live-p frame)
4404 (let ((window (frame-root-window frame)))
4405 ;; `frame-root-window' may be an internal window which is considered
4406 ;; "dead" by `window-live-p'. Hence if `window' is not live we
4407 ;; implicitly know that `frame' has a visible window we can use.
4408 (unless (and (window-live-p window)
4409 (or (window-minibuffer-p window)
4410 ;; If the window is soft-dedicated, the frame is usable.
4411 ;; Actually, even if the window is really dedicated,
4412 ;; the frame is still usable by splitting it.
4413 ;; At least Emacs-22 allowed it, and it is desirable
4414 ;; when displaying same-frame windows.
4415 nil ; (eq t (window-dedicated-p window))
4416 ))
4417 frame))))
4418
4419 (defcustom even-window-heights t
4420 "If non-nil `display-buffer' will try to even window heights.
4421 Otherwise `display-buffer' will leave the window configuration
4422 alone. Heights are evened only when `display-buffer' chooses a
4423 window that appears above or below the selected window."
4424 :type 'boolean
4425 :group 'windows)
4426
4427 (defun window--even-window-heights (window)
4428 "Even heights of WINDOW and selected window.
4429 Do this only if these windows are vertically adjacent to each
4430 other, `even-window-heights' is non-nil, and the selected window
4431 is higher than WINDOW."
4432 (when (and even-window-heights
4433 (not (eq window (selected-window)))
4434 ;; Don't resize minibuffer windows.
4435 (not (window-minibuffer-p (selected-window)))
4436 (> (window-height (selected-window)) (window-height window))
4437 (eq (window-frame window) (window-frame (selected-window)))
4438 (let ((sel-edges (window-edges (selected-window)))
4439 (win-edges (window-edges window)))
4440 (and (= (nth 0 sel-edges) (nth 0 win-edges))
4441 (= (nth 2 sel-edges) (nth 2 win-edges))
4442 (or (= (nth 1 sel-edges) (nth 3 win-edges))
4443 (= (nth 3 sel-edges) (nth 1 win-edges))))))
4444 (let ((window-min-height 1))
4445 ;; Don't throw an error if we can't even window heights for
4446 ;; whatever reason.
4447 (condition-case nil
4448 (enlarge-window (/ (- (window-height window) (window-height)) 2))
4449 (error nil)))))
4450
4451 (defun window--display-buffer-1 (window)
4452 "Raise the frame containing WINDOW.
4453 Do not raise the selected frame. Return WINDOW."
4454 (let* ((frame (window-frame window))
4455 (visible (frame-visible-p frame)))
4456 (unless (or (not visible)
4457 ;; Assume the selected frame is already visible enough.
4458 (eq frame (selected-frame))
4459 ;; Assume the frame from which we invoked the minibuffer
4460 ;; is visible.
4461 (and (minibuffer-window-active-p (selected-window))
4462 (eq frame (window-frame (minibuffer-selected-window)))))
4463 (raise-frame frame))
4464 window))
4465
4466 (defun window--display-buffer-2 (buffer window &optional dedicated)
4467 "Display BUFFER in WINDOW and make its frame visible.
4468 Set `window-dedicated-p' to DEDICATED if non-nil.
4469 Return WINDOW."
4470 (when (and (buffer-live-p buffer) (window-live-p window))
4471 (set-window-buffer window buffer)
4472 (when dedicated
4473 (set-window-dedicated-p window dedicated))
4474 (window--display-buffer-1 window)))
4475
4476 (defvar display-buffer-mark-dedicated nil
4477 "If non-nil, `display-buffer' marks the windows it creates as dedicated.
4478 The actual non-nil value of this variable will be copied to the
4479 `window-dedicated-p' flag.")
4480
4481 (defun window-normalize-buffer-to-display (buffer-or-name)
4482 "Normalize BUFFER-OR-NAME argument for buffer display functions.
4483 If BUFFER-OR-NAME is nil, return the curent buffer. Else, if a
4484 buffer specified by BUFFER-OR-NAME exists, return that buffer.
4485 If no such buffer exists, create a buffer with the name
4486 BUFFER-OR-NAME and return that buffer."
4487 (if buffer-or-name
4488 (or (get-buffer buffer-or-name)
4489 (let ((buffer (get-buffer-create buffer-or-name)))
4490 (set-buffer-major-mode buffer)
4491 buffer))
4492 (current-buffer)))
4493
4494 (defvar display-buffer-alist nil
4495 "Alist of conditional actions for `display-buffer'.
4496 This is a list of elements (CONDITION . ACTION), where:
4497
4498 CONDITION is either a regexp matching buffer names, or a function
4499 that takes a buffer and returns a boolean.
4500
4501 ACTION is a cons cell (FUNCTION . ALIST), where FUNCTION is
4502 either a function or a list of functions. Each such function
4503 should accept 2 arguments: a buffer to display and an alist of
4504 the same form as ALIST. It should return the window used, or
4505 nil if it fails to display the window. See `display-buffer'
4506 for more details.
4507
4508 Usable action functions include:
4509 `display-buffer-reuse-selected-window'
4510 `display-buffer-same-window'
4511 `display-buffer-maybe-same-window'
4512 `display-buffer-reuse-window'
4513 `display-buffer-pop-up-frame'
4514 `display-buffer-pop-up-window'
4515 `display-buffer-reuse-or-pop-window'
4516 `display-buffer-use-some-window'
4517
4518 The above functions recognize the following alist entries:
4519 - `inhibit-same-window', if non-nil, prevents the same window
4520 from being used for display.
4521 - `reuse-frame' specifies the frames that can be searched for a
4522 window displaying the buffer. Its values have the same
4523 meaning as the ALL-FRAMES arg to `get-buffer-window-list'.")
4524
4525 (defvar display-buffer-default-action
4526 '((display-buffer-reuse-selected-window
4527 display-buffer-maybe-same-window
4528 display-buffer-reuse-or-pop-window
4529 display-buffer-use-some-window
4530 ;; If all else fails, pop up a new frame regardless of
4531 ;; restrictions.
4532 display-buffer-pop-up-frame))
4533 "List of default actions for `display-buffer'.
4534 It should be a cons cell of the form (FUNCTION . ALIST), which
4535 has the same meaning as in `display-buffer-alist'.")
4536
4537 (defvar display-buffer-overriding-action nil
4538 "Overriding action to perform to display a buffer.
4539 If non-nil, it should be a cons cell (FUNCTION . ALIST), which
4540 has the same meaning as in `display-buffer-alist'.")
4541
4542 (defun display-buffer-assq-regexp (buffer-name alist)
4543 "Retrieve ALIST entry corresponding to BUFFER-NAME."
4544 (catch 'match
4545 (dolist (entry alist)
4546 (let ((key (car entry))
4547 (value (cdr entry)))
4548 (when (or (and (stringp key)
4549 (string-match-p key buffer-name))
4550 (and (symbolp key) (functionp key)
4551 (funcall key buffer-name alist)))
4552 (throw 'match (cdr entry)))))))
4553
4554 (defun display-buffer (&optional buffer-or-name action frame)
4555 "Display BUFFER-OR-NAME in some window.
4556 BUFFER-OR-NAME must be a buffer or the name of an existing
4557 buffer. Return the window chosen for displaying BUFFER-OR-NAME,
4558 or nil if no such window is found.
4559
4560 Optional argument ACTION should have the form (FUNCTION . ALIST).
4561 FUNCTION is either a function or a list of functions. Each such
4562 function is called with 2 arguments: the buffer to display and an
4563 alist. It should either display the buffer and return the
4564 window, or return nil if it is unable to display the buffer.
4565
4566 `display-buffer' constructs a list of action functions and an
4567 action alist from `display-buffer-overriding-action',
4568 `user-action', ACTION, and `display-buffer-default-action' (in
4569 order). It calls each action function in turn, passing the
4570 consolidated action alist as the second argument, until one of
4571 the functions returns non-nil.
4572
4573 ACTION can also have a non-nil and non-list value. This means to
4574 display the buffer in a window other than the selected one, even
4575 if it is already displayed in the selected window. If called
4576 interactively with a prefix argument, ACTION is t.
4577
4578 Optional argument FRAME specifies where to look for a window that
4579 already displays the buffer. If nil, check only the selected
4580 frame (actually the last non-minibuffer frame), except if
4581 `display-buffer-reuse-frames' or `pop-up-frames' is non-nil
4582 \(non-nil and not graphic-only on a text-only terminal), in which
4583 case check all visible or iconified frames. Otherwise, FRAME can
4584 be a specific frame, `visible' (all visible frames), 0 (all
4585 frames on the current terminal), or t (all frames)."
4586 (interactive "BDisplay buffer:\nP")
4587 (let ((buffer (window-normalize-buffer-to-display buffer-or-name))
4588 ;; Handle the old form of the first argument.
4589 (inhibit-same-window (and action (not (listp action)))))
4590 (unless (listp action) (setq action nil))
4591 (if display-buffer-function
4592 ;; If `display-buffer-function' is defined, let it do the job.
4593 (funcall display-buffer-function buffer inhibit-same-window)
4594 ;; Otherwise, use the defined actions.
4595 (let* ((user-action
4596 (display-buffer-assq-regexp (buffer-name buffer)
4597 display-buffer-alist))
4598 ;; Extra actions from the arguments to this function:
4599 (extra-action
4600 (cons nil (append (if inhibit-same-window
4601 '((inhibit-same-window . t)))
4602 (if frame
4603 `((reuse-frame . ,frame))))))
4604 ;; Construct action function list and action alist.
4605 (actions (list display-buffer-overriding-action
4606 user-action action extra-action
4607 display-buffer-default-action))
4608 (functions (apply 'append
4609 (mapcar (lambda (x)
4610 (setq x (car x))
4611 (if (listp x) x (list x)))
4612 actions)))
4613 (alist (apply 'append (mapcar 'cdr actions)))
4614 window)
4615 (unless (buffer-live-p buffer)
4616 (error "Invalid buffer"))
4617 (while (and functions (not window))
4618 (setq window (funcall (car functions) buffer alist)
4619 functions (cdr functions)))
4620 window))))
4621
4622 (defun display-buffer-other-frame (buffer)
4623 "Display buffer BUFFER in another frame.
4624 This uses the function `display-buffer' as a subroutine; see
4625 its documentation for additional customization information."
4626 (interactive "BDisplay buffer in other frame: ")
4627 (let ((pop-up-frames t)
4628 same-window-buffer-names same-window-regexps
4629 ;;(old-window (selected-window))
4630 new-window)
4631 (setq new-window (display-buffer buffer t))
4632 ;; This may have been here in order to prevent the new frame from hiding
4633 ;; the old frame. But it does more harm than good.
4634 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
4635 ;;(lower-frame (window-frame new-window))
4636
4637 ;; This may have been here in order to make sure the old-frame gets the
4638 ;; focus. But not only can it cause an annoying flicker, with some
4639 ;; window-managers it just makes the window invisible, with no easy
4640 ;; way to recover it. --Stef
4641 ;;(make-frame-invisible (window-frame old-window))
4642 ;;(make-frame-visible (window-frame old-window))
4643 ))
4644
4645 ;;; `display-buffer' action functions:
4646
4647 (defun display-buffer-reuse-selected-window (buffer alist)
4648 "Try to display BUFFER in the selected window if it is already there.
4649 If this succeeds, return the selected window.
4650
4651 This fails if BUFFER is not displayed in the selected window, or
4652 if ALIST has a non-nil `inhibit-same-window' entry. In that
4653 case, return nil."
4654 (when (and (not (cdr (assq 'inhibit-same-window alist)))
4655 (eq buffer (window-buffer)))
4656 (display-buffer-record-window 'reuse-window (selected-window) buffer)
4657 (window--display-buffer-1 (selected-window))))
4658
4659 (defun display-buffer-same-window (buffer alist)
4660 "Try to display BUFFER in the selected window.
4661 If this succeeds, return the selected window.
4662
4663 This fails if the selected window is a minibuffer window or is
4664 dedicated to another buffer, or if ALIST has a non-nil
4665 `inhibit-same-window' entry. In that case, return nil."
4666 (unless (or (cdr (assq 'inhibit-same-window alist))
4667 (window-minibuffer-p)
4668 (window-dedicated-p))
4669 (display-buffer-record-window 'reuse-window (selected-window) buffer)
4670 (window--display-buffer-2 buffer (selected-window))))
4671
4672 (defun display-buffer-maybe-same-window (buffer alist)
4673 "Try to display BUFFER in the selected window.
4674 This acts like `display-buffer-same-window', except that it also
4675 fails if `same-window-p' returns nil for this buffer."
4676 (and (same-window-p (buffer-name buffer))
4677 (display-buffer-same-window buffer alist)))
4678
4679 (defun display-buffer-reuse-window (buffer alist)
4680 "Return a window that is already displaying BUFFER.
4681 If no usable window is found, return nil.
4682
4683 If ALIST has a non-nil `inhibit-same-window' entry, the same
4684 window cannot be reused.
4685
4686 If ALIST contains a `reuse-frame' entry, that determines the
4687 frames to check for a window displaying the buffer. If the entry
4688 is omitted or the value is nil, check only this frame. The value
4689 can also be a specific frame, `visible' (all visible frames),
4690 0 (all frames on the current terminal), or t (all frames)."
4691 (let* ((can-use-selected-window
4692 (not (cdr (assq 'inhibit-same-window alist))))
4693 (frames (or (cdr (assq 'reuse-frame alist))
4694 (last-nonminibuffer-frame)))
4695 (window (catch 'found
4696 (dolist (window (get-buffer-window-list
4697 buffer 'nomini frames))
4698 (when (or can-use-selected-window
4699 (not (eq (selected-window) window)))
4700 (throw 'found window))))))
4701 (when window
4702 (display-buffer-record-window 'reuse-window window buffer)
4703 (window--display-buffer-1 window))))
4704
4705 (defun display-buffer-pop-up-frame (buffer alist)
4706 "Display BUFFER in a new frame.
4707 This works by calling `pop-up-frame-function'. If sucessful,
4708 return the window on the new frame; otherwise return nil."
4709 (let ((fun pop-up-frame-function)
4710 frame window)
4711 (when (and fun
4712 (setq frame (funcall fun))
4713 (setq window (frame-selected-window frame)))
4714 (display-buffer-record-window 'pop-up-frame window buffer)
4715 (window--display-buffer-2 buffer window))))
4716
4717 (defun display-buffer-pop-up-window (buffer alist)
4718 "Display BUFFER by popping up a new window.
4719 The new window is created on the selected frame, or in
4720 `last-nonminibuffer-frame' if no windows can be created there.
4721 If sucessful, return the new window; otherwise return nil."
4722 (let ((frame (or (window--frame-usable-p (selected-frame))
4723 (window--frame-usable-p (last-nonminibuffer-frame))))
4724 window)
4725 (when (and (or (not (frame-parameter frame 'unsplittable))
4726 ;; If the selected frame cannot be split, look at
4727 ;; `last-nonminibuffer-frame'.
4728 (and (eq frame (selected-frame))
4729 (setq frame (last-nonminibuffer-frame))
4730 (window--frame-usable-p frame)
4731 (not (frame-parameter frame 'unsplittable))))
4732 ;; Attempt to split largest or least recently used window.
4733 (setq window (or (window--try-to-split-window
4734 (get-largest-window frame t))
4735 (window--try-to-split-window
4736 (get-lru-window frame t)))))
4737 (display-buffer-record-window 'pop-up-window window buffer)
4738 (window--display-buffer-2 buffer window))))
4739
4740 ;; This display action function groups together some lower-level ones:
4741 (defun display-buffer-reuse-or-pop-window (buffer alist)
4742 "Display BUFFER in some window other than the selected one.
4743 This attempts to call the following functions (in order):
4744 - `display-buffer-reuse-window', ensuring that it checks all
4745 frames on this terminal if `display-buffer-reuse-frames' or
4746 `pop-up-frames' is non-nil.
4747 - `special-display-function', if it is available.
4748 - `display-buffer-pop-up-frame', if specified by `pop-up-frames'.
4749 - `display-buffer-pop-up-window', if specified by `pop-up-windows'.
4750
4751 If BUFFER is sucessfully display, return its window; otherwise
4752 return nil."
4753 (let ((use-pop-up-frames (if (eq pop-up-frames 'graphic-only)
4754 (display-graphic-p)
4755 pop-up-frames)))
4756 (or (display-buffer-reuse-window
4757 buffer
4758 ;; If `display-buffer-reuse-frames' or `pop-up-frames' is
4759 ;; non-nil, check all frames on this terminal.
4760 (if (and (null (cdr (assq 'reuse-frame alist)))
4761 (or use-pop-up-frames display-buffer-reuse-frames))
4762 (cons '(reuse-frame . 0) alist)
4763 alist))
4764 ;; Try with `special-display-function':
4765 (and special-display-function
4766 ;; `special-display-p' returns either t or a list of frame
4767 ;; parameters to pass to `special-display-function'.
4768 (let ((pars (special-display-p (buffer-name buffer))))
4769 (when pars
4770 (funcall special-display-function
4771 buffer (if (listp pars) pars)))))
4772 (and use-pop-up-frames
4773 (display-buffer-pop-up-frame buffer alist))
4774 (and pop-up-windows
4775 (display-buffer-pop-up-window buffer alist)))))
4776
4777 (defun display-buffer-use-some-window (buffer alist)
4778 "Display BUFFER in an existing window.
4779 Search for a usable window, set that window to the buffer, and
4780 return the window. If no suitable window is found, return nil."
4781 (let* ((not-this-window (cdr (assq 'inhibit-same-window alist)))
4782 (window-to-undedicate
4783 ;; When NOT-THIS-WINDOW is non-nil, temporarily dedicate the
4784 ;; selected window to its buffer, to prevent any of the
4785 ;; `get-' routines below from choosing it. (Bug#1415)
4786 (and not-this-window (not (window-dedicated-p))
4787 (set-window-dedicated-p (selected-window) t)
4788 (selected-window)))
4789 (frame (or (window--frame-usable-p (selected-frame))
4790 (window--frame-usable-p (last-nonminibuffer-frame))))
4791 (use-pop-up-frames (if (eq pop-up-frames 'graphic-only)
4792 (display-graphic-p)
4793 pop-up-frames))
4794 window popped-up-frame)
4795 (unwind-protect
4796 (setq window
4797 ;; Reuse an existing window.
4798 (or (get-lru-window frame)
4799 (let ((window (get-buffer-window buffer 'visible)))
4800 (unless (and not-this-window
4801 (eq window (selected-window)))
4802 window))
4803 (get-largest-window 'visible)
4804 (let ((window (get-buffer-window buffer 0)))
4805 (unless (and not-this-window
4806 (eq window (selected-window)))
4807 window))
4808 (get-largest-window 0)
4809 (and use-pop-up-frames
4810 (prog1
4811 (frame-selected-window (funcall pop-up-frame-function))
4812 (setq popped-up-frame t)))))
4813 (when (window-live-p window-to-undedicate)
4814 ;; Restore dedicated status of selected window.
4815 (set-window-dedicated-p window-to-undedicate nil)))
4816 (when window
4817 (display-buffer-record-window
4818 (if popped-up-frame 'pop-up-frame 'reuse-window) window buffer)
4819 (window--even-window-heights window)
4820 (window--display-buffer-2 buffer window))))
4821
4822 ;;; Display + selection commands:
4823
4824 (defun pop-to-buffer (buffer-or-name &optional other-window norecord)
4825 "Select buffer BUFFER-OR-NAME in some window, preferably a different one.
4826 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
4827 nil. If BUFFER-OR-NAME is a string not naming an existent
4828 buffer, create a buffer with that name. If BUFFER-OR-NAME is
4829 nil, choose some other buffer.
4830
4831 If `pop-up-windows' is non-nil, windows can be split to display
4832 the buffer. If optional second arg OTHER-WINDOW is non-nil,
4833 insist on finding another window even if the specified buffer is
4834 already visible in the selected window, and ignore
4835 `same-window-regexps' and `same-window-buffer-names'.
4836
4837 If the window to show BUFFER-OR-NAME is not on the selected
4838 frame, raise that window's frame and give it input focus.
4839
4840 This function returns the buffer it switched to. This uses the
4841 function `display-buffer' as a subroutine; see the documentation
4842 of `display-buffer' for additional customization information.
4843
4844 Optional third arg NORECORD non-nil means do not put this buffer
4845 at the front of the list of recently selected ones."
4846 (interactive "BPop to buffer:\nP")
4847 (pop-to-buffer-1 buffer-or-name (if other-window t nil) norecord))
4848
4849 (defun pop-to-buffer-same-window (&optional buffer-or-name norecord)
4850 "Pop to buffer specified by BUFFER-OR-NAME in the selected window.
4851 Another window will be used only if the buffer can't be shown in
4852 the selected window, usually because it is dedicated to another
4853 buffer. Optional arguments BUFFER-OR-NAME and NORECORD are as
4854 for `pop-to-buffer'."
4855 (interactive "BPop to buffer in selected window:\nP")
4856 (pop-to-buffer-1 buffer-or-name 'same-window norecord))
4857
4858 (defun pop-to-buffer-1 (buffer-or-name window-choice norecord)
4859 (set-buffer (window-normalize-buffer-to-display
4860 ;; BUFFER-OR-NAME nil means another buffer.
4861 (or buffer-or-name
4862 (other-buffer (current-buffer)))))
4863 (let ((old-window (selected-window))
4864 (old-frame (selected-frame))
4865 (same-window-buffer-names same-window-buffer-names)
4866 (same-window-regexps same-window-regexps))
4867 (if (eq window-choice t)
4868 (setq same-window-buffer-names nil
4869 same-window-regexps nil))
4870 (let* ((action
4871 ;; Based on the WINDOW-CHOICE argument, choose an action
4872 ;; argument to pass to `display-buffer'.
4873 (cond
4874 ((eq window-choice 'same-window)
4875 '((display-buffer-reuse-selected-window
4876 display-buffer-same-window)))
4877 (window-choice
4878 '(nil (inhibit-same-window . t)))))
4879 (window (display-buffer (current-buffer) action))
4880 (frame (window-frame window)))
4881 (if (eq frame old-frame)
4882 ;; Make sure new window gets selected (Bug#8615), (Bug#6954).
4883 (select-window window norecord)
4884 ;; If `display-buffer' has chosen another frame, make sure it
4885 ;; gets input focus.
4886 (select-frame-set-input-focus frame norecord))
4887 (current-buffer))))
4888
4889 (defun read-buffer-to-switch (prompt)
4890 "Read the name of a buffer to switch to, prompting with PROMPT.
4891 Return the neame of the buffer as a string.
4892
4893 This function is intended for the `switch-to-buffer' family of
4894 commands since these need to omit the name of the current buffer
4895 from the list of completions and default values."
4896 (let ((rbts-completion-table (internal-complete-buffer-except)))
4897 (minibuffer-with-setup-hook
4898 (lambda ()
4899 (setq minibuffer-completion-table rbts-completion-table)
4900 ;; Since rbts-completion-table is built dynamically, we
4901 ;; can't just add it to the default value of
4902 ;; icomplete-with-completion-tables, so we add it
4903 ;; here manually.
4904 (if (and (boundp 'icomplete-with-completion-tables)
4905 (listp icomplete-with-completion-tables))
4906 (set (make-local-variable 'icomplete-with-completion-tables)
4907 (cons rbts-completion-table
4908 icomplete-with-completion-tables))))
4909 (read-buffer prompt (other-buffer (current-buffer))
4910 (confirm-nonexistent-file-or-buffer)))))
4911
4912 (defun window-normalize-buffer-to-switch-to (buffer-or-name)
4913 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
4914 If BUFFER-OR-NAME is nil, return the buffer returned by
4915 `other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
4916 exists, return that buffer. If no such buffer exists, create a
4917 buffer with the name BUFFER-OR-NAME and return that buffer."
4918 (if buffer-or-name
4919 (or (get-buffer buffer-or-name)
4920 (let ((buffer (get-buffer-create buffer-or-name)))
4921 (set-buffer-major-mode buffer)
4922 buffer))
4923 (other-buffer)))
4924
4925 (defun switch-to-buffer (buffer-or-name &optional norecord force-same-window)
4926 "Switch to buffer BUFFER-OR-NAME in the selected window.
4927 If called interactively, prompt for the buffer name using the
4928 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
4929 determines whether to request confirmation before creating a new
4930 buffer.
4931
4932 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
4933 nil. If BUFFER-OR-NAME is a string that does not identify an
4934 existing buffer, create a buffer with that name. If
4935 BUFFER-OR-NAME is nil, switch to the buffer returned by
4936 `other-buffer'.
4937
4938 Optional argument NORECORD non-nil means do not put the buffer
4939 specified by BUFFER-OR-NAME at the front of the buffer list and
4940 do not make the window displaying it the most recently selected
4941 one.
4942
4943 If FORCE-SAME-WINDOW is non-nil, BUFFER-OR-NAME must be displayed
4944 in the currently selected window; signal an error if that is
4945 impossible (e.g. if the selected window is minibuffer-only).
4946 If non-nil, BUFFER-OR-NAME may be displayed in another window.
4947
4948 Return the buffer switched to."
4949 (interactive
4950 (list (read-buffer-to-switch "Switch to buffer: ") nil nil))
4951 (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name)))
4952 (if (null force-same-window)
4953 (cond
4954 ((eq buffer (window-buffer))
4955 (unless norecord
4956 (select-window (selected-window)))
4957 (set-buffer buffer))
4958 ((or (window-minibuffer-p) (window-dedicated-p))
4959 (pop-to-buffer buffer))
4960 (t
4961 (set-window-buffer nil buffer)
4962 (unless norecord
4963 (select-window (selected-window)))
4964 (set-buffer buffer)))
4965 (cond
4966 ;; Don't call set-window-buffer if it's not needed since it
4967 ;; might signal an error (e.g. if the window is dedicated).
4968 ((eq buffer (window-buffer)))
4969 ((window-minibuffer-p)
4970 (error "Cannot switch buffers in minibuffer window"))
4971 ((eq (window-dedicated-p) t)
4972 (error "Cannot switch buffers in a dedicated window"))
4973 (t (set-window-buffer nil buffer)))
4974
4975 (unless norecord
4976 (select-window (selected-window)))
4977 (set-buffer buffer))))
4978
4979 (defun switch-to-buffer-other-window (buffer-or-name &optional norecord)
4980 "Select the buffer specified by BUFFER-OR-NAME in another window.
4981 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
4982 nil. Return the buffer switched to.
4983
4984 If called interactively, prompt for the buffer name using the
4985 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
4986 determines whether to request confirmation before creating a new
4987 buffer.
4988
4989 If BUFFER-OR-NAME is a string and does not identify an existing
4990 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
4991 nil, switch to the buffer returned by `other-buffer'.
4992
4993 Optional second argument NORECORD non-nil means do not put this
4994 buffer at the front of the list of recently selected ones.
4995
4996 This uses the function `display-buffer' as a subroutine; see its
4997 documentation for additional customization information."
4998 (interactive
4999 (list (read-buffer-to-switch "Switch to buffer in other window: ")))
5000 (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name))
5001 (pop-up-windows t)
5002 same-window-buffer-names same-window-regexps)
5003 (pop-to-buffer buffer t norecord)))
5004
5005 (defun switch-to-buffer-other-frame (buffer-or-name &optional norecord)
5006 "Switch to buffer BUFFER-OR-NAME in another frame.
5007 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
5008 nil. Return the buffer switched to.
5009
5010 If called interactively, prompt for the buffer name using the
5011 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5012 determines whether to request confirmation before creating a new
5013 buffer.
5014
5015 If BUFFER-OR-NAME is a string and does not identify an existing
5016 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5017 nil, switch to the buffer returned by `other-buffer'.
5018
5019 Optional second arg NORECORD non-nil means do not put this
5020 buffer at the front of the list of recently selected ones.
5021
5022 This uses the function `display-buffer' as a subroutine; see its
5023 documentation for additional customization information."
5024 (interactive
5025 (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
5026 (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name))
5027 (pop-up-frames t)
5028 same-window-buffer-names same-window-regexps)
5029 (pop-to-buffer buffer t norecord)))
5030 \f
5031 (defun set-window-text-height (window height)
5032 "Set the height in lines of the text display area of WINDOW to HEIGHT.
5033 WINDOW must be a live window. HEIGHT doesn't include the mode
5034 line or header line, if any, or any partial-height lines in the
5035 text display area.
5036
5037 Note that the current implementation of this function cannot
5038 always set the height exactly, but attempts to be conservative,
5039 by allocating more lines than are actually needed in the case
5040 where some error may be present."
5041 (setq window (window-normalize-live-window window))
5042 (let ((delta (- height (window-text-height window))))
5043 (unless (zerop delta)
5044 ;; Setting window-min-height to a value like 1 can lead to very
5045 ;; bizarre displays because it also allows Emacs to make *other*
5046 ;; windows 1-line tall, which means that there's no more space for
5047 ;; the modeline.
5048 (let ((window-min-height (min 2 height))) ; One text line plus a modeline.
5049 (window-resize window delta)))))
5050
5051 (defun enlarge-window-horizontally (delta)
5052 "Make selected window DELTA columns wider.
5053 Interactively, if no argument is given, make selected window one
5054 column wider."
5055 (interactive "p")
5056 (enlarge-window delta t))
5057
5058 (defun shrink-window-horizontally (delta)
5059 "Make selected window DELTA columns narrower.
5060 Interactively, if no argument is given, make selected window one
5061 column narrower."
5062 (interactive "p")
5063 (shrink-window delta t))
5064
5065 (defun count-screen-lines (&optional beg end count-final-newline window)
5066 "Return the number of screen lines in the region.
5067 The number of screen lines may be different from the number of actual lines,
5068 due to line breaking, display table, etc.
5069
5070 Optional arguments BEG and END default to `point-min' and `point-max'
5071 respectively.
5072
5073 If region ends with a newline, ignore it unless optional third argument
5074 COUNT-FINAL-NEWLINE is non-nil.
5075
5076 The optional fourth argument WINDOW specifies the window used for obtaining
5077 parameters such as width, horizontal scrolling, and so on. The default is
5078 to use the selected window's parameters.
5079
5080 Like `vertical-motion', `count-screen-lines' always uses the current buffer,
5081 regardless of which buffer is displayed in WINDOW. This makes possible to use
5082 `count-screen-lines' in any buffer, whether or not it is currently displayed
5083 in some window."
5084 (unless beg
5085 (setq beg (point-min)))
5086 (unless end
5087 (setq end (point-max)))
5088 (if (= beg end)
5089 0
5090 (save-excursion
5091 (save-restriction
5092 (widen)
5093 (narrow-to-region (min beg end)
5094 (if (and (not count-final-newline)
5095 (= ?\n (char-before (max beg end))))
5096 (1- (max beg end))
5097 (max beg end)))
5098 (goto-char (point-min))
5099 (1+ (vertical-motion (buffer-size) window))))))
5100
5101 (defun window-buffer-height (window)
5102 "Return the height (in screen lines) of the buffer that WINDOW is displaying."
5103 (with-current-buffer (window-buffer window)
5104 (max 1
5105 (count-screen-lines (point-min) (point-max)
5106 ;; If buffer ends with a newline, ignore it when
5107 ;; counting height unless point is after it.
5108 (eobp)
5109 window))))
5110
5111 ;;; Resizing buffers to fit their contents exactly.
5112 (defun fit-window-to-buffer (&optional window max-height min-height override)
5113 "Adjust height of WINDOW to display its buffer's contents exactly.
5114 WINDOW can be any live window and defaults to the selected one.
5115
5116 Optional argument MAX-HEIGHT specifies the maximum height of
5117 WINDOW and defaults to the height of WINDOW's frame. Optional
5118 argument MIN-HEIGHT specifies the minimum height of WINDOW and
5119 defaults to `window-min-height'. Both, MAX-HEIGHT and MIN-HEIGHT
5120 are specified in lines and include the mode line and header line,
5121 if any.
5122
5123 Optional argument OVERRIDE non-nil means override restrictions
5124 imposed by `window-min-height' and `window-min-width' on the size
5125 of WINDOW.
5126
5127 Return the number of lines by which WINDOW was enlarged or
5128 shrunk. If an error occurs during resizing, return nil but don't
5129 signal an error.
5130
5131 Note that even if this function makes WINDOW large enough to show
5132 _all_ lines of its buffer you might not see the first lines when
5133 WINDOW was scrolled."
5134 (interactive)
5135 ;; Do all the work in WINDOW and its buffer and restore the selected
5136 ;; window and the current buffer when we're done.
5137 (setq window (window-normalize-live-window window))
5138 ;; Can't resize a full height or fixed-size window.
5139 (unless (or (window-size-fixed-p window)
5140 (window-full-height-p window))
5141 ;; `with-selected-window' should orderly restore the current buffer.
5142 (with-selected-window window
5143 ;; We are in WINDOW's buffer now.
5144 (let* (;; Adjust MIN-HEIGHT.
5145 (min-height
5146 (if override
5147 (window-min-size window nil window)
5148 (max (or min-height window-min-height)
5149 window-safe-min-height)))
5150 (max-window-height
5151 (window-total-size (frame-root-window window)))
5152 ;; Adjust MAX-HEIGHT.
5153 (max-height
5154 (if (or override (not max-height))
5155 max-window-height
5156 (min max-height max-window-height)))
5157 ;; Make `desired-height' the height necessary to show
5158 ;; all of WINDOW's buffer, constrained by MIN-HEIGHT
5159 ;; and MAX-HEIGHT.
5160 (desired-height
5161 (max
5162 (min
5163 (+ (count-screen-lines)
5164 ;; For non-minibuffers count the mode line, if any.
5165 (if (and (not (window-minibuffer-p window))
5166 mode-line-format)
5167 1
5168 0)
5169 ;; Count the header line, if any.
5170 (if header-line-format 1 0))
5171 max-height)
5172 min-height))
5173 (desired-delta
5174 (- desired-height (window-total-size window)))
5175 (delta
5176 (if (> desired-delta 0)
5177 (min desired-delta
5178 (window-max-delta window nil window))
5179 (max desired-delta
5180 (- (window-min-delta window nil window))))))
5181 ;; This `condition-case' shouldn't be necessary, but who knows?
5182 (condition-case nil
5183 (if (zerop delta)
5184 ;; Return zero if DELTA became zero in the proces.
5185 0
5186 ;; Don't try to redisplay with the cursor at the end on its
5187 ;; own line--that would force a scroll and spoil things.
5188 (when (and (eobp) (bolp) (not (bobp)))
5189 ;; It's silly to put `point' at the end of the previous
5190 ;; line and so maybe force horizontal scrolling.
5191 (set-window-point window (line-beginning-position 0)))
5192 ;; Call `window-resize' with OVERRIDE argument equal WINDOW.
5193 (window-resize window delta nil window)
5194 ;; Check if the last line is surely fully visible. If
5195 ;; not, enlarge the window.
5196 (let ((end (save-excursion
5197 (goto-char (point-max))
5198 (when (and (bolp) (not (bobp)))
5199 ;; Don't include final newline.
5200 (backward-char 1))
5201 (when truncate-lines
5202 ;; If line-wrapping is turned off, test the
5203 ;; beginning of the last line for
5204 ;; visibility instead of the end, as the
5205 ;; end of the line could be invisible by
5206 ;; virtue of extending past the edge of the
5207 ;; window.
5208 (forward-line 0))
5209 (point))))
5210 (set-window-vscroll window 0)
5211 ;; This loop might in some rare pathological cases raise
5212 ;; an error - another reason for the `condition-case'.
5213 (while (and (< desired-height max-height)
5214 (= desired-height (window-total-size))
5215 (not (pos-visible-in-window-p end)))
5216 (window-resize window 1 nil window)
5217 (setq desired-height (1+ desired-height)))))
5218 (error (setq delta nil)))
5219 delta))))
5220
5221 (defun window-safely-shrinkable-p (&optional window)
5222 "Return t if WINDOW can be shrunk without shrinking other windows.
5223 WINDOW defaults to the selected window."
5224 (with-selected-window (or window (selected-window))
5225 (let ((edges (window-edges)))
5226 ;; The following doesn't satisfy the doc-string's claim when
5227 ;; window and previous-/next-window are not part of the same
5228 ;; combination but still share a common edge. Using
5229 ;; `window-iso-combined-p' instead should handle that.
5230 (or (= (nth 2 edges) (nth 2 (window-edges (previous-window))))
5231 (= (nth 0 edges) (nth 0 (window-edges (next-window))))))))
5232 ;; (make-obsolete
5233 ;; 'window-safely-shrinkable-p "use `window-iso-combined-p' instead." "24.1")
5234
5235 (defun shrink-window-if-larger-than-buffer (&optional window)
5236 "Shrink height of WINDOW if its buffer doesn't need so many lines.
5237 More precisely, shrink WINDOW vertically to be as small as
5238 possible, while still showing the full contents of its buffer.
5239 WINDOW defaults to the selected window.
5240
5241 Do not shrink WINDOW to less than `window-min-height' lines. Do
5242 nothing if the buffer contains more lines than the present window
5243 height, or if some of the window's contents are scrolled out of
5244 view, or if shrinking this window would also shrink another
5245 window, or if the window is the only window of its frame.
5246
5247 Return non-nil if the window was shrunk, nil otherwise."
5248 (interactive)
5249 (setq window (window-normalize-live-window window))
5250 ;; Make sure that WINDOW is vertically combined and `point-min' is
5251 ;; visible (for whatever reason that's needed). The remaining issues
5252 ;; should be taken care of by `fit-window-to-buffer'.
5253 (when (and (window-iso-combined-p window)
5254 (pos-visible-in-window-p (point-min) window))
5255 (fit-window-to-buffer window (window-total-size window))))
5256 \f
5257 (defun kill-buffer-and-window ()
5258 "Kill the current buffer and delete the selected window."
5259 (interactive)
5260 (let ((window-to-delete (selected-window))
5261 (buffer-to-kill (current-buffer))
5262 (delete-window-hook (lambda () (ignore-errors (delete-window)))))
5263 (unwind-protect
5264 (progn
5265 (add-hook 'kill-buffer-hook delete-window-hook t t)
5266 (if (kill-buffer (current-buffer))
5267 ;; If `delete-window' failed before, we rerun it to regenerate
5268 ;; the error so it can be seen in the echo area.
5269 (when (eq (selected-window) window-to-delete)
5270 (delete-window))))
5271 ;; If the buffer is not dead for some reason (probably because
5272 ;; of a `quit' signal), remove the hook again.
5273 (ignore-errors
5274 (with-current-buffer buffer-to-kill
5275 (remove-hook 'kill-buffer-hook delete-window-hook t))))))
5276
5277 \f
5278 (defvar recenter-last-op nil
5279 "Indicates the last recenter operation performed.
5280 Possible values: `top', `middle', `bottom', integer or float numbers.")
5281
5282 (defcustom recenter-positions '(middle top bottom)
5283 "Cycling order for `recenter-top-bottom'.
5284 A list of elements with possible values `top', `middle', `bottom',
5285 integer or float numbers that define the cycling order for
5286 the command `recenter-top-bottom'.
5287
5288 Top and bottom destinations are `scroll-margin' lines the from true
5289 window top and bottom. Middle redraws the frame and centers point
5290 vertically within the window. Integer number moves current line to
5291 the specified absolute window-line. Float number between 0.0 and 1.0
5292 means the percentage of the screen space from the top. The default
5293 cycling order is middle -> top -> bottom."
5294 :type '(repeat (choice
5295 (const :tag "Top" top)
5296 (const :tag "Middle" middle)
5297 (const :tag "Bottom" bottom)
5298 (integer :tag "Line number")
5299 (float :tag "Percentage")))
5300 :version "23.2"
5301 :group 'windows)
5302
5303 (defun recenter-top-bottom (&optional arg)
5304 "Move current buffer line to the specified window line.
5305 With no prefix argument, successive calls place point according
5306 to the cycling order defined by `recenter-positions'.
5307
5308 A prefix argument is handled like `recenter':
5309 With numeric prefix ARG, move current line to window-line ARG.
5310 With plain `C-u', move current line to window center."
5311 (interactive "P")
5312 (cond
5313 (arg (recenter arg)) ; Always respect ARG.
5314 (t
5315 (setq recenter-last-op
5316 (if (eq this-command last-command)
5317 (car (or (cdr (member recenter-last-op recenter-positions))
5318 recenter-positions))
5319 (car recenter-positions)))
5320 (let ((this-scroll-margin
5321 (min (max 0 scroll-margin)
5322 (truncate (/ (window-body-height) 4.0)))))
5323 (cond ((eq recenter-last-op 'middle)
5324 (recenter))
5325 ((eq recenter-last-op 'top)
5326 (recenter this-scroll-margin))
5327 ((eq recenter-last-op 'bottom)
5328 (recenter (- -1 this-scroll-margin)))
5329 ((integerp recenter-last-op)
5330 (recenter recenter-last-op))
5331 ((floatp recenter-last-op)
5332 (recenter (round (* recenter-last-op (window-height))))))))))
5333
5334 (define-key global-map [?\C-l] 'recenter-top-bottom)
5335
5336 (defun move-to-window-line-top-bottom (&optional arg)
5337 "Position point relative to window.
5338
5339 With a prefix argument ARG, acts like `move-to-window-line'.
5340
5341 With no argument, positions point at center of window.
5342 Successive calls position point at positions defined
5343 by `recenter-positions'."
5344 (interactive "P")
5345 (cond
5346 (arg (move-to-window-line arg)) ; Always respect ARG.
5347 (t
5348 (setq recenter-last-op
5349 (if (eq this-command last-command)
5350 (car (or (cdr (member recenter-last-op recenter-positions))
5351 recenter-positions))
5352 (car recenter-positions)))
5353 (let ((this-scroll-margin
5354 (min (max 0 scroll-margin)
5355 (truncate (/ (window-body-height) 4.0)))))
5356 (cond ((eq recenter-last-op 'middle)
5357 (call-interactively 'move-to-window-line))
5358 ((eq recenter-last-op 'top)
5359 (move-to-window-line this-scroll-margin))
5360 ((eq recenter-last-op 'bottom)
5361 (move-to-window-line (- -1 this-scroll-margin)))
5362 ((integerp recenter-last-op)
5363 (move-to-window-line recenter-last-op))
5364 ((floatp recenter-last-op)
5365 (move-to-window-line (round (* recenter-last-op (window-height))))))))))
5366
5367 (define-key global-map [?\M-r] 'move-to-window-line-top-bottom)
5368 \f
5369 ;;; Scrolling commands.
5370
5371 ;;; Scrolling commands which does not signal errors at top/bottom
5372 ;;; of buffer at first key-press (instead moves to top/bottom
5373 ;;; of buffer).
5374
5375 (defcustom scroll-error-top-bottom nil
5376 "Move point to top/bottom of buffer before signalling a scrolling error.
5377 A value of nil means just signal an error if no more scrolling possible.
5378 A value of t means point moves to the beginning or the end of the buffer
5379 \(depending on scrolling direction) when no more scrolling possible.
5380 When point is already on that position, then signal an error."
5381 :type 'boolean
5382 :group 'scrolling
5383 :version "24.1")
5384
5385 (defun scroll-up-command (&optional arg)
5386 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
5387 If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
5388 scroll window further, move cursor to the bottom line.
5389 When point is already on that position, then signal an error.
5390 A near full screen is `next-screen-context-lines' less than a full screen.
5391 Negative ARG means scroll downward.
5392 If ARG is the atom `-', scroll downward by nearly full screen."
5393 (interactive "^P")
5394 (cond
5395 ((null scroll-error-top-bottom)
5396 (scroll-up arg))
5397 ((eq arg '-)
5398 (scroll-down-command nil))
5399 ((< (prefix-numeric-value arg) 0)
5400 (scroll-down-command (- (prefix-numeric-value arg))))
5401 ((eobp)
5402 (scroll-up arg)) ; signal error
5403 (t
5404 (condition-case nil
5405 (scroll-up arg)
5406 (end-of-buffer
5407 (if arg
5408 ;; When scrolling by ARG lines can't be done,
5409 ;; move by ARG lines instead.
5410 (forward-line arg)
5411 ;; When ARG is nil for full-screen scrolling,
5412 ;; move to the bottom of the buffer.
5413 (goto-char (point-max))))))))
5414
5415 (put 'scroll-up-command 'scroll-command t)
5416
5417 (defun scroll-down-command (&optional arg)
5418 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
5419 If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
5420 scroll window further, move cursor to the top line.
5421 When point is already on that position, then signal an error.
5422 A near full screen is `next-screen-context-lines' less than a full screen.
5423 Negative ARG means scroll upward.
5424 If ARG is the atom `-', scroll upward by nearly full screen."
5425 (interactive "^P")
5426 (cond
5427 ((null scroll-error-top-bottom)
5428 (scroll-down arg))
5429 ((eq arg '-)
5430 (scroll-up-command nil))
5431 ((< (prefix-numeric-value arg) 0)
5432 (scroll-up-command (- (prefix-numeric-value arg))))
5433 ((bobp)
5434 (scroll-down arg)) ; signal error
5435 (t
5436 (condition-case nil
5437 (scroll-down arg)
5438 (beginning-of-buffer
5439 (if arg
5440 ;; When scrolling by ARG lines can't be done,
5441 ;; move by ARG lines instead.
5442 (forward-line (- arg))
5443 ;; When ARG is nil for full-screen scrolling,
5444 ;; move to the top of the buffer.
5445 (goto-char (point-min))))))))
5446
5447 (put 'scroll-down-command 'scroll-command t)
5448
5449 ;;; Scrolling commands which scroll a line instead of full screen.
5450
5451 (defun scroll-up-line (&optional arg)
5452 "Scroll text of selected window upward ARG lines; or one line if no ARG.
5453 If ARG is omitted or nil, scroll upward by one line.
5454 This is different from `scroll-up-command' that scrolls a full screen."
5455 (interactive "p")
5456 (scroll-up (or arg 1)))
5457
5458 (put 'scroll-up-line 'scroll-command t)
5459
5460 (defun scroll-down-line (&optional arg)
5461 "Scroll text of selected window down ARG lines; or one line if no ARG.
5462 If ARG is omitted or nil, scroll down by one line.
5463 This is different from `scroll-down-command' that scrolls a full screen."
5464 (interactive "p")
5465 (scroll-down (or arg 1)))
5466
5467 (put 'scroll-down-line 'scroll-command t)
5468
5469 \f
5470 (defun scroll-other-window-down (lines)
5471 "Scroll the \"other window\" down.
5472 For more details, see the documentation for `scroll-other-window'."
5473 (interactive "P")
5474 (scroll-other-window
5475 ;; Just invert the argument's meaning.
5476 ;; We can do that without knowing which window it will be.
5477 (if (eq lines '-) nil
5478 (if (null lines) '-
5479 (- (prefix-numeric-value lines))))))
5480
5481 (defun beginning-of-buffer-other-window (arg)
5482 "Move point to the beginning of the buffer in the other window.
5483 Leave mark at previous position.
5484 With arg N, put point N/10 of the way from the true beginning."
5485 (interactive "P")
5486 (let ((orig-window (selected-window))
5487 (window (other-window-for-scrolling)))
5488 ;; We use unwind-protect rather than save-window-excursion
5489 ;; because the latter would preserve the things we want to change.
5490 (unwind-protect
5491 (progn
5492 (select-window window)
5493 ;; Set point and mark in that window's buffer.
5494 (with-no-warnings
5495 (beginning-of-buffer arg))
5496 ;; Set point accordingly.
5497 (recenter '(t)))
5498 (select-window orig-window))))
5499
5500 (defun end-of-buffer-other-window (arg)
5501 "Move point to the end of the buffer in the other window.
5502 Leave mark at previous position.
5503 With arg N, put point N/10 of the way from the true end."
5504 (interactive "P")
5505 ;; See beginning-of-buffer-other-window for comments.
5506 (let ((orig-window (selected-window))
5507 (window (other-window-for-scrolling)))
5508 (unwind-protect
5509 (progn
5510 (select-window window)
5511 (with-no-warnings
5512 (end-of-buffer arg))
5513 (recenter '(t)))
5514 (select-window orig-window))))
5515 \f
5516 (defvar mouse-autoselect-window-timer nil
5517 "Timer used by delayed window autoselection.")
5518
5519 (defvar mouse-autoselect-window-position nil
5520 "Last mouse position recorded by delayed window autoselection.")
5521
5522 (defvar mouse-autoselect-window-window nil
5523 "Last window recorded by delayed window autoselection.")
5524
5525 (defvar mouse-autoselect-window-state nil
5526 "When non-nil, special state of delayed window autoselection.
5527 Possible values are `suspend' \(suspend autoselection after a menu or
5528 scrollbar interaction\) and `select' \(the next invocation of
5529 'handle-select-window' shall select the window immediately\).")
5530
5531 (defun mouse-autoselect-window-cancel (&optional force)
5532 "Cancel delayed window autoselection.
5533 Optional argument FORCE means cancel unconditionally."
5534 (unless (and (not force)
5535 ;; Don't cancel for select-window or select-frame events
5536 ;; or when the user drags a scroll bar.
5537 (or (memq this-command
5538 '(handle-select-window handle-switch-frame))
5539 (and (eq this-command 'scroll-bar-toolkit-scroll)
5540 (memq (nth 4 (event-end last-input-event))
5541 '(handle end-scroll)))))
5542 (setq mouse-autoselect-window-state nil)
5543 (when (timerp mouse-autoselect-window-timer)
5544 (cancel-timer mouse-autoselect-window-timer))
5545 (remove-hook 'pre-command-hook 'mouse-autoselect-window-cancel)))
5546
5547 (defun mouse-autoselect-window-start (mouse-position &optional window suspend)
5548 "Start delayed window autoselection.
5549 MOUSE-POSITION is the last position where the mouse was seen as returned
5550 by `mouse-position'. Optional argument WINDOW non-nil denotes the
5551 window where the mouse was seen. Optional argument SUSPEND non-nil
5552 means suspend autoselection."
5553 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
5554 (setq mouse-autoselect-window-position mouse-position)
5555 (when window (setq mouse-autoselect-window-window window))
5556 (setq mouse-autoselect-window-state (when suspend 'suspend))
5557 ;; Install timer which runs `mouse-autoselect-window-select' after
5558 ;; `mouse-autoselect-window' seconds.
5559 (setq mouse-autoselect-window-timer
5560 (run-at-time
5561 (abs mouse-autoselect-window) nil 'mouse-autoselect-window-select)))
5562
5563 (defun mouse-autoselect-window-select ()
5564 "Select window with delayed window autoselection.
5565 If the mouse position has stabilized in a non-selected window, select
5566 that window. The minibuffer window is selected only if the minibuffer is
5567 active. This function is run by `mouse-autoselect-window-timer'."
5568 (ignore-errors
5569 (let* ((mouse-position (mouse-position))
5570 (window
5571 (ignore-errors
5572 (window-at (cadr mouse-position) (cddr mouse-position)
5573 (car mouse-position)))))
5574 (cond
5575 ((or (menu-or-popup-active-p)
5576 (and window
5577 (not (coordinates-in-window-p (cdr mouse-position) window))))
5578 ;; A menu / popup dialog is active or the mouse is on the scroll-bar
5579 ;; of WINDOW, temporarily suspend delayed autoselection.
5580 (mouse-autoselect-window-start mouse-position nil t))
5581 ((eq mouse-autoselect-window-state 'suspend)
5582 ;; Delayed autoselection was temporarily suspended, reenable it.
5583 (mouse-autoselect-window-start mouse-position))
5584 ((and window (not (eq window (selected-window)))
5585 (or (not (numberp mouse-autoselect-window))
5586 (and (> mouse-autoselect-window 0)
5587 ;; If `mouse-autoselect-window' is positive, select
5588 ;; window if the window is the same as before.
5589 (eq window mouse-autoselect-window-window))
5590 ;; Otherwise select window if the mouse is at the same
5591 ;; position as before. Observe that the first test after
5592 ;; starting autoselection usually fails since the value of
5593 ;; `mouse-autoselect-window-position' recorded there is the
5594 ;; position where the mouse has entered the new window and
5595 ;; not necessarily where the mouse has stopped moving.
5596 (equal mouse-position mouse-autoselect-window-position))
5597 ;; The minibuffer is a candidate window if it's active.
5598 (or (not (window-minibuffer-p window))
5599 (eq window (active-minibuffer-window))))
5600 ;; Mouse position has stabilized in non-selected window: Cancel
5601 ;; delayed autoselection and try to select that window.
5602 (mouse-autoselect-window-cancel t)
5603 ;; Select window where mouse appears unless the selected window is the
5604 ;; minibuffer. Use `unread-command-events' in order to execute pre-
5605 ;; and post-command hooks and trigger idle timers. To avoid delaying
5606 ;; autoselection again, set `mouse-autoselect-window-state'."
5607 (unless (window-minibuffer-p (selected-window))
5608 (setq mouse-autoselect-window-state 'select)
5609 (setq unread-command-events
5610 (cons (list 'select-window (list window))
5611 unread-command-events))))
5612 ((or (and window (eq window (selected-window)))
5613 (not (numberp mouse-autoselect-window))
5614 (equal mouse-position mouse-autoselect-window-position))
5615 ;; Mouse position has either stabilized in the selected window or at
5616 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
5617 (mouse-autoselect-window-cancel t))
5618 (t
5619 ;; Mouse position has not stabilized yet, resume delayed
5620 ;; autoselection.
5621 (mouse-autoselect-window-start mouse-position window))))))
5622
5623 (defun handle-select-window (event)
5624 "Handle select-window events."
5625 (interactive "e")
5626 (let ((window (posn-window (event-start event))))
5627 (unless (or (not (window-live-p window))
5628 ;; Don't switch if we're currently in the minibuffer.
5629 ;; This tries to work around problems where the
5630 ;; minibuffer gets unselected unexpectedly, and where
5631 ;; you then have to move your mouse all the way down to
5632 ;; the minibuffer to select it.
5633 (window-minibuffer-p (selected-window))
5634 ;; Don't switch to minibuffer window unless it's active.
5635 (and (window-minibuffer-p window)
5636 (not (minibuffer-window-active-p window)))
5637 ;; Don't switch when autoselection shall be delayed.
5638 (and (numberp mouse-autoselect-window)
5639 (not (zerop mouse-autoselect-window))
5640 (not (eq mouse-autoselect-window-state 'select))
5641 (progn
5642 ;; Cancel any delayed autoselection.
5643 (mouse-autoselect-window-cancel t)
5644 ;; Start delayed autoselection from current mouse
5645 ;; position and window.
5646 (mouse-autoselect-window-start (mouse-position) window)
5647 ;; Executing a command cancels delayed autoselection.
5648 (add-hook
5649 'pre-command-hook 'mouse-autoselect-window-cancel))))
5650 (when mouse-autoselect-window
5651 ;; Reset state of delayed autoselection.
5652 (setq mouse-autoselect-window-state nil)
5653 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
5654 (run-hooks 'mouse-leave-buffer-hook))
5655 (select-window window))))
5656
5657 (defun truncated-partial-width-window-p (&optional window)
5658 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
5659 WINDOW defaults to the selected window.
5660 Return nil if WINDOW is not a partial-width window
5661 (regardless of the value of `truncate-lines').
5662 Otherwise, consult the value of `truncate-partial-width-windows'
5663 for the buffer shown in WINDOW."
5664 (unless window
5665 (setq window (selected-window)))
5666 (unless (window-full-width-p window)
5667 (let ((t-p-w-w (buffer-local-value 'truncate-partial-width-windows
5668 (window-buffer window))))
5669 (if (integerp t-p-w-w)
5670 (< (window-width window) t-p-w-w)
5671 t-p-w-w))))
5672 \f
5673 ;; Some of these are in tutorial--default-keys, so update that if you
5674 ;; change these.
5675 (define-key ctl-x-map "0" 'delete-window)
5676 (define-key ctl-x-map "1" 'delete-other-windows)
5677 (define-key ctl-x-map "2" 'split-window-above-each-other)
5678 (define-key ctl-x-map "3" 'split-window-side-by-side)
5679 (define-key ctl-x-map "o" 'other-window)
5680 (define-key ctl-x-map "^" 'enlarge-window)
5681 (define-key ctl-x-map "}" 'enlarge-window-horizontally)
5682 (define-key ctl-x-map "{" 'shrink-window-horizontally)
5683 (define-key ctl-x-map "-" 'shrink-window-if-larger-than-buffer)
5684 (define-key ctl-x-map "+" 'balance-windows)
5685 (define-key ctl-x-4-map "0" 'kill-buffer-and-window)
5686
5687 ;;; window.el ends here