;; they don't substitute the selected window for nil), and they return
;; nil when WINDOW doesn't have a parent (like a frame's root window or
;; a minibuffer window).
-(defsubst window-right (window)
+(defun window-right (window)
"Return WINDOW's right sibling.
Return nil if WINDOW is the root window of its frame. WINDOW can
be any window."
(and window (window-parent window) (window-next-sibling window)))
-(defsubst window-left (window)
+(defun window-left (window)
"Return WINDOW's left sibling.
Return nil if WINDOW is the root window of its frame. WINDOW can
be any window."
(and window (window-parent window) (window-prev-sibling window)))
-(defsubst window-child (window)
+(defun window-child (window)
"Return WINDOW's first child window."
(or (window-top-child window) (window-left-child window)))
(setq window (window-next-sibling window))))
window)
-(defsubst window-any-p (object)
- "Return t if OBJECT denotes a live or internal window."
+(defun window-valid-p (object)
+ "Return t if OBJECT denotes a live window or internal window.
+Otherwise, return nil; this includes the case where OBJECT is a
+deleted window."
(and (windowp object)
(or (window-buffer object) (window-child object))
t))
-(defsubst window-normalize-buffer (buffer-or-name)
+(defun window-normalize-buffer (buffer-or-name)
"Return buffer specified by BUFFER-OR-NAME.
BUFFER-OR-NAME must be either a buffer or a string naming a live
buffer and defaults to the current buffer."
(t
(error "No such buffer %s" buffer-or-name))))
-(defsubst window-normalize-frame (frame)
+(defun window-normalize-frame (frame)
"Return frame specified by FRAME.
FRAME must be a live frame and defaults to the selected frame."
(if frame
(error "%s is not a live frame" frame))
(selected-frame)))
-(defsubst window-normalize-any-window (window)
+(defun window-normalize-window (window &optional live-only)
"Return window specified by WINDOW.
-WINDOW must be a window that has not been deleted and defaults to
-the selected window."
- (if window
- (if (window-any-p window)
- window
- (error "%s is not a window" window))
- (selected-window)))
-
-(defsubst window-normalize-live-window (window)
- "Return live window specified by WINDOW.
-WINDOW must be a live window and defaults to the selected one."
- (if window
- (if (and (windowp window) (window-buffer window))
- window
- (error "%s is not a live window" window))
- (selected-window)))
+If WINDOW is nil, return `selected-window'.
+If WINDOW is a live window or internal window, return WINDOW;
+ if LIVE-ONLY is non-nil, return WINDOW for a live window only.
+Otherwise, signal an error."
+ (cond ((null window)
+ (selected-window))
+ (live-only
+ (if (window-live-p window)
+ window
+ (error "%s is not a live window" window)))
+ ((if (window-valid-p window)
+ window
+ (error "%s is not a window" window)))))
(defvar ignore-window-parameters nil
"If non-nil, standard functions ignore window parameters.
these functions to inhibit processing of window parameters.")
(defconst window-safe-min-height 1
- "The absolut minimum number of lines of a window.
+ "The absolute minimum number of lines of a window.
Anything less might crash Emacs.")
(defcustom window-min-height 4
window to a height less than the one specified here, an
application should instead call `window-resize' with a non-nil
IGNORE argument. In order to have `split-window' make a window
-shorter, explictly specify the SIZE argument of that function."
+shorter, explicitly specify the SIZE argument of that function."
:type 'integer
:version "24.1"
:group 'windows)
(defconst window-safe-min-width 2
- "The absolut minimum number of columns of a window.
+ "The absolute minimum number of columns of a window.
Anything less might crash Emacs.")
(defcustom window-min-width 10
"The minimum number of columns of any window.
-The value has to accomodate margins, fringes, or scrollbars if
+The value has to accommodate margins, fringes, or scrollbars if
present. A value less than `window-safe-min-width' is ignored.
The value of this variable is honored when windows are resized or
split.
window to a width less than the one specified here, an
application should instead call `window-resize' with a non-nil
IGNORE argument. In order to have `split-window' make a window
-narrower, explictly specify the SIZE argument of that function."
+narrower, explicitly specify the SIZE argument of that function."
:type 'integer
:version "24.1"
:group 'windows)
-(defun window-iso-combination-p (&optional window horizontal)
- "If WINDOW is a vertical combination return WINDOW's first child.
-WINDOW can be any window and defaults to the selected one.
-Optional argument HORIZONTAL non-nil means return WINDOW's first
-child if WINDOW is a horizontal combination."
- (setq window (window-normalize-any-window window))
- (if horizontal
- (window-left-child window)
- (window-top-child window)))
+(defun window-combined-p (&optional window horizontal)
+ "Return non-nil if WINDOW has siblings in a given direction.
+If WINDOW is omitted or nil, it defaults to the selected window.
-(defsubst window-iso-combined-p (&optional window horizontal)
- "Return non-nil if and only if WINDOW is vertically combined.
-WINDOW can be any window and defaults to the selected one.
-Optional argument HORIZONTAL non-nil means return non-nil if and
-only if WINDOW is horizontally combined."
- (setq window (window-normalize-any-window window))
+HORIZONTAL determines a direction for the window combination.
+If HORIZONTAL is omitted or nil, return non-nil if WINDOW is part
+of a vertical window combination.
+If HORIZONTAL is non-nil, return non-nil if WINDOW is part of a
+horizontal window combination."
+ (setq window (window-normalize-window window))
(let ((parent (window-parent window)))
- (and parent (window-iso-combination-p parent horizontal))))
-
-(defun window-iso-combinations (&optional window horizontal)
- "Return largest number of vertically arranged subwindows of WINDOW.
-WINDOW can be any window and defaults to the selected one.
-Optional argument HORIZONTAL non-nil means to return the largest
-number of horizontally arranged subwindows of WINDOW."
- (setq window (window-normalize-any-window window))
+ (and parent
+ (if horizontal
+ (window-left-child parent)
+ (window-top-child parent)))))
+
+(defun window-combinations (window &optional horizontal)
+ "Return largest number of windows vertically arranged within WINDOW.
+If WINDOW is omitted or nil, it defaults to the selected window.
+If HORIZONTAL is non-nil, return the largest number of
+windows horizontally arranged within WINDOW."
+ (setq window (window-normalize-window window))
(cond
((window-live-p window)
;; If WINDOW is live, return 1.
1)
- ((window-iso-combination-p window horizontal)
+ ((if horizontal
+ (window-left-child window)
+ (window-top-child window))
;; If WINDOW is iso-combined, return the sum of the values for all
- ;; subwindows of WINDOW.
+ ;; child windows of WINDOW.
(let ((child (window-child window))
(count 0))
(while child
(setq count
- (+ (window-iso-combinations child horizontal)
+ (+ (window-combinations child horizontal)
count))
(setq child (window-right child)))
count))
(t
;; If WINDOW is not iso-combined, return the maximum value of any
- ;; subwindow of WINDOW.
+ ;; child window of WINDOW.
(let ((child (window-child window))
(count 1))
(while child
(setq count
- (max (window-iso-combinations child horizontal)
+ (max (window-combinations child horizontal)
count))
(setq child (window-right child)))
count))))
-(defun walk-window-tree-1 (proc walk-window-tree-window any &optional sub-only)
+(defun walk-window-tree-1 (fun walk-window-tree-window any &optional sub-only)
"Helper function for `walk-window-tree' and `walk-window-subtree'."
(let (walk-window-tree-buffer)
(while walk-window-tree-window
(setq walk-window-tree-buffer
(window-buffer walk-window-tree-window))
(when (or walk-window-tree-buffer any)
- (funcall proc walk-window-tree-window))
+ (funcall fun walk-window-tree-window))
(unless walk-window-tree-buffer
(walk-window-tree-1
- proc (window-left-child walk-window-tree-window) any)
+ fun (window-left-child walk-window-tree-window) any)
(walk-window-tree-1
- proc (window-top-child walk-window-tree-window) any))
+ fun (window-top-child walk-window-tree-window) any))
(if sub-only
(setq walk-window-tree-window nil)
(setq walk-window-tree-window
(window-right walk-window-tree-window))))))
-(defun walk-window-tree (proc &optional frame any)
- "Run function PROC on each live window of FRAME.
-PROC must be a function with one argument - a window. FRAME must
+(defun walk-window-tree (fun &optional frame any)
+ "Run function FUN on each live window of FRAME.
+FUN must be a function with one argument - a window. FRAME must
be a live frame and defaults to the selected one. ANY, if
-non-nil means to run PROC on all live and internal windows of
+non-nil means to run FUN on all live and internal windows of
FRAME.
This function performs a pre-order, depth-first traversal of the
-window tree. If PROC changes the window tree, the result is
+window tree. If FUN changes the window tree, the result is
unpredictable."
(let ((walk-window-tree-frame (window-normalize-frame frame)))
(walk-window-tree-1
- proc (frame-root-window walk-window-tree-frame) any)))
+ fun (frame-root-window walk-window-tree-frame) any)))
-(defun walk-window-subtree (proc &optional window any)
- "Run function PROC on each live subwindow of WINDOW.
-WINDOW defaults to the selected window. PROC must be a function
-with one argument - a window. ANY, if non-nil means to run PROC
-on all live and internal subwindows of WINDOW.
+(defun walk-window-subtree (fun &optional window any)
+ "Run function FUN on the subtree of windows rooted at WINDOW.
+WINDOW defaults to the selected window. FUN must be a function
+with one argument - a window. By default, run FUN only on live
+windows of the subtree. If the optional argument ANY is non-nil,
+run FUN on all live and internal windows of the subtree. If
+WINDOW is live, run FUN on WINDOW only.
This function performs a pre-order, depth-first traversal of the
-window tree rooted at WINDOW. If PROC changes that window tree,
-the result is unpredictable."
- (setq window (window-normalize-any-window window))
- (walk-window-tree-1 proc window any t))
-
-(defun windows-with-parameter (parameter &optional value frame any values)
- "Return a list of all windows on FRAME with PARAMETER non-nil.
-FRAME defaults to the selected frame. Optional argument VALUE
-non-nil means only return windows whose window-parameter value of
-PARAMETER equals VALUE \(comparison is done using `equal').
-Optional argument ANY non-nil means consider internal windows
-too. Optional argument VALUES non-nil means return a list of cons
-cells whose car is the value of the parameter and whose cdr is
-the window."
- (let (this-value windows)
- (walk-window-tree
- (lambda (window)
- (when (and (setq this-value (window-parameter window parameter))
- (or (not value) (or (equal value this-value))))
- (setq windows
- (if values
- (cons (cons this-value window) windows)
- (cons window windows)))))
- frame any)
-
- (nreverse windows)))
+subtree rooted at WINDOW. If FUN changes that tree, the result
+is unpredictable."
+ (setq window (window-normalize-window window))
+ (walk-window-tree-1 fun window any t))
(defun window-with-parameter (parameter &optional value frame any)
"Return first window on FRAME with PARAMETER non-nil.
"Return root of atomic window WINDOW is a part of.
WINDOW can be any window and defaults to the selected one.
Return nil if WINDOW is not part of a atomic window."
- (setq window (window-normalize-any-window window))
+ (setq window (window-normalize-window window))
(let (root)
(while (and window (window-parameter window 'window-atom))
(setq root window)
window t)
window))
-(defun window-atom-check-1 (window)
- "Subroutine of `window-atom-check'."
+(defun window--atom-check-1 (window)
+ "Subroutine of `window--atom-check'."
(when window
(if (window-parameter window 'window-atom)
(let ((count 0))
window t)))
;; Check children.
(unless (window-buffer window)
- (window-atom-check-1 (window-left-child window))
- (window-atom-check-1 (window-top-child window))))
+ (window--atom-check-1 (window-left-child window))
+ (window--atom-check-1 (window-top-child window))))
;; Check right sibling
- (window-atom-check-1 (window-right window))))
+ (window--atom-check-1 (window-right window))))
-(defun window-atom-check (&optional frame)
+(defun window--atom-check (&optional frame)
"Check atomicity of all windows on FRAME.
FRAME defaults to the selected frame. If an atomic window is
-wrongly configured, reset the atomicity of all its subwindows to
-nil. An atomic window is wrongly configured if it has no
-subwindows or one of its subwindows is not atomic."
- (window-atom-check-1 (frame-root-window frame)))
+wrongly configured, reset the atomicity of all its windows on
+FRAME to nil. An atomic window is wrongly configured if it has
+no child windows or one of its child windows is not atomic."
+ (window--atom-check-1 (frame-root-window frame)))
;; Side windows.
(defvar window-sides '(left top right bottom)
(integer :tag "Number" :value 3 :size 5)))
:group 'windows)
-(defun window-side-check (&optional frame)
+(defun window--side-check (&optional frame)
"Check the window-side parameter of all windows on FRAME.
FRAME defaults to the selected frame. If the configuration is
invalid, reset all window-side parameters to nil.
(set-window-parameter window 'window-side nil))
frame t))))
-(defun window-check (&optional frame)
+(defun window--check (&optional frame)
"Check atomic and side windows on FRAME.
FRAME defaults to the selected frame."
- (window-side-check frame)
- (window-atom-check frame))
+ (window--side-check frame)
+ (window--atom-check frame))
;;; Window sizes.
(defvar window-size-fixed nil
window).")
(make-variable-buffer-local 'window-size-fixed)
-(defsubst window-size-ignore (window ignore)
+(defun window--size-ignore (window ignore)
"Return non-nil if IGNORE says to ignore size restrictions for WINDOW."
- (if (window-any-p ignore) (eq window ignore) ignore))
+ (if (window-valid-p ignore) (eq window ignore) ignore))
(defun window-min-size (&optional window horizontal ignore)
"Return the minimum number of lines of WINDOW.
windows may get as small as `window-safe-min-height' lines and
`window-safe-min-width' columns. IGNORE a window means ignore
restrictions for that window only."
- (window-min-size-1
- (window-normalize-any-window window) horizontal ignore))
+ (window--min-size-1
+ (window-normalize-window window) horizontal ignore))
-(defun window-min-size-1 (window horizontal ignore)
+(defun window--min-size-1 (window horizontal ignore)
"Internal function of `window-min-size'."
(let ((sub (window-child window)))
(if sub
(let ((value 0))
;; WINDOW is an internal window.
- (if (window-iso-combined-p sub horizontal)
+ (if (window-combined-p sub horizontal)
;; The minimum size of an iso-combination is the sum of
- ;; the minimum sizes of its subwindows.
+ ;; the minimum sizes of its child windows.
(while sub
(setq value (+ value
- (window-min-size-1 sub horizontal ignore)))
+ (window--min-size-1 sub horizontal ignore)))
(setq sub (window-right sub)))
;; The minimum size of an ortho-combination is the maximum of
- ;; the minimum sizes of its subwindows.
+ ;; the minimum sizes of its child windows.
(while sub
(setq value (max value
- (window-min-size-1 sub horizontal ignore)))
+ (window--min-size-1 sub horizontal ignore)))
(setq sub (window-right sub))))
value)
(with-current-buffer (window-buffer window)
(cond
- ((and (not (window-size-ignore window ignore))
+ ((and (not (window--size-ignore window ignore))
(window-size-fixed-p window horizontal))
;; The minimum size of a fixed size window is its size.
(window-total-size window horizontal))
(ceiling (or (frame-parameter frame 'scroll-bar-width) 14)
(frame-char-width)))
(t 0)))
- (if (and (not (window-size-ignore window ignore))
+ (if (and (not (window--size-ignore window ignore))
(numberp window-min-width))
window-min-width
0))))
(max (+ window-safe-min-height
(if header-line-format 1 0)
(if mode-line-format 1 0))
- (if (and (not (window-size-ignore window ignore))
+ (if (and (not (window--size-ignore window ignore))
(numberp window-min-height))
window-min-height
0))))))))
columns can be added to WINDOW. A return value of zero means
that no lines (or columns) can be added to WINDOW.
-This function looks only at WINDOW and its subwindows. The
-function `window-resizable' looks at other windows as well.
+This function looks only at WINDOW and, recursively, its child
+windows. The function `window-resizable' looks at other windows
+as well.
DELTA positive means WINDOW shall be enlarged by DELTA lines or
columns. If WINDOW cannot be enlarged by DELTA lines or columns
windows may get as small as `window-safe-min-height' lines and
`window-safe-min-width' columns. IGNORE any window means ignore
restrictions for that window only."
- (setq window (window-normalize-any-window window))
+ (setq window (window-normalize-window window))
(cond
((< delta 0)
(max (- (window-min-size window horizontal ignore)
(window-total-size window horizontal))
delta))
- ((window-size-ignore window ignore)
+ ((window--size-ignore window ignore)
delta)
((> delta 0)
(if (window-size-fixed-p window horizontal)
delta))
(t 0)))
-(defsubst window-sizable-p (window delta &optional horizontal ignore)
+(defun window-sizable-p (window delta &optional horizontal ignore)
"Return t if WINDOW can be resized by DELTA lines.
For the meaning of the arguments of this function see the
doc-string of `window-sizable'."
- (setq window (window-normalize-any-window window))
+ (setq window (window-normalize-window window))
(if (> delta 0)
(>= (window-sizable window delta horizontal ignore) delta)
(<= (window-sizable window delta horizontal ignore) delta)))
-(defun window-size-fixed-1 (window horizontal)
+(defun window--size-fixed-1 (window horizontal)
"Internal function for `window-size-fixed-p'."
(let ((sub (window-child window)))
(catch 'fixed
(if sub
;; WINDOW is an internal window.
- (if (window-iso-combined-p sub horizontal)
- ;; An iso-combination is fixed size if all its subwindows
- ;; are fixed-size.
+ (if (window-combined-p sub horizontal)
+ ;; An iso-combination is fixed size if all its child
+ ;; windows are fixed-size.
(progn
(while sub
- (unless (window-size-fixed-1 sub horizontal)
- ;; We found a non-fixed-size subwindow, so WINDOW's
- ;; size is not fixed.
+ (unless (window--size-fixed-1 sub horizontal)
+ ;; We found a non-fixed-size child window, so
+ ;; WINDOW's size is not fixed.
(throw 'fixed nil))
(setq sub (window-right sub)))
- ;; All subwindows are fixed-size, so WINDOW's size is
+ ;; All child windows are fixed-size, so WINDOW's size is
;; fixed.
(throw 'fixed t))
;; An ortho-combination is fixed-size if at least one of its
- ;; subwindows is fixed-size.
+ ;; child windows is fixed-size.
(while sub
- (when (window-size-fixed-1 sub horizontal)
- ;; We found a fixed-size subwindow, so WINDOW's size is
- ;; fixed.
+ (when (window--size-fixed-1 sub horizontal)
+ ;; We found a fixed-size child window, so WINDOW's size
+ ;; is fixed.
(throw 'fixed t))
(setq sub (window-right sub))))
;; WINDOW is a live window.
non-nil if WINDOW's width is fixed.
If this function returns nil, this does not necessarily mean that
-WINDOW can be resized in the desired direction. The functions
-`window-resizable' and `window-resizable-p' will tell that."
- (window-size-fixed-1
- (window-normalize-any-window window) horizontal))
+WINDOW can be resized in the desired direction. The function
+`window-resizable' can tell that."
+ (window--size-fixed-1
+ (window-normalize-window window) horizontal))
-(defun window-min-delta-1 (window delta &optional horizontal ignore trail noup)
+(defun window--min-delta-1 (window delta &optional horizontal ignore trail noup)
"Internal function for `window-min-delta'."
(if (not (window-parent window))
;; If we can't go up, return zero.
(let* ((parent (window-parent window))
(sub (window-child parent)))
(catch 'done
- (if (window-iso-combined-p sub horizontal)
+ (if (window-combined-p sub horizontal)
;; In an iso-combination throw DELTA if we find at least one
- ;; subwindow and that subwindow is either not of fixed-size
- ;; or we can ignore fixed-sizeness.
+ ;; child window and that window is either not fixed-size or
+ ;; we can ignore fixed-sizeness.
(let ((skip (eq trail 'after)))
(while sub
(cond
((eq sub window)
(setq skip (eq trail 'before)))
(skip)
- ((and (not (window-size-ignore window ignore))
+ ((and (not (window--size-ignore window ignore))
(window-size-fixed-p sub horizontal)))
(t
- ;; We found a non-fixed-size subwindow.
+ ;; We found a non-fixed-size child window.
(throw 'done delta)))
(setq sub (window-right sub))))
;; In an ortho-combination set DELTA to the minimum value by
- ;; which other subwindows can shrink.
+ ;; which other child windows can shrink.
(while sub
(unless (eq sub window)
(setq delta
(setq sub (window-right sub))))
(if noup
delta
- (window-min-delta-1 parent delta horizontal ignore trail))))))
+ (window--min-delta-1 parent delta horizontal ignore trail))))))
(defun window-min-delta (&optional window horizontal ignore trail noup nodown)
"Return number of lines by which WINDOW can be shrunk.
tree but try to enlarge windows within WINDOW's combination only.
Optional argument NODOWN non-nil means don't check whether WINDOW
-itself \(and its subwindows) can be shrunk; check only whether at
-least one other windows can be enlarged appropriately."
- (setq window (window-normalize-any-window window))
+itself \(and its child windows) can be shrunk; check only whether
+at least one other window can be enlarged appropriately."
+ (setq window (window-normalize-window window))
(let ((size (window-total-size window horizontal))
(minimum (window-min-size window horizontal ignore)))
(cond
(nodown
;; If NODOWN is t, try to recover the entire size of WINDOW.
- (window-min-delta-1 window size horizontal ignore trail noup))
+ (window--min-delta-1 window size horizontal ignore trail noup))
((= size minimum)
;; If NODOWN is nil and WINDOW's size is already at its minimum,
;; there's nothing to recover.
(t
;; Otherwise, try to recover whatever WINDOW is larger than its
;; minimum size.
- (window-min-delta-1
+ (window--min-delta-1
window (- size minimum) horizontal ignore trail noup)))))
-(defun window-max-delta-1 (window delta &optional horizontal ignore trail noup)
+(defun window--max-delta-1 (window delta &optional horizontal ignore trail noup)
"Internal function of `window-max-delta'."
(if (not (window-parent window))
;; Can't go up. Return DELTA.
(let* ((parent (window-parent window))
(sub (window-child parent)))
(catch 'fixed
- (if (window-iso-combined-p sub horizontal)
+ (if (window-combined-p sub horizontal)
;; For an iso-combination calculate how much we can get from
- ;; other subwindows.
+ ;; other child windows.
(let ((skip (eq trail 'after)))
(while sub
(cond
(window-min-size sub horizontal ignore))))))
(setq sub (window-right sub))))
;; For an ortho-combination throw DELTA when at least one
- ;; subwindow is fixed-size.
+ ;; child window is fixed-size.
(while sub
(when (and (not (eq sub window))
- (not (window-size-ignore sub ignore))
+ (not (window--size-ignore sub ignore))
(window-size-fixed-p sub horizontal))
(throw 'fixed delta))
(setq sub (window-right sub))))
delta
;; Else try with parent of WINDOW, passing the DELTA we
;; recovered so far.
- (window-max-delta-1 parent delta horizontal ignore trail))))))
+ (window--max-delta-1 parent delta horizontal ignore trail))))))
(defun window-max-delta (&optional window horizontal ignore trail noup nodown)
"Return maximum number of lines WINDOW by which WINDOW can be enlarged.
WINDOW's combination.
Optional argument NODOWN non-nil means do not check whether
-WINDOW itself \(and its subwindows) can be enlarged; check only
-whether other windows can be shrunk appropriately."
- (setq window (window-normalize-any-window window))
- (if (and (not (window-size-ignore window ignore))
+WINDOW itself \(and its child windows) can be enlarged; check
+only whether other windows can be shrunk appropriately."
+ (setq window (window-normalize-window window))
+ (if (and (not (window--size-ignore window ignore))
(not nodown) (window-size-fixed-p window horizontal))
;; With IGNORE and NOWDON nil return zero if WINDOW has fixed
;; size.
0
;; WINDOW has no fixed size.
- (window-max-delta-1 window 0 horizontal ignore trail noup)))
+ (window--max-delta-1 window 0 horizontal ignore trail noup)))
;; Make NOUP also inhibit the min-size check.
-(defun window-resizable (window delta &optional horizontal ignore trail noup nodown)
+(defun window--resizable (window delta &optional horizontal ignore trail noup nodown)
"Return DELTA if WINDOW can be resized vertically by DELTA lines.
Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
can be resized horizontally by DELTA columns. A return value of
zero means that WINDOW is not resizable.
DELTA positive means WINDOW shall be enlarged by DELTA lines or
-columns. If WINDOW cannot be enlarged by DELTA lines or columns
+columns. If WINDOW cannot be enlarged by DELTA lines or columns,
return the maximum value in the range 0..DELTA by which WINDOW
can be enlarged.
shrunk.
Optional argument NOUP non-nil means don't go up in the window
-tree but try to distribute the space among the other windows
-within WINDOW's combination.
+tree but check only whether space can be obtained from (or given
+to) WINDOW's siblings.
-Optional argument NODOWN non-nil means don't check whether WINDOW
-and its subwindows can be resized."
- (setq window (window-normalize-any-window window))
+Optional argument NODOWN non-nil means don't go down in the
+window tree. This means do not check whether resizing would
+violate size restrictions of WINDOW or its child windows."
+ (setq window (window-normalize-window window))
(cond
((< delta 0)
(max (- (window-min-delta window horizontal ignore trail noup nodown))
delta))
(t 0)))
-(defun window-resizable-p (window delta &optional horizontal ignore trail noup nodown)
+(defun window--resizable-p (window delta &optional horizontal ignore trail noup nodown)
"Return t if WINDOW can be resized vertically by DELTA lines.
For the meaning of the arguments of this function see the
-doc-string of `window-resizable'."
- (setq window (window-normalize-any-window window))
+doc-string of `window--resizable'."
+ (setq window (window-normalize-window window))
(if (> delta 0)
- (>= (window-resizable window delta horizontal ignore trail noup nodown)
+ (>= (window--resizable window delta horizontal ignore trail noup nodown)
delta)
- (<= (window-resizable window delta horizontal ignore trail noup nodown)
+ (<= (window--resizable window delta horizontal ignore trail noup nodown)
delta)))
-(defsubst window-total-height (&optional window)
- "Return the total number of lines of WINDOW.
-WINDOW can be any window and defaults to the selected one. The
-return value includes WINDOW's mode line and header line, if any.
-If WINDOW is internal the return value is the sum of the total
-number of lines of WINDOW's child windows if these are vertically
-combined and the height of WINDOW's first child otherwise.
+(defun window-resizable (window delta &optional horizontal ignore)
+ "Return DELTA if WINDOW can be resized vertically by DELTA lines.
+Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
+can be resized horizontally by DELTA columns. A return value of
+zero means that WINDOW is not resizable.
-Note: This function does not take into account the value of
-`line-spacing' when calculating the number of lines in WINDOW."
- (window-total-size window))
+DELTA positive means WINDOW shall be enlarged by DELTA lines or
+columns. If WINDOW cannot be enlarged by DELTA lines or columns
+return the maximum value in the range 0..DELTA by which WINDOW
+can be enlarged.
+
+DELTA negative means WINDOW shall be shrunk by -DELTA lines or
+columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
+return the minimum value in the range DELTA..0 that can be used
+for shrinking WINDOW.
+
+Optional argument IGNORE non-nil means ignore any restrictions
+imposed by fixed size windows, `window-min-height' or
+`window-min-width' settings. IGNORE a window means ignore
+restrictions for that window only. IGNORE equal `safe' means
+live windows may get as small as `window-safe-min-height' lines
+and `window-safe-min-width' columns."
+ (setq window (window-normalize-window window))
+ (window--resizable window delta horizontal ignore))
+
+(defun window-total-size (&optional window horizontal)
+ "Return the total height or width of window WINDOW.
+If WINDOW is omitted or nil, it defaults to the selected window.
+
+If HORIZONTAL is omitted or nil, return the total height of
+WINDOW, in lines, like `window-total-height'. Otherwise return
+the total width, in columns, like `window-total-width'."
+ (if horizontal
+ (window-total-width window)
+ (window-total-height window)))
;; Eventually we should make `window-height' obsolete.
(defalias 'window-height 'window-total-height)
;; See discussion in bug#4543.
-(defsubst window-full-height-p (&optional window)
+(defun window-full-height-p (&optional window)
"Return t if WINDOW is as high as the containing frame.
More precisely, return t if and only if the total height of
WINDOW equals the total height of the root window of WINDOW's
frame. WINDOW can be any window and defaults to the selected
one."
- (setq window (window-normalize-any-window window))
+ (setq window (window-normalize-window window))
(= (window-total-size window)
(window-total-size (frame-root-window window))))
-(defsubst window-total-width (&optional window)
- "Return the total number of columns of WINDOW.
-WINDOW can be any window and defaults to the selected one. The
-return value includes any vertical dividers or scrollbars of
-WINDOW. If WINDOW is internal, the return value is the sum of
-the total number of columns of WINDOW's child windows if these
-are horizontally combined and the width of WINDOW's first child
-otherwise."
- (window-total-size window t))
-
-(defsubst window-full-width-p (&optional window)
+(defun window-full-width-p (&optional window)
"Return t if WINDOW is as wide as the containing frame.
More precisely, return t if and only if the total width of WINDOW
equals the total width of the root window of WINDOW's frame.
WINDOW can be any window and defaults to the selected one."
- (setq window (window-normalize-any-window window))
+ (setq window (window-normalize-window window))
(= (window-total-size window t)
(window-total-size (frame-root-window window) t)))
-(defsubst window-body-height (&optional window)
- "Return the number of lines of WINDOW's body.
-WINDOW must be a live window and defaults to the selected one.
-
-The return value does not include WINDOW's mode line and header
-line, if any. If a line at the bottom of the window is only
-partially visible, that line is included in the return value. If
-you do not want to include a partially visible bottom line in the
-return value, use `window-text-height' instead."
- (window-body-size window))
-
-(defsubst window-body-width (&optional window)
- "Return the number of columns of WINDOW's body.
-WINDOW must be a live window and defaults to the selected one.
+(defun window-body-size (&optional window horizontal)
+ "Return the height or width of WINDOW's text area.
+If WINDOW is omitted or nil, it defaults to the selected window.
+Signal an error if the window is not live.
-The return value does not include any vertical dividers or scroll
-bars owned by WINDOW. On a window-system the return value does
-not include the number of columns used for WINDOW's fringes or
-display margins either."
- (window-body-size window t))
+If HORIZONTAL is omitted or nil, return the height of the text
+area, like `window-body-height'. Otherwise, return the width of
+the text area, like `window-body-width'."
+ (if horizontal
+ (window-body-width window)
+ (window-body-height window)))
;; Eventually we should make `window-height' obsolete.
(defalias 'window-width 'window-body-width)
Unlike `window-scroll-bars', this function reports the scroll bar
type actually used, once frame defaults and `scroll-bar-mode' are
taken into account."
- (setq window (window-normalize-live-window window))
+ (setq window (window-normalize-window window t))
(let ((vert (nth 2 (window-scroll-bars window)))
(hor nil))
(when (or (eq vert t) (eq hor t))
(setq hor (cdr fcsb)))))
(cons vert hor)))
-(defun walk-windows (proc &optional minibuf all-frames)
- "Cycle through all live windows, calling PROC for each one.
-PROC must specify a function with a window as its sole argument.
+(defun walk-windows (fun &optional minibuf all-frames)
+ "Cycle through all live windows, calling FUN for each one.
+FUN must specify a function with a window as its sole argument.
The optional arguments MINIBUF and ALL-FRAMES specify the set of
windows to include in the walk.
(when (framep all-frames)
(select-window (frame-first-window all-frames) 'norecord))
(dolist (walk-windows-window (window-list-1 nil minibuf all-frames))
- (funcall proc walk-windows-window))))
+ (funcall fun walk-windows-window))))
+
+(defun window-point-1 (&optional window)
+ "Return value of WINDOW's point.
+WINDOW can be any live window and defaults to the selected one.
-(defun window-in-direction-2 (window posn &optional horizontal)
+This function is like `window-point' with one exception: If
+WINDOW is selected, it returns the value of `point' of WINDOW's
+buffer regardless of whether that buffer is current or not."
+ (setq window (window-normalize-window window t))
+ (if (eq window (selected-window))
+ (with-current-buffer (window-buffer window)
+ (point))
+ (window-point window)))
+
+(defun set-window-point-1 (window pos)
+ "Set value of WINDOW's point to POS.
+WINDOW can be any live window and defaults to the selected one.
+
+This function is like `set-window-point' with one exception: If
+WINDOW is selected, it moves `point' of WINDOW's buffer to POS
+regardless of whether that buffer is current or not."
+ (setq window (window-normalize-window window t))
+ (if (eq window (selected-window))
+ (with-current-buffer (window-buffer window)
+ (goto-char pos))
+ (set-window-point window pos)))
+
+(defun window-at-side-p (&optional window side)
+ "Return t if WINDOW is at SIDE of its containing frame.
+WINDOW can be any window and defaults to the selected one. SIDE
+can be any of the symbols `left', `top', `right' or `bottom'.
+The default value nil is handled like `bottom'."
+ (setq window (window-normalize-window window))
+ (let ((edge
+ (cond
+ ((eq side 'left) 0)
+ ((eq side 'top) 1)
+ ((eq side 'right) 2)
+ ((memq side '(bottom nil)) 3))))
+ (= (nth edge (window-edges window))
+ (nth edge (window-edges (frame-root-window window))))))
+
+(defun window-at-side-list (&optional frame side)
+ "Return list of all windows on SIDE of FRAME.
+FRAME must be a live frame and defaults to the selected frame.
+SIDE can be any of the symbols `left', `top', `right' or
+`bottom'. The default value nil is handled like `bottom'."
+ (setq frame (window-normalize-frame frame))
+ (let (windows)
+ (walk-window-tree
+ (lambda (window)
+ (when (window-at-side-p window side)
+ (setq windows (cons window windows))))
+ frame)
+ (nreverse windows)))
+
+(defun window--in-direction-2 (window posn &optional horizontal)
"Support function for `window-in-direction'."
(if horizontal
(let ((top (window-top-line window)))
WINDOW must be a live window and defaults to the selected one.
IGNORE, when non-nil means a window can be returned even if its
`no-other-window' parameter is non-nil."
- (setq window (window-normalize-live-window window))
+ (setq window (window-normalize-window window t))
(unless (memq direction '(above below left right))
(error "Wrong direction %s" direction))
(let* ((frame (window-frame window))
(last (+ first (if hor
(window-total-width window)
(window-total-height window))))
- (posn-cons (nth 6 (posn-at-point (window-point window) window)))
+ (posn-cons (nth 6 (posn-at-point (window-point-1 window) window)))
;; The column / row value of `posn-at-point' can be nil for the
;; mini-window, guard against that.
(posn (if hor
;; W is to the left or right of WINDOW but does not
;; cover POSN.
(setq best-diff-2-new
- (window-in-direction-2 w posn hor))
+ (window--in-direction-2 w posn hor))
(or (< best-diff-2-new best-diff-2)
(and (= best-diff-2-new best-diff-2)
(if (eq direction 'left)
(and (eq direction 'below) (<= last w-top)))
;; W is above or below WINDOW but does not cover POSN.
(setq best-diff-2-new
- (window-in-direction-2 w posn hor))
+ (window--in-direction-2 w posn hor))
(or (< best-diff-2-new best-diff-2)
(and (= best-diff-2-new best-diff-2)
(if (eq direction 'above)
;; Resize now.
(window--resize-reset frame)
- ;; Ideally we should be able to resize just the last subwindow of
- ;; root here. See the comment in `resize-root-window-vertically'
- ;; for why we do not do that.
+ ;; Ideally we should be able to resize just the last child of root
+ ;; here. See the comment in `resize-root-window-vertically' for
+ ;; why we do not do that.
(window--resize-this-window root (- delta) nil nil t)
(set-window-new-total window (+ height delta))
;; The following routine catches the case where we want to resize
deletes any windows. If you want to move only the low (right)
edge of WINDOW consider using `adjust-window-trailing-edge'
instead."
- (setq window (window-normalize-any-window window))
+ (setq window (window-normalize-window window))
(let* ((frame (window-frame window))
sibling)
(cond
(error "Cannot resize the root window of a frame"))
((window-minibuffer-p window)
(window--resize-mini-window window delta))
- ((window-resizable-p window delta horizontal ignore)
+ ((window--resizable-p window delta horizontal ignore)
(window--resize-reset frame horizontal)
(window--resize-this-window window delta horizontal ignore t)
- (if (and (not (window-splits window))
- (window-iso-combined-p window horizontal)
+ (if (and (not window-combination-resize)
+ (window-combined-p window horizontal)
(setq sibling (or (window-right window) (window-left window)))
(window-sizable-p sibling (- delta) horizontal ignore))
- ;; If window-splits returns nil for WINDOW, WINDOW is part of
- ;; an iso-combination, and WINDOW's neighboring right or left
+ ;; If window-combination-resize is nil, WINDOW is part of an
+ ;; iso-combination, and WINDOW's neighboring right or left
;; sibling can be resized as requested, resize that sibling.
(let ((normal-delta
(/ (float delta)
(t
(error "Cannot resize window %s" window)))))
-(defsubst window--resize-subwindows-skip-p (window)
+(defun window--resize-child-windows-skip-p (window)
"Return non-nil if WINDOW shall be skipped by resizing routines."
(memq (window-new-normal window) '(ignore stuck skip)))
-(defun window--resize-subwindows-normal (parent horizontal window this-delta &optional trail other-delta)
- "Set the new normal height of subwindows of window PARENT.
+(defun window--resize-child-windows-normal (parent horizontal window this-delta &optional trail other-delta)
+ "Recursively set new normal height of child windows of window PARENT.
HORIZONTAL non-nil means set the new normal width of these
-windows. WINDOW specifies a subwindow of PARENT that has been
+windows. WINDOW specifies a child window of PARENT that has been
resized by THIS-DELTA lines \(columns).
Optional argument TRAIL either 'before or 'after means set values
(parent-normal 0.0)
(skip (eq trail 'after)))
- ;; Set parent-normal to the sum of the normal sizes of all
- ;; subwindows of PARENT that shall be resized, excluding only WINDOW
+ ;; Set parent-normal to the sum of the normal sizes of all child
+ ;; windows of PARENT that shall be resized, excluding only WINDOW
;; and any windows specified by the optional TRAIL argument.
(while sub
(cond
(+ parent-normal (window-normal-size sub horizontal)))))
(setq sub (window-right sub)))
- ;; Set the new normal size of all subwindows of PARENT from what
+ ;; Set the new normal size of all child windows of PARENT from what
;; they should have contributed for recovering THIS-DELTA lines
;; (columns).
(setq sub (window-child parent))
;; Don't get larger than 1 or smaller than 0.
(min 1.0 (max (- 1.0 sum) 0.0))))))
-(defun window--resize-subwindows (parent delta &optional horizontal window ignore trail edge)
- "Resize subwindows of window PARENT vertically by DELTA lines.
+(defun window--resize-child-windows (parent delta &optional horizontal window ignore trail edge)
+ "Resize child windows of window PARENT vertically by DELTA lines.
PARENT must be a vertically combined internal window.
-Optional argument HORIZONTAL non-nil means resize subwindows of
+Optional argument HORIZONTAL non-nil means resize child windows of
PARENT horizontally by DELTA columns. In this case PARENT must
be a horizontally combined internal window.
(setq sub first)
(while (and (window-right sub)
(or (and (eq trail 'before)
- (not (window--resize-subwindows-skip-p
+ (not (window--resize-child-windows-skip-p
(window-right sub))))
(and (eq trail 'after)
- (window--resize-subwindows-skip-p sub))))
+ (window--resize-child-windows-skip-p sub))))
(setq sub (window-right sub)))
sub)
(if horizontal
window (- (window-normal-size window horizontal)
(- (window-new-normal sub)
(window-normal-size sub horizontal)))))
- (window--resize-subwindows-normal
+ (window--resize-child-windows-normal
parent horizontal sub 0 trail delta))
;; Return 'normalized to notify `window--resize-siblings' that
;; normal sizes have been already set.
(setq sub first)
(while sub
(cond
- ((or (window--resize-subwindows-skip-p sub)
- ;; Ignore windows to skip and fixed-size subwindows - in
- ;; the latter case make it a window to skip.
+ ((or (window--resize-child-windows-skip-p sub)
+ ;; Ignore windows to skip and fixed-size child windows -
+ ;; in the latter case make it a window to skip.
(and (not ignore)
(window-size-fixed-p sub horizontal)
(set-window-new-normal sub 'ignore))))
(set-window-new-normal sub))
(unless (eq (window-new-normal sub) 'ignore)
- ;; Resize this subwindow's subwindows (back-engineering
+ ;; Resize this window's child windows (back-engineering
;; delta from sub's old and new total sizes).
(let ((delta (- (window-new-total sub)
(window-total-size sub horizontal))))
(when (window-parent window)
(let* ((parent (window-parent window))
(sub (window-child parent)))
- (if (window-iso-combined-p sub horizontal)
+ (if (window-combined-p sub horizontal)
;; In an iso-combination try to extract DELTA from WINDOW's
;; siblings.
(let ((first sub)
;; Make sure this sibling is left alone when
;; resizing its siblings.
(set-window-new-normal sub 'ignore))
- ((or (window-size-ignore sub ignore)
+ ((or (window--size-ignore sub ignore)
(not (window-size-fixed-p sub horizontal)))
;; Set this-delta to t to signal that we found a sibling
;; of WINDOW whose size is not fixed.
;; Set this-delta to what we can get from WINDOW's siblings.
(if (= (- delta) (window-total-size window horizontal))
;; A deletion, presumably. We must handle this case
- ;; specially since `window-resizable' can't be used.
+ ;; specially since `window--resizable' can't be used.
(if this-delta
;; There's at least one resizable sibling we can
;; give WINDOW's size to.
(setq this-delta 0))
;; Any other form of resizing.
(setq this-delta
- (window-resizable window delta horizontal ignore trail t)))
+ (window--resizable window delta horizontal ignore trail t)))
;; Set other-delta to what we still have to get from
;; ancestor windows of parent.
(if (zerop this-delta)
;; We haven't got anything from WINDOW's siblings but we
;; must update the normal sizes to respect other-delta.
- (window--resize-subwindows-normal
+ (window--resize-child-windows-normal
parent horizontal window this-delta trail other-delta)
;; We did get something from WINDOW's siblings which means
- ;; we have to resize their subwindows.
- (unless (eq (window--resize-subwindows
+ ;; we have to resize their child windows.
+ (unless (eq (window--resize-child-windows
parent (- this-delta) horizontal
window ignore trail edge)
- ;; If `window--resize-subwindows' returns
+ ;; If `window--resize-child-windows' returns
;; 'normalized, this means it has set the
;; normal sizes already.
'normalized)
;; Set the normal sizes.
- (window--resize-subwindows-normal
+ (window--resize-child-windows-normal
parent horizontal window this-delta trail other-delta))
;; Set DELTA to what we still have to get from ancestor
;; windows.
`after', resize only windows on the right or below EDGE. Also,
preferably only resize windows adjacent to EDGE.
-This function recursively resizes WINDOW's subwindows to fit the
-new size. Make sure that WINDOW is `window-resizable' before
+This function recursively resizes WINDOW's child windows to fit the
+new size. Make sure that WINDOW is `window--resizable' before
calling this function. Note that this function does not resize
siblings of WINDOW or WINDOW's parent window. You have to
eventually call `window-resize-apply' in order to make resizing
(let ((sub (window-child window)))
(cond
((not sub))
- ((window-iso-combined-p sub horizontal)
- ;; In an iso-combination resize subwindows according to their
+ ((window-combined-p sub horizontal)
+ ;; In an iso-combination resize child windows according to their
;; normal sizes.
- (window--resize-subwindows
+ (window--resize-child-windows
window delta horizontal nil ignore trail edge))
- ;; In an ortho-combination resize each subwindow by DELTA.
+ ;; In an ortho-combination resize each child window by DELTA.
(t
(while sub
(window--resize-this-window
"Resize root window WINDOW vertically by DELTA lines.
If DELTA is less than zero and we can't shrink WINDOW by DELTA
lines, shrink it as much as possible. If DELTA is greater than
-zero, this function can resize fixed-size subwindows in order to
+zero, this function can resize fixed-size windows in order to
recover the necessary lines.
Return the number of lines that were recovered.
right. If DELTA is less than zero, move the edge upwards or to
the left. If the edge can't be moved by DELTA lines or columns,
move it as far as possible in the desired direction."
- (setq window (window-normalize-any-window window))
+ (setq window (window-normalize-window window))
(let ((frame (window-frame window))
(right window)
left this-delta min-delta max-delta failed)
;; Find the edge we want to move.
- (while (and (or (not (window-iso-combined-p right horizontal))
+ (while (and (or (not (window-combined-p right horizontal))
(not (window-right right)))
(setq right (window-parent right))))
(cond
(or (window-left left)
(progn
(while (and (setq left (window-parent left))
- (not (window-iso-combined-p left horizontal))))
+ (not (window-combined-p left horizontal))))
(window-left left)))))
(unless left
(if horizontal
(or (window-right right)
(progn
(while (and (setq right (window-parent right))
- (not (window-iso-combined-p right horizontal))))
+ (not (window-combined-p right horizontal))))
(window-right right)))))
(unless right
(if horizontal
;; two windows we want to resize.
(cond
((> delta 0)
- (setq max-delta (window-max-delta-1 left 0 horizontal nil 'after))
- (setq min-delta (window-min-delta-1 right (- delta) horizontal nil 'before))
+ (setq max-delta (window--max-delta-1 left 0 horizontal nil 'after))
+ (setq min-delta (window--min-delta-1 right (- delta) horizontal nil 'before))
(when (or (< max-delta delta) (> min-delta (- delta)))
;; We can't get the whole DELTA - move as far as possible.
(setq delta (min max-delta (- min-delta))))
;; Start resizing.
(window--resize-reset frame horizontal)
;; Try to enlarge LEFT first.
- (setq this-delta (window-resizable left delta horizontal))
+ (setq this-delta (window--resizable left delta horizontal))
(unless (zerop this-delta)
(window--resize-this-window
left this-delta horizontal nil t 'before
(window-left-column right)
(window-top-line right)))))
((< delta 0)
- (setq max-delta (window-max-delta-1 right 0 horizontal nil 'before))
- (setq min-delta (window-min-delta-1 left delta horizontal nil 'after))
+ (setq max-delta (window--max-delta-1 right 0 horizontal nil 'before))
+ (setq min-delta (window--min-delta-1 left delta horizontal nil 'after))
(when (or (< max-delta (- delta)) (> min-delta delta))
;; We can't get the whole DELTA - move as far as possible.
(setq delta (max (- max-delta) min-delta)))
;; Start resizing.
(window--resize-reset frame horizontal)
;; Try to enlarge RIGHT.
- (setq this-delta (window-resizable right (- delta) horizontal))
+ (setq this-delta (window--resizable right (- delta) horizontal))
(unless (zerop this-delta)
(window--resize-this-window
right this-delta horizontal nil t 'after
((zerop delta))
((window-size-fixed-p nil horizontal)
(error "Selected window has fixed size"))
- ((window-resizable-p nil delta horizontal)
+ ((window--resizable-p nil delta horizontal)
(window-resize nil delta horizontal))
(t
(window-resize
((zerop delta))
((window-size-fixed-p nil horizontal)
(error "Selected window has fixed size"))
- ((window-resizable-p nil (- delta) horizontal)
+ ((window--resizable-p nil (- delta) horizontal)
(window-resize nil (- delta) horizontal))
(t
(window-resize
Make WINDOW as large as possible without deleting any windows.
WINDOW can be any window and defaults to the selected window."
(interactive)
- (setq window (window-normalize-any-window window))
+ (setq window (window-normalize-window window))
(window-resize window (window-max-delta window))
(window-resize window (window-max-delta window t) t))
Make WINDOW as small as possible without deleting any windows.
WINDOW can be any window and defaults to the selected window."
(interactive)
- (setq window (window-normalize-any-window window))
+ (setq window (window-normalize-window window))
(window-resize window (- (window-min-delta window)))
(window-resize window (- (window-min-delta window t)) t))
\f
-(defsubst frame-root-window-p (window)
+(defun frame-root-window-p (window)
"Return non-nil if WINDOW is the root window of its frame."
(eq window (frame-root-window window)))
-(defun window-tree-1 (window &optional next)
- "Return window tree rooted at WINDOW.
-Optional argument NEXT non-nil means include windows right
+(defun window--subtree (window &optional next)
+ "Return window subtree rooted at WINDOW.
+Optional argument NEXT non-nil means include WINDOW's right
siblings in the return value.
See the documentation of `window-tree' for a description of the
(cond
((window-top-child window)
(cons t (cons (window-edges window)
- (window-tree-1 (window-top-child window) t))))
+ (window--subtree (window-top-child window) t))))
((window-left-child window)
(cons nil (cons (window-edges window)
- (window-tree-1 (window-left-child window) t))))
+ (window--subtree (window-left-child window) t))))
(t window))
list))
(setq window (when next (window-next-sibling window))))
If the root window is not split, ROOT is the root window itself.
Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
for a horizontal split, and t for a vertical split. EDGES gives
-the combined size and position of the subwindows in the split,
-and the rest of the elements are the subwindows in the split.
-Each of the subwindows may again be a window or a list
+the combined size and position of the child windows in the split,
+and the rest of the elements are the child windows in the split.
+Each of the child windows may again be a window or a list
representing a window split, and so on. EDGES is a list \(LEFT
TOP RIGHT BOTTOM) as returned by `window-edges'."
(setq frame (window-normalize-frame frame))
- (window-tree-1 (frame-root-window frame) t))
+ (window--subtree (frame-root-window frame) t))
\f
(defun other-window (count &optional all-frames)
"Select another window in cyclic ordering of windows.
(next-window base-window (if nomini 'arg) all-frames))))
\f
;;; Deleting windows.
-(defcustom frame-auto-delete 'automatic
- "If non-nil, quitting a window can delete its frame.
-If this variable is nil, functions that quit a window never
-delete the associated frame. If this variable's value is the
-symbol `automatic', a frame is deleted only if the window is
-dedicated or was created by `display-buffer'. If this variable
-is t, a frame can be always deleted, even if it was created by
-`make-frame-command'. Other values should not be used.
-
-Note that a frame will be effectively deleted if and only if
-another frame still exists.
-
-Functions quitting a window and consequently affected by this
-variable are `switch-to-prev-buffer', `delete-windows-on',
-`replace-buffer-in-windows' and `quit-window'."
- :type '(choice
- (const :tag "Never" nil)
- (const :tag "Automatic" automatic)
- (const :tag "Always" t))
- :group 'windows
- :group 'frames)
-
(defun window-deletable-p (&optional window)
"Return t if WINDOW can be safely deleted from its frame.
Return `frame' if deleting WINDOW should also delete its
frame."
- (setq window (window-normalize-any-window window))
+ (setq window (window-normalize-window window))
+
(unless ignore-window-parameters
;; Handle atomicity.
(when (window-parameter window 'window-atom)
(setq window (window-atom-root window))))
- (let ((parent (window-parent window))
- (frame (window-frame window))
- (buffer (window-buffer window))
- (dedicated (and (window-buffer window) (window-dedicated-p window)))
- (quit-restore (window-parameter window 'quit-restore)))
+
+ (let* ((parent (window-parent window))
+ (frame (window-frame window))
+ (buffer (window-buffer window)))
(cond
((frame-root-window-p window)
- ;; Don't delete FRAME if `frame-auto-delete' is nil.
- (when (and (or (eq frame-auto-delete t)
- (and (eq frame-auto-delete 'automatic)
- ;; Delete FRAME only if it's either dedicated
- ;; or quit-restore's car is `new-frame' and
- ;; WINDOW still displays the same buffer
- (or dedicated
- (and (eq (car-safe quit-restore) 'new-frame)
- (eq (nth 1 quit-restore)
- (window-buffer window))))))
- ;; Don't delete FRAME if we have another buffer in
- ;; WINDOW's previous buffers. Bug#9419.
- (or (not (window-prev-buffers window))
- (eq (caar (window-prev-buffers window)) buffer))
- ;; Don't try to delete FRAME when there are no other
- ;; visible frames left.
- (other-visible-frames-p frame))
+ ;; WINDOW's frame can be deleted only if there are other frames
+ ;; on the same terminal.
+ (unless (eq frame (next-frame frame 0))
'frame))
- ;; Don't delete WINDOW if we find another buffer in WINDOW's
- ;; previous buffers.
- ((and (or (not (window-prev-buffers window))
- (eq (caar (window-prev-buffers window)) buffer))
- ;; Delete WINDOW only if it's dedicated or quit-restore's car
- ;; is `new-frame' or `new-window' and it still displays the
- ;; same buffer.
- (or dedicated
- (and (memq (car-safe quit-restore) '(new-window new-frame))
- (eq (nth 1 quit-restore) (window-buffer window))))
- ;; Don't delete the last main window.
- (or ignore-window-parameters
- (not (eq (window-parameter window 'window-side) 'none))
- (and parent
- (eq (window-parameter parent 'window-side) 'none))))
+ ((or ignore-window-parameters
+ (not (eq (window-parameter window 'window-side) 'none))
+ (and parent (eq (window-parameter parent 'window-side) 'none)))
+ ;; WINDOW can be deleted unless it is the main window of its
+ ;; frame.
t))))
-(defun window-or-subwindow-p (subwindow window)
- "Return t if SUBWINDOW is either WINDOW or a subwindow of WINDOW."
- (or (eq subwindow window)
- (let ((parent (window-parent subwindow)))
+(defun window--in-subtree-p (window root)
+ "Return t if WINDOW is either ROOT or a member of ROOT's subtree."
+ (or (eq window root)
+ (let ((parent (window-parent window)))
(catch 'done
(while parent
- (if (eq parent window)
+ (if (eq parent root)
(throw 'done t)
(setq parent (window-parent parent))))))))
argument. If WINDOW is the only window on its frame or the last
non-side window, signal an error."
(interactive)
- (setq window (window-normalize-any-window window))
+ (setq window (window-normalize-window window))
(let* ((frame (window-frame window))
(function (window-parameter window 'delete-window))
(parent (window-parent window))
atom-root)
- (window-check frame)
+ (window--check frame)
(catch 'done
;; Handle window parameters.
(cond
(let* ((horizontal (window-left-child parent))
(size (window-total-size window horizontal))
(frame-selected
- (window-or-subwindow-p (frame-selected-window frame) window))
+ (window--in-subtree-p (frame-selected-window frame) window))
;; Emacs 23 preferably gives WINDOW's space to its left
;; sibling.
(sibling (or (window-left window) (window-right window))))
(window--resize-reset frame horizontal)
(cond
- ((and (not (window-splits window))
+ ((and (not window-combination-resize)
sibling (window-sizable-p sibling size))
;; Resize WINDOW's sibling.
(window--resize-this-window sibling size horizontal nil t)
(set-window-new-normal
sibling (+ (window-normal-size sibling horizontal)
(window-normal-size window horizontal))))
- ((window-resizable-p window (- size) horizontal nil nil nil t)
+ ((window--resizable-p window (- size) horizontal nil nil nil t)
;; Can do without resizing fixed-size windows.
(window--resize-siblings window (- size) horizontal))
(t
;; not be selected, fix this here.
(other-window -1 frame))
(run-window-configuration-change-hook frame)
- (window-check frame)
+ (window--check frame)
;; Always return nil.
nil))))
on the frame. Side windows are not deleted. If WINDOW is a side
window signal an error."
(interactive)
- (setq window (window-normalize-any-window window))
+ (setq window (window-normalize-window window))
(let* ((frame (window-frame window))
(function (window-parameter window 'delete-other-windows))
(window-side (window-parameter window 'window-side))
atom-root side-main)
- (window-check frame)
+ (window--check frame)
(catch 'done
(cond
;; Ignore window parameters if `ignore-window-parameters' is t or
(unless (eq window side-main)
(delete-other-windows-internal window side-main)
(run-window-configuration-change-hook frame)
- (window-check frame))
+ (window--check frame))
;; Always return nil.
nil)))
(defun record-window-buffer (&optional window)
"Record WINDOW's buffer.
WINDOW must be a live window and defaults to the selected one."
- (let* ((window (window-normalize-live-window window))
+ (let* ((window (window-normalize-window window t))
(buffer (window-buffer window))
(entry (assq buffer (window-prev-buffers window))))
;; Reset WINDOW's next buffers. If needed, they are resurrected by
;; Add an entry for buffer to WINDOW's previous buffers.
(with-current-buffer buffer
(let ((start (window-start window))
- (point (window-point window)))
+ (point (window-point-1 window)))
(setq entry
(cons buffer
(if entry
WINDOW must be a live window and defaults to the selected one.
BUFFER must be a live buffer and defaults to the buffer of
WINDOW."
- (let* ((window (window-normalize-live-window window))
+ (let* ((window (window-normalize-window window t))
(buffer (or buffer (window-buffer window))))
(set-window-prev-buffers
window (assq-delete-all buffer (window-prev-buffers window)))
(when (and selected current)
(set-buffer buffer))
(when start
- (set-window-start window start))
+ ;; Don't force window-start here (even if POINT is nil).
+ (set-window-start window start t))
(when point
- (if selected
- (with-current-buffer buffer
- (goto-char point))
- (set-window-point window point)))))
+ (set-window-point-1 window point))))
(defun switch-to-prev-buffer (&optional window bury-or-kill)
"In WINDOW switch to previous buffer.
shown in WINDOW is about to be buried or killed and consequently
shall not be switched to in future invocations of this command."
(interactive)
- (let* ((window (window-normalize-live-window window))
+ (let* ((window (window-normalize-window window t))
(old-buffer (window-buffer window))
;; Save this since it's destroyed by `set-window-buffer'.
(next-buffers (window-next-buffers window))
- entry new-buffer killed-buffers deletable visible)
- (cond
- ;; When BURY-OR-KILL is non-nil, there's no previous buffer for
- ;; this window, and we can delete the window (or the frame) do
- ;; that.
- ((and bury-or-kill
- (or (not (window-prev-buffers window))
- (and (eq (caar (window-prev-buffers window)) old-buffer)
- (not (cdr (car (window-prev-buffers window))))))
- (setq deletable (window-deletable-p window)))
- (if (eq deletable 'frame)
- (delete-frame (window-frame window))
- (delete-window window)))
- ((window-dedicated-p window)
- (error "Window %s is dedicated to buffer %s" window old-buffer)))
-
- (unless deletable
- (catch 'found
- ;; Scan WINDOW's previous buffers first, skipping entries of next
- ;; buffers.
- (dolist (entry (window-prev-buffers window))
- (when (and (setq new-buffer (car entry))
- (or (buffer-live-p new-buffer)
+ entry new-buffer killed-buffers visible)
+ (when (window-dedicated-p window)
+ (error "Window %s is dedicated to buffer %s" window old-buffer))
+
+ (catch 'found
+ ;; Scan WINDOW's previous buffers first, skipping entries of next
+ ;; buffers.
+ (dolist (entry (window-prev-buffers window))
+ (when (and (setq new-buffer (car entry))
+ (or (buffer-live-p new-buffer)
+ (not (setq killed-buffers
+ (cons new-buffer killed-buffers))))
+ (not (eq new-buffer old-buffer))
+ (or bury-or-kill
+ (not (memq new-buffer next-buffers))))
+ (set-window-buffer-start-and-point
+ window new-buffer (nth 1 entry) (nth 2 entry))
+ (throw 'found t)))
+ ;; Scan reverted buffer list of WINDOW's frame next, skipping
+ ;; entries of next buffers. Note that when we bury or kill a
+ ;; buffer we don't reverse the global buffer list to avoid showing
+ ;; a buried buffer instead. Otherwise, we must reverse the global
+ ;; buffer list in order to make sure that switching to the
+ ;; previous/next buffer traverse it in opposite directions.
+ (dolist (buffer (if bury-or-kill
+ (buffer-list (window-frame window))
+ (nreverse (buffer-list (window-frame window)))))
+ (when (and (buffer-live-p buffer)
+ (not (eq buffer old-buffer))
+ (not (eq (aref (buffer-name buffer) 0) ?\s))
+ (or bury-or-kill (not (memq buffer next-buffers))))
+ (if (get-buffer-window buffer)
+ ;; Try to avoid showing a buffer visible in some other window.
+ (setq visible buffer)
+ (setq new-buffer buffer)
+ (set-window-buffer-start-and-point window new-buffer)
+ (throw 'found t))))
+ (unless bury-or-kill
+ ;; Scan reverted next buffers last (must not use nreverse
+ ;; here!).
+ (dolist (buffer (reverse next-buffers))
+ ;; Actually, buffer _must_ be live here since otherwise it
+ ;; would have been caught in the scan of previous buffers.
+ (when (and (or (buffer-live-p buffer)
(not (setq killed-buffers
- (cons new-buffer killed-buffers))))
- (not (eq new-buffer old-buffer))
- (or bury-or-kill
- (not (memq new-buffer next-buffers))))
- (set-window-buffer-start-and-point
- window new-buffer (nth 1 entry) (nth 2 entry))
- (throw 'found t)))
- ;; Scan reverted buffer list of WINDOW's frame next, skipping
- ;; entries of next buffers. Note that when we bury or kill a
- ;; buffer we don't reverse the global buffer list to avoid showing
- ;; a buried buffer instead. Otherwise, we must reverse the global
- ;; buffer list in order to make sure that switching to the
- ;; previous/next buffer traverse it in opposite directions.
- (dolist (buffer (if bury-or-kill
- (buffer-list (window-frame window))
- (nreverse (buffer-list (window-frame window)))))
- (when (and (buffer-live-p buffer)
+ (cons buffer killed-buffers))))
(not (eq buffer old-buffer))
- (not (eq (aref (buffer-name buffer) 0) ?\s))
- (or bury-or-kill (not (memq buffer next-buffers))))
- (if (get-buffer-window buffer)
- ;; Try to avoid showing a buffer visible in some other window.
- (setq visible buffer)
+ (setq entry (assq buffer (window-prev-buffers window))))
(setq new-buffer buffer)
- (set-window-buffer-start-and-point window new-buffer)
+ (set-window-buffer-start-and-point
+ window new-buffer (nth 1 entry) (nth 2 entry))
(throw 'found t))))
- (unless bury-or-kill
- ;; Scan reverted next buffers last (must not use nreverse
- ;; here!).
- (dolist (buffer (reverse next-buffers))
- ;; Actually, buffer _must_ be live here since otherwise it
- ;; would have been caught in the scan of previous buffers.
- (when (and (or (buffer-live-p buffer)
- (not (setq killed-buffers
- (cons buffer killed-buffers))))
- (not (eq buffer old-buffer))
- (setq entry (assq buffer (window-prev-buffers window))))
- (setq new-buffer buffer)
- (set-window-buffer-start-and-point
- window new-buffer (nth 1 entry) (nth 2 entry))
- (throw 'found t))))
-
- ;; Show a buffer visible in another window.
- (when visible
- (setq new-buffer visible)
- (set-window-buffer-start-and-point window new-buffer)))
-
- (if bury-or-kill
- ;; Remove `old-buffer' from WINDOW's previous and (restored list
- ;; of) next buffers.
- (progn
- (set-window-prev-buffers
- window (assq-delete-all old-buffer (window-prev-buffers window)))
- (set-window-next-buffers window (delq old-buffer next-buffers)))
- ;; Move `old-buffer' to head of WINDOW's restored list of next
- ;; buffers.
- (set-window-next-buffers
- window (cons old-buffer (delq old-buffer next-buffers)))))
+
+ ;; Show a buffer visible in another window.
+ (when visible
+ (setq new-buffer visible)
+ (set-window-buffer-start-and-point window new-buffer)))
+
+ (if bury-or-kill
+ ;; Remove `old-buffer' from WINDOW's previous and (restored list
+ ;; of) next buffers.
+ (progn
+ (set-window-prev-buffers
+ window (assq-delete-all old-buffer (window-prev-buffers window)))
+ (set-window-next-buffers window (delq old-buffer next-buffers)))
+ ;; Move `old-buffer' to head of WINDOW's restored list of next
+ ;; buffers.
+ (set-window-next-buffers
+ window (cons old-buffer (delq old-buffer next-buffers))))
;; Remove killed buffers from WINDOW's previous and next buffers.
(when killed-buffers
"In WINDOW switch to next buffer.
WINDOW must be a live window and defaults to the selected one."
(interactive)
- (let* ((window (window-normalize-live-window window))
+ (let* ((window (window-normalize-window window t))
(old-buffer (window-buffer window))
(next-buffers (window-next-buffers window))
new-buffer entry killed-buffers visible)
(set-buffer-major-mode scratch)
scratch)))
+(defcustom frame-auto-hide-function #'iconify-frame
+ "Function called to automatically hide frames.
+The function is called with one argument - a frame.
+
+Functions affected by this option are those that bury a buffer
+shown in a separate frame like `quit-window' and `bury-buffer'."
+ :type '(choice (const :tag "Iconify" iconify-frame)
+ (const :tag "Delete" delete-frame)
+ (const :tag "Do nothing" ignore)
+ function)
+ :group 'windows
+ :group 'frames
+ :version "24.1")
+
+(defun window--delete (&optional window dedicated-only kill)
+ "Delete WINDOW if possible.
+WINDOW must be a live window and defaults to the selected one.
+Optional argument DEDICATED-ONLY non-nil means to delete WINDOW
+only if it's dedicated to its buffer. Optional argument KILL
+means the buffer shown in window will be killed. Return non-nil
+if WINDOW gets deleted or its frame is auto-hidden."
+ (setq window (window-normalize-window window t))
+ (unless (and dedicated-only (not (window-dedicated-p window)))
+ (let* ((buffer (window-buffer window))
+ (deletable (window-deletable-p window)))
+ (cond
+ ((eq deletable 'frame)
+ (let ((frame (window-frame window)))
+ (cond
+ (kill
+ (delete-frame frame))
+ ((functionp frame-auto-hide-function)
+ (funcall frame-auto-hide-function frame))))
+ 'frame)
+ (deletable
+ (delete-window window)
+ t)))))
+
(defun bury-buffer (&optional buffer-or-name)
"Put BUFFER-OR-NAME at the end of the list of all buffers.
There it is the least likely candidate for `other-buffer' to
;; is shown in the selected window.
(cond
((or buffer-or-name (not (eq buffer (window-buffer)))))
- ((not (window-dedicated-p))
- (switch-to-prev-buffer nil 'bury))
- ((and (frame-root-window-p (selected-window))
- ;; Don't iconify if it's the only frame.
- (not (eq (next-frame nil 0) (selected-frame))))
- (iconify-frame (window-frame (selected-window))))
- ((window-deletable-p)
- (delete-window)))
+ ((window--delete nil t))
+ (t
+ ;; Switch to another buffer in window.
+ (set-window-dedicated-p nil nil)
+ (switch-to-prev-buffer nil 'bury)))
+
;; Always return nil.
nil))
(if (eq (window-buffer window) buffer)
(let ((deletable (window-deletable-p window)))
(cond
- ((eq deletable 'frame)
- ;; Delete frame.
+ ((and (eq deletable 'frame) (window-dedicated-p window))
+ ;; Delete frame if and only if window is dedicated.
(delete-frame (window-frame window)))
- (deletable
- ;; Delete window only.
+ ((eq deletable t)
+ ;; Delete window.
(delete-window window))
(t
;; In window switch to previous buffer.
BUFFER-OR-NAME may be a buffer or the name of an existing buffer
and defaults to the current buffer.
-When a window showing BUFFER-OR-NAME is either dedicated, or the
-window has no previous buffer, that window is deleted. If that
-window is the only window on its frame, the frame is deleted too
-when there are other frames left. If there are no other frames
-left, some other buffer is displayed in that window.
+When a window showing BUFFER-OR-NAME is dedicated, that window is
+deleted. If that window is the only window on its frame, the
+frame is deleted too when there are other frames left. If there
+are no other frames left, some other buffer is displayed in that
+window.
This function removes the buffer denoted by BUFFER-OR-NAME from
all window-local buffer lists."
+ (interactive "bBuffer to replace: ")
(let ((buffer (window-normalize-buffer buffer-or-name)))
(dolist (window (window-list-1 nil nil t))
(if (eq (window-buffer window) buffer)
- (let ((deletable (window-deletable-p window)))
- (cond
- ((eq deletable 'frame)
- ;; Delete frame.
- (delete-frame (window-frame window)))
- ((and (window-dedicated-p window) deletable)
- ;; Delete window.
- (delete-window window))
- (t
- ;; Switch to another buffer in window.
- (set-window-dedicated-p window nil)
- (switch-to-prev-buffer window 'kill))))
+ (unless (window--delete window t t)
+ ;; Switch to another buffer in window.
+ (set-window-dedicated-p window nil)
+ (switch-to-prev-buffer window 'kill))
;; Unrecord BUFFER in WINDOW.
(unrecord-window-buffer window buffer)))))
(defun quit-window (&optional kill window)
"Quit WINDOW and bury its buffer.
-WINDOW defaults to the selected window.
-With a prefix argument, kill the buffer instead.
+WINDOW must be a live window and defaults to the selected one.
+With prefix argument KILL non-nil, kill the buffer instead of
+burying it.
According to information stored in WINDOW's `quit-restore' window
parameter either \(1) delete WINDOW and its frame, \(2) delete
or \(4) make WINDOW display some other buffer than the present
one. If non-nil, reset `quit-restore' parameter to nil."
(interactive "P")
- (setq window (window-normalize-live-window window))
- (let ((buffer (window-buffer window))
- (quit-restore (window-parameter window 'quit-restore))
- deletable resize)
+ (setq window (window-normalize-window window t))
+ (let* ((buffer (window-buffer window))
+ (quit-restore (window-parameter window 'quit-restore))
+ (prev-buffer
+ (let* ((prev-buffers (window-prev-buffers window))
+ (prev-buffer (caar prev-buffers)))
+ (and (or (not (eq prev-buffer buffer))
+ (and (cdr prev-buffers)
+ (not (eq (setq prev-buffer (cadr prev-buffers))
+ buffer))))
+ prev-buffer)))
+ quad resize)
(cond
- ((and (or (and (memq (car-safe quit-restore) '(new-window new-frame))
- ;; Check that WINDOW's buffer is still the same.
- (eq (window-buffer window) (nth 1 quit-restore)))
- (window-dedicated-p window))
- (setq deletable (window-deletable-p window)))
- ;; Check if WINDOW's frame can be deleted.
- (if (eq deletable 'frame)
- (delete-frame (window-frame window))
- (delete-window window))
+ ((and (not prev-buffer)
+ (memq (nth 1 quit-restore) '(window frame))
+ (eq (nth 3 quit-restore) buffer)
+ ;; Delete WINDOW if possible.
+ (window--delete window nil kill))
;; If the previously selected window is still alive, select it.
(when (window-live-p (nth 2 quit-restore))
(select-window (nth 2 quit-restore))))
- ((and (buffer-live-p (nth 0 quit-restore))
- ;; The buffer currently shown in WINDOW must still be the
- ;; buffer shown when its `quit-restore' parameter was created
- ;; in the first place.
- (eq (window-buffer window) (nth 3 quit-restore)))
- (setq resize (with-current-buffer buffer temp-buffer-resize-mode))
- (unrecord-window-buffer window buffer)
- ;; Display buffer stored in the quit-restore parameter.
+ ((and (listp (setq quad (nth 1 quit-restore)))
+ (buffer-live-p (car quad))
+ (eq (nth 3 quit-restore) buffer))
+ ;; Show another buffer stored in quit-restore parameter.
+ (setq resize (with-current-buffer buffer
+ (and temp-buffer-resize-mode
+ (/= (nth 3 quad) (window-total-size window)))))
(set-window-dedicated-p window nil)
- (set-window-buffer window (nth 0 quit-restore))
- (set-window-start window (nth 1 quit-restore))
- (set-window-point window (nth 2 quit-restore))
- (and resize
- (/= (nth 4 quit-restore) (window-total-size window))
- (window-resize window
- (- (nth 4 quit-restore)
- (window-total-size window))))
+ (when resize
+ ;; Try to resize WINDOW to its old height but don't signal an
+ ;; error.
+ (condition-case nil
+ (window-resize window (- (nth 3 quad) (window-total-size window)))
+ (error nil)))
+ ;; Restore WINDOW's previous buffer, start and point position.
+ (set-window-buffer-start-and-point
+ window (nth 0 quad) (nth 1 quad) (nth 2 quad))
+ ;; Unrecord WINDOW's buffer here (Bug#9937) to make sure it's not
+ ;; re-recorded by `set-window-buffer'.
+ (unrecord-window-buffer window buffer)
;; Reset the quit-restore parameter.
(set-window-parameter window 'quit-restore nil)
- (when (window-live-p (nth 5 quit-restore))
- (select-window (nth 5 quit-restore))))
+ ;; Select old window.
+ (when (window-live-p (nth 2 quit-restore))
+ (select-window (nth 2 quit-restore))))
(t
- ;; Otherwise, show another buffer in WINDOW and reset the
- ;; quit-restore parameter.
+ ;; Show some other buffer in WINDOW and reset the quit-restore
+ ;; parameter.
(set-window-parameter window 'quit-restore nil)
+ ;; Make sure that WINDOW is no more dedicated.
+ (set-window-dedicated-p window nil)
(switch-to-prev-buffer window 'bury-or-kill)))
;; Kill WINDOW's old-buffer if requested
(if kill
(kill-buffer buffer)
(bury-buffer-internal buffer))))
+
+(defun quit-windows-on (&optional buffer-or-name kill frame)
+ "Quit all windows showing BUFFER-OR-NAME.
+BUFFER-OR-NAME may be a buffer or the name of an existing buffer
+and defaults to the current buffer. Optional argument KILL
+non-nil means to kill BUFFER-OR-NAME. KILL nil means to bury
+BUFFER-OR-NAME. Optional argument FRAME is handled as by
+`delete-windows-on'.
+
+This function calls `quit-window' on all candidate windows
+showing BUFFER-OR-NAME."
+ (interactive "BQuit windows on (buffer):\nP")
+ (let ((buffer (window-normalize-buffer buffer-or-name))
+ ;; Handle the "inverted" meaning of the FRAME argument wrt other
+ ;; `window-list-1' based function.
+ (all-frames (cond ((not frame) t) ((eq frame t) nil) (t frame))))
+ (dolist (window (window-list-1 nil nil all-frames))
+ (if (eq (window-buffer window) buffer)
+ (quit-window kill window)
+ ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
+ (unrecord-window-buffer window buffer)))))
\f
;;; Splitting windows.
-(defsubst window-split-min-size (&optional horizontal)
+(defun window-split-min-size (&optional horizontal)
"Return minimum height of any window when splitting windows.
Optional argument HORIZONTAL non-nil means return minimum width."
(if horizontal
new window are inherited from the window selected on WINDOW's
frame. The selected window is not changed by this function."
(interactive "i")
- (setq window (window-normalize-any-window window))
+ (setq window (window-normalize-window window))
(let* ((side (cond
((not side) 'below)
((memq side '(below above right left)) side)
(parent (window-parent window))
(function (window-parameter window 'split-window))
(window-side (window-parameter window 'window-side))
- ;; Rebind `window-nest' since in some cases we may have to
- ;; override its value.
- (window-nest window-nest)
+ ;; Rebind `window-combination-limit' since in some cases we may
+ ;; have to override its value.
+ (window-combination-limit window-combination-limit)
atom-root)
- (window-check frame)
+ (window--check frame)
(catch 'done
(cond
;; Ignore window parameters if either `ignore-window-parameters'
;; The `split-window' parameter specifies the function to call.
;; If that function is `ignore', do nothing.
(throw 'done (funcall function window size side)))
- ;; If WINDOW is a subwindow of an atomic window, split the root
- ;; window of that atomic window instead.
+ ;; If WINDOW is part of an atomic window, split the root window
+ ;; of that atomic window instead.
((and (window-parameter window 'window-atom)
(setq atom-root (window-atom-root window))
(not (eq atom-root window)))
(or (not parent)
(not (window-parameter parent 'window-side))))
;; WINDOW is a side root window. To make sure that a new parent
- ;; window gets created set `window-nest' to t.
- (setq window-nest t))
+ ;; window gets created set `window-combination-limit' to t.
+ (setq window-combination-limit t))
- (when (and window-splits size (> size 0))
- ;; If `window-splits' is non-nil and SIZE is a non-negative
- ;; integer, we cannot reasonably resize other windows. Rather
- ;; bind `window-nest' to t to make sure that subsequent window
- ;; deletions are handled correctly.
- (setq window-nest t))
+ (when (and window-combination-resize size (> size 0))
+ ;; If `window-combination-resize' is non-nil and SIZE is a
+ ;; non-negative integer, we cannot reasonably resize other
+ ;; windows. Rather bind `window-combination-limit' to t to make
+ ;; sure that subsequent window deletions are handled correctly.
+ (setq window-combination-limit t))
(let* ((parent-size
;; `parent-size' is the size of WINDOW's parent, provided
;; `resize' non-nil means we are supposed to resize other
;; windows in WINDOW's combination.
(resize
- (and window-splits (not window-nest)
+ (and window-combination-resize (not window-combination-limit)
;; Resize makes sense in iso-combinations only.
- (window-iso-combined-p window horizontal)))
+ (window-combined-p window horizontal)))
;; `old-size' is the current size of WINDOW.
(old-size (window-total-size window horizontal))
;; `new-size' is the specified or calculated size of the
(min (- parent-size
(window-min-size parent horizontal))
(/ parent-size
- (1+ (window-iso-combinations
+ (1+ (window-combinations
parent horizontal))))
;; Else try to give the new window half the size
;; of WINDOW (plus an eventual odd line).
;; Make new-parent non-nil if we need a new parent window;
;; either because we want to nest or because WINDOW is not
;; iso-combined.
- (or window-nest (not (window-iso-combined-p window horizontal))))
+ (or window-combination-limit
+ (not (window-combined-p window horizontal))))
(setq new-normal
;; Make new-normal the normal size of the new window.
(cond
(size (/ (float new-size) (if new-parent old-size parent-size)))
(new-parent 0.5)
- (resize (/ 1.0 (1+ (window-iso-combinations parent horizontal))))
+ (resize (/ 1.0 (1+ (window-combinations parent horizontal))))
(t (/ (window-normal-size window horizontal) 2.0))))
(if resize
;; we won't be able to return space to those windows when we
;; delete the one we create here. Hence we do not go up.
(progn
- (window--resize-subwindows parent (- new-size) horizontal)
+ (window--resize-child-windows parent (- new-size) horizontal)
(let* ((normal (- 1.0 new-normal))
(sub (window-child parent)))
(while sub
(set-window-parameter new 'window-side window-side))
(run-window-configuration-change-hook frame)
- (window-check frame)
+ (window--check frame)
;; Always return the new window.
new)))))
;; I think this should be the default; I think people will prefer it--rms.
(defcustom split-window-keep-point t
- "If non-nil, \\[split-window-above-each-other] keeps the original point \
-in both children.
-This is often more convenient for editing.
-If nil, adjust point in each of the two windows to minimize redisplay.
-This is convenient on slow terminals, but point can move strangely.
-
-This option applies only to `split-window-above-each-other' and
-functions that call it. `split-window' always keeps the original
-point in both children."
+ "If non-nil, \\[split-window-below] preserves point in the new window.
+If nil, adjust point in the two windows to minimize redisplay.
+This option applies only to `split-window-below' and functions
+that call it. The low-level `split-window' function always keeps
+the original point in both windows."
:type 'boolean
:group 'windows)
-(defun split-window-above-each-other (&optional size)
- "Split selected window into two windows, one above the other.
-The upper window gets SIZE lines and the lower one gets the rest.
-SIZE negative means the lower window gets -SIZE lines and the
-upper one the rest. With no argument, split windows equally or
-close to it. Both windows display the same buffer, now current.
-
-If the variable `split-window-keep-point' is non-nil, both new
-windows will get the same value of point as the selected window.
-This is often more convenient for editing. The upper window is
-the selected window.
-
-Otherwise, we choose window starts so as to minimize the amount of
-redisplay; this is convenient on slow terminals. The new selected
-window is the one that the current value of point appears in. The
-value of point can change if the text around point is hidden by the
-new mode line.
-
-Regardless of the value of `split-window-keep-point', the upper
-window is the original one and the return value is the new, lower
-window."
+(defun split-window-below (&optional size)
+ "Split the selected window into two windows, one above the other.
+The selected window is above. The newly split-off window is
+below, and displays the same buffer. Return the new window.
+
+If optional argument SIZE is omitted or nil, both windows get the
+same height, or close to it. If SIZE is positive, the upper
+\(selected) window gets SIZE lines. If SIZE is negative, the
+lower (new) window gets -SIZE lines.
+
+If the variable `split-window-keep-point' is non-nil, both
+windows get the same value of point as the selected window.
+Otherwise, the window starts are chosen so as to minimize the
+amount of redisplay; this is convenient on slow terminals."
(interactive "P")
(let ((old-window (selected-window))
(old-point (point))
(set-window-parameter new-window 'quit-restore quit-restore)))
new-window))
-(defalias 'split-window-vertically 'split-window-above-each-other)
-
-(defun split-window-side-by-side (&optional size)
- "Split selected window into two windows side by side.
-The selected window becomes the left one and gets SIZE columns.
-SIZE negative means the right window gets -SIZE columns.
-
-SIZE includes the width of the window's scroll bar; if there are
-no scroll bars, it includes the width of the divider column to
-the window's right, if any. SIZE omitted or nil means split
-window equally.
-
-The selected window remains selected. Return the new window."
+(defalias 'split-window-vertically 'split-window-below)
+
+(defun split-window-right (&optional size)
+ "Split the selected window into two side-by-side windows.
+The selected window is on the left. The newly split-off window
+is on the right, and displays the same buffer. Return the new
+window.
+
+If optional argument SIZE is omitted or nil, both windows get the
+same width, or close to it. If SIZE is positive, the left-hand
+\(selected) window gets SIZE columns. If SIZE is negative, the
+right-hand (new) window gets -SIZE columns. Here, SIZE includes
+the width of the window's scroll bar; if there are no scroll
+bars, it includes the width of the divider column to the window's
+right, if any."
(interactive "P")
(let ((old-window (selected-window))
(size (and size (prefix-numeric-value size)))
(set-window-parameter new-window 'quit-restore quit-restore)))
new-window))
-(defalias 'split-window-horizontally 'split-window-side-by-side)
+(defalias 'split-window-horizontally 'split-window-right)
\f
;;; Balancing windows.
;; The following routine uses the recycled code from an old version of
-;; `window--resize-subwindows'. It's not very pretty, but coding it the way the
-;; new `window--resize-subwindows' code does would hardly make it any shorter or
+;; `window--resize-child-windows'. It's not very pretty, but coding it the way the
+;; new `window--resize-child-windows' code does would hardly make it any shorter or
;; more readable (FWIW we'd need three loops - one to calculate the
;; minimum sizes per window, one to enlarge or shrink windows until the
;; new parent-size matches, and one where we shrink the largest/enlarge
;; the smallest window).
(defun balance-windows-2 (window horizontal)
"Subroutine of `balance-windows-1'.
-WINDOW must be an iso-combination."
+WINDOW must be a vertical combination (horizontal if HORIZONTAL
+is non-nil."
(let* ((first (window-child window))
(sub first)
(number-of-children 0)
(setq failed nil)
(setq sub first)
(while (and sub (not failed))
- ;; Ignore subwindows that should be ignored or are stuck.
- (unless (window--resize-subwindows-skip-p sub)
+ ;; Ignore child windows that should be ignored or are stuck.
+ (unless (window--resize-child-windows-skip-p sub)
(setq found t)
(setq sub-total (window-total-size sub horizontal))
(setq sub-delta (- size sub-total))
(setq sub-amount
(window-sizable sub sub-delta horizontal))
- ;; Register the new total size for this subwindow.
+ ;; Register the new total size for this child window.
(set-window-new-total sub (+ sub-total sub-amount))
(unless (= sub-amount sub-delta)
(setq total-sum (- total-sum sub-total sub-amount))
;; (column) until `rest' is zero.
(setq sub first)
(while (and sub (> rest 0))
- (unless (window--resize-subwindows-skip-p window)
+ (unless (window--resize-child-windows-skip-p window)
(set-window-new-total sub 1 t)
(setq rest (1- rest)))
(setq sub (window-right sub)))
(window-total-size sub horizontal)
(window-new-total sub))
(float parent-size)))
- ;; Recursively balance each subwindow's subwindows.
+ ;; Recursively balance each window's child windows.
(balance-windows-1 sub horizontal)
(setq sub (window-right sub)))))
"Subroutine of `balance-windows'."
(if (window-child window)
(let ((sub (window-child window)))
- (if (window-iso-combined-p sub horizontal)
+ (if (window-combined-p sub horizontal)
(balance-windows-2 window horizontal)
(let ((size (window-new-total window)))
(while sub
(setq sub (window-right sub))))))))
(defun balance-windows (&optional window-or-frame)
- "Balance the sizes of subwindows of WINDOW-OR-FRAME.
+ "Balance the sizes of windows of WINDOW-OR-FRAME.
WINDOW-OR-FRAME is optional and defaults to the selected frame.
If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
-subwindows of that frame's root window. If WINDOW-OR-FRAME
-denots a window, balance the sizes of all subwindows of that
+windows of that frame. If WINDOW-OR-FRAME denotes a window,
+recursively balance the sizes of all child windows of that
window."
(interactive)
(let* ((window
))
;;; Window states, how to get them and how to put them in a window.
-(defsubst window-list-no-nils (&rest args)
- "Like LIST but do not add nil elements of ARGS."
- (delq nil (apply 'list args)))
-
(defvar window-state-ignored-parameters '(quit-restore)
"List of window parameters ignored by `window-state-get'.")
-(defun window-state-get-1 (window &optional markers)
+(defun window--state-get-1 (window &optional markers)
"Helper function for `window-state-get'."
(let* ((type
(cond
(buffer (window-buffer window))
(selected (eq window (selected-window)))
(head
- (window-list-no-nils
- type
- (unless (window-next-sibling window) (cons 'last t))
- (cons 'total-height (window-total-size window))
- (cons 'total-width (window-total-size window t))
- (cons 'normal-height (window-normal-size window))
- (cons 'normal-width (window-normal-size window t))
- (cons 'splits (window-splits window))
- (cons 'nest (window-nest window))
- (let (list)
- (dolist (parameter (window-parameters window))
- (unless (memq (car parameter)
- window-state-ignored-parameters)
- (setq list (cons parameter list))))
- (unless (window-parameter window 'clone-of)
- ;; Make a clone-of parameter.
- (setq list (cons (cons 'clone-of window) list)))
- (when list
- (cons 'parameters list)))
- (when buffer
- ;; All buffer related things go in here - make the buffer
- ;; current when retrieving `point' and `mark'.
- (with-current-buffer (window-buffer window)
- (let ((point (if selected (point) (window-point window)))
- (start (window-start window))
- (mark (mark)))
- (window-list-no-nils
- 'buffer (buffer-name buffer)
- (cons 'selected selected)
- (when window-size-fixed (cons 'size-fixed window-size-fixed))
- (cons 'hscroll (window-hscroll window))
- (cons 'fringes (window-fringes window))
- (cons 'margins (window-margins window))
- (cons 'scroll-bars (window-scroll-bars window))
- (cons 'vscroll (window-vscroll window))
- (cons 'dedicated (window-dedicated-p window))
- (cons 'point (if markers (copy-marker point) point))
- (cons 'start (if markers (copy-marker start) start))
- (when mark
- (cons 'mark (if markers (copy-marker mark) mark)))))))))
+ `(,type
+ ,@(unless (window-next-sibling window) `((last . t)))
+ (total-height . ,(window-total-size window))
+ (total-width . ,(window-total-size window t))
+ (normal-height . ,(window-normal-size window))
+ (normal-width . ,(window-normal-size window t))
+ (combination-limit . ,(window-combination-limit window))
+ ,@(let (list)
+ (dolist (parameter (window-parameters window))
+ (unless (memq (car parameter)
+ window-state-ignored-parameters)
+ (setq list (cons parameter list))))
+ (unless (window-parameter window 'clone-of)
+ ;; Make a clone-of parameter.
+ (setq list (cons (cons 'clone-of window) list)))
+ (when list
+ `((parameters . ,list))))
+ ,@(when buffer
+ ;; All buffer related things go in here - make the buffer
+ ;; current when retrieving `point' and `mark'.
+ (with-current-buffer (window-buffer window)
+ (let ((point (window-point-1 window))
+ (start (window-start window))
+ (mark (mark)))
+ `((buffer
+ ,(buffer-name buffer)
+ (selected . ,selected)
+ ,@(when window-size-fixed
+ `((size-fixed . ,window-size-fixed)))
+ (hscroll . ,(window-hscroll window))
+ (fringes . ,(window-fringes window))
+ (margins . ,(window-margins window))
+ (scroll-bars . ,(window-scroll-bars window))
+ (vscroll . ,(window-vscroll window))
+ (dedicated . ,(window-dedicated-p window))
+ (point . ,(if markers (copy-marker point) point))
+ (start . ,(if markers (copy-marker start) start))
+ ,@(when mark
+ `((mark . ,(if markers
+ (copy-marker mark) mark)))))))))))
(tail
(when (memq type '(vc hc))
(let (list)
(setq window (window-child window))
(while window
- (setq list (cons (window-state-get-1 window markers) list))
+ (setq list (cons (window--state-get-1 window markers) list))
(setq window (window-right window)))
(nreverse list)))))
(append head tail)))
value can be also stored on disk and read back in a new session."
(setq window
(if window
- (if (window-any-p window)
+ (if (window-valid-p window)
window
(error "%s is not a live or internal window" window))
(frame-root-window)))
;; The return value is a cons whose car specifies some constraints on
- ;; the size of WINDOW. The cdr lists the states of the subwindows of
- ;; WINDOW.
+ ;; the size of WINDOW. The cdr lists the states of the child windows
+ ;; of WINDOW.
(cons
;; Frame related things would go into a function, say `frame-state',
;; calling `window-state-get' to insert the frame's root window.
- (window-list-no-nils
- (cons 'min-height (window-min-size window))
- (cons 'min-width (window-min-size window t))
- (cons 'min-height-ignore (window-min-size window nil t))
- (cons 'min-width-ignore (window-min-size window t t))
- (cons 'min-height-safe (window-min-size window nil 'safe))
- (cons 'min-width-safe (window-min-size window t 'safe))
- ;; These are probably not needed.
- (when (window-size-fixed-p window) (cons 'fixed-height t))
- (when (window-size-fixed-p window t) (cons 'fixed-width t)))
- (window-state-get-1 window markers)))
+ `((min-height . ,(window-min-size window))
+ (min-width . ,(window-min-size window t))
+ (min-height-ignore . ,(window-min-size window nil t))
+ (min-width-ignore . ,(window-min-size window t t))
+ (min-height-safe . ,(window-min-size window nil 'safe))
+ (min-width-safe . ,(window-min-size window t 'safe))
+ ;; These are probably not needed.
+ ,@(when (window-size-fixed-p window) `((fixed-height . t)))
+ ,@(when (window-size-fixed-p window t) `((fixed-width . t))))
+ (window--state-get-1 window markers)))
(defvar window-state-put-list nil
"Helper variable for `window-state-put'.")
-(defun window-state-put-1 (state &optional window ignore totals)
+(defun window--state-put-1 (state &optional window ignore totals)
"Helper function for `window-state-put'."
(let ((type (car state)))
(setq state (cdr state))
((eq type 'leaf)
;; For a leaf window just add unprocessed entries to
;; `window-state-put-list'.
- (setq window-state-put-list
- (cons (cons window state) window-state-put-list)))
+ (push (cons window state) window-state-put-list))
((memq type '(vc hc))
(let* ((horizontal (eq type 'hc))
(total (window-total-size window horizontal))
;; real window that we want to fill with what we find here.
(when (memq (car item) '(leaf vc hc))
(if (assq 'last item)
- ;; The last child window. Below `window-state-put-1'
+ ;; The last child window. Below `window--state-put-1'
;; will put into it whatever ITEM has in store.
(setq new nil)
;; Not the last child window, prepare for splitting
window-safe-min-width)))
(if (window-sizable-p window (- size) horizontal 'safe)
- (let* ((window-nest (assq 'nest item)))
- ;; We must inherit the nesting, otherwise we might mess
- ;; up handling of atomic and side window.
+ (let* ((window-combination-limit
+ (assq 'combination-limit item)))
+ ;; We must inherit the combiantion limit, otherwise
+ ;; we might mess up handling of atomic and side
+ ;; window.
(setq new (split-window window size horizontal)))
;; Give up if we can't resize window down to safe sizes.
(error "Cannot resize window %s" window))
;; Now process the current window (either the one we've just
;; split or the last child of its parent).
- (window-state-put-1 item window ignore totals)
+ (window--state-put-1 item window ignore totals)
;; Continue with the last window split off.
(setq window new))))))))
-(defun window-state-put-2 (ignore)
+(defun window--state-put-2 (ignore)
"Helper function for `window-state-put'."
(dolist (item window-state-put-list)
(let ((window (car item))
(splits (cdr (assq 'splits item)))
- (nest (cdr (assq 'nest item)))
+ (combination-limit (cdr (assq 'combination-limit item)))
(parameters (cdr (assq 'parameters item)))
(state (cdr (assq 'buffer item))))
- (when splits (set-window-splits window splits))
- (when nest (set-window-nest window nest))
+ (when combination-limit
+ (set-window-combination-limit window combination-limit))
;; Process parameters.
(when parameters
(dolist (parameter parameters)
(let ((delta (- (cdr (assq 'total-height item))
(window-total-height window)))
window-size-fixed)
- (when (window-resizable-p window delta)
+ (when (window--resizable-p window delta)
(window-resize window delta)))
;; Else check whether the window is not high enough.
(let* ((min-size (window-min-size window nil ignore))
(delta (- min-size (window-total-size window))))
(when (and (> delta 0)
- (window-resizable-p window delta nil ignore))
+ (window--resizable-p window delta nil ignore))
(window-resize window delta nil ignore))))
;; Adjust horizontally.
(if (memq window-size-fixed '(t width))
(let ((delta (- (cdr (assq 'total-width item))
(window-total-width window)))
window-size-fixed)
- (when (window-resizable-p window delta)
+ (when (window--resizable-p window delta)
(window-resize window delta)))
;; Else check whether the window is not wide enough.
(let* ((min-size (window-min-size window t ignore))
(delta (- min-size (window-total-size window t))))
(when (and (> delta 0)
- (window-resizable-p window delta t ignore))
+ (window--resizable-p window delta t ignore))
(window-resize window delta t ignore))))
;; Set dedicated status.
(set-window-dedicated-p window (cdr (assq 'dedicated state)))
Optional argument IGNORE non-nil means ignore minimum window
sizes and fixed size restrictions. IGNORE equal `safe' means
-subwindows can get as small as `window-safe-min-height' and
+windows can get as small as `window-safe-min-height' and
`window-safe-min-width'."
- (setq window (window-normalize-live-window window))
+ (setq window (window-normalize-window window t))
(let* ((frame (window-frame window))
(head (car state))
;; We check here (1) whether the total sizes of root window of
(cdr (assq 'total-width state)))))
(min-height (cdr (assq 'min-height head)))
(min-width (cdr (assq 'min-width head)))
- window-splits selected)
+ selected)
(if (and (not totals)
(or (> min-height (window-total-size window))
(> min-width (window-total-size window t)))
;; issues - so IGNORE equal 'safe might not always produce the
;; minimum possible state. But such configurations hardly make
;; sense anyway.
- (error "Window %s too small to accomodate state" window)
+ (error "Window %s too small to accommodate state" window)
(setq state (cdr state))
(setq window-state-put-list nil)
;; Work on the windows of a temporary buffer to make sure that
;; splitting proceeds regardless of any buffer local values of
;; `window-size-fixed'. Release that buffer after the buffers of
- ;; all live windows have been set by `window-state-put-2'.
+ ;; all live windows have been set by `window--state-put-2'.
(with-temp-buffer
(set-window-buffer window (current-buffer))
- (window-state-put-1 state window nil totals)
- (window-state-put-2 ignore))
- (window-check frame))))
+ (window--state-put-1 state window nil totals)
+ (window--state-put-2 ignore))
+ (window--check frame))))
\f
-(defvar display-buffer-window nil
- "Window used by `display-buffer' and related information.
-After `display-buffer' displays a buffer in some window this
-variable is a cons cell whose car denotes the window used to
-display the buffer. The cdr is supposed to be one of the symbols
-`reuse-buffer-window', `reuse-other-window', `new-window' or
-`new-frame'.
-
-See the function `display-buffer-record-window' for how this
-variable can be assigned a value.")
-
(defun display-buffer-record-window (type window buffer)
"Record information for window used by `display-buffer'.
-TYPE must be one of the symbols reuse-window, pop-up-window, or
-pop-up-frame. WINDOW is the window used for or created by the
-`display-buffer' routines. BUFFER is the buffer that shall be
-displayed."
+TYPE specifies the type of the calling operation and must be one
+of the symbols 'reuse \(when WINDOW existed already and was
+reused for displaying BUFFER), 'window \(when WINDOW was created
+on an already existing frame), or 'frame \(when WINDOW was
+created on a new frame). WINDOW is the window used for or created
+by the `display-buffer' routines. BUFFER is the buffer that
+shall be displayed.
+
+This function installs or updates the quit-restore parameter of
+WINDOW. The quit-restore parameter is a list of four elements:
+The first element is one of the symbols 'window, 'frame, 'same or
+'other. The second element is either one of the symbols 'window
+or 'frame or a list whose elements are the buffer previously
+shown in the window, that buffer's window start and window point,
+and the window's height. The third element is the window
+selected at the time the parameter was created. The fourth
+element is BUFFER."
(cond
- ((eq type 'reuse-window)
- ;; In `display-buffer-window' record whether we used a window on the
- ;; same buffer or another one.
+ ((eq type 'reuse)
(if (eq (window-buffer window) buffer)
- (setq display-buffer-window
- (cons window 'reuse-buffer-window))
- (setq display-buffer-window
- (cons window 'reuse-other-window)))
- ;; In quit-restore parameter record information about the old buffer
- ;; unless such information exists already.
- (unless (window-parameter window 'quit-restore)
+ ;; WINDOW shows BUFFER already.
+ (when (consp (window-parameter window 'quit-restore))
+ ;; If WINDOW has a quit-restore parameter, reset its car.
+ (setcar (window-parameter window 'quit-restore) 'same))
+ ;; WINDOW shows another buffer.
(set-window-parameter
window 'quit-restore
- (list (window-buffer window) (window-start window)
- (window-point window) buffer
- (window-total-size window) (selected-window)))))
- ((eq type 'pop-up-window)
- ;; In `display-buffer-window' record window as new.
- (setq display-buffer-window (cons window 'new-window))
- ;; In `quit-restore' parameter record that we popped up this window,
- ;; its buffer, and which window was selected before.
+ (list 'other
+ ;; A quadruple of WINDOW's buffer, start, point and height.
+ (list (window-buffer window) (window-start window)
+ (window-point-1 window) (window-total-size window))
+ (selected-window) buffer))))
+ ((eq type 'window)
+ ;; WINDOW has been created on an existing frame.
(set-window-parameter
- window 'quit-restore (list 'new-window buffer (selected-window))))
- ((eq type 'pop-up-frame)
- ;; In `display-buffer-window' record window as on new frame.
- (setq display-buffer-window (cons window 'new-frame))
- ;; In `quit-restore' parameter record that we popped up this window
- ;; on a new frame, the buffer, and which window was selected before.
+ window 'quit-restore
+ (list 'window 'window (selected-window) buffer)))
+ ((eq type 'frame)
+ ;; WINDOW has been created on a new frame.
(set-window-parameter
- window 'quit-restore (list 'new-frame buffer (selected-window))))))
+ window 'quit-restore
+ (list 'frame 'frame (selected-window) buffer)))))
(defcustom display-buffer-function nil
"If non-nil, function to call to handle `display-buffer'.
should choose or create a window, display the specified buffer in
it, and return the window.
-The function specified here is responsible for setting the value
-of `display-buffer-window' and the quit-restore parameter of the
-window used."
+The specified function should call `display-buffer-record-window'
+with corresponding arguments to set up the quit-restore parameter
+of the window used."
:type '(choice
(const nil)
(function :tag "function"))
\(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
`special-display-popup-frame' will call FUNCTION with the buffer
named BUFFER-NAME as first argument, and OTHER-ARGS as the
-second. If `special-display-function' specifies some other
-function, that function is called with the buffer named
-BUFFER-NAME as first, and the element's cdr as second argument.
-In any case, that function is responsible for setting the value
-of `display-buffer-window' and the quit-restore parameter of the
-window used.
+second.
+
+Any alternative function specified here is responsible for
+setting up the quit-restore parameter of the window used.
If this variable appears \"not to work\", because you added a
name to it but the corresponding buffer is displayed in the
Finally, an element of this list can be also specified as
\(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
will then call FUNCTION with the buffer whose name matched
-REGEXP as first, and OTHER-ARGS as second argument. If
-`special-display-function' specifies some other function, that
-function is called with the buffer whose name matched REGEXP
-as first, and the element's cdr as second argument.
+REGEXP as first, and OTHER-ARGS as second argument.
+
+Any alternative function specified here is responsible for
+setting up the quit-restore parameter of the window used.
If this variable appears \"not to work\", because you added a
name to it but the corresponding buffer is displayed in the
(let ((frame (window-frame window)))
(make-frame-visible frame)
(raise-frame frame)
- (display-buffer-record-window 'reuse-window window buffer)
+ (display-buffer-record-window 'reuse window buffer)
window))
;; Reuse the current window if the user requested it.
(when (cdr (assq 'same-window args))
special-display-buffer-names special-display-regexps)
(display-buffer buffer)))
;; If no window yet, make one in a new frame.
- (let ((frame
- (with-current-buffer buffer
- (make-frame (append args special-display-frame-alist)))))
- (display-buffer-record-window
- 'pop-up-frame (frame-selected-window frame) buffer)
- (set-window-buffer (frame-selected-window frame) buffer)
- (set-window-dedicated-p (frame-selected-window frame) t)
- (frame-selected-window frame))))))
+ (let* ((frame
+ (with-current-buffer buffer
+ (make-frame (append args special-display-frame-alist))))
+ (window (frame-selected-window frame)))
+ (display-buffer-record-window 'frame window buffer)
+ ;; FIXME: Use window--display-buffer-2?
+ (set-window-buffer window buffer)
+ ;; Reset list of WINDOW's previous buffers to nil.
+ (set-window-prev-buffers window nil)
+ (set-window-dedicated-p window t)
+ window)))))
(defcustom special-display-function 'special-display-popup-frame
"Function to call for displaying special buffers.
`special-display-buffer-names' or matches a regexp in
`special-display-regexps'.
-The function specified here is responsible for setting the value
-of `display-buffer-window' and the quit-restore parameter of the
-window used."
+The specified function should call `display-buffer-record-window'
+with corresponding arguments to set up the quit-restore parameter
+of the window used."
:type 'function
:group 'frames)
(or (and (window-splittable-p window)
;; Split window vertically.
(with-selected-window window
- (split-window-vertically)))
+ (split-window-below)))
(and (window-splittable-p window t)
;; Split window horizontally.
(with-selected-window window
- (split-window-horizontally)))
+ (split-window-right)))
(and (eq window (frame-root-window (window-frame window)))
(not (window-minibuffer-p window))
;; If WINDOW is the only window on its frame and is not the
(let ((split-height-threshold 0))
(when (window-splittable-p window)
(with-selected-window window
- (split-window-vertically)))))))
+ (split-window-below)))))))
(defun window--try-to-split-window (window)
"Try to split WINDOW.
(defun window-normalize-buffer-to-display (buffer-or-name)
"Normalize BUFFER-OR-NAME argument for buffer display functions.
-If BUFFER-OR-NAME is nil, return the curent buffer. Else, if a
+If BUFFER-OR-NAME is nil, return the current buffer. Else, if a
buffer specified by BUFFER-OR-NAME exists, return that buffer.
If no such buffer exists, create a buffer with the name
BUFFER-OR-NAME and return that buffer."
buffer))
(current-buffer)))
-(defvar display-buffer-alist nil
+(defconst display-buffer--action-function-custom-type
+ '(choice :tag "Function"
+ (const :tag "--" ignore) ; default for insertion
+ (const display-buffer-reuse-window)
+ (const display-buffer-use-some-window)
+ (const display-buffer-same-window)
+ (const display-buffer-pop-up-frame)
+ (const display-buffer-use-some-window)
+ (function :tag "Other function"))
+ "Custom type for `display-buffer' action functions.")
+
+(defconst display-buffer--action-custom-type
+ `(cons :tag "Action"
+ (choice :tag "Action functions"
+ ,display-buffer--action-function-custom-type
+ (repeat
+ :tag "List of functions"
+ ,display-buffer--action-function-custom-type))
+ (alist :tag "Action arguments"
+ :key-type symbol
+ :value-type (sexp :tag "Value")))
+ "Custom type for `display-buffer' actions.")
+
+(defvar display-buffer-overriding-action '(nil . nil)
+ "Overriding action to perform to display a buffer.
+It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
+function or a list of functions. Each function should accept 2
+arguments: a buffer to display and an alist similar to ALIST.
+See `display-buffer' for details.")
+(put 'display-buffer-overriding-action 'risky-local-variable t)
+
+(defcustom display-buffer-alist nil
"Alist of conditional actions for `display-buffer'.
This is a list of elements (CONDITION . ACTION), where:
CONDITION is either a regexp matching buffer names, or a function
that takes a buffer and returns a boolean.
- ACTION is a cons cell (FUNCTION . ALIST), where FUNCTION is
- either a function or a list of functions. Each such function
- should accept 2 arguments: a buffer to display and an alist of
- the same form as ALIST. It should return the window used, or
- nil if it fails to display the window. See `display-buffer'
- for more details.
+ ACTION is a cons cell (FUNCTION . ALIST), where FUNCTION is a
+ function or a list of functions. Each such function should
+ accept 2 arguments: a buffer to display and an alist of the
+ same form as ALIST. See `display-buffer' for details."
+ :type `(alist :key-type
+ (choice :tag "Condition"
+ regexp
+ (function :tag "Matcher function"))
+ :value-type ,display-buffer--action-custom-type)
+ :risky t
+ :version "24.1"
+ :group 'windows)
-Usable action functions include:
- `display-buffer-reuse-selected-window'
- `display-buffer-same-window'
- `display-buffer-maybe-same-window'
- `display-buffer-reuse-window'
- `display-buffer-pop-up-frame'
- `display-buffer-pop-up-window'
- `display-buffer-reuse-or-pop-window'
- `display-buffer-use-some-window'
+(defcustom display-buffer-base-action '(nil . nil)
+ "User-specified default action for `display-buffer'.
+It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
+function or a list of functions. Each function should accept 2
+arguments: a buffer to display and an alist similar to ALIST.
+See `display-buffer' for details."
+ :type display-buffer--action-custom-type
+ :risky t
+ :version "24.1"
+ :group 'windows)
-The above functions recognize the following alist entries:
- - `inhibit-same-window', if non-nil, prevents the same window
- from being used for display.
- - `reuse-frame' specifies the frames that can be searched for a
- window displaying the buffer. Its values have the same
- meaning as the ALL-FRAMES arg to `get-buffer-window-list'.")
-
-(defvar display-buffer-default-action
- '((display-buffer-reuse-selected-window
- display-buffer-maybe-same-window
- display-buffer-reuse-or-pop-window
+(defconst display-buffer-fallback-action
+ '((display-buffer--maybe-same-window ;FIXME: why isn't this redundant?
+ display-buffer-reuse-window
+ display-buffer--maybe-pop-up-frame-or-window
display-buffer-use-some-window
- ;; If all else fails, pop up a new frame regardless of
- ;; restrictions.
+ ;; If all else fails, pop up a new frame.
display-buffer-pop-up-frame))
- "List of default actions for `display-buffer'.
-It should be a cons cell of the form (FUNCTION . ALIST), which
-has the same meaning as in `display-buffer-alist'.")
-
-(defvar display-buffer-overriding-action nil
- "Overriding action to perform to display a buffer.
-If non-nil, it should be a cons cell (FUNCTION . ALIST), which
-has the same meaning as in `display-buffer-alist'.")
+ "Default fallback action for `display-buffer'.
+This is the action used by `display-buffer' if no other actions
+specified, e.g. by the user options `display-buffer-alist' or
+`display-buffer-base-action'. See `display-buffer'.")
+(put 'display-buffer-fallback-action 'risky-local-variable t)
(defun display-buffer-assq-regexp (buffer-name alist)
"Retrieve ALIST entry corresponding to BUFFER-NAME."
(funcall key buffer-name alist)))
(throw 'match (cdr entry)))))))
+(defvar display-buffer--same-window-action
+ '(display-buffer-same-window
+ (inhibit-same-window . nil))
+ "A `display-buffer' action for displaying in the same window.")
+(put 'display-buffer--same-window-action 'risky-local-variable t)
+
+(defvar display-buffer--other-frame-action
+ '((display-buffer-reuse-window
+ display-buffer-pop-up-frame)
+ (reusable-frames . 0)
+ (inhibit-same-window . t))
+ "A `display-buffer' action for displaying in another frame.")
+(put 'display-buffer--other-frame-action 'risky-local-variable t)
+
(defun display-buffer (&optional buffer-or-name action frame)
- "Display BUFFER-OR-NAME in some window.
+ "Display BUFFER-OR-NAME in some window, without selecting it.
BUFFER-OR-NAME must be a buffer or the name of an existing
buffer. Return the window chosen for displaying BUFFER-OR-NAME,
or nil if no such window is found.
FUNCTION is either a function or a list of functions. Each such
function is called with 2 arguments: the buffer to display and an
alist. It should either display the buffer and return the
-window, or return nil if it is unable to display the buffer.
+window, or return nil if unable to display the buffer.
+
+The `display-buffer' function builds a function list and an alist
+from `display-buffer-overriding-action', `display-buffer-alist',
+the ACTION argument, `display-buffer-base-action', and
+`display-buffer-fallback-action' (in that order). Then it calls
+each function in the combined function list in turn, passing the
+buffer as the first argument and the combined alist as the second
+argument, until one of the functions returns non-nil.
+
+Available action functions include:
+ `display-buffer-same-window'
+ `display-buffer-reuse-window'
+ `display-buffer-pop-up-frame'
+ `display-buffer-pop-up-window'
+ `display-buffer-use-some-window'
+
+Recognized alist entries include:
-`display-buffer' constructs a list of action functions and an
-action alist by combining `display-buffer-overriding-action',
-`display-buffer-alist', the ACTION argument, and
-`display-buffer-default-action' (in that order). It calls each
-action function in turn, passing the combined action alist as the
-second argument, until one of the functions returns non-nil.
+ `inhibit-same-window' -- A non-nil value prevents the same
+ window from being used for display.
+
+ `reusable-frames' -- Value specifies frame(s) to search for a
+ window that already displays the buffer.
+ See `display-buffer-reuse-window'.
The ACTION argument to `display-buffer' can also have a non-nil
and non-list value. This means to display the buffer in a window
the selected window. If called interactively with a prefix
argument, ACTION is t.
-Optional argument FRAME specifies where to look for a window that
-already displays the buffer. If nil, check only the selected
-frame (actually the last non-minibuffer frame), except if
-`display-buffer-reuse-frames' or `pop-up-frames' is non-nil
-\(non-nil and not graphic-only on a text-only terminal), in which
-case check all visible or iconified frames. Otherwise, FRAME can
-be a specific frame, `visible' (all visible frames), 0 (all
-frames on the current terminal), or t (all frames)."
+Optional argument FRAME, if non-nil, acts like an additional
+ALIST entry (reusable-frames . FRAME), specifying the frame(s) to
+search for a window that is already displaying the buffer. See
+`display-buffer-reuse-window'."
(interactive (list (read-buffer "Display buffer: " (other-buffer))
(if current-prefix-arg t)))
(let ((buffer (window-normalize-buffer-to-display buffer-or-name))
(let* ((user-action
(display-buffer-assq-regexp (buffer-name buffer)
display-buffer-alist))
+ (special-action (display-buffer--special-action buffer))
;; Extra actions from the arguments to this function:
(extra-action
(cons nil (append (if inhibit-same-window
'((inhibit-same-window . t)))
(if frame
- `((reuse-frame . ,frame))))))
+ `((reusable-frames . ,frame))))))
;; Construct action function list and action alist.
(actions (list display-buffer-overriding-action
- user-action action extra-action
- display-buffer-default-action))
+ user-action special-action action extra-action
+ display-buffer-base-action
+ display-buffer-fallback-action))
(functions (apply 'append
(mapcar (lambda (x)
(setq x (car x))
This uses the function `display-buffer' as a subroutine; see
its documentation for additional customization information."
(interactive "BDisplay buffer in other frame: ")
- (let ((pop-up-frames t)
- same-window-buffer-names same-window-regexps
- ;;(old-window (selected-window))
- new-window)
- (setq new-window (display-buffer buffer t))
- ;; This may have been here in order to prevent the new frame from hiding
- ;; the old frame. But it does more harm than good.
- ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
- ;;(lower-frame (window-frame new-window))
-
- ;; This may have been here in order to make sure the old-frame gets the
- ;; focus. But not only can it cause an annoying flicker, with some
- ;; window-managers it just makes the window invisible, with no easy
- ;; way to recover it. --Stef
- ;;(make-frame-invisible (window-frame old-window))
- ;;(make-frame-visible (window-frame old-window))
- ))
+ (display-buffer buffer display-buffer--other-frame-action t))
;;; `display-buffer' action functions:
-(defun display-buffer-reuse-selected-window (buffer alist)
- "Try to display BUFFER in the selected window if it is already there.
-If this succeeds, return the selected window.
-
-This fails if BUFFER is not displayed in the selected window, or
-if ALIST has a non-nil `inhibit-same-window' entry. In that
-case, return nil."
- (when (and (not (cdr (assq 'inhibit-same-window alist)))
- (eq buffer (window-buffer)))
- (display-buffer-record-window 'reuse-window (selected-window) buffer)
- (window--display-buffer-1 (selected-window))))
-
(defun display-buffer-same-window (buffer alist)
- "Try to display BUFFER in the selected window.
-If this succeeds, return the selected window.
-
-This fails if the selected window is a minibuffer window or is
-dedicated to another buffer, or if ALIST has a non-nil
-`inhibit-same-window' entry. In that case, return nil."
+ "Display BUFFER in the selected window.
+This fails if ALIST has a non-nil `inhibit-same-window' entry, or
+if the selected window is a minibuffer window or is dedicated to
+another buffer; in that case, return nil. Otherwise, return the
+selected window."
(unless (or (cdr (assq 'inhibit-same-window alist))
(window-minibuffer-p)
(window-dedicated-p))
- (display-buffer-record-window 'reuse-window (selected-window) buffer)
+ (display-buffer-record-window 'reuse (selected-window) buffer)
(window--display-buffer-2 buffer (selected-window))))
-(defun display-buffer-maybe-same-window (buffer alist)
- "Try to display BUFFER in the selected window.
-This acts like `display-buffer-same-window', except that it also
-fails if `same-window-p' returns nil for this buffer."
+(defun display-buffer--maybe-same-window (buffer alist)
+ "Conditionally display BUFFER in the selected window.
+If `same-window-p' returns non-nil for BUFFER's name, call
+`display-buffer-same-window' and return its value. Otherwise,
+return nil."
(and (same-window-p (buffer-name buffer))
(display-buffer-same-window buffer alist)))
(defun display-buffer-reuse-window (buffer alist)
"Return a window that is already displaying BUFFER.
-If no usable window is found, return nil.
-
-If ALIST has a non-nil `inhibit-same-window' entry, the same
-window cannot be reused.
-
-If ALIST contains a `reuse-frame' entry, that determines the
-frames to check for a window displaying the buffer. If the entry
-is omitted or the value is nil, check only this frame. The value
-can also be a specific frame, `visible' (all visible frames),
-0 (all frames on the current terminal), or t (all frames)."
- (let* ((can-use-selected-window
- (not (cdr (assq 'inhibit-same-window alist))))
- (frames (or (cdr (assq 'reuse-frame alist))
- (last-nonminibuffer-frame)))
- (window (catch 'found
- (dolist (window (get-buffer-window-list
- buffer 'nomini frames))
- (when (or can-use-selected-window
- (not (eq (selected-window) window)))
- (throw 'found window))))))
+Return nil if no usable window is found.
+
+If ALIST has a non-nil `inhibit-same-window' entry, the selected
+window is not eligible for reuse.
+
+If ALIST contains a `reusable-frames' entry, its value determines
+which frames to search for a reusable window:
+ nil -- the selected frame (actually the last non-minibuffer frame)
+ A frame -- just that frame
+ `visible' -- all visible frames
+ 0 -- all frames on the current terminal
+ t -- all frames.
+
+If ALIST contains no `reusable-frames' entry, search just the
+selected frame if `display-buffer-reuse-frames' and
+`pop-up-frames' are both nil; search all frames on the current
+terminal if either of those variables is non-nil."
+ (let* ((alist-entry (assq 'reusable-frames alist))
+ (frames (cond (alist-entry (cdr alist-entry))
+ ((if (eq pop-up-frames 'graphic-only)
+ (display-graphic-p)
+ pop-up-frames)
+ 0)
+ (display-buffer-reuse-frames 0)
+ (t (last-nonminibuffer-frame))))
+ (window (if (and (eq buffer (window-buffer))
+ (not (cdr (assq 'inhibit-same-window alist))))
+ (selected-window)
+ (car (delq (selected-window)
+ (get-buffer-window-list buffer 'nomini
+ frames))))))
(when window
- (display-buffer-record-window 'reuse-window window buffer)
+ (display-buffer-record-window 'reuse window buffer)
(window--display-buffer-1 window))))
+(defun display-buffer--special-action (buffer)
+ "Return special display action for BUFFER, if any.
+If `special-display-p' returns non-nil for BUFFER, return an
+appropriate display action involving `special-display-function'.
+See `display-buffer' for the format of display actions."
+ (and special-display-function
+ ;; `special-display-p' returns either t or a list of frame
+ ;; parameters to pass to `special-display-function'.
+ (let ((pars (special-display-p (buffer-name buffer))))
+ (when pars
+ (list (list #'display-buffer-reuse-window
+ `(lambda (buffer _alist)
+ (funcall special-display-function
+ buffer ',(if (listp pars) pars)))))))))
+
(defun display-buffer-pop-up-frame (buffer alist)
"Display BUFFER in a new frame.
-This works by calling `pop-up-frame-function'. If sucessful,
-return the window on the new frame; otherwise return nil."
+This works by calling `pop-up-frame-function'. If successful,
+return the window used; otherwise return nil."
(let ((fun pop-up-frame-function)
frame window)
(when (and fun
(setq frame (funcall fun))
(setq window (frame-selected-window frame)))
- (display-buffer-record-window 'pop-up-frame window buffer)
- (window--display-buffer-2 buffer window)
+ (display-buffer-record-window 'frame window buffer)
+ (window--display-buffer-2 buffer window display-buffer-mark-dedicated)
;; Reset list of WINDOW's previous buffers to nil.
(set-window-prev-buffers window nil)
window)))
(get-largest-window frame t))
(window--try-to-split-window
(get-lru-window frame t)))))
- (display-buffer-record-window 'pop-up-window window buffer)
- (window--display-buffer-2 buffer window)
+ (display-buffer-record-window 'window window buffer)
+ (window--display-buffer-2 buffer window display-buffer-mark-dedicated)
;; Reset list of WINDOW's previous buffers to nil.
(set-window-prev-buffers window nil)
window)))
-;; This display action function groups together some lower-level ones:
-(defun display-buffer-reuse-or-pop-window (buffer alist)
- "Display BUFFER in some window other than the selected one.
-This attempts to call the following functions (in order):
- - `display-buffer-reuse-window', ensuring that it checks all
- frames on this terminal if `display-buffer-reuse-frames' or
- `pop-up-frames' is non-nil.
- - `special-display-function', if it is available.
- - `display-buffer-pop-up-frame', if specified by `pop-up-frames'.
- - `display-buffer-pop-up-window', if specified by `pop-up-windows'.
-
-If BUFFER is sucessfully display, return its window; otherwise
-return nil."
- (let ((use-pop-up-frames (if (eq pop-up-frames 'graphic-only)
- (display-graphic-p)
- pop-up-frames)))
- (or (display-buffer-reuse-window
- buffer
- ;; If `display-buffer-reuse-frames' or `pop-up-frames' is
- ;; non-nil, check all frames on this terminal.
- (if (and (null (cdr (assq 'reuse-frame alist)))
- (or use-pop-up-frames display-buffer-reuse-frames))
- (cons '(reuse-frame . 0) alist)
- alist))
- ;; Try with `special-display-function':
- (and special-display-function
- ;; `special-display-p' returns either t or a list of frame
- ;; parameters to pass to `special-display-function'.
- (let ((pars (special-display-p (buffer-name buffer))))
- (when pars
- (funcall special-display-function
- buffer (if (listp pars) pars)))))
- (and use-pop-up-frames
- (display-buffer-pop-up-frame buffer alist))
- (and pop-up-windows
- (display-buffer-pop-up-window buffer alist)))))
+(defun display-buffer--maybe-pop-up-frame-or-window (buffer alist)
+ "Try displaying BUFFER based on `pop-up-frames' or `pop-up-windows'.
+
+If `pop-up-frames' is non-nil (and not `graphic-only' on a
+text-only terminal), try with `display-buffer-pop-up-frame'.
+
+If that cannot be done, and `pop-up-windows' is non-nil, try
+again with `display-buffer-pop-up-window'."
+ (or (and (if (eq pop-up-frames 'graphic-only)
+ (display-graphic-p)
+ pop-up-frames)
+ (display-buffer-pop-up-frame buffer alist))
+ (and pop-up-windows
+ (display-buffer-pop-up-window buffer alist))))
(defun display-buffer-use-some-window (buffer alist)
"Display BUFFER in an existing window.
(selected-window)))
(frame (or (window--frame-usable-p (selected-frame))
(window--frame-usable-p (last-nonminibuffer-frame))))
- (use-pop-up-frames (if (eq pop-up-frames 'graphic-only)
- (display-graphic-p)
- pop-up-frames))
- window popped-up-frame)
+ window)
(unwind-protect
(setq window
;; Reuse an existing window.
(unless (and not-this-window
(eq window (selected-window)))
window))
- (get-largest-window 0)
- (and use-pop-up-frames
- (prog1
- (frame-selected-window (funcall pop-up-frame-function))
- (setq popped-up-frame t)))))
+ (get-largest-window 0)))
(when (window-live-p window-to-undedicate)
;; Restore dedicated status of selected window.
(set-window-dedicated-p window-to-undedicate nil)))
(when window
- (display-buffer-record-window
- (if popped-up-frame 'pop-up-frame 'reuse-window) window buffer)
+ (display-buffer-record-window 'reuse window buffer)
(window--even-window-heights window)
(window--display-buffer-2 buffer window))))
at the front of the list of recently selected ones."
(interactive (list (read-buffer "Pop to buffer: " (other-buffer))
(if current-prefix-arg t)))
- (setq buffer (window-normalize-buffer-to-display
- ;; BUFFER nil means another buffer.
- (or buffer (other-buffer))))
+ (setq buffer (window-normalize-buffer-to-switch-to buffer))
(set-buffer buffer)
(let* ((old-window (selected-window))
(old-frame (selected-frame))
- (window (display-buffer (current-buffer) action))
+ (window (display-buffer buffer action))
(frame (window-frame window)))
- (if (eq frame old-frame)
- ;; Make sure new window is selected (Bug#8615), (Bug#6954).
- (select-window window norecord)
- ;; If `display-buffer' has chosen another frame, make sure it
- ;; gets input focus.
+ ;; If we chose another frame, make sure it gets input focus.
+ (unless (eq frame old-frame)
(select-frame-set-input-focus frame norecord))
+ ;; Make sure new window is selected (Bug#8615), (Bug#6954).
+ (select-window window norecord)
buffer))
+(defun pop-to-buffer-same-window (buffer &optional norecord)
+ "Select buffer BUFFER in some window, preferably the same one.
+This function behaves much like `switch-to-buffer', except it
+displays with `special-display-function' if BUFFER has a match in
+`special-display-buffer-names' or `special-display-regexps'.
+
+Unlike `pop-to-buffer', this function prefers using the selected
+window over popping up a new window or frame.
+
+BUFFER may be a buffer, a string (a buffer name), or nil. If it
+is a string not naming an existent buffer, create a buffer with
+that name. If BUFFER is nil, choose some other buffer. Return
+the buffer.
+
+NORECORD, if non-nil means do not put this buffer at the front of
+the list of recently selected ones."
+ (pop-to-buffer buffer
+ '(display-buffer-same-window
+ (inhibit-same-window . nil))
+ norecord))
+
(defun read-buffer-to-switch (prompt)
"Read the name of a buffer to switch to, prompting with PROMPT.
-Return the neame of the buffer as a string.
+Return the name of the buffer as a string.
This function is intended for the `switch-to-buffer' family of
commands since these need to omit the name of the current buffer
one.
If FORCE-SAME-WINDOW is non-nil, BUFFER-OR-NAME must be displayed
-in the currently selected window; signal an error if that is
-impossible (e.g. if the selected window is minibuffer-only).
-If non-nil, BUFFER-OR-NAME may be displayed in another window.
+in the selected window; signal an error if that is
+impossible (e.g. if the selected window is minibuffer-only). If
+nil, BUFFER-OR-NAME may be displayed in another window.
Return the buffer switched to."
(interactive
- (list (read-buffer-to-switch "Switch to buffer: ") nil nil))
+ (list (read-buffer-to-switch "Switch to buffer: ") nil 'force-same-window))
(let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name)))
(if (null force-same-window)
- (cond
- ((eq buffer (window-buffer))
- (unless norecord
- (select-window (selected-window)))
- (set-buffer buffer))
- ((or (window-minibuffer-p) (window-dedicated-p))
- (pop-to-buffer buffer))
- (t
- (set-window-buffer nil buffer)
- (unless norecord
- (select-window (selected-window)))
- (set-buffer buffer)))
+ (pop-to-buffer buffer display-buffer--same-window-action norecord)
(cond
;; Don't call set-window-buffer if it's not needed since it
;; might signal an error (e.g. if the window is dedicated).
documentation for additional customization information."
(interactive
(list (read-buffer-to-switch "Switch to buffer in other window: ")))
- (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name))
- (pop-up-windows t)
- same-window-buffer-names same-window-regexps)
- (pop-to-buffer buffer t norecord)))
+ (let ((pop-up-windows t))
+ (pop-to-buffer buffer-or-name t norecord)))
(defun switch-to-buffer-other-frame (buffer-or-name &optional norecord)
"Switch to buffer BUFFER-OR-NAME in another frame.
documentation for additional customization information."
(interactive
(list (read-buffer-to-switch "Switch to buffer in other frame: ")))
- (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name))
- (pop-up-frames t)
- same-window-buffer-names same-window-regexps)
- (pop-to-buffer buffer t norecord)))
+ (pop-to-buffer buffer-or-name display-buffer--other-frame-action norecord))
\f
(defun set-window-text-height (window height)
"Set the height in lines of the text display area of WINDOW to HEIGHT.
always set the height exactly, but attempts to be conservative,
by allocating more lines than are actually needed in the case
where some error may be present."
- (setq window (window-normalize-live-window window))
+ (setq window (window-normalize-window window t))
(let ((delta (- height (window-text-height window))))
(unless (zerop delta)
;; Setting window-min-height to a value like 1 can lead to very
(interactive)
;; Do all the work in WINDOW and its buffer and restore the selected
;; window and the current buffer when we're done.
- (setq window (window-normalize-live-window window))
+ (setq window (window-normalize-window window t))
;; Can't resize a full height or fixed-size window.
(unless (or (window-size-fixed-p window)
(window-full-height-p window))
WINDOW defaults to the selected window."
(with-selected-window (or window (selected-window))
(let ((edges (window-edges)))
- ;; The following doesn't satisfy the doc-string's claim when
- ;; window and previous-/next-window are not part of the same
- ;; combination but still share a common edge. Using
- ;; `window-iso-combined-p' instead should handle that.
(or (= (nth 2 edges) (nth 2 (window-edges (previous-window))))
(= (nth 0 edges) (nth 0 (window-edges (next-window))))))))
-;; (make-obsolete
- ;; 'window-safely-shrinkable-p "use `window-iso-combined-p' instead." "24.1")
(defun shrink-window-if-larger-than-buffer (&optional window)
"Shrink height of WINDOW if its buffer doesn't need so many lines.
Return non-nil if the window was shrunk, nil otherwise."
(interactive)
- (setq window (window-normalize-live-window window))
+ (setq window (window-normalize-window window t))
;; Make sure that WINDOW is vertically combined and `point-min' is
;; visible (for whatever reason that's needed). The remaining issues
;; should be taken care of by `fit-window-to-buffer'.
- (when (and (window-iso-combined-p window)
+ (when (and (window-combined-p window)
(pos-visible-in-window-p (point-min) window))
(fit-window-to-buffer window (window-total-size window))))
\f
\f
;;; Scrolling commands.
-;;; Scrolling commands which does not signal errors at top/bottom
-;;; of buffer at first key-press (instead moves to top/bottom
+;;; Scrolling commands which do not signal errors at top/bottom
+;;; of buffer at first key-press (instead move to top/bottom
;;; of buffer).
(defcustom scroll-error-top-bottom nil
- "Move point to top/bottom of buffer before signalling a scrolling error.
+ "Move point to top/bottom of buffer before signaling a scrolling error.
A value of nil means just signal an error if no more scrolling possible.
A value of t means point moves to the beginning or the end of the buffer
\(depending on scrolling direction) when no more scrolling possible.
;; change these.
(define-key ctl-x-map "0" 'delete-window)
(define-key ctl-x-map "1" 'delete-other-windows)
-(define-key ctl-x-map "2" 'split-window-above-each-other)
-(define-key ctl-x-map "3" 'split-window-side-by-side)
+(define-key ctl-x-map "2" 'split-window-below)
+(define-key ctl-x-map "3" 'split-window-right)
(define-key ctl-x-map "o" 'other-window)
(define-key ctl-x-map "^" 'enlarge-window)
(define-key ctl-x-map "}" 'enlarge-window-horizontally)