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