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
"The minimum number of lines of any window.
-The value has to accomodate a mode- or header-line if present. A
-value less than `window-safe-min-height' is ignored. The value
+The value has to accommodate a mode- or header-line if present.
+A value less than `window-safe-min-height' is ignored. The value
of this variable is honored when windows are resized or split.
Applications should never rebind this variable. To resize a
: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.
(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 it's frame.
-If this variable is nil, functions that quit a window never
-delete the associated frame. If this variable equals the symbol
-`automatic', a frame is deleted only if it 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-restore-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 delete its frame
-instead."
+Return `frame' if deleting WINDOW should also delete its
+frame."
(setq window (window-normalize-any-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))
- (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)
- (when (and (or (eq frame-auto-delete t)
- (and (eq frame-auto-delete 'automatic)
- (or dedicated
- (and (eq (car-safe quit-restore) 'new-frame)
- (eq (nth 1 quit-restore)
- (window-buffer window))))))
- (other-visible-frames-p frame))
- ;; WINDOW is the root window of its frame. Return `frame' but
- ;; only if WINDOW is (1) either dedicated or quit-restore's car
- ;; is new-frame and the window still displays the same buffer
- ;; and (2) there are other frames left.
+ ;; WINDOW's frame can be deleted only if there are other frames
+ ;; on the same terminal.
+ (unless (eq frame (next-frame frame 0))
'frame))
- ((and (not ignore-window-parameters)
- (eq (window-parameter window 'window-side) 'none)
- (or (not parent)
- (not (eq (window-parameter parent 'window-side) 'none))))
- ;; Can't delete last main window.
- nil)
- (t))))
+ ((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."
(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
(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
(let* ((buffer (window-normalize-buffer buffer-or-name)))
;; If `buffer-or-name' is not on the selected frame we unrecord it
;; although it's not "here" (call it a feature).
- (unrecord-buffer buffer)
+ (bury-buffer-internal buffer)
;; Handle case where `buffer-or-name' is nil and the current buffer
;; is shown in the selected window.
(cond
;; 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)
+ ((eq (window-deletable-p) t)
(delete-window)))
+
;; Always return nil.
nil))
(defun next-buffer ()
"In selected window switch to next buffer."
(interactive)
+ (if (window-minibuffer-p)
+ (error "Cannot switch buffers in minibuffer window"))
(switch-to-next-buffer))
(defun previous-buffer ()
"In selected window switch to previous buffer."
(interactive)
+ (if (window-minibuffer-p)
+ (error "Cannot switch buffers in minibuffer window"))
(switch-to-prev-buffer))
(defun delete-windows-on (&optional buffer-or-name frame)
(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.
(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)))
+ (let ((deletable (and (window-dedicated-p window)
+ (window-deletable-p window))))
(cond
((eq deletable 'frame)
;; Delete frame.
(delete-frame (window-frame window)))
- ((and (window-dedicated-p window) deletable)
+ (deletable
;; Delete window.
(delete-window window))
(t
;; Unrecord BUFFER in WINDOW.
(unrecord-window-buffer window buffer)))))
-(defun quit-restore-window (&optional window kill)
- "Quit WINDOW in some way.
-WINDOW must be a live window and defaults to the selected window.
-Return nil.
+(defun quit-window (&optional kill window)
+ "Quit WINDOW and bury its buffer.
+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
WINDOW, \(3) restore the buffer previously displayed in WINDOW,
or \(4) make WINDOW display some other buffer than the present
-one. If non-nil, reset `quit-restore' parameter to nil.
-
-Optional argument KILL non-nil means in addition kill WINDOW's
-buffer. If KILL is nil, put WINDOW's buffer at the end of the
-buffer list. Interactively, KILL is the prefix argument."
- (interactive "i\nP")
+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)
+ (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)))
+ ((and (not prev-buffer)
+ (eq (nth 1 quit-restore) 'frame)
+ (eq (window-deletable-p window) 'frame)
+ (eq (nth 3 quit-restore) buffer))
+ ;; WINDOW's frame can be deleted.
+ (delete-frame (window-frame window))
+ ;; 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 (not prev-buffer)
+ (eq (nth 1 quit-restore) 'window)
+ (eq (window-deletable-p window) t)
+ (eq (nth 3 quit-restore) buffer))
;; WINDOW can be deleted.
- (unrecord-buffer buffer)
- (if (eq deletable 'frame)
- ;; WINDOW's frame can be deleted.
- (delete-frame (window-frame window))
- ;; Just delete WINDOW.
- (delete-window window))
+ (delete-window window)
;; 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 buffer.
- (unrecord-buffer buffer)
+ ((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)))))
(unrecord-window-buffer window buffer)
- ;; Display buffer stored in the quit-restore parameter.
(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))
- (when (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, window start and point.
+ (set-window-buffer-start-and-point
+ window (nth 0 quad) (nth 1 quad) (nth 2 quad))
;; 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)
- (unrecord-buffer buffer)
+ ;; 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
- (when kill (kill-buffer buffer))
- nil))
+ (if kill
+ (kill-buffer buffer)
+ (bury-buffer-internal buffer))))
\f
;;; Splitting windows.
(defsubst window-split-min-size (&optional horizontal)
(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 lines.
+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
(balance-windows-2 window horizontal)
(let ((size (window-new-total window)))
(while sub
- (set-window-new-total sub size)
+ (set-window-new-total sub size)
(balance-windows-1 sub horizontal)
(setq sub (window-right sub))))))))
(window-list-no-nils
type
(unless (window-next-sibling window) (cons 'last t))
- (cons 'clone-number (window-clone-number window))
(cons 'total-height (window-total-size window))
(cons 'total-width (window-total-size window t))
(cons 'normal-height (window-normal-size 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
"Helper function for `window-state-put'."
(dolist (item window-state-put-list)
(let ((window (car item))
- (clone-number (cdr (assq 'clone-number item)))
(splits (cdr (assq 'splits item)))
(nest (cdr (assq 'nest item)))
(parameters (cdr (assq 'parameters item)))
(state (cdr (assq 'buffer item))))
- ;; Put in clone-number.
- (when clone-number (set-window-clone-number window clone-number))
(when splits (set-window-splits window splits))
(when nest (set-window-nest window nest))
;; Process parameters.
;; 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
(window-state-put-2 ignore))
(window-check frame))))
\f
-;;; Displaying buffers.
-(defconst display-buffer-default-specifiers
- '((reuse-window nil same visible)
- (pop-up-window (largest . nil) (lru . nil))
- (pop-up-window-min-height . 40)
- (pop-up-window-min-width . 80)
- (reuse-window other nil nil)
- (reuse-window nil other visible)
- (reuse-window nil nil t)
- (reuse-window-even-sizes . t))
- "Buffer display default specifiers.
-The value specified here is used when no other specifiers have
-been specified by the user or the application. Consult the
-documentation of `display-buffer-alist' for a description of
-buffer display specifiers.")
-
-(defconst display-buffer-macro-specifiers
- '((same-window
- ;; Use the same window.
- (reuse-window same nil nil))
- (same-frame
- ;; Avoid other frames.
- (reuse-window nil same nil)
- (pop-up-window (largest . nil) (lru . nil))
- (reuse-window nil other nil))
- ;; (other-window
- ;; ;; Avoid selected window.
- ;; (reuse-window other same visible)
- ;; (pop-up-window (largest . nil) (lru . nil))
- ;; (reuse-window other other visible))
- (same-frame-other-window
- ;; Avoid other frames and selected window.
- (reuse-window other same nil)
- (pop-up-window (largest . nil) (lru . nil))
- (reuse-window other other nil))
- (other-frame
- ;; Avoid selected frame.
- (reuse-window nil same other)
- (pop-up-frame)
- (reuse-window nil other other))
- (default
- ;; The default specifiers.
- display-buffer-default-specifiers))
- "Buffer display macro specifiers.")
-
-(defcustom display-buffer-alist
- '((((regexp . ".*"))
- ;; Reuse window showing same buffer on same frame.
- reuse-window (reuse-window nil same nil)
- ;; Pop up window.
- pop-up-window
- ;; Split largest or lru window.
- (pop-up-window (largest . nil) (lru . nil))
- (pop-up-window-min-height . 40) ; split-height-threshold / 2
- (pop-up-window-min-width . 80) ; split-width-threshold / 2
- ;; Reuse any but selected window on same frame.
- reuse-window (reuse-window other nil nil)
- (reuse-window-even-sizes . t)))
- "List associating buffer identifiers with display specifiers.
-The car of each element of this list is built from a set of cons
-cells called buffer identifiers. `display-buffer' shows a buffer
-according to the display specifiers in the element's cdr
-\(elements are true lists) if at least one of the identifiers
-matches the first or third argument of `display-buffer'. Such a
-match occurs in one of the following three cases:
-
-- The car of the buffer identifier is the symbol `name' and its
- cdr is a string equalling the name of the buffer specified by
- the first \(BUFFER-OR-NAME) argument of `display-buffer'.
-
-- The car is the symbol `regexp' and the cdr is a regular
- expression matching the name of the buffer specified by the
- first \(BUFFER-OR-NAME) argument of `display-buffer'.
-
-- The car is the symbol `label' and the cdr is a symbol equalling
- the third \(LABEL) argument of `display-buffer'.
-
-Display specifiers are either symbols, cons cells, or lists.
-Five specifiers have been reserved to indicate the basic method
-for displaying the buffer: `reuse-window', `pop-up-window',
-`pop-up-frame', `use-side-window', and `function'.
-
-A list whose car is the symbol `reuse-window' indicates that an
-existing window shall be reused for displaying the buffer. The
-second element of this list specifies the window to use and can
-be one of the following symbols:
-
- nil stands for any window.
-
- `same' stands for the selected window.
-
- `other' stands for any but the selected window.
-
-The third element specifies whether the buffer shown in a window
-that shall be reused must be the same buffer that shall be
-displayed or another buffer and can be one of the following:
-
- nil means to not care about the window's buffer.
-
- `same' means the window must show the buffer already.
-
- `other' means the window must not show the buffer yet.
-
-The fourth element specifies the set of frames to search for a
-suitable window and can be one of the following:
-
- nil to reuse a window on the selected frame.
-
- `visible' to search visible frames on the current terminal.
-
- `other' stands for any visible frame but the selected one.
-
- 0 \(the number zero) to search visible and iconified frames on
- the current terminal.
-
- t to search arbitrary frames including invisible ones.
-
-If more than one window fits the constraints imposed by these
-elements, the least recently used candidate is chosen. A side
-window is never reused unless it already shows the buffer.
-
-The following two specifiers are useful when the method equals
-`reuse-window':
-
-- A cons cell whose car is the symbol `reuse-window-even-sizes'
- and whose cdr is non-nil means to even out the sizes of a
- reused window and the selected window provided they (1) appear
- adjacent to each other and (2) the selected window is larger
- than the window chosen. If the cdr is nil, this means that the
- window sizes are left alone.
-
-- A cons cell whose car is the symbol `reuse-window-dedicated'
- and whose cdr is non-nil means that a window can be reused even
- if it's weakly dedicated to its buffer. If the cdr is t, a
- strongly dedicated window can be reused to show the buffer.
- Any other non-nil value means only weakly dedicated windows can
- be reused. If the cdr is nil, dedicated windows are not
- reused.
-
- This specifier should be used in emergency cases only since
- windows are usually made dedicated in order to prevent
- `display-buffer' from reusing them.
-
-A list whose car is the symbol `pop-up-window' and whose cdr is
-built from cons cells representing window/side tuples indicates
-that a new window shall be made for displaying the buffer on the
-selected frame.
-
-Window/side tuples are cons cells. The car of such a tuple
-identifies the window that shall be split. Possible values are
-`largest', `lru', `selected', and `root' to split the largest,
-least recently used, selected or root window of the selected
-frame.
-
-If the frame has side windows, these values do allow to split
-only the selected frame's main window or one of its subwindows.
-Setting the car to one of `left', `top', `right' and `bottom'
-splits the corresponding side window, provided such a window
-exists.
-
-The cdr of each pair specifies on which side of the window to
-split the new window shall appear and can be one of `below',
-`right', `above', or `left' with the obvious meanings. If the
-cdr is nil, the window is split in a fashion suitable for its
-current dimensions. If the cdr specifies a function, that
-function is called with one argument - the window to split. The
-function is supposed to split that window and return the new
-window.
-
-`display-buffer' scans these tuples until it can either produce a
-suitable window or fails. The default value for
-`display-buffer-alist' contains the tuples \(largest . nil) and
-\(lru . nil) in order to split the largest window first and, if
-that fails, the least recently used one.
-
-The following specifiers are useful if the method specifier is
-`pop-up-window'.
-
-- A cons cell whose car is the symbol `pop-up-window-min-height'
- specifiies the minimum height of the new window. If the cdr is
- an integer number, it specifies the minimum number of lines of
- the window. A floating point number gives the minimum fraction
- of the window height with respect to the height of the frame's
- root window. A new window is created only if it can be made at
- least as high as specified by the number. If the cdr is nil,
- this means to use the value of `window-min-height'.
-
-- A cons cell whose car is the symbol `pop-up-window-min-width'
- specifies the minimum width of the new window. If the cdr is
- an integer number, it specifies the minimum number of columns
- of the window. A floating point number gives the minimum
- fraction of the window width with respect to the width of the
- frame's root window. A new window is created only if it can be
- made at least as wide as specified by the number. If the cdr
- is nil, this means to use the value of `window-min-width'.
-
-- A cons cell whose car is `pop-up-window-set-height' with
- the following interpretations for the cdr:
-
- - nil means leave the height of the new window alone.
-
- - A number specifies the desired height of the new window. An
- integer number specifies the number of lines of the window.
- A floating point number gives the fraction of the window
- height with respect to the height of the frame's root window.
-
- - If the cdr specifies a function, that function is called with
- one argument - the new window. The function is supposed to
- adjust the height of the window; its return value is ignored.
- Suitable functions are `shrink-window-if-larger-than-buffer'
- and `fit-window-to-buffer'.
-
-- A cons cell whose car equals `pop-up-window-set-width' with
- the following interpretations for the cdr:
-
- - nil means leave the width of the new window alone.
-
- - A number specifies the desired width of the new window. An
- integer number specifies the number of columns of the window.
- A floating point number gives the fraction of the window
- width with respect to the width of the frame's root window.
-
- - If the cdr specifies a function, that function is called with
- one argument - the new window. The function is supposed to
- adjust the width of the window; its return value is ignored.
-
- Observe that specifying `pop-up-window-set-height' or
- `pop-up-window-set-width' may override restrictions given by
- the `pop-up-window-min-height' and `pop-up-window-min-width'
- specifiers.
-
-- A cons cell whose car is `pop-up-window-split-unsplittable' and
- whose cdr is non-nil allows to make a new window on an
- unsplittable frame. If the cdr is nil, unsplittable frames are
- not split. This specifier should be used in special cases only
- since frames are usually made unsplittable in order to prevent
- `display-buffer' from splitting them.
-
-A list whose car is the symbol `pop-up-frame' specifies that a
-new frame shall be made for displaying the buffer. The second
-element, if non-nil, allows popping up a new frame on graphic
-displays only.
-
-The following specifiers are useful if the method specifier is
-`pop-up-frame'.
-
-- A list whose car is the symbol `pop-up-frame-function' together
- with a valid function as cdr specifies the function for
- creating a new frame. If the cdr is nil, the default function
- `make-frame' is called. The function is called with the
- parameters and values provided by the specifier described next.
-
-- A list whose car is the symbol `pop-up-frame-alist' followed by
- an arbitrary number of frame parameter/value tuples, each given
- as a cons cell, specifies the parameters passed to the pop-up
- frame function.
-
-A list of three elements whose car is the symbol
-`use-side-window' specifies that the buffer shall be displayed in
-a side window of the selected frame. The second element denotes
-the side of the frame where the window appears or shall be made.
-The third element denotes the slot used by the window. If a side
-window with the specified slot exists already, that window is
-reused. If no such window exists it is created.
-
-The following specifiers are useful in connection with the
-`use-side-window' method specifier: `reuse-window-dedicated',
-`pop-up-window-min-height', `pop-up-window-min-width',
-`pop-up-window-set-height' and `pop-up-window-set-width'.
-
-A list whose car is the symbol `function' specifies that the
-function specified in the second element of the list is
-responsible for displaying the buffer. `display-buffer' calls
-this function with the buffer as first argument and the remaining
-elements of the list as the other arguments.
-
-The function should choose or create a window, display the buffer
-in it, and return the window. It is also responsible for giving
-the variable `display-buffer-window' and the `quit-restore'
-parameter of the window used a meaningful value.
-
-Within the body of this function avoid calling `display-buffer'
-with the same buffer as argument since this may lead to endless
-recursion.
-
-Instead of supplying basic method specifiers, it's sometimes more
-convenient to use macro specifiers. They provide some commonly
-used display methods but do not support the fine control provided
-by the basic method specifiers. Macro specifiers are symbols.
-The following macro specifiers are provided:
-
- `same-window' to display the buffer in the selected window.
-
- `same-frame' to display the buffer on the selected frame.
-
- `other-window' to display the buffer in any window but the
- selected one.
-
- `same-frame-other-window' as `other-window' but stay on the
- selected frame.
-
- `other-frame' to display the buffer on another visible
- frame.
-
- `default' to use the default value of `display-buffer-alist'.
-
-One specifier is useful with any method specifier: A list whose
-car is the symbol `dedicate' and whose cdr is non-nil will
-dedicate the window to its buffer. The following values are
-supported:
-
-- nil to not dedicate the window to the buffer.
-
-- `weak' to weakly dedicate the window to the buffer.
-
-- t to strongly dedicate the window to the buffer.
-
-A cons cell whose car is `other-window-means-other-frame' and
-whose cdr is non-nil means that you want calls of
-`display-buffer' with the second argument t or the symbol
-`other-window' to display the buffer in another frame. This
-means, for example, that you prefer functions like
-`find-file-other-window' or `switch-to-buffer-other-window' to
-make a new frame instead of a new window on the selected frame.
-
-Usually, applications are free to override the specifiers of
-`display-buffer-alist' by passing their own specifiers as second
-argument of `display-buffer'. For every `display-buffer-alist'
-entry you can, however, add a cons cell whose car is the symbol
-`override' and whose cdr is non-nil, to explicitly override any
-value supplied by the application.
-
-Overriding specifiers supplied by the calling application is, in
-general, not advisable. It permits, for example, to change the
-semantics of a function like `display-buffer-other-window' by
-using the location specifiers `same-window' or `other-frame'."
- :risky t
- :type
- '(repeat
- :offset 9
- ;; Associations of buffer identifiers and display specifiers.
- (list
- :format "%v"
- ;; Buffer identifiers.
- (repeat
- :tag "Buffer identifiers"
- (choice
- :tag "Identifier"
- :format "%[%t%] %v" :size 15
- (cons
- :tag "Name"
- :format "%v"
- :help-echo "A buffer name."
- (const :format "" name)
- (string :format "Name: %v\n" :size 32))
- (cons
- :tag "Regexp"
- :format "%v"
- :help-echo "A regular expression matching buffer names."
- (const :format "" regexp)
- (string :format "Regexp: %v\n" :size 32))
- (cons
- :tag "Label"
- :format "%v"
- :help-echo "A symbol equalling the buffer display label."
- (const :format "" label)
- (symbol :format "Label: %v\n" :size 32))))
-
- ;; Display specifiers.
- (repeat
- :offset 9
- :tag "Display specifiers"
- :inline t
- (list
- :inline t
- :format "%v"
- (choice
- :tag "Method"
- :value (reuse-window
- (reuse-window nil same nil)
- (reuse-window-even-sizes . t))
- :inline t
- :help-echo "Method for displaying the buffer."
- :format "%[Method%] %v" :size 15
-
- ;; Reuse window specifiers.
- (list
- :tag "Reuse window"
- :value (reuse-window
- (reuse-window nil same nil)
- (reuse-window-even-sizes . t))
- :format "%t\n%v"
- :inline t
- ;; For customization purposes only.
- (const :format "" reuse-window)
- (set
- :format "%v"
- :inline t
- ;; The window to reuse.
- (list
- :format "%v\n"
- (const :format "" reuse-window)
- ;; The window type.
- (choice
- :tag "Window"
- :help-echo "Window to reuse."
- :value nil
- :format "%[Window%] %v" :size 15
- (const :tag "Any window" :format "%t" nil)
- (const :tag "Same window" :format "%t" same)
- (const :tag "Other window" :format "%t" other))
- ;; The window's buffer.
- (choice
- :tag "Buffer"
- :help-echo "Buffer shown by reused window."
- :value t
- :format " %[Buffer%] %v" :size 15
- (const :tag "Any buffer" :format "%t" nil)
- (const :tag "Same buffer" :format "%t" same)
- (const :tag "Other buffer" :format "%t" other))
- ;; The window's frame.
- (choice
- :help-echo "Frames to search for a window to reuse."
- :tag "Frame"
- :value nil
- :format " %[Frame%] %v" :size 15
- (const :tag "Same frame only" :format "%t" nil)
- (const :tag "Visible frames" :format "%t" visible)
- (const :tag "Any other visible frame" :format "%t" other)
- (const :tag "Visible and iconified frames" :format "%t" 0)
- (const :tag "All frames" :format "%t" t)))
- ;; Whether window sizes should be evened out.
- (cons
- :format "%v\n"
- :tag "Even window sizes"
- (const :format "" reuse-window-even-sizes)
- (choice
- :tag "Even window sizes"
- :help-echo "Whether to even sizes of selected and reused window."
- :value t
- :format "%[Even window sizes%] %v" :size 15
- (const :tag "Off" :format "%t" nil)
- (const :tag "Even window sizes" :format "%t" t)))
- ;; Whether to reuse a dedicated window
- (cons
- :format "%v\n"
- (const :format "" reuse-window-dedicated)
- (choice
- :tag "Reuse dedicated window" :value nil
- :help-echo "Reuse a window even if it is dedicated to its buffer."
- :format "%[Reuse dedicated window%] %v" :size 15
- (const :tag "Off" :format "%t" nil)
- (const :tag "Reuse weakly dedicated windows" :format "%t" weak)
- (const :tag "Reuse any dedicated window" :format "%t" t)))))
-
- ;; Pop-up window specifiers.
- (list
- :tag "Pop-up window"
- :value (pop-up-window (pop-up-window (largest . nil) (lru . nil)))
- :format "%t\n%v"
- :inline t
- (const :format "" pop-up-window)
- (set
- :format "%v"
- :inline t
- ;; Pop-up window list.
- (list
- :format "%v"
- :value (pop-up-window (largest . nil) (lru . nil))
- (const :format "" pop-up-window)
- (repeat
- :tag "Window / Side tuples"
- :inline t
- (cons
- :format "%v\n"
- (choice
- :tag "Window"
- :help-echo "The window to split."
- :value largest
- :format "%[Window%] %v"
- (const :tag "Largest" :format "%t" largest)
- (const :tag "Least recently used" :format "%t" lru)
- (const :tag "Selected" :format "%t" selected)
- (const :tag "Root" :format "%t" root)
- (const :tag "Left" :format "%t" left)
- (const :tag "Top" :format "%t" top)
- (const :tag "Right" :format "%t" right)
- (const :tag "Bottom" :format "%t" bottom))
- (choice
- :tag "Side"
- :help-echo "The position of the new window with respect to the window to split."
- :value nil
- :format " %[Side%] %v"
- (const :tag "Dynamic" :format "%t" nil)
- (const :tag "Below" :format "%t" below)
- (const :tag "Right" :format "%t" right)
- (const :tag "Above" :format "%t" above)
- (const :tag "Left" :format "%t" left)
- (function
- :tag "Function" :format "%v" :size 25)))))
- ;; Minimum height of pop-up windows.
- (cons
- :format "%v\n"
- (const :format "" pop-up-window-min-height)
- (choice
- :help-echo "Minimum height of popped-up window."
- :format "%[Minimum height%] %v"
- (const :tag "Default" :format "%t" :value nil)
- (integer :tag "Number of lines" :value 12 :size 5)
- (float :tag "Fraction of frame height" :value .25 :size 5)))
- ;; Minimum width of pop-up windows.
- (cons
- :format "%v\n"
- (const :format "" pop-up-window-min-width)
- (choice
- :help-echo "Minimum width of popped-up window."
- :format "%[Minimum width%] %v"
- (const :tag "Default" :format "%t" :value nil)
- (integer :tag "Number of columns" :value 12 :size 5)
- (float :tag "Fraction of frame width" :value .25 :size 5)))
- ;; Desired height of pop-up windows.
- (cons
- :format "%v\n"
- (const :format "" pop-up-window-set-height)
- (choice
- :help-echo "Desired height of popped-up window."
- :format "%[Desired height%] %v"
- (const :tag "Default" :format "%t" :value nil)
- (integer :tag "Number of lines" :value 12 :size 5)
- (float :tag "Fraction of frame height" :value .25 :size 5)
- (function :tag "Function" :size 25)))
- ;; Desired width of pop-up windows.
- (cons
- :format "%v\n"
- (const :format "" pop-up-window-set-width)
- (choice
- :help-echo "Desired width of popped-up window."
- :format "%[Desired width%] %v"
- (const :tag "Default" :format "%t" :value nil)
- (integer :tag "Number of column" :value 12 :size 5)
- (float :tag "Fraction of frame width" :value .25 :size 5)
- (function :tag "Function" :size 25)))
- ;; Split unsplittable frames.
- (cons
- :format "%v\n"
- (const :format "" pop-up-window-unsplittable)
- (choice
- :help-echo "Allow popping up a window on \"unsplittable\" frames."
- :format "%[Split unsplittable frame%] %v"
- (const :tag "Off" :format "%t" nil)
- (const :tag "Allow" :format "%t" t)))))
-
- ;; Pop-up frame specifiers.
- (list
- :tag "Pop-up frame"
- :value (pop-up-frame
- (pop-up-frame))
- :format "%t\n%v"
- :inline t
- (const :format "" pop-up-frame)
- (set
- :format "%v"
- :inline t
- ;; Pop-up frame.
- (list
- :tag "Pop-up a new frame"
- :value (pop-up-frame)
- :format "%v"
- (const :format "" pop-up-frame)
- (choice
- :tag "Pop-up a new frame"
- :help-echo "Whether to pop-up a new frame on a display."
- :format "%[Display%] %v\n" :size 15
- (const :tag "On any display" :format "%t" nil)
- (const :tag "On graphic displays only" :format "%t" t)))
- ;; Pop-up frame function.
- (cons
- :format "%v\n"
- (const :format "" pop-up-frame-function)
- (choice
- :tag "Pop-up frame function"
- :value nil
- :help-echo "Function to use to pop-up a new frame."
- :format "%[Function%] %v" :size 15
- (const :tag "Default" :format "%t" nil)
- (function
- :value make-frame
- :format "%t: %v"
- :size 25)))
- ;; Pop-up frame alist.
- (list
- :format "%v"
- (const :format "" pop-up-frame-alist)
- (repeat
- :tag "Parameter / Value tuples"
- :inline t
- (cons
- :format "%v\n"
- (symbol
- :tag "Parameter"
- :format "Parameter: %v"
- :size 16)
- (sexp
- :tag "Value"
- :format " Value: %v"
- :size 8))))))
-
- ;; Use side-window specifiers.
- (list
- :tag "Use side-window"
- :value (use-side-window (use-side-window bottom 0))
- :format "%t\n%v"
- :inline t
- ;; For customization purposes only.
- (const :format "" use-side-window)
- (set
- :format "%v"
- :inline t
- ;; Side and slot.
- (list
- :format "%v\n"
- :value (use-side-window bottom 0)
- (const :format "" use-side-window)
- ;; The side.
- (choice
- :tag "Side"
- :help-echo "Side of frame."
- :value bottom
- :format "%[Side%] %v" :size 15
- (const :tag "Left" :format "%t" left)
- (const :tag "Top" :format "%t" top)
- (const :tag "Right" :format "%t" right)
- (const :tag "Bottom" :format "%t" bottom))
- ;; The slot
- (number
- :tag "Slot"
- :help-echo "The slot (an arbitrary number, where 0 stands for the center slot)."
- :value 0
- :format " Slot: %v" :size 8))
- ;; Whether to reuse a dedicated side window
- (cons
- :format "%v\n"
- (const :format "" reuse-window-dedicated)
- (choice
- :tag "Reuse dedicated side window" :value nil
- :help-echo "Reuse a side window even if it is dedicated to its buffer."
- :format "%[Reuse dedicated side window%] %v" :size 15
- (const :tag "Off" :format "%t" nil)
- (const :tag "Reuse weakly dedicated side windows" :format "%t" weak)
- (const :tag "Reuse any dedicated side window" :format "%t" t)))
- ;; Minimum height of pop-up side windows.
- (cons
- :format "%v\n"
- (const :format "" pop-up-window-min-height)
- (choice
- :help-echo "Minimum height of popped-up side window."
- :format "%[Minimum height%] %v"
- (const :tag "Default" :format "%t" :value nil)
- (integer :tag "Number of lines" :value 12 :size 5)
- (float :tag "Fraction of frame height" :value .25 :size 5)))
- ;; Minimum width of pop-up windows.
- (cons
- :format "%v\n"
- (const :format "" pop-up-window-min-width)
- (choice
- :help-echo "Minimum width of popped-up side window."
- :format "%[Minimum width%] %v"
- (const :tag "Default" :format "%t" :value nil)
- (integer :tag "Number of columns" :value 12 :size 5)
- (float :tag "Fraction of frame width" :value .25 :size 5)))
- ;; Desired height of pop-up windows.
- (cons
- :format "%v\n"
- (const :format "" pop-up-window-set-height)
- (choice
- :help-echo "Desired height of popped-up side window."
- :format "%[Desired height%] %v"
- (const :tag "Default" :format "%t" :value nil)
- (integer :tag "Number of lines" :value 12 :size 5)
- (float :tag "Fraction of frame height" :value .25 :size 5)
- (function :tag "Function" :size 25)))
- ;; Desired width of pop-up windows.
- (cons
- :format "%v\n"
- (const :format "" pop-up-window-set-width)
- (choice
- :help-echo "Desired width of popped-up side window."
- :format "%[Desired width%] %v"
- (const :tag "Default" :format "%t" :value nil)
- (integer :tag "Number of column" :value 12 :size 5)
- (float :tag "Fraction of frame width" :value .25 :size 5)
- (function :tag "Function" :size 25)))))
-
- ;; Function with argument specifiers.
- (list
- :tag "Function with arguments"
- :value (function (function 'ignore))
- :format "%t\n%v"
- :inline t
- ;; For customization purposes only.
- (const :format "" function)
- (set
- :format "%v"
- :inline t
- (list
- :format "%v"
- :value (function 'ignore)
- (const :format "" function)
- (function :tag "Function" :format "%t: %v\n" :size 25)
- (list
- :format "%v"
- (repeat
- :tag "Arguments"
- :inline t
- (sexp
- :format "%v\n"
- :size 16))))))
-
- ;; Macro specifiers.
- (list
- :tag "Same window"
- :format "%t%v"
- :inline t
- (const :format "\n" same-window))
- (list
- :tag "Same frame"
- :format "%t%v"
- :inline t
- (const :format "\n" same-frame))
- (list
- :tag "Other window"
- :format "%t%v"
- :inline t
- (const :format "\n" other-window))
- (list
- :tag "Same frame other window"
- :format "%t%v"
- :inline t
- (const :format "\n" same-frame-other-window))
- (list
- :tag "Other frame"
- :format "%t%v"
- :inline t
- (const :format "\n" other-frame))
- (list
- :tag "Default"
- :format "%t%v"
- :inline t
- (const :format "\n" default)))))
-
- (set
- :format "%v"
- :inline t
- ;; Dedicate window to buffer.
- (cons
- :format "%v"
- (const :format "" dedicate)
- (choice
- :help-echo "Mark window as dedicated to its buffer."
- :format "%[Dedicate window to buffer%] %v\n" :size 15
- (const :tag "Off" :format "%t" nil)
- (const :tag "Weak" :format "%t" weak)
- (const :tag "Strong" :format "%t" t)))
- ;; No other window.
- (cons
- :format "%v"
- (const :format "" no-other-window)
- (choice
- :help-echo "Whether `other-window' shall ignore the window."
- :format "%[No other window%] %v\n" :size 15
- (const :tag "Off" :format "%t" nil)
- (const :tag "Ignore" :format "%t" t)))
- ;; Other window means other frame.
- (cons
- :format "%v"
- (const :format "" other-window-means-other-frame)
- (choice
- :help-echo "Whether other window means same or other frame."
- :format "%[Other window means other frame%] %v\n" :size 15
- (const :tag "Off" :format "%t" nil)
- (const :tag "On" :format "%t" t)))
- ;; Overriding.
- (cons
- :format "%v\n"
- (const :format "" override)
- (choice
- :help-echo "Override application supplied specifiers."
- :format "%[Override%] %v"
- (const :tag "Off" :format "%t" nil)
- (const :tag "Override" :format "%t" t))))))
- :group 'windows
- :group 'frames)
+(defun display-buffer-record-window (type window buffer)
+ "Record information for window used by `display-buffer'.
+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)
+ (if (eq (window-buffer window) buffer)
+ ;; 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 'other
+ ;; A quadruple of WINDOW's buffer, start, point and height.
+ (list (window-buffer window) (window-start window)
+ (window-point 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 'window 'window (selected-window) buffer)))
+ ((eq type 'frame)
+ ;; WINDOW has been created on a new frame.
+ (set-window-parameter
+ window 'quit-restore
+ (list 'frame 'frame (selected-window) buffer)))))
(defcustom display-buffer-function nil
- "If non-nil, function to call to display a buffer.
-`display-buffer' calls this function with two arguments, the
-buffer to display and a list of buffer display specifiers, see
-`display-buffer-alist'.
-
-The function is supposed to choose or create a window, display
-the specified buffer in it, and return the window. It is also
-responsible for giving the variable `display-buffer-window' and
-the `quit-restore' parameter of the window used a meaningful
-value.
-
-The function specified here overrides all specifiers of the
-variable `display-buffer-alist' any specifiers passed to
-`display-buffer'.
-
-If you call `display-buffer' within the body of the function,
-bind the value of `display-buffer-function' to nil around that
-call to avoid that the function recursively calls itself."
+ "If non-nil, function to call to handle `display-buffer'.
+It will receive two args, the buffer and a flag which if non-nil
+means that the currently selected window is not acceptable. It
+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
+quit-restore and help-setup parameters of the window used."
:type '(choice
(const nil)
- (function :tag "Function"))
+ (function :tag "function"))
:group 'windows)
-;; The following is a global variable which is used externally (by
-;; help.el) to (1) know which window was used for displaying a buffer
-;; and (2) whether the window was new or reused.
-(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'.
-
-If the buffer display location specifier is one of 'same-window,
-'same-frame, or 'other-frame, the `display-buffer' routines
-assign the value of this variable. If the location specifier is
-a function, that function becomes responsible for assigning a
-meaningful value to this variable. See the functions
-`display-buffer-reuse-window', `display-buffer-pop-up-window' and
-`display-buffer-pop-up-frame' for how this can be done.")
-
-(defun display-buffer-even-window-sizes (window specifiers)
- "Even sizes of WINDOW and selected window according to SPECIFIERS.
-SPECIFIERS must be a list of buffer display specifiers, see the
-documentation of `display-buffer-alist' for a description.
-
-Sizes are evened out if and only if WINDOW and the selected
-window appear next to each other and the selected window is
-larger than WINDOW."
- (cond
- ((or (not (cdr (assq 'reuse-window-even-sizes specifiers)))
- ;; Don't resize minibuffer windows.
- (window-minibuffer-p)
- ;; WINDOW must be adjacent to the selected one.
- (not (or (eq window (window-prev-sibling))
- (eq window (window-next-sibling))))))
- ((and (window-iso-combined-p window)
- ;; Resize iff the selected window is higher than WINDOW.
- (> (window-total-height) (window-total-height window)))
- ;; Don't throw an error if we can't even window heights for
- ;; whatever reason. In any case, enlarging the selected window
- ;; might fail anyway if there are other windows above or below
- ;; WINDOW and the selected one. But for a simple two windows
- ;; configuration the present behavior is good enough so why care?
- (ignore-errors
- (window-resize
- window (/ (- (window-total-height) (window-total-height window))
- 2))))
- ((and (window-iso-combined-p window t)
- ;; Resize iff the selected window is wider than WINDOW.
- (> (window-total-width) (window-total-width window)))
- ;; Don't throw an error if we can't even window widths, see
- ;; comment above.
- (ignore-errors
- (window-resize
- window (/ (- (window-total-width) (window-total-width window))
- 2) t)))))
-
-(defun display-buffer-set-height (window specifiers)
- "Adjust height of WINDOW according to SPECIFIERS.
-SPECIFIERS must be a list of buffer display specifiers, see the
-documentation of `display-buffer-alist' for a description."
- (let ((set-height (cdr (assq 'pop-up-window-set-height specifiers))))
- (cond
- ((numberp set-height)
- (let* ((height (if (integerp set-height)
- set-height
- (round
- (* (window-total-size (frame-root-window window))
- set-height))))
- (delta (- height (window-total-size window))))
- (when (and (window-resizable-p window delta nil 'safe)
- (window-iso-combined-p window))
- (window-resize window delta nil 'safe))))
- ((functionp set-height)
- (ignore-errors (funcall set-height window))))))
-
-(defun display-buffer-set-width (window specifiers)
- "Adjust width of WINDOW according to SPECIFIERS.
-SPECIFIERS must be a list of buffer display specifiers, see the
-documentation of `display-buffer-alist' for a description."
- (let ((set-width (cdr (assq 'pop-up-window-set-width specifiers))))
- (cond
- ((numberp set-width)
- (let* ((width (if (integerp set-width)
- set-width
- (round
- (* (window-total-size (frame-root-window window) t)
- set-width))))
- (delta (- width (window-total-size window t))))
- (when (and (window-resizable-p window delta t 'safe)
- (window-iso-combined-p window t))
- (window-resize window delta t 'safe))))
- ((functionp set-width)
- (ignore-errors (funcall set-width window))))))
-
-(defun display-buffer-in-window (buffer window specifiers)
- "Display BUFFER in WINDOW and raise its frame if needed.
-WINDOW must be a live window and defaults to the selected one.
-Return WINDOW.
-
-SPECIFIERS must be a list of buffer display specifiers, see the
-documentation of `display-buffer-alist' for a description."
- (setq buffer (window-normalize-buffer buffer))
- (setq window (window-normalize-live-window window))
- (let* ((old-frame (selected-frame))
- (new-frame (window-frame window))
- (dedicated (cdr (assq 'dedicated specifiers)))
- (no-other-window (cdr (assq 'no-other-window specifiers))))
- ;; Show BUFFER in WINDOW.
- (unless (eq buffer (window-buffer window))
- ;; If we show another buffer in WINDOW, undedicate it first.
- (set-window-dedicated-p window nil))
- (set-window-buffer window buffer)
- (when dedicated
- (set-window-dedicated-p window dedicated))
- (when no-other-window
- (set-window-parameter window 'no-other-window t))
- (unless (or (eq old-frame new-frame)
- (not (frame-visible-p new-frame))
- ;; Assume the selected frame is already visible enough.
- (eq new-frame (selected-frame))
- ;; Assume the frame from which we invoked the minibuffer
- ;; is visible.
- (and (minibuffer-window-active-p (selected-window))
- (eq new-frame
- (window-frame (minibuffer-selected-window)))))
- (raise-frame new-frame))
- ;; Return window.
- window))
+(defcustom pop-up-frame-alist nil
+ "Alist of parameters for automatically generated new frames.
+You can set this in your init file; for example,
-(defun display-buffer-reuse-window (buffer method &optional specifiers)
- "Display BUFFER in an existing window.
-METHOD must be a list in the form of the cdr of a `reuse-window'
-buffer display specifier, see `display-buffer-alist' for an
-explanation. The first element must specifiy the window to use,
-and can be either nil, `same', `other', or a live window. The
-second element must specify the window's buffer and can be either
-nil, `same', `other', or a live buffer. The third element is the
-frame to use - either nil, 0, `visible', `other', t, or a live
-frame.
-
-Optional argument SPECIFIERS must be a list of valid display
-specifiers. Return the window chosen to display BUFFER, nil if
-none was found."
- (let* ((method-window (nth 0 method))
- (method-buffer (nth 1 method))
- (method-frame (nth 2 method))
- (reuse-dedicated (cdr (assq 'reuse-window-dedicated specifiers)))
- windows other-frame dedicated time best-window best-time)
- (when (eq method-frame 'other)
- ;; `other' is not handled by `window-list-1'.
- (setq other-frame t)
- (setq method-frame t))
- (dolist (window (window-list-1 nil 'nomini method-frame))
- (let ((window-buffer (window-buffer window)))
- (when (and (not (window-minibuffer-p window))
- ;; Don't reuse a side window.
- (or (not (eq (window-parameter window 'window-side) 'side))
- (eq window-buffer buffer))
- (or (not method-window)
- (and (eq method-window 'same)
- (eq window (selected-window)))
- (and (eq method-window 'other)
- (not (eq window (selected-window))))
- ;; Special case for applications that specifiy
- ;; the window explicitly.
- (eq method-window window))
- (or (not method-buffer)
- (and (eq method-buffer 'same)
- (eq window-buffer buffer))
- (and (eq method-buffer 'other)
- (not (eq window-buffer buffer)))
- ;; Special case for applications that specifiy
- ;; the window's buffer explicitly.
- (eq method-buffer window-buffer))
- (or (not other-frame)
- (not (eq (window-frame window) (selected-frame))))
- ;; Handle dedicatedness.
- (or (eq window-buffer buffer)
- ;; The window does not show the same buffer.
- (not (setq dedicated (window-dedicated-p window)))
- ;; If the window is weakly dedicated to its
- ;; buffer, reuse-dedicated must be non-nil.
- (and (not (eq dedicated t)) reuse-dedicated)
- ;; If the window is strongly dedicated to its
- ;; buffer, reuse-dedicated must be t.
- (eq reuse-dedicated t)))
- (setq windows (cons window windows)))))
-
- (if (eq method-buffer 'same)
- ;; When reusing a window on the same buffer use the lru one.
- (dolist (window windows)
- (setq time (window-use-time window))
- (when (or (not best-window) (< time best-time))
- (setq best-window window)
- (setq best-time time)))
- ;; Otherwise, sort windows according to their use-time.
- (setq windows
- (sort windows
- #'(lambda (window-1 window-2)
- (<= (window-use-time window-1)
- (window-use-time window-2)))))
- (setq best-window
- ;; Try to get a full-width window (this is silly and can
- ;; get us to another frame but let's ignore these issues
- ;; for the moment).
- (catch 'found
- (dolist (window windows)
- (when (window-full-width-p window)
- (throw 'found window)))
- ;; If there's no full-width window return the lru window.
- (car windows))))
-
- (when best-window
- (display-buffer-even-window-sizes best-window specifiers)
- ;; Never change the quit-restore parameter of a window here.
- (if (eq (window-buffer best-window) buffer)
- (setq display-buffer-window
- (cons best-window 'reuse-buffer-window))
- (setq display-buffer-window
- (cons best-window 'reuse-other-window))
- (unless (window-parameter best-window 'quit-restore)
- ;; Don't overwrite an existing quit-restore entry.
- (set-window-parameter
- best-window 'quit-restore
- (list (window-buffer best-window) (window-start best-window)
- (window-point best-window) buffer
- (window-total-size best-window) (selected-window)))))
-
- (display-buffer-in-window buffer best-window specifiers))))
-
-(defconst display-buffer-split-specifiers '(largest lru selected root left top right bottom)
- "List of symbols identifying window that shall be split.")
-
-(defconst display-buffer-side-specifiers '(below right above left nil)
- "List of symbols identifying side of split-off window.")
-
-(defun display-buffer-split-window-1 (window side min-size)
- "Subroutine of `display-buffer-split-window'."
- (let* ((horizontal (memq side '(left right)))
- (parent (window-parent window))
- (resize (and window-splits (window-iso-combined-p window horizontal)))
- (old-size
- ;; We either resize WINDOW or its parent.
- (window-total-size (if resize parent window) horizontal))
- new-size)
- ;; We don't call split-window-vertically/-horizontally any more
- ;; here. If for some reason it's needed we can always do so
- ;; (provided we give it an optional SIDE argument).
- (cond
- (resize
- ;; When we resize a combination, the new window must be at least
- ;; MIN-SIZE large after the split.
- (setq new-size
- (max min-size
- (min (- old-size (window-min-size parent horizontal))
- (/ old-size
- ;; Try to make the size of the new window
- ;; proportional to the number of iso-arranged
- ;; windows in the combination.
- (1+ (window-iso-combinations parent horizontal))))))
- (when (window-sizable-p parent (- new-size) horizontal)
- (split-window window (- new-size) side)))
- ((window-live-p window)
- (setq new-size (/ old-size 2))
- ;; When WINDOW is live, the old _and_ the new window must be at
- ;; least MIN-SIZE large after the split.
- (when (and (>= new-size min-size)
- (window-sizable-p window (- new-size) horizontal))
- ;; Do an even split to make Stepan happy.
- (split-window window nil side)))
- (t
- ;; When WINDOW is internal, the new window must be at least
- ;; MIN-SIZE large after the split.
- (setq new-size
- (max min-size
- (/ old-size
- ;; Try to make the size of the new window
- ;; proportional to the number of iso-arranged
- ;; subwindows of WINDOW.
- (1+ (window-iso-combinations window horizontal)))))
- (when (window-sizable-p window (- new-size) horizontal)
- (split-window window (- new-size) side))))))
-
-(defun display-buffer-split-window (window &optional side specifiers)
- "Split WINDOW in a way suitable for `display-buffer'.
-Optional argument SIDE must be a side specifier \(one of the
-symbols below, right, above, left, or nil). SPECIFIERS must be a
-list of buffer display specifiers, see the documentation of
-`display-buffer-alist' for a description.
-
-Return the new window, nil if it could not be created."
- (let ((min-height (cdr (assq 'pop-up-window-min-height specifiers)))
- (min-width (cdr (assq 'pop-up-window-min-width specifiers)))
- size)
- ;; Normalize min-height and min-width, we might need both.
- (setq min-height
- ;; If min-height is specified, it can be as small as
- ;; `window-safe-min-height'.
- (cond
- ((and (integerp min-height)
- (>= min-height window-safe-min-height))
- min-height)
- ((and (floatp min-height)
- (<= min-height 1)
- (let* ((root-height (window-total-height
- (frame-root-window
- (window-frame window))))
- (height (round (* min-height root-height))))
- (when (>= height window-safe-min-height)
- height))))
- (t window-min-height)))
- (setq min-width
- ;; If min-width is specified, it can be as small as
- ;; `window-safe-min-width'.
- (cond
- ((and (integerp min-width)
- (>= min-width window-safe-min-width))
- min-width)
- ((and (floatp min-width)
- (<= min-width 1)
- (let* ((root-width (window-total-width
- (frame-root-window
- (window-frame window))))
- (width (round (* min-width root-width))))
- (when (>= width window-safe-min-width)
- width))))
- (t window-min-width)))
-
- (or (and (memq side '(nil above below))
- (display-buffer-split-window-1
- window (or side 'below) min-height))
- ;; If SIDE is nil and vertical splitting failed, we try again
- ;; splitting horizontally this time.
- (and (memq side '(nil left right))
- (display-buffer-split-window-1
- window (or side 'right) min-width))
- ;; If WINDOW is live and the root window of its frame, try once
- ;; more splitting vertically, disregarding the min-height
- ;; specifier this time and using `window-min-height' instead.
- (and (memq side '(nil above below))
- (<= window-min-height min-height)
- (window-live-p window)
- (eq window (frame-root-window window))
- (display-buffer-split-window-1
- window (or side 'below) window-min-height)))))
-
-(defun display-buffer-split-atom-window (window &optional side nest specifiers)
- "Make WINDOW part of an atomic window."
- (let ((ignore-window-parameters t)
- (window-nest t)
- (selected-window (selected-window))
- root new new-parent)
-
- ;; We are in an atomic window.
- (when (and (window-parameter window 'window-atom) (not nest))
- ;; Split the root window.
- (setq window (window-atom-root window)))
-
- (when (setq new (display-buffer-split-window window side specifiers))
- (setq new-parent (window-parent window))
- ;; WINDOW is or becomes atomic.
- (unless (window-parameter window 'window-atom)
- (walk-window-subtree
- (lambda (window)
- (set-window-parameter window 'window-atom t))
- window t))
- ;; New window and any new parent get their window-atom parameter
- ;; set too.
- (set-window-parameter new 'window-atom t)
- (set-window-parameter new-parent 'window-atom t)
- new)))
-
-(defun display-buffer-pop-up-window (buffer methods &optional specifiers)
- "Display BUFFER in a new window.
-Return the window displaying BUFFER, nil if popping up the window
-failed. METHODS must be a list of window/side tuples like those
-forming the cdr of the `pop-up-window' buffer display specifier.
-As a special case, the car of such a tuple can be also a live
-window.
-
-Optional argument SPECIFIERS must be a list of buffer display
-specifiers, see the doc-string of `display-buffer-alist' for a
-description."
- (let* ((frame (display-buffer-frame))
- (selected-window (frame-selected-window frame))
- cand window side atomic)
- (unless (and (cdr (assq 'unsplittable (frame-parameters frame)))
- ;; Don't split an unsplittable frame unless
- ;; SPECIFIERS allow it.
- (not (cdr (assq 'split-unsplittable-frame specifiers))))
- (catch 'done
- (dolist (method methods)
- (setq cand (car method))
- (setq side (cdr method))
- (setq window
- (cond
- ((eq cand 'largest)
- ;; The largest window.
- (get-largest-window frame t))
- ((eq cand 'lru)
- ;; The least recently used window.
- (get-lru-window frame t))
- ((eq cand 'selected)
- ;; The selected window.
- (frame-selected-window frame))
- ((eq cand 'root)
- ;; If there are side windows, split the main window
- ;; else the frame's root window.
- (or (window-with-parameter 'window-side 'none nil t)
- (frame-root-window frame)))
- ((memq cand window-sides)
- ;; This should gets us the "root" side window if there
- ;; exists more than one window on that side.
- (window-with-parameter 'window-side cand nil t))
- ((windowp cand)
- ;; A window, directly specified.
- cand)))
-
- (when (and (window-live-p window)
- ;; The window must be on the correct frame,
- (eq (window-frame window) frame)
- ;; and must be neither a minibuffer window
- (not (window-minibuffer-p window))
- ;; nor a side window.
- (not (eq (window-parameter window 'window-side) 'side)))
- (setq window
- (cond
- ((memq side display-buffer-side-specifiers)
- (if (and (window-buffer window)
- (setq atomic (cdr (assq 'atomic specifiers))))
- (display-buffer-split-atom-window
- window side (eq atomic 'nest) specifiers)
- (display-buffer-split-window window side specifiers)))
- ((functionp side)
- (ignore-errors
- ;; Don't pass any specifiers to this function.
- (funcall side window)))))
-
- (when window
- ;; Adjust sizes if asked for.
- (display-buffer-set-height window specifiers)
- (display-buffer-set-width window specifiers)
- (set-window-parameter
- window 'quit-restore (list 'new-window buffer selected-window))
- (setq display-buffer-window (cons window 'new-window))
- (display-buffer-in-window buffer window specifiers)
- (set-window-prev-buffers window nil)
- (throw 'done window))))))))
-
-(defun display-buffer-pop-up-frame (buffer &optional graphic-only specifiers)
- "Make a new frame for displaying BUFFER.
-Return the window displaying BUFFER if creating the new frame was
-successful, nil otherwise. Optional argument GRAPHIC-ONLY
-non-nil means to make a new frame on graphic displays only.
-
-SPECIFIERS must be a list of buffer display specifiers, see the
-documentation of `display-buffer-alist' for a description."
- (unless (or (and graphic-only (not (display-graphic-p)))
- noninteractive)
- (let* ((selected-window (selected-window))
- (function (or (cdr (assq 'pop-up-frame-function specifiers))
- 'make-frame))
- (parameters
- (when (symbolp function)
- (cdr (assq 'pop-up-frame-alist specifiers))))
- (frame
- (if (symbolp function)
- (funcall function parameters)
- (funcall function))))
- (when frame
- (let ((window (frame-selected-window frame)))
- (set-window-parameter
- window 'quit-restore (list 'new-frame buffer selected-window))
- (setq display-buffer-window (cons window 'new-frame))
- (display-buffer-in-window buffer window specifiers))))))
-
-(defun display-buffer-pop-up-side-window (buffer side slot &optional specifiers)
- "Display BUFFER in a new window on SIDE of the selected frame.
-SLOT specifies the slot to use. SPECIFIERS must be a list of
-buffer display specifiers.
-
-Return the window displaying BUFFER, nil if popping up the window
-failed."
- (let* ((root (frame-root-window))
- (main (window-with-parameter 'window-side 'none nil t))
- (left-or-right (memq side '(left right)))
- (main-or-root
- (if (and main
- (or (and left-or-right (not window-sides-vertical))
- (and (not left-or-right) window-sides-vertical)))
- main
- root))
- (selected-window (selected-window))
- (on-side (cond
- ((eq side 'top) 'above)
- ((eq side 'bottom) 'below)
- (t side)))
- (window
- (display-buffer-split-window main-or-root on-side specifiers))
- fun)
- (when window
- (unless main
- (walk-window-subtree
- (lambda (window)
- ;; Make all main-or-root subwindows main windows.
- (set-window-parameter window 'window-side 'none))
- main-or-root t))
- ;; Make sure that parent's window-side is nil.
- (set-window-parameter (window-parent window) 'window-side nil)
- ;; Initialize side.
- (set-window-parameter window 'window-side side)
- ;; Adjust sizes if asked for.
- (display-buffer-set-height window specifiers)
- (display-buffer-set-width window specifiers)
- ;; Set window parameters.
- (set-window-parameter
- window 'quit-restore (list 'new-window buffer selected-window))
- (setq display-buffer-window (cons window 'new-window))
- (set-window-parameter window 'window-slot slot)
- (display-buffer-in-window buffer window specifiers)
- (set-window-prev-buffers window nil)
- window)))
+ (setq pop-up-frame-alist '((width . 80) (height . 20)))
-(defun display-buffer-in-side-window (buffer side &optional slot specifiers)
- "Display BUFFER in a window on SIDE of the selected frame.
-SLOT, if non-nil, specifies the window slot where to display the
-BUFFER. SLOT zero or nil means use the central slot on SIDE.
-SLOT negative means use a slot preceding the central window.
-SLOT positive means use a slot following the central window.
-
-SPECIFIERS must be a list of buffer display specifiers."
- (unless (memq side window-sides)
- (error "Invalid side %s specified" side))
- (let* ((major (window-with-parameter 'window-side side nil t))
- ;; `major' is the major window on SIDE, `windows' the life
- ;; windows on SIDE.
- (windows (when major (windows-with-parameter 'window-side side)))
- (reuse-dedicated (cdr (assq 'reuse-window-dedicated specifiers)))
- (slots (when major (window-child-count major)))
- (max-slots
- (nth (cond
- ((eq side 'left) 0)
- ((eq side 'top) 1)
- ((eq side 'right) 2)
- ((eq side 'bottom) 3))
- window-sides-slots))
- (selected-window (selected-window))
- window this-window this-slot prev-window next-window
- best-window best-slot abs-slot dedicated)
-
- (unless (numberp slot)
- (setq slot 0))
- (if (not windows)
- ;; No suitable side window exists, make one.
- (display-buffer-pop-up-side-window buffer side slot specifiers)
- ;; Scan windows on SIDE.
- (catch 'found
- (dolist (window windows)
- (setq this-slot (window-parameter window 'window-slot))
- (cond
- ((not (numberp this-slot)))
- ((and (= this-slot slot)
- ;; Dedicatedness check.
- (or (not (setq dedicated (window-dedicated-p window)))
- ;; If the window is weakly dedicated to its
- ;; buffer, reuse-dedicated must be non-nil.
- (and (not (eq dedicated t)) reuse-dedicated)
- ;; If the window is strongly dedicated to its
- ;; buffer, reuse-dedicated must be t.
- (eq reuse-dedicated t)))
- ;; Window with matching SLOT, use it.
- (setq this-window window)
- (throw 'found t))
- (t
- (setq abs-slot (abs (- (abs slot) (abs this-slot))))
- (unless (and best-slot (<= best-slot abs-slot))
- (setq best-window window)
- (setq best-slot abs-slot))
- (cond
- ((<= this-slot slot)
- (setq prev-window window))
- ((not next-window)
- (setq next-window window)))))))
-
- ;; `this-window' is the first window with the same SLOT.
- ;; `prev-window' is the window with the largest slot < SLOT. A new
- ;; window will be created after it.
- ;; `next-window' is the window with the smallest slot > SLOT. A new
- ;; window will be created before it.
- ;; `best-window' is the window with the smallest absolute difference
- ;; of its slot and SLOT.
- (or (and this-window
- ;; Reuse this window.
- (prog1
- (setq window this-window)
- (if (eq (window-buffer window) buffer)
- (setq display-buffer-window
- (cons window 'reuse-buffer-window))
- (setq display-buffer-window
- (cons window 'reuse-other-window))
- (unless (window-parameter window 'quit-restore)
- ;; Don't overwrite an existing quit-restore entry.
- (set-window-parameter
- window 'quit-restore
- (list (window-buffer window) (window-start window)
- (window-point window) buffer
- (window-total-size window) (selected-window)))))))
- (and (or (not max-slots) (< slots max-slots))
- (or (and next-window
- ;; Make new window before next-window.
- (let ((next-side
- (if (memq side '(left right)) 'above 'left)))
- (setq window (display-buffer-split-window
- next-window next-side specifiers))))
- (and prev-window
- ;; Make new window after prev-window.
- (let ((prev-side
- (if (memq side '(left right)) 'below 'right)))
- (setq window (display-buffer-split-window
- prev-window prev-side specifiers)))))
- (progn
- (display-buffer-set-height window specifiers)
- (display-buffer-set-width window specifiers)
- (set-window-parameter
- window 'quit-restore
- (list 'new-window buffer selected-window))
- (setq display-buffer-window (cons window 'new-window))
- window))
- (and best-window
- (setq window best-window)
- ;; Reuse best window (the window nearest to SLOT).
- (if (eq (window-buffer window) buffer)
- (setq display-buffer-window
- (cons window 'reuse-buffer-window))
- (setq display-buffer-window
- (cons window 'reuse-other-window))
-
- (unless (window-parameter window 'quit-restore)
- ;; Don't overwrite an existing quit-restore entry.
- (set-window-parameter
- window 'quit-restore
- (list (window-buffer window) (window-start window)
- (window-point window) buffer
- (window-total-size window) (selected-window)))))
- window))
-
- (when window
- (unless (window-parameter window 'window-slot)
- ;; Don't change exisiting slot value.
- (set-window-parameter window 'window-slot slot))
- (display-buffer-in-window buffer window specifiers)))))
+If non-nil, the value you specify here is used by the default
+`pop-up-frame-function' for the creation of new frames.
-(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
-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."
- (if buffer-or-name
- (or (get-buffer buffer-or-name)
- (let ((buffer (get-buffer-create buffer-or-name)))
- (set-buffer-major-mode buffer)
- buffer))
- (current-buffer)))
+Since `pop-up-frame-function' is used by `display-buffer' for
+making new frames, any value specified here by default affects
+the automatic generation of new frames via `display-buffer' and
+all functions based on it. The behavior of `make-frame' is not
+affected by this variable."
+ :type '(repeat (cons :format "%v"
+ (symbol :tag "Parameter")
+ (sexp :tag "Value")))
+ :group 'frames)
-(defun display-buffer-other-window-means-other-frame (buffer-or-name &optional label)
- "Return non-nil if BUFFER shall be preferably displayed in another frame.
-BUFFER must be a live buffer or the name of a live buffer.
-
-Return nil if BUFFER shall be preferably displayed in another
-window on the selected frame. Return non-nil if BUFFER shall be
-preferably displayed in a window on any but the selected frame.
-
-Optional argument LABEL is like the same argument of
-`display-buffer'.
-
-The calculation of the return value is exclusively based on the
-user preferences expressed in `display-buffer-alist'."
- (let* ((buffer (window-normalize-buffer buffer-or-name))
- (list (display-buffer-normalize-alist (buffer-name buffer) label))
- (value (assq 'other-window-means-other-frame
- (or (car list) (cdr list)))))
- (when value (cdr value))))
-
-(defun display-buffer-normalize-arguments (buffer-name specifiers label other-frame)
- "Normalize second and third argument of `display-buffer'.
-BUFFER-NAME is the name of the buffer that shall be displayed,
-SPECIFIERS is the second argument of `display-buffer'. LABEL is
-the same argument of `display-buffer'. OTHER-FRAME non-nil means
-use other-frame for other-window."
- (let (normalized entry specifier pars)
- (setq specifier
- (cond
- ((not specifiers)
- nil)
- ((listp specifiers)
- ;; If SPECIFIERS is a list, we assume it is a list of specifiers.
- (dolist (specifier specifiers)
- (cond
- ((consp specifier)
- (setq normalized (cons specifier normalized)))
- ((eq specifier 'other-window)
- ;; `other-window' must be treated separately.
- (let ((entry (assq (if other-frame
- 'other-frame
- 'same-frame-other-window)
- display-buffer-macro-specifiers)))
- (dolist (item (cdr entry))
- (setq normalized (cons item normalized)))))
- ((symbolp specifier)
- ;; Might be a macro specifier, try to expand it (the cdr is a
- ;; list and we have to reverse it later, so do it one at a
- ;; time).
- (let ((entry (assq specifier display-buffer-macro-specifiers)))
- (dolist (item (cdr entry))
- (setq normalized (cons item normalized)))))))
- ;; Reverse list.
- (nreverse normalized))
- ((setq entry (assq specifiers display-buffer-macro-specifiers))
- ;; A macro specifier.
- (cdr entry))
- ((or other-frame (with-no-warnings pop-up-frames))
- ;; `special-display-p' group.
- (if (and (with-no-warnings special-display-function)
- ;; `special-display-p' returns either t or a list
- ;; of frame parameters to pass to
- ;; `special-display-function'.
- (setq pars (with-no-warnings
- (special-display-p buffer-name))))
- (list (list 'function
- (with-no-warnings special-display-function)
- (when (listp pars) pars)))
- ;; Pop up another frame.
- (cddr (assq 'other-frame display-buffer-macro-specifiers))))
- (t
- ;; In any other case pop up a new window.
- (cdr (assq 'same-frame-other-window
- display-buffer-macro-specifiers)))))
+(defcustom pop-up-frame-function
+ (lambda () (make-frame pop-up-frame-alist))
+ "Function used by `display-buffer' for creating a new frame.
+This function is called with no arguments and should return a new
+frame. The default value calls `make-frame' with the argument
+`pop-up-frame-alist'."
+ :type 'function
+ :group 'frames)
- ;; Handle the old meaning of the LABEL argument of `display-buffer'.
- (cond
- ((or (memq label '(visible 0 t)) (frame-live-p label))
- ;; LABEL must be one of visible (and visible frame), 0 (any
- ;; visible or iconfied frame), t (any frame), or a live frame.
- (cons `(reuse-window nil same ,label) specifier))
- ((or other-frame
- (with-no-warnings pop-up-frames)
- (with-no-warnings display-buffer-reuse-frames))
- (cons '(reuse-window nil same 0) specifier))
- (t
- specifier))))
-
-(defun display-buffer-normalize-options (buffer-or-name)
- "Subroutine of `display-buffer-normalize-specifiers'.
-BUFFER-OR-NAME is the buffer to display. This routine provides a
-compatibility layer for the now obsolete Emacs 23 buffer display
-options."
- (with-no-warnings
- (let* ((buffer (window-normalize-buffer buffer-or-name))
- (buffer-name (buffer-name buffer))
- (use-pop-up-frames
- (or (and (eq pop-up-frames 'graphic-only)
- (display-graphic-p))
- pop-up-frames))
- specifiers)
- ;; `even-window-heights', unless nil or unset.
- (unless (memq even-window-heights '(nil unset))
- (setq specifiers
- (cons (cons 'reuse-window-even-sizes t) specifiers)))
-
- ;; `display-buffer-mark-dedicated'
- (when display-buffer-mark-dedicated
- (setq specifiers
- (cons (cons 'dedicate display-buffer-mark-dedicated)
- specifiers)))
-
- ;; `pop-up-window' group. Anything is added here iff
- ;; `pop-up-windows' is neither nil nor unset.
- (let ((pop-up-window (not (memq pop-up-windows '(nil unset))))
- (fun (unless (eq split-window-preferred-function
- 'split-window-sensibly)
- split-window-preferred-function))
- (min-height (if (numberp split-height-threshold)
- (/ split-height-threshold 2)
- 1.0))
- (min-width (if (numberp split-width-threshold)
- (/ split-width-threshold 2)
- 1.0)))
- ;; Create an entry only if a default value was changed.
- (when (or pop-up-window
- (not (equal split-height-threshold 80))
- (not (equal split-width-threshold 160)))
- ;; `reuse-window' (needed as fallback when popping up the new
- ;; window fails).
- (setq specifiers
- (cons (list 'reuse-window 'other nil nil)
- specifiers))
- ;; `split-width-threshold'
- (setq specifiers
- (cons (cons 'pop-up-window-min-width min-width)
- specifiers))
- ;; `split-height-threshold'
- (setq specifiers
- (cons (cons 'pop-up-window-min-height min-height)
- specifiers))
- ;; `pop-up-window'
- (setq specifiers
- (cons (list 'pop-up-window
- (cons 'largest fun) (cons 'lru fun))
- specifiers))))
-
- ;; `pop-up-frame' group.
- (when use-pop-up-frames
- ;; `pop-up-frame-function'. If `pop-up-frame-function' uses the
- ;; now obsolete `pop-up-frame-alist' it will continue to do so.
- (setq specifiers
- (cons (cons 'pop-up-frame-function pop-up-frame-function)
- specifiers))
- ;; `pop-up-frame'
- (setq specifiers
- (cons (list 'pop-up-frame t) specifiers)))
-
- ;; `pop-up-windows' and `use-pop-up-frames' both nil means means
- ;; we are supposed to reuse any window on the same frame (unless
- ;; we find one showing the same buffer already).
- (unless (or pop-up-windows use-pop-up-frames)
- ;; `reuse-window' showing any buffer on same frame.
- (setq specifiers
- (cons (list 'reuse-window nil nil nil)
- specifiers)))
-
- ;; `special-display-p' group.
- (when 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)))
- (when pars
- (setq specifiers
- (cons (list 'function special-display-function
- (when (listp pars) pars))
- specifiers)))))
-
- ;; `pop-up-frames', `display-buffer-reuse-frames' means search for
- ;; a window showing the buffer on some visible or iconfied frame.
- ;; `last-nonminibuffer-frame' set and not the same frame means
- ;; search that frame.
- (let ((frames (or (and (or use-pop-up-frames
- display-buffer-reuse-frames
- (not (last-nonminibuffer-frame)))
- ;; All visible or iconfied frames.
- 0)
- ;; Same frame.
- (last-nonminibuffer-frame))))
- (when frames
- (setq specifiers
- (cons (list 'reuse-window 'other 'same frames)
- specifiers))))
-
- ;; `same-window-p' group.
- (when (same-window-p buffer-name)
- ;; Try to reuse the same (selected) window.
- (setq specifiers
- (cons (list 'reuse-window 'same nil nil)
- specifiers)))
-
- ;; Prepend "reuse window on same frame if showing the buffer
- ;; already" specifier. It will be overriden by the application
- ;; supplied 'other-window specifier.
- (setq specifiers (cons (list 'reuse-window nil 'same nil)
- specifiers))
-
- specifiers)))
-
-(defun display-buffer-normalize-alist-1 (specifiers label)
- "Subroutine of `display-buffer-normalize-alist'.
-SPECIFIERS is a list of buffer display specfiers. LABEL is the
-same argument of `display-buffer'."
- (let (normalized entry)
- (cond
- ((not specifiers)
- nil)
- ((listp specifiers)
- ;; If SPECIFIERS is a list, we assume it is a list of specifiers.
- (dolist (specifier specifiers)
- (cond
- ((consp specifier)
- (setq normalized (cons specifier normalized)))
- ((symbolp specifier)
- ;; Might be a macro specifier, try to expand it (the cdr is a
- ;; list and we have to reverse it later, so do it one at a
- ;; time).
- (let ((entry (assq specifier display-buffer-macro-specifiers)))
- (dolist (item (cdr entry))
- (setq normalized (cons item normalized)))))))
- ;; Reverse list.
- (nreverse normalized))
- ((setq entry (assq specifiers display-buffer-macro-specifiers))
- ;; A macro specifier.
- (cdr entry)))))
-
-(defun display-buffer-normalize-alist (buffer-name label)
- "Normalize `display-buffer-alist'.
-BUFFER-NAME must be the name of the buffer that shall be displayed.
-LABEL the corresponding argument of `display-buffer'."
- (let (list-1 list-2)
- (dolist (entry display-buffer-alist)
- (when (and (listp entry)
- (catch 'match
- (dolist (id (car entry))
- (when (consp id)
- (let ((type (car id))
- (value (cdr id)))
- (when (or (and (eq type 'name) (stringp value)
- (equal value buffer-name))
- (and (eq type 'regexp) (stringp value)
- (string-match-p value buffer-name))
- (and (eq type 'label) (eq value label)))
- (throw 'match t)))))))
- (let* ((specifiers (cdr entry))
- (normalized
- (display-buffer-normalize-alist-1 specifiers label)))
- (if (cdr (assq 'override specifiers))
- (setq list-1
- (if list-1
- (append list-1 normalized)
- normalized))
- (setq list-2
- (if list-2
- (append list-2 normalized)
- normalized))))))
-
- (cons list-1 list-2)))
-
-(defvar display-buffer-normalize-options-inhibit nil
- "If non-nil, `display-buffer' doesn't process obsolete options.")
-
-(defun display-buffer-normalize-specifiers (buffer-name specifiers label)
- "Return normalized specifiers for a buffer matching BUFFER-NAME or LABEL.
-BUFFER-NAME must be a string specifying a valid buffer name.
-SPECIFIERS and LABEL are the homonymous arguments of
-`display-buffer'.
-
-The method for displaying the buffer specified by BUFFER-NAME or
-LABEL is established by appending the following four lists of
-specifiers:
-
-- The specifiers in `display-buffer-alist' whose buffer
- identifier matches BUFFER-NAME or LABEL and whose 'override
- component is set.
-
-- SPECIFIERS.
-
-- The specifiers in `display-buffer-alist' whose buffer
- identifier matches BUFFER-NAME or LABEL and whose 'override
- component is not set.
-
-- `display-buffer-default-specifiers'."
- (let* ((list (display-buffer-normalize-alist buffer-name label))
- (other-frame (cdr (assq 'other-window-means-other-frame
- (or (car list) (cdr list))))))
- (append
- ;; Overriding user specifiers.
- (car list)
- ;; Application specifiers.
- (display-buffer-normalize-arguments
- buffer-name specifiers label other-frame)
- ;; Emacs 23 compatibility specifiers.
- (unless display-buffer-normalize-options-inhibit
- (display-buffer-normalize-options buffer-name))
- ;; Non-overriding user specifiers.
- (cdr list)
- ;; Default specifiers.
- display-buffer-default-specifiers)))
-
-;; Minibuffer-only frames should be documented better. They really
-;; deserve a separate section in the manual. Also
-;; `last-nonminibuffer-frame' is nowhere documented in the manual.
-(defun display-buffer-frame (&optional frame)
- "Return FRAME if it is live and not a minibuffer-only frame.
-Return the value of `last-nonminibuffer-frame' otherwise."
- (setq frame (window-normalize-frame frame))
- (if (and (frame-live-p frame)
- ;; A not very nice way to get that information.
- (not (window-minibuffer-p (frame-root-window frame))))
- frame
- (last-nonminibuffer-frame)))
-
-(defun display-buffer (&optional buffer-or-name specifiers label)
- "Make the buffer specified by BUFFER-OR-NAME appear in some window.
-Optional argument BUFFER-OR-NAME may be a buffer, a string \(a
-buffer name), or nil. If BUFFER-OR-NAME is a string not naming
-an existent buffer, create a buffer with that name. If
-BUFFER-OR-NAME is nil or omitted, display the current buffer.
-Interactively, prompt for the buffer name using the minibuffer.
-
-Return the window chosen to display the buffer or nil if no such
-window is found. Do not change the selected window unless the
-buffer is shown on a different frame than the selected one.
-
-Optional argument SPECIFIERS must be a list of buffer display
-specifiers, see the documentation of `display-buffer-alist' for a
-description.
-
-For convenience, SPECIFIERS may also consist of a single buffer
-display location specifier or t, where the latter means to
-display the buffer in any but the selected window. If SPECIFIERS
-is nil or omitted, this means to exclusively use the specifiers
-provided by `display-buffer-alist'. If the value of the latter
-is nil too, all specifiers are provided by the constant
-`display-buffer-default-specifiers'.
-
-As a special case, the `reuse-window' specifier allows to specify
-as second element an arbitrary window, as third element an
-arbitrary buffer, and as fourth element an arbitrary frame. As
-first element of a window/side pair of the `pop-up-window'
-specifier you can specifiy an arbitrary window.
-
-The optional third argument LABEL, if non-nil, must be a symbol
-specifiying the buffer display label. Applications should set
-this when the buffer shall be displayed in some special way but
-BUFFER-OR-NAME does not identify the buffer as special. Typical
-buffers that fit into this category are those whose names are
-derived from the name of the file they are visiting. A user can
-override SPECIFIERS by adding an entry to `display-buffer-alist'
-whose car contains LABEL and whose cdr specifies the preferred
-alternative display method.
-
-The following values of LABEL have a special meaning and allow to
-specify the set of frames to investigate when the buffer already
-appears in a window:
-
-`visible' - the set of visible frames.
-
-0 - the set of visible or iconified frames.
-
-t - the set of all frames.
-
-A live frame - the set containing that frame as its only element.
-
-If the buffer is already displayed in a window on a frame in the
-specified set, return that window.
-
-The method to display the buffer is derived by combining the
-values of `display-buffer-alist' and SPECIFIERS. Highest
-priority is given to overriding elements of
-`display-buffer-alist'. Next come the elements specified by
-SPECIFIERS, followed by the non-overriding elements of
-`display-buffer-alist'.
-
-The result must be a list of valid buffer display specifiers. If
-`display-buffer-function' is non-nil, call it with the buffer and
-this list as arguments."
- (interactive "BDisplay buffer:\nP")
- (let* ((buffer (window-normalize-buffer-to-display buffer-or-name))
- (buffer-name (buffer-name buffer))
- (normalized
- ;; Normalize specifiers.
- (display-buffer-normalize-specifiers buffer-name specifiers label))
- ;; Don't use a minibuffer frame.
- (frame (display-buffer-frame))
- ;; `window' is the window we use for showing `buffer'.
- window specifier method)
- ;; Reset this.
- (setq display-buffer-window nil)
- (if display-buffer-function
- ;; Let `display-buffer-function' do the job.
- (funcall display-buffer-function buffer specifiers)
- ;; Retrieve the next location specifier while there a specifiers
- ;; left and we don't have a valid window.
- (while (and normalized (not (window-live-p window)))
- (setq specifier (car normalized))
- (setq normalized (cdr normalized))
- (setq method (car specifier))
- (setq window
- (cond
- ((eq method 'reuse-window)
- (display-buffer-reuse-window
- buffer (cdr specifier) normalized))
- ((eq method 'pop-up-window)
- (display-buffer-pop-up-window
- buffer (cdr specifier) normalized))
- ((eq method 'pop-up-frame)
- (display-buffer-pop-up-frame
- buffer (cdr specifier) normalized))
- ((eq method 'use-side-window)
- (display-buffer-in-side-window
- buffer (nth 1 specifier) (nth 2 specifier) normalized))
- ((eq method 'function)
- (funcall (nth 1 specifier) buffer (nth 2 specifier))))))
-
- ;; If we don't have a window yet, try a fallback method. All
- ;; specifiers have been used up by now.
- (or (and (window-live-p window) window)
- ;; Try reusing a window showing BUFFER on any visible or
- ;; iconfied frame.
- (display-buffer-reuse-window buffer `(nil ,buffer 0))
- ;; Try reusing a window not showing BUFFER on any visible or
- ;; iconified frame.
- (display-buffer-reuse-window buffer '(nil other 0))
- ;; Eli says it's better to never try making a new frame.
- ;; (display-buffer-pop-up-frame buffer)
- ;; Try using a weakly dedicated window.
- (display-buffer-reuse-window
- buffer '(nil nil t) '((reuse-window-dedicated . weak)))
- ;; Try using a strongly dedicated window.
- (display-buffer-reuse-window
- buffer '(nil nil t) '((reuse-window-dedicated . t)))))))
-
-(defsubst display-buffer-same-window (&optional buffer-or-name label)
- "Display buffer specified by BUFFER-OR-NAME in the selected window.
-Another window will be used only if the buffer can't be shown in
-the selected window, usually because it is dedicated to another
-buffer. Optional argument BUFFER-OR-NAME and LABEL are as for
-`display-buffer'."
- (interactive "BDisplay buffer in same window:\nP")
- (display-buffer buffer-or-name 'same-window label))
-
-(defsubst display-buffer-same-frame (&optional buffer-or-name label)
- "Display buffer specified by BUFFER-OR-NAME in a window on the same frame.
-Another frame will be used only if there is no other choice.
-Optional argument BUFFER-OR-NAME and LABEL are as for
-`display-buffer'."
- (interactive "BDisplay buffer on same frame:\nP")
- (display-buffer buffer-or-name 'same-frame label))
-
-(defsubst display-buffer-other-window (&optional buffer-or-name label)
- "Display buffer specified by BUFFER-OR-NAME in another window.
-The selected window will be used only if there is no other
-choice. Windows on the selected frame are preferred to windows
-on other frames. Optional argument BUFFER-OR-NAME and LABEL are as
-for `display-buffer'."
- (interactive "BDisplay buffer in another window:\nP")
- (display-buffer buffer-or-name 'other-window label))
-
-(defun display-buffer-same-frame-other-window (&optional buffer-or-name label)
- "Display buffer specified by BUFFER-OR-NAME in another window on the same frame.
-The selected window or another frame will be used only if there
-is no other choice. Optional argument BUFFER-OR-NAME and LABEL are
-as for `display-buffer'."
- (interactive "BDisplay buffer in another window on same frame:\nP")
- (display-buffer buffer-or-name 'same-frame-other-window label))
-
-(defun display-buffer-other-frame (&optional buffer-or-name label)
- "Display buffer specified by BUFFER-OR-NAME on another frame.
-The selected frame will be used only if there is no other choice.
-Optional argument BUFFER-OR-NAME and LABEL are as for
-`display-buffer'.
-
-If this command uses another frame, it will also select that frame."
- (interactive "BDisplay buffer in other frame: ")
- (display-buffer buffer-or-name 'other-frame label))
-
-(defun pop-to-buffer (&optional buffer-or-name specifiers norecord label)
- "Display buffer specified by BUFFER-OR-NAME and select the window used.
-Optional argument BUFFER-OR-NAME may be a buffer, a string \(a
-buffer name), or nil. If BUFFER-OR-NAME is a string not naming
-an existent buffer, create a buffer with that name. If
-BUFFER-OR-NAME is nil or omitted, display the current buffer.
-Interactively, prompt for the buffer name using the minibuffer.
-
-Optional second argument SPECIFIERS must be a list of buffer
-display specifiers, a single location specifier, `t' which means
-the latter means to display the buffer in any but the selected
-window, or nil which means to exclusively apply the specifiers
-customized by the user.
+(defcustom special-display-buffer-names nil
+ "List of names of buffers that should be displayed specially.
+Displaying a buffer with `display-buffer' or `pop-to-buffer', if
+its name is in this list, displays the buffer in a way specified
+by `special-display-function'. `special-display-popup-frame'
+\(the default for `special-display-function') usually displays
+the buffer in a separate frame made with the parameters specified
+by `special-display-frame-alist'. If `special-display-function'
+has been set to some other function, that function is called with
+the buffer as first, and nil as second argument.
-Optional argument NORECORD non-nil means do not put the buffer
-specified by BUFFER-OR-NAME at the front of the buffer list and
-do not make the window displaying it the most recently selected
-one.
+Alternatively, an element of this list can be specified as
+\(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
+name and FRAME-PARAMETERS an alist of \(PARAMETER . VALUE) pairs.
+`special-display-popup-frame' will interpret such pairs as frame
+parameters when it creates a special frame, overriding the
+corresponding values from `special-display-frame-alist'.
-The optional argument LABEL, if non-nil, is a symbol specifying the
-display purpose. Applications should set this when the buffer
-shall be displayed in a special way but BUFFER-OR-NAME does not
-identify the buffer as special. Buffers that typically fit into
-this category are those whose names have been derived from the
-name of the file they are visiting.
+As a special case, if FRAME-PARAMETERS contains (same-window . t)
+`special-display-popup-frame' displays that buffer in the
+selected window. If FRAME-PARAMETERS contains (same-frame . t),
+it displays that buffer in a window on the selected frame.
-Return the buffer specified by BUFFER-OR-NAME or nil if
-displaying the buffer failed.
+If `special-display-function' specifies some other function than
+`special-display-popup-frame', that function is called with the
+buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
+argument.
-This uses the function `display-buffer' as a subroutine; see the
-documentations of `display-buffer' and `display-buffer-alist' for
-additional information."
- (interactive "BPop to buffer:\nP")
- (let ((buffer (window-normalize-buffer-to-display buffer-or-name))
- (old-window (selected-window))
- (old-frame (selected-frame))
- new-window new-frame)
- (set-buffer buffer)
- (setq new-window (display-buffer buffer specifiers label))
- (unless (eq new-window old-window)
- ;; `display-buffer' has chosen another window, select it.
- (select-window new-window norecord)
- (setq new-frame (window-frame new-window))
- (unless (eq new-frame old-frame)
- ;; `display-buffer' has chosen another frame, make sure it gets
- ;; input focus and is risen.
- (select-frame-set-input-focus new-frame)))
+Finally, an element of this list can be also specified as
+\(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
+The function specified here is responsible for setting the
+quit-restore and help-setup parameters of the window used.
- buffer))
+If this variable appears \"not to work\", because you added a
+name to it but the corresponding buffer is displayed in the
+selected window, look at the values of `same-window-buffer-names'
+and `same-window-regexps'. Those variables take precedence over
+this one.
-(defsubst pop-to-buffer-same-window (&optional buffer-or-name norecord label)
- "Pop to buffer specified by BUFFER-OR-NAME in the selected window.
-Another window will be used only if the buffer can't be shown in
-the selected window, usually because it is dedicated to another
-buffer. Optional arguments BUFFER-OR-NAME, NORECORD and LABEL are
-as for `pop-to-buffer'."
- (interactive "BPop to buffer in selected window:\nP")
- (pop-to-buffer buffer-or-name 'same-window norecord label))
-
-(defsubst pop-to-buffer-same-frame (&optional buffer-or-name norecord label)
- "Pop to buffer specified by BUFFER-OR-NAME in a window on the selected frame.
-Another frame will be used only if there is no other choice.
-Optional arguments BUFFER-OR-NAME, NORECORD and LABEL are as for
-`pop-to-buffer'."
- (interactive "BPop to buffer on same frame:\nP")
- (pop-to-buffer buffer-or-name 'same-frame norecord label))
-
-(defsubst pop-to-buffer-other-window (&optional buffer-or-name norecord label)
- "Pop to buffer specified by BUFFER-OR-NAME in another window.
-The selected window will be used only if there is no other
-choice. Windows on the selected frame are preferred to windows
-on other frames. Optional arguments BUFFER-OR-NAME, NORECORD and
-LABEL are as for `pop-to-buffer'."
- (interactive "BPop to buffer in another window:\nP")
- (pop-to-buffer buffer-or-name 'other-window norecord))
-
-(defsubst pop-to-buffer-same-frame-other-window (&optional buffer-or-name norecord label)
- "Pop to buffer specified by BUFFER-OR-NAME in another window on the selected frame.
-The selected window or another frame will be used only if there
-is no other choice. Optional arguments BUFFER-OR-NAME, NORECORD
-and LABEL are as for `pop-to-buffer'."
- (interactive "BPop to buffer in another window on same frame:\nP")
- (pop-to-buffer buffer-or-name 'same-frame-other-window norecord label))
-
-(defsubst pop-to-buffer-other-frame (&optional buffer-or-name norecord label)
- "Pop to buffer specified by BUFFER-OR-NAME on another frame.
-The selected frame will be used only if there's no other choice.
-Optional arguments BUFFER-OR-NAME, NORECORD and LABEL are as for
-`pop-to-buffer'."
- (interactive "BPop to buffer on another frame:\nP")
- (pop-to-buffer buffer-or-name 'other-frame norecord label))
+See also `special-display-regexps'."
+ :type '(repeat
+ (choice :tag "Buffer"
+ :value ""
+ (string :format "%v")
+ (cons :tag "With parameters"
+ :format "%v"
+ :value ("" . nil)
+ (string :format "%v")
+ (repeat :tag "Parameters"
+ (cons :format "%v"
+ (symbol :tag "Parameter")
+ (sexp :tag "Value"))))
+ (list :tag "With function"
+ :format "%v"
+ :value ("" . nil)
+ (string :format "%v")
+ (function :tag "Function")
+ (repeat :tag "Arguments" (sexp)))))
+ :group 'windows
+ :group 'frames)
-(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.
+;;;###autoload
+(put 'special-display-buffer-names 'risky-local-variable t)
-This function is intended for the `switch-to-buffer' family of
-commands since these need to omit the name of the current buffer
-from the list of completions and default values."
- (let ((rbts-completion-table (internal-complete-buffer-except)))
- (minibuffer-with-setup-hook
- (lambda ()
- (setq minibuffer-completion-table rbts-completion-table)
- ;; Since rbts-completion-table is built dynamically, we
- ;; can't just add it to the default value of
- ;; icomplete-with-completion-tables, so we add it
- ;; here manually.
- (if (and (boundp 'icomplete-with-completion-tables)
- (listp icomplete-with-completion-tables))
- (set (make-local-variable 'icomplete-with-completion-tables)
- (cons rbts-completion-table
- icomplete-with-completion-tables))))
- (read-buffer prompt (other-buffer (current-buffer))
- (confirm-nonexistent-file-or-buffer)))))
+(defcustom special-display-regexps nil
+ "List of regexps saying which buffers should be displayed specially.
+Displaying a buffer with `display-buffer' or `pop-to-buffer', if
+any regexp in this list matches its name, displays it specially
+using `special-display-function'. `special-display-popup-frame'
+\(the default for `special-display-function') usually displays
+the buffer in a separate frame made with the parameters specified
+by `special-display-frame-alist'. If `special-display-function'
+has been set to some other function, that function is called with
+the buffer as first, and nil as second argument.
-(defun window-normalize-buffer-to-switch-to (buffer-or-name)
- "Normalize BUFFER-OR-NAME argument of buffer switching functions.
-If BUFFER-OR-NAME is nil, return the buffer returned by
-`other-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."
- (if buffer-or-name
- (or (get-buffer buffer-or-name)
- (let ((buffer (get-buffer-create buffer-or-name)))
- (set-buffer-major-mode buffer)
- buffer))
- (other-buffer)))
-
-(defun switch-to-buffer (buffer-or-name &optional norecord)
- "Switch to buffer BUFFER-OR-NAME in the selected window.
-If called interactively, prompt for the buffer name using the
-minibuffer. The variable `confirm-nonexistent-file-or-buffer'
-determines whether to request confirmation before creating a new
-buffer.
-
-BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
-nil. If BUFFER-OR-NAME is a string that does not identify an
-existing buffer, create a buffer with that name. If
-BUFFER-OR-NAME is nil, switch to the buffer returned by
-`other-buffer'.
-
-Optional argument NORECORD non-nil means do not put the buffer
-specified by BUFFER-OR-NAME at the front of the buffer list and
-do not make the window displaying it the most recently selected
-one. Return the buffer switched to.
-
-This function is intended for interactive use only. Lisp
-functions should call `pop-to-buffer-same-window' instead."
- (interactive
- (list (read-buffer-to-switch "Switch to buffer: ")))
- (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name)))
- (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).
- ((eq buffer (window-buffer)) nil)
- ((window-minibuffer-p)
- (error "Cannot switch buffers in minibuffer window"))
- ((eq (window-dedicated-p) t)
- (error "Cannot switch buffers in a dedicated window"))
- (t (set-window-buffer nil buffer)))
- (unless norecord
- (select-window (selected-window)))
- (set-buffer buffer)))
-
-(defun switch-to-buffer-same-frame (buffer-or-name &optional norecord)
- "Switch to buffer BUFFER-OR-NAME in a window on the selected frame.
-Another frame will be used only if there is no other choice.
-Arguments BUFFER-OR-NAME and NORECORD have the same meaning as
-for `switch-to-buffer'.
-
-This function is intended for interactive use only. Lisp
-functions should call `pop-to-buffer-same-frame' instead."
- (interactive
- (list (read-buffer-to-switch "Switch to buffer in other window: ")))
- (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name)))
- (pop-to-buffer buffer 'same-frame norecord)))
-
-(defun switch-to-buffer-other-window (buffer-or-name &optional norecord)
- "Switch to buffer BUFFER-OR-NAME in another window.
-The selected window will be used only if there is no other
-choice. Windows on the selected frame are preferred to windows
-on other frames. Arguments BUFFER-OR-NAME and NORECORD have the
-same meaning as for `switch-to-buffer'.
-
-This function is intended for interactive use only. Lisp
-functions should call `pop-to-buffer-other-window' instead."
- (interactive
- (list (read-buffer-to-switch "Switch to buffer in other window: ")))
- (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name)))
- (pop-to-buffer buffer 'other-window norecord)))
-
-(defun switch-to-buffer-other-window-same-frame (buffer-or-name &optional norecord)
- "Switch to buffer BUFFER-OR-NAME in another window on the selected frame.
-The selected window or another frame will be used only if there
-is no other choice. Arguments BUFFER-OR-NAME and NORECORD have
-the same meaning as for `switch-to-buffer'.
-
-This function is intended for interactive use only. Lisp
-functions should call `pop-to-buffer-other-window-same-frame'
-instead."
- (interactive
- (list (read-buffer-to-switch "Switch to buffer in other window: ")))
- (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name)))
- (pop-to-buffer buffer 'same-frame-other-window norecord)))
-
-(defun switch-to-buffer-other-frame (buffer-or-name &optional norecord)
- "Switch to buffer BUFFER-OR-NAME on another frame.
-The same frame will be used only if there is no other choice.
-Arguments BUFFER-OR-NAME and NORECORD have the same meaning
-as for `switch-to-buffer'.
-
-This function is intended for interactive use only. Lisp
-functions should call `pop-to-buffer-other-frame' instead."
- (interactive
- (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
- (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name)))
- (pop-to-buffer buffer 'other-frame norecord)))
-
-;;; Obsolete definitions of `display-buffer' below.
-(defcustom same-window-buffer-names nil
- "List of names of buffers that should appear in the \"same\" window.
-`display-buffer' and `pop-to-buffer' show a buffer whose name is
-on this list in the selected rather than some other window.
+Alternatively, an element of this list can be specified as
+\(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
+FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
+`special-display-popup-frame' will then interpret these pairs as
+frame parameters when creating a special frame for a buffer whose
+name matches REGEXP, overriding the corresponding values from
+`special-display-frame-alist'.
-An element of this list can be a cons cell instead of just a
-string. In that case, the cell's car must be a string specifying
-the buffer name. This is for compatibility with
-`special-display-buffer-names'; the cdr of the cons cell is
-ignored.
+As a special case, if FRAME-PARAMETERS contains (same-window . t)
+`special-display-popup-frame' displays buffers matching REGEXP in
+the selected window. \(same-frame . t) in FRAME-PARAMETERS means
+to display such buffers in a window on the selected frame.
-See also `same-window-regexps'."
- :type '(repeat (string :format "%v"))
- :group 'windows)
-;; (make-obsolete-variable
- ;; 'same-window-buffer-names
- ;; "use 2nd arg of `display-buffer' instead." "24.1")
+If `special-display-function' specifies some other function than
+`special-display-popup-frame', that function is called with the
+buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
+as second argument.
-(defcustom same-window-regexps nil
- "List of regexps saying which buffers should appear in the \"same\" window.
-`display-buffer' and `pop-to-buffer' show a buffer whose name
-matches a regexp on this list in the selected rather than some
-other window.
+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.
-An element of this list can be a cons cell instead of just a
-string. In that case, the cell's car must be a regexp matching
-the buffer name. This is for compatibility with
-`special-display-regexps'; the cdr of the cons cell is ignored.
+If this variable appears \"not to work\", because you added a
+name to it but the corresponding buffer is displayed in the
+selected window, look at the values of `same-window-buffer-names'
+and `same-window-regexps'. Those variables take precedence over
+this one.
-See also `same-window-buffer-names'."
- :type '(repeat (regexp :format "%v"))
- :group 'windows)
-;; (make-obsolete-variable
- ;; 'same-window-regexps
- ;; "use 2nd arg of `display-buffer' instead." "24.1")
+See also `special-display-buffer-names'."
+ :type '(repeat
+ (choice :tag "Buffer"
+ :value ""
+ (regexp :format "%v")
+ (cons :tag "With parameters"
+ :format "%v"
+ :value ("" . nil)
+ (regexp :format "%v")
+ (repeat :tag "Parameters"
+ (cons :format "%v"
+ (symbol :tag "Parameter")
+ (sexp :tag "Value"))))
+ (list :tag "With function"
+ :format "%v"
+ :value ("" . nil)
+ (regexp :format "%v")
+ (function :tag "Function")
+ (repeat :tag "Arguments" (sexp)))))
+ :group 'windows
+ :group 'frames)
-(defun same-window-p (buffer-name)
- "Return non-nil if a buffer named BUFFER-NAME would be shown in the \"same\" window.
-This function returns non-nil if `display-buffer' or
-`pop-to-buffer' would show a buffer named BUFFER-NAME in the
-selected rather than \(as usual\) some other window. See
-`same-window-buffer-names' and `same-window-regexps'."
- (let ((buffer-names (with-no-warnings same-window-buffer-names))
- (regexps (with-no-warnings same-window-regexps)))
+(defun special-display-p (buffer-name)
+ "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
+More precisely, return t if `special-display-buffer-names' or
+`special-display-regexps' contain a string entry equaling or
+matching BUFFER-NAME. If `special-display-buffer-names' or
+`special-display-regexps' contain a list entry whose car equals
+or matches BUFFER-NAME, the return value is the cdr of that
+entry."
+ (let (tmp)
(cond
((not (stringp buffer-name)))
- ;; The elements of `same-window-buffer-names' can be buffer
- ;; names or cons cells whose cars are buffer names.
- ((member buffer-name buffer-names))
- ((assoc buffer-name buffer-names))
+ ((member buffer-name special-display-buffer-names)
+ t)
+ ((setq tmp (assoc buffer-name special-display-buffer-names))
+ (cdr tmp))
((catch 'found
- (dolist (regexp regexps)
- ;; The elements of `same-window-regexps' can be regexps
- ;; or cons cells whose cars are regexps.
- (when (or (and (stringp regexp)
- (string-match regexp buffer-name))
- (and (consp regexp) (stringp (car regexp))
- (string-match-p (car regexp) buffer-name)))
- (throw 'found t))))))))
-;; (make-obsolete
- ;; 'same-window-p "pass argument to buffer display function instead." "24.1")
+ (dolist (regexp special-display-regexps)
+ (cond
+ ((stringp regexp)
+ (when (string-match-p regexp buffer-name)
+ (throw 'found t)))
+ ((and (consp regexp) (stringp (car regexp))
+ (string-match-p (car regexp) buffer-name))
+ (throw 'found (cdr regexp))))))))))
(defcustom special-display-frame-alist
'((height . 14) (width . 80) (unsplittable . t))
(symbol :tag "Parameter")
(sexp :tag "Value")))
:group 'frames)
-;; (make-obsolete-variable
- ;; 'special-display-frame-alist
- ;; "use 2nd arg of `display-buffer' instead." "24.1")
(defun special-display-popup-frame (buffer &optional args)
- "Display BUFFER in a special frame and return the window chosen.
+ "Display BUFFER and return the window chosen.
If BUFFER is already displayed in a visible or iconified frame,
-raise that frame. Otherwise, display BUFFER in a way as
-specified by optional argument ARGS.
+raise that frame. Otherwise, display BUFFER in a new frame.
+
+Optional argument ARGS is a list specifying additional
+information.
If ARGS is an alist, use it as a list of frame parameters. If
these parameters contain \(same-window . t), display BUFFER in
the selected window. If they contain \(same-frame . t), display
-BUFFER in a window on the selected frame.
+BUFFER in a window of the selected frame.
If ARGS is a list whose car is a symbol, use (car ARGS) as a
function to do the work. Pass it BUFFER as first argument,
(let ((frame (window-frame window)))
(make-frame-visible frame)
(raise-frame frame)
+ (display-buffer-record-window 'reuse window buffer)
window))
;; Reuse the current window if the user requested it.
(when (cdr (assq 'same-window args))
- (display-buffer-reuse-window
- buffer '(same nil nil) '((reuse-dedicated . weak))))
+ (condition-case nil
+ (progn (switch-to-buffer buffer nil t) (selected-window))
+ (error nil)))
;; Stay on the same frame if requested.
- (when (or (cdr (assq 'same-frame args))
- (cdr (assq 'same-window args)))
- (or (display-buffer-pop-up-window
- buffer '((largest . nil) (lru . nil)))
- (display-buffer-reuse-window
- buffer '(nil nil nil))))
+ (when (or (cdr (assq 'same-frame args)) (cdr (assq 'same-window args)))
+ (let* ((pop-up-windows t)
+ pop-up-frames
+ 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 (with-no-warnings
- special-display-frame-alist))))))
- (set-window-buffer (frame-selected-window frame) buffer)
- (set-window-dedicated-p (frame-selected-window frame) t)
- (frame-selected-window frame))))))
-;; (make-obsolete
- ;; 'special-display-popup-frame
- ;; "use 2nd arg of `display-buffer' instead." "24.1")
+ (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)
+ (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.
A buffer is special when its name is either listed in
`special-display-buffer-names' or matches a regexp in
-`special-display-regexps'."
- :type 'function
- :group 'windows
- :group 'frames)
-;; (make-obsolete-variable
- ;; 'special-display-function
- ;; "use 2nd arg of `display-buffer' instead." "24.1")
-
-(defcustom special-display-buffer-names nil
- "List of names of buffers that should be displayed specially.
-Displaying a buffer with `display-buffer' or `pop-to-buffer', if
-its name is in this list, displays the buffer in a way specified
-by `special-display-function'. `special-display-popup-frame'
-\(the default for `special-display-function') usually displays
-the buffer in a separate frame made with the parameters specified
-by `special-display-frame-alist'. If `special-display-function'
-has been set to some other function, that function is called with
-the buffer as first, and nil as second argument.
-
-Alternatively, an element of this list can be specified as
-\(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
-name and FRAME-PARAMETERS an alist of \(PARAMETER . VALUE) pairs.
-`special-display-popup-frame' will interpret such pairs as frame
-parameters when it creates a special frame, overriding the
-corresponding values from `special-display-frame-alist'.
-
-As a special case, if FRAME-PARAMETERS contains (same-window . t)
-`special-display-popup-frame' displays that buffer in the
-selected window. If FRAME-PARAMETERS contains (same-frame . t),
-it displays that buffer in a window on the selected frame.
-
-If `special-display-function' specifies some other function than
-`special-display-popup-frame', that function is called with the
-buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
-argument.
-
-Finally, an element of this list can be also specified as
-\(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.
+`special-display-regexps'.
-If this variable appears \"not to work\", because you added a
-name to it but the corresponding buffer is displayed in the
-selected window, look at the values of `same-window-buffer-names'
-and `same-window-regexps'. Those variables take precedence over
-this one.
-
-See also `special-display-regexps'."
- :type '(repeat
- (choice :tag "Buffer"
- :value ""
- (string :format "%v")
- (cons :tag "With parameters"
- :format "%v"
- :value ("" . nil)
- (string :format "%v")
- (repeat :tag "Parameters"
- (cons :format "%v"
- (symbol :tag "Parameter")
- (sexp :tag "Value"))))
- (list :tag "With function"
- :format "%v"
- :value ("" . nil)
- (string :format "%v")
- (function :tag "Function")
- (repeat :tag "Arguments" (sexp)))))
- :group 'windows
+The function specified here is responsible for setting the
+quit-restore and help-setup parameters of the window used."
+ :type 'function
:group 'frames)
-;; (make-obsolete-variable
- ;; 'special-display-buffer-names
- ;; "use 2nd arg of `display-buffer' instead." "24.1")
-
-;;;###autoload
-(put 'special-display-buffer-names 'risky-local-variable t)
-
-(defcustom special-display-regexps nil
- "List of regexps saying which buffers should be displayed specially.
-Displaying a buffer with `display-buffer' or `pop-to-buffer', if
-any regexp in this list matches its name, displays it specially
-using `special-display-function'. `special-display-popup-frame'
-\(the default for `special-display-function') usually displays
-the buffer in a separate frame made with the parameters specified
-by `special-display-frame-alist'. If `special-display-function'
-has been set to some other function, that function is called with
-the buffer as first, and nil as second argument.
-
-Alternatively, an element of this list can be specified as
-\(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
-FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
-`special-display-popup-frame' will then interpret these pairs as
-frame parameters when creating a special frame for a buffer whose
-name matches REGEXP, overriding the corresponding values from
-`special-display-frame-alist'.
-
-As a special case, if FRAME-PARAMETERS contains (same-window . t)
-`special-display-popup-frame' displays buffers matching REGEXP in
-the selected window. \(same-frame . t) in FRAME-PARAMETERS means
-to display such buffers in a window on the selected frame.
-If `special-display-function' specifies some other function than
-`special-display-popup-frame', that function is called with the
-buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
-as second argument.
-
-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.
-
-If this variable appears \"not to work\", because you added a
-name to it but the corresponding buffer is displayed in the
-selected window, look at the values of `same-window-buffer-names'
-and `same-window-regexps'. Those variables take precedence over
-this one.
-
-See also `special-display-buffer-names'."
- :type '(repeat
- (choice :tag "Buffer"
- :value ""
- (regexp :format "%v")
- (cons :tag "With parameters"
- :format "%v"
- :value ("" . nil)
- (regexp :format "%v")
- (repeat :tag "Parameters"
- (cons :format "%v"
- (symbol :tag "Parameter")
- (sexp :tag "Value"))))
- (list :tag "With function"
- :format "%v"
- :value ("" . nil)
- (regexp :format "%v")
- (function :tag "Function")
- (repeat :tag "Arguments" (sexp)))))
- :group 'windows
- :group 'frames)
-;; (make-obsolete-variable
- ;; 'special-display-regexps
- ;; "use 2nd arg of `display-buffer' instead." "24.1")
+(defcustom same-window-buffer-names nil
+ "List of names of buffers that should appear in the \"same\" window.
+`display-buffer' and `pop-to-buffer' show a buffer whose name is
+on this list in the selected rather than some other window.
-(defun special-display-p (buffer-name)
- "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
-More precisely, return t if `special-display-buffer-names' or
-`special-display-regexps' contain a string entry equaling or
-matching BUFFER-NAME. If `special-display-buffer-names' or
-`special-display-regexps' contain a list entry whose car equals
-or matches BUFFER-NAME, the return value is the cdr of that
-entry."
- (let ((buffer-names (with-no-warnings special-display-buffer-names))
- (regexps (with-no-warnings special-display-regexps))
- tmp)
- (cond
- ((not (stringp buffer-name)))
- ((member buffer-name buffer-names)
- t)
- ((setq tmp (assoc buffer-name buffer-names))
- (cdr tmp))
- ((catch 'found
- (dolist (regexp regexps)
- (cond
- ((stringp regexp)
- (when (string-match-p regexp buffer-name)
- (throw 'found t)))
- ((and (consp regexp) (stringp (car regexp))
- (string-match-p (car regexp) buffer-name))
- (throw 'found (cdr regexp))))))))))
-;; (make-obsolete
- ;; 'special-display-p
- ;; "pass argument to buffer display function instead." "24.1")
+An element of this list can be a cons cell instead of just a
+string. In that case, the cell's car must be a string specifying
+the buffer name. This is for compatibility with
+`special-display-buffer-names'; the cdr of the cons cell is
+ignored.
-(defcustom pop-up-frame-alist nil
- "Alist of parameters for automatically generated new frames.
-You can set this in your init file; for example,
+See also `same-window-regexps'."
+ :type '(repeat (string :format "%v"))
+ :group 'windows)
- (setq pop-up-frame-alist '((width . 80) (height . 20)))
+(defcustom same-window-regexps nil
+ "List of regexps saying which buffers should appear in the \"same\" window.
+`display-buffer' and `pop-to-buffer' show a buffer whose name
+matches a regexp on this list in the selected rather than some
+other window.
-If non-nil, the value you specify here is used by the default
-`pop-up-frame-function' for the creation of new frames.
+An element of this list can be a cons cell instead of just a
+string. In that case, the cell's car must be a regexp matching
+the buffer name. This is for compatibility with
+`special-display-regexps'; the cdr of the cons cell is ignored.
-Since `pop-up-frame-function' is used by `display-buffer' for
-making new frames, any value specified here by default affects
-the automatic generation of new frames via `display-buffer' and
-all functions based on it. The behavior of `make-frame' is not
-affected by this variable."
- :type '(repeat (cons :format "%v"
- (symbol :tag "Parameter")
- (sexp :tag "Value")))
- :group 'frames)
-;; (make-obsolete-variable
- ;; 'pop-up-frame-alist
- ;; "use 2nd arg of `display-buffer' instead." "24.1")
+See also `same-window-buffer-names'."
+ :type '(repeat (regexp :format "%v"))
+ :group 'windows)
-(defcustom pop-up-frame-function
- (lambda () (make-frame pop-up-frame-alist))
- "Function used by `display-buffer' for creating a new frame.
-This function is called with no arguments and should return a new
-frame. The default value calls `make-frame' with the argument
-`pop-up-frame-alist'."
- :type 'function
- :group 'frames)
-;; (make-obsolete-variable
- ;; 'pop-up-frame-function
- ;; "use 2nd arg of `display-buffer' instead." "24.1")
+(defun same-window-p (buffer-name)
+ "Return non-nil if a buffer named BUFFER-NAME would be shown in the \"same\" window.
+This function returns non-nil if `display-buffer' or
+`pop-to-buffer' would show a buffer named BUFFER-NAME in the
+selected rather than \(as usual\) some other window. See
+`same-window-buffer-names' and `same-window-regexps'."
+ (cond
+ ((not (stringp buffer-name)))
+ ;; The elements of `same-window-buffer-names' can be buffer
+ ;; names or cons cells whose cars are buffer names.
+ ((member buffer-name same-window-buffer-names))
+ ((assoc buffer-name same-window-buffer-names))
+ ((catch 'found
+ (dolist (regexp same-window-regexps)
+ ;; The elements of `same-window-regexps' can be regexps
+ ;; or cons cells whose cars are regexps.
+ (when (or (and (stringp regexp)
+ (string-match regexp buffer-name))
+ (and (consp regexp) (stringp (car regexp))
+ (string-match-p (car regexp) buffer-name)))
+ (throw 'found t)))))))
(defcustom pop-up-frames nil
"Whether `display-buffer' should make a separate frame.
(const :tag "Never" nil)
(const :tag "On graphic displays only" graphic-only)
(const :tag "Always" t))
- :group 'windows
- :group 'frames)
-;; (make-obsolete-variable
- ;; 'pop-up-frames
- ;; "use 2nd arg of `display-buffer' instead." "24.1")
+ :group 'windows)
(defcustom display-buffer-reuse-frames nil
- "Set and non-nil means `display-buffer' should reuse frames.
+ "Non-nil means `display-buffer' should reuse frames.
If the buffer in question is already displayed in a frame, raise
that frame."
:type 'boolean
:version "21.1"
- :group 'windows
- :group 'frames)
-;; (make-obsolete-variable
- ;; 'display-buffer-reuse-frames
- ;; "use 2nd arg of `display-buffer' instead." "24.1")
+ :group 'windows)
-(defcustom pop-up-windows 'unset ; t
- "Set and non-nil means `display-buffer' should make a new window."
+(defcustom pop-up-windows t
+ "Non-nil means `display-buffer' should make a new window."
:type 'boolean
- :version "24.1"
:group 'windows)
-;; (make-obsolete-variable
- ;; 'pop-up-windows
- ;; "use 2nd arg of `display-buffer' instead." "24.1")
(defcustom split-window-preferred-function 'split-window-sensibly
- "Function called by `display-buffer' to split a window.
+ "Function called by `display-buffer' routines to split a window.
This function is called with a window as single argument and is
supposed to split that window and return the new window. If the
window can (or shall) not be split, it is supposed to return nil.
-
The default is to call the function `split-window-sensibly' which
tries to split the window in a way which seems most suitable.
You can customize the options `split-height-threshold' and/or
`split-width-threshold' in order to have `split-window-sensibly'
prefer either vertical or horizontal splitting.
-If you set this to any other function, bear in mind that
-`display-buffer' may call that function repeatedly; the option
-`pop-up-windows' controls which windows may become the argument
-of this function.
+If you set this to any other function, bear in mind that the
+`display-buffer' routines may call this function two times. The
+argument of the first call is the largest window on its frame.
+If that call fails to return a live window, the function is
+called again with the least recently used window as argument. If
+that call fails too, `display-buffer' will use an existing window
+to display its buffer.
The window selected at the time `display-buffer' was invoked is
still selected when this function is called. Hence you can
:type 'function
:version "23.1"
:group 'windows)
-;; (make-obsolete-variable
- ;; 'split-window-preferred-function
- ;; "use 2nd arg of `display-buffer' instead." "24.1")
(defcustom split-height-threshold 80
- "Minimum height for splitting a window to display a buffer.
-If this is an integer, `display-buffer' can split a window
+ "Minimum height for splitting windows sensibly.
+If this is an integer, `split-window-sensibly' may split a window
vertically only if it has at least this many lines. If this is
-nil, `display-buffer' does not split windows vertically. If a
-window is the only window on its frame, `display-buffer' may
-split it vertically disregarding the value of this variable."
+nil, `split-window-sensibly' is not allowed to split a window
+vertically. If, however, a window is the only window on its
+frame, `split-window-sensibly' may split it vertically
+disregarding the value of this variable."
:type '(choice (const nil) (integer :tag "lines"))
:version "23.1"
:group 'windows)
-;; (make-obsolete-variable
- ;; 'split-height-threshold
- ;; "use 2nd arg of `display-buffer' instead." "24.1")
(defcustom split-width-threshold 160
- "Minimum width for splitting a window to display a buffer.
-If this is an integer, `display-buffer' can split a window
+ "Minimum width for splitting windows sensibly.
+If this is an integer, `split-window-sensibly' may split a window
horizontally only if it has at least this many columns. If this
-is nil, `display-buffer' cannot split windows horizontally."
+is nil, `split-window-sensibly' is not allowed to split a window
+horizontally."
:type '(choice (const nil) (integer :tag "columns"))
:version "23.1"
:group 'windows)
-;; (make-obsolete-variable
- ;; 'split-width-threshold
- ;; "use 2nd arg of `display-buffer' instead." "24.1")
-
-(defcustom even-window-heights 'unset ; t
- "If set and non-nil `display-buffer' will try to even window heights.
-Otherwise `display-buffer' will leave the window configuration
-alone. Heights are evened only when `display-buffer' reuses a
-window that appears above or below the selected window."
- :type 'boolean
- :version "24.1"
- :group 'windows)
-;; (make-obsolete-variable
- ;; 'even-window-heights
- ;; "use 2nd arg of `display-buffer' instead." "24.1")
-
-(defvar display-buffer-mark-dedicated nil
- "Non-nil means `display-buffer' marks the windows it creates as dedicated.
-The actual non-nil value of this variable will be copied to the
-`window-dedicated-p' flag.")
-;; (make-obsolete-variable
- ;; 'display-buffer-mark-dedicated
- ;; "use 2nd arg of `display-buffer' instead." "24.1")
(defun window-splittable-p (window &optional horizontal)
"Return non-nil if `split-window-sensibly' may split WINDOW.
(max split-height-threshold
(* 2 (max window-min-height
(if mode-line-format 2 1))))))))))
-;; (make-obsolete
- ;; 'window-splittable-p "use 2nd arg of `display-buffer' instead." "24.1")
(defun split-window-sensibly (window)
"Split WINDOW in a way suitable for `display-buffer'.
Have a look at the function `window-splittable-p' if you want to
know how `split-window-sensibly' determines whether WINDOW can be
split."
- (or (and (with-no-warnings (window-splittable-p window))
+ (or (and (window-splittable-p window)
;; Split window vertically.
(with-selected-window window
(split-window-vertically)))
- (and (with-no-warnings (window-splittable-p window t))
+ (and (window-splittable-p window t)
;; Split window horizontally.
(with-selected-window window
(split-window-horizontally)))
;; minibuffer window, try to split it vertically disregarding
;; the value of `split-height-threshold'.
(let ((split-height-threshold 0))
- (when (with-no-warnings (window-splittable-p window))
+ (when (window-splittable-p window)
(with-selected-window window
(split-window-vertically)))))))
-;; (make-obsolete
- ;; 'split-window-sensibly "use 2nd arg of `display-buffer' instead." "24.1")
-
-;; Functions for converting Emacs 23 buffer display options to buffer
-;; display specifiers.
-(defun display-buffer-alist-add (identifiers specifiers &optional no-custom)
- "Helper function for `display-buffer-alist-set'."
- (unless identifiers
- (setq identifiers '((regexp . ".*"))))
- (unless (atom specifiers)
- (setq specifiers (delq nil specifiers)))
-
- (if no-custom
- (setq display-buffer-alist
- (cons (cons identifiers specifiers) display-buffer-alist))
- (customize-set-variable
- 'display-buffer-alist
- (cons (cons identifiers specifiers) display-buffer-alist))))
-
-(defun display-buffer-alist-set (&optional no-custom add)
- "Set `display-buffer-alist' from Emacs 23 buffer display options.
-Optional argument NO-CUSTOM nil means use `customize-set-variable'
-to set the value of `display-buffer-alist'. NO-CUSTOM non-nil
-means to use `setq' instead.
-
-Optional argument ADD nil means to replace the actual value of
-`display-buffer-alist' with the value calculated here. ADD
-non-nil means prepend the value calculated here to the current
-value of `display-buffer-alist'."
- (unless add
- (if no-custom
- (setq display-buffer-alist nil)
- (customize-set-variable 'display-buffer-alist nil)))
-
- ;; Disable warnings, there are too many obsolete options here.
- (with-no-warnings
- ;; `pop-up-windows'
- (display-buffer-alist-add
- nil
- (let ((fun (unless (eq split-window-preferred-function
- 'split-window-sensibly)
- ;; `split-window-sensibly' has been merged into the
- ;; `display-buffer-split-window' code as `nil'.
- split-window-preferred-function))
- (min-height
- (if (numberp split-height-threshold)
- (/ split-height-threshold 2)
- ;; Undocumented hack.
- 1.0))
- (min-width
- (if (numberp split-width-threshold)
- (/ split-width-threshold 2)
- ;; Undocumented hack.
- 1.0)))
- (list
- 'pop-up-window
- (when pop-up-windows ; unset qualifies as t
- (list
- 'pop-up-window
- (cons 'largest fun)
- (cons 'lru fun)))
- (cons 'pop-up-window-min-height min-height)
- (cons 'pop-up-window-min-width min-width)))
- no-custom)
-
- ;; `pop-up-frames'
- (display-buffer-alist-add
- nil
- (list
- 'pop-up-frame
- (when pop-up-frames
- (list 'pop-up-frame pop-up-frames))
- (when pop-up-frame-function
- (cons 'pop-up-frame-function pop-up-frame-function))
- (when pop-up-frame-alist
- (cons 'pop-up-frame-alist pop-up-frame-alist)))
- no-custom)
-
- ;; `special-display-regexps'
- (dolist (entry special-display-regexps)
- (cond
- ((stringp entry)
- ;; Plain string.
- (display-buffer-alist-add
- `((regexp . ,entry))
- (list
- 'function
- (list 'function special-display-function
- special-display-frame-alist))
- no-custom))
- ((consp entry)
- (let ((name (car entry))
- (rest (cdr entry)))
- (cond
- ((functionp (car rest))
- ;; A function.
- (display-buffer-alist-add
- `((name . ,name))
- (list
- 'function
- ;; Weary.
- (list 'function (car rest) (cadr rest)))
- no-custom))
- ((listp rest)
- ;; A list of parameters.
- (cond
- ((assq 'same-window rest)
- (display-buffer-alist-add
- `((name . ,name))
- (list 'reuse-window
- (list 'reuse-window 'same)
- (list 'reuse-window-dedicated 'weak))
- no-custom))
- ((assq 'same-frame rest)
- (display-buffer-alist-add
- `((name . ,name)) (list 'same-frame) no-custom))
- (t
- (display-buffer-alist-add
- `((name . ,name))
- (list
- 'function
- (list 'function special-display-function
- special-display-frame-alist))
- no-custom)))))))))
-
- ;; `special-display-buffer-names'
- (dolist (entry special-display-buffer-names)
- (cond
- ((stringp entry)
- ;; Plain string.
- (display-buffer-alist-add
- `((name . ,entry))
- (list
- 'function
- (list 'function special-display-function
- special-display-frame-alist))
- no-custom))
- ((consp entry)
- (let ((name (car entry))
- (rest (cdr entry)))
- (cond
- ((functionp (car rest))
- ;; A function.
- (display-buffer-alist-add
- `((name . ,name))
- (list
- 'function
- ;; Weary.
- (list 'function (car rest) (cadr rest)))
- no-custom))
- ((listp rest)
- ;; A list of parameters.
- (cond
- ((assq 'same-window rest)
- (display-buffer-alist-add
- `((name . ,name))
- (list 'reuse-window
- (list 'reuse-window 'same)
- (list 'reuse-window-dedicated 'weak))
- no-custom))
- ((assq 'same-frame rest)
- (display-buffer-alist-add
- `((name . ,name)) (list 'same-frame) no-custom))
- (t
- (display-buffer-alist-add
- `((name . ,name))
- (list
- 'function
- (list 'function special-display-function
- special-display-frame-alist))
- no-custom)))))))))
-
- ;; `same-window-regexps'
- (dolist (entry same-window-regexps)
- (cond
- ((stringp entry)
- (display-buffer-alist-add
- `((regexp . ,entry))
- (list 'reuse-window (list 'reuse-window 'same))
- no-custom))
- ((consp entry)
- (display-buffer-alist-add
- `((regexp . ,(car entry)))
- (list 'reuse-window (list 'reuse-window 'same))
- no-custom))))
-
- ;; `same-window-buffer-names'
- (dolist (entry same-window-buffer-names)
+
+(defun window--try-to-split-window (window)
+ "Try to split WINDOW.
+Return value returned by `split-window-preferred-function' if it
+represents a live window, nil otherwise."
+ (and (window-live-p window)
+ (not (frame-parameter (window-frame window) 'unsplittable))
+ (let ((new-window
+ ;; Since `split-window-preferred-function' might
+ ;; throw an error use `condition-case'.
+ (condition-case nil
+ (funcall split-window-preferred-function window)
+ (error nil))))
+ (and (window-live-p new-window) new-window))))
+
+(defun window--frame-usable-p (frame)
+ "Return FRAME if it can be used to display a buffer."
+ (when (frame-live-p frame)
+ (let ((window (frame-root-window frame)))
+ ;; `frame-root-window' may be an internal window which is considered
+ ;; "dead" by `window-live-p'. Hence if `window' is not live we
+ ;; implicitly know that `frame' has a visible window we can use.
+ (unless (and (window-live-p window)
+ (or (window-minibuffer-p window)
+ ;; If the window is soft-dedicated, the frame is usable.
+ ;; Actually, even if the window is really dedicated,
+ ;; the frame is still usable by splitting it.
+ ;; At least Emacs-22 allowed it, and it is desirable
+ ;; when displaying same-frame windows.
+ nil ; (eq t (window-dedicated-p window))
+ ))
+ frame))))
+
+(defcustom even-window-heights t
+ "If non-nil `display-buffer' will try to even window heights.
+Otherwise `display-buffer' will leave the window configuration
+alone. Heights are evened only when `display-buffer' chooses a
+window that appears above or below the selected window."
+ :type 'boolean
+ :group 'windows)
+
+(defun window--even-window-heights (window)
+ "Even heights of WINDOW and selected window.
+Do this only if these windows are vertically adjacent to each
+other, `even-window-heights' is non-nil, and the selected window
+is higher than WINDOW."
+ (when (and even-window-heights
+ (not (eq window (selected-window)))
+ ;; Don't resize minibuffer windows.
+ (not (window-minibuffer-p (selected-window)))
+ (> (window-height (selected-window)) (window-height window))
+ (eq (window-frame window) (window-frame (selected-window)))
+ (let ((sel-edges (window-edges (selected-window)))
+ (win-edges (window-edges window)))
+ (and (= (nth 0 sel-edges) (nth 0 win-edges))
+ (= (nth 2 sel-edges) (nth 2 win-edges))
+ (or (= (nth 1 sel-edges) (nth 3 win-edges))
+ (= (nth 3 sel-edges) (nth 1 win-edges))))))
+ (let ((window-min-height 1))
+ ;; Don't throw an error if we can't even window heights for
+ ;; whatever reason.
+ (condition-case nil
+ (enlarge-window (/ (- (window-height window) (window-height)) 2))
+ (error nil)))))
+
+(defun window--display-buffer-1 (window)
+ "Raise the frame containing WINDOW.
+Do not raise the selected frame. Return WINDOW."
+ (let* ((frame (window-frame window))
+ (visible (frame-visible-p frame)))
+ (unless (or (not visible)
+ ;; Assume the selected frame is already visible enough.
+ (eq frame (selected-frame))
+ ;; Assume the frame from which we invoked the minibuffer
+ ;; is visible.
+ (and (minibuffer-window-active-p (selected-window))
+ (eq frame (window-frame (minibuffer-selected-window)))))
+ (raise-frame frame))
+ window))
+
+(defun window--display-buffer-2 (buffer window &optional dedicated)
+ "Display BUFFER in WINDOW and make its frame visible.
+Set `window-dedicated-p' to DEDICATED if non-nil.
+Return WINDOW."
+ (when (and (buffer-live-p buffer) (window-live-p window))
+ (set-window-buffer window buffer)
+ (when dedicated
+ (set-window-dedicated-p window dedicated))
+ (window--display-buffer-1 window)))
+
+(defvar display-buffer-mark-dedicated nil
+ "If non-nil, `display-buffer' marks the windows it creates as dedicated.
+The actual non-nil value of this variable will be copied to the
+`window-dedicated-p' flag.")
+
+(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
+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."
+ (if buffer-or-name
+ (or (get-buffer buffer-or-name)
+ (let ((buffer (get-buffer-create buffer-or-name)))
+ (set-buffer-major-mode buffer)
+ buffer))
+ (current-buffer)))
+
+(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 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)
+
+(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)
+
+(defconst display-buffer-fallback-action
+ '((display-buffer--maybe-same-window
+ display-buffer-reuse-window
+ display-buffer--special
+ display-buffer--maybe-pop-up-frame-or-window
+ display-buffer-use-some-window
+ ;; If all else fails, pop up a new frame.
+ display-buffer-pop-up-frame))
+ "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."
+ (catch 'match
+ (dolist (entry alist)
+ (let ((key (car entry))
+ (value (cdr entry)))
+ (when (or (and (stringp key)
+ (string-match-p key buffer-name))
+ (and (symbolp key) (functionp key)
+ (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--special
+ 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, 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.
+
+Optional argument ACTION should have the form (FUNCTION . ALIST).
+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 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:
+
+ `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
+other than the selected one, even if it is already displayed in
+the selected window. If called interactively with a prefix
+argument, ACTION is t.
+
+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))
+ ;; Handle the old form of the first argument.
+ (inhibit-same-window (and action (not (listp action)))))
+ (unless (listp action) (setq action nil))
+ (if display-buffer-function
+ ;; If `display-buffer-function' is defined, let it do the job.
+ (funcall display-buffer-function buffer inhibit-same-window)
+ ;; Otherwise, use the defined actions.
+ (let* ((user-action
+ (display-buffer-assq-regexp (buffer-name buffer)
+ display-buffer-alist))
+ ;; Extra actions from the arguments to this function:
+ (extra-action
+ (cons nil (append (if inhibit-same-window
+ '((inhibit-same-window . t)))
+ (if frame
+ `((reusable-frames . ,frame))))))
+ ;; Construct action function list and action alist.
+ (actions (list display-buffer-overriding-action
+ user-action action extra-action
+ display-buffer-base-action
+ display-buffer-fallback-action))
+ (functions (apply 'append
+ (mapcar (lambda (x)
+ (setq x (car x))
+ (if (functionp x) (list x) x))
+ actions)))
+ (alist (apply 'append (mapcar 'cdr actions)))
+ window)
+ (unless (buffer-live-p buffer)
+ (error "Invalid buffer"))
+ (while (and functions (not window))
+ (setq window (funcall (car functions) buffer alist)
+ functions (cdr functions)))
+ window))))
+
+(defun display-buffer-other-frame (buffer)
+ "Display buffer BUFFER in another frame.
+This uses the function `display-buffer' as a subroutine; see
+its documentation for additional customization information."
+ (interactive "BDisplay buffer in other frame: ")
+ (display-buffer buffer display-buffer--other-frame-action t))
+
+;;; `display-buffer' action functions:
+
+(defun display-buffer-same-window (buffer alist)
+ "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 (selected-window) buffer)
+ (window--display-buffer-2 buffer (selected-window))))
+
+(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.
+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 buffer)
+ (window--display-buffer-1 window))))
+
+(defun display-buffer--special (buffer alist)
+ "Try to display BUFFER using `special-display-function'.
+Call `special-display-p' on BUFFER's name, and if that returns
+non-nil, call `special-display-function' on BUFFER."
+ (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))))))
+
+(defun display-buffer-pop-up-frame (buffer alist)
+ "Display BUFFER in a new frame.
+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 'frame window buffer)
+ (window--display-buffer-2 buffer window)
+ ;; Reset list of WINDOW's previous buffers to nil.
+ (set-window-prev-buffers window nil)
+ window)))
+
+(defun display-buffer-pop-up-window (buffer alist)
+ "Display BUFFER by popping up a new window.
+The new window is created on the selected frame, or in
+`last-nonminibuffer-frame' if no windows can be created there.
+If sucessful, return the new window; otherwise return nil."
+ (let ((frame (or (window--frame-usable-p (selected-frame))
+ (window--frame-usable-p (last-nonminibuffer-frame))))
+ window)
+ (when (and (or (not (frame-parameter frame 'unsplittable))
+ ;; If the selected frame cannot be split, look at
+ ;; `last-nonminibuffer-frame'.
+ (and (eq frame (selected-frame))
+ (setq frame (last-nonminibuffer-frame))
+ (window--frame-usable-p frame)
+ (not (frame-parameter frame 'unsplittable))))
+ ;; Attempt to split largest or least recently used window.
+ (setq window (or (window--try-to-split-window
+ (get-largest-window frame t))
+ (window--try-to-split-window
+ (get-lru-window frame t)))))
+ (display-buffer-record-window 'window window buffer)
+ (window--display-buffer-2 buffer window)
+ ;; Reset list of WINDOW's previous buffers to nil.
+ (set-window-prev-buffers window nil)
+ window)))
+
+(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.
+Search for a usable window, set that window to the buffer, and
+return the window. If no suitable window is found, return nil."
+ (let* ((not-this-window (cdr (assq 'inhibit-same-window alist)))
+ (window-to-undedicate
+ ;; When NOT-THIS-WINDOW is non-nil, temporarily dedicate the
+ ;; selected window to its buffer, to prevent any of the
+ ;; `get-' routines below from choosing it. (Bug#1415)
+ (and not-this-window (not (window-dedicated-p))
+ (set-window-dedicated-p (selected-window) t)
+ (selected-window)))
+ (frame (or (window--frame-usable-p (selected-frame))
+ (window--frame-usable-p (last-nonminibuffer-frame))))
+ window)
+ (unwind-protect
+ (setq window
+ ;; Reuse an existing window.
+ (or (get-lru-window frame)
+ (let ((window (get-buffer-window buffer 'visible)))
+ (unless (and not-this-window
+ (eq window (selected-window)))
+ window))
+ (get-largest-window 'visible)
+ (let ((window (get-buffer-window buffer 0)))
+ (unless (and not-this-window
+ (eq window (selected-window)))
+ window))
+ (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 'reuse window buffer)
+ (window--even-window-heights window)
+ (window--display-buffer-2 buffer window))))
+
+;;; Display + selection commands:
+
+(defun pop-to-buffer (buffer &optional action norecord)
+ "Select buffer BUFFER in some window, preferably a different one.
+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.
+
+This uses `display-buffer' as a subroutine. The optional ACTION
+argument is passed to `display-buffer' as its ACTION argument.
+See `display-buffer' for more information. ACTION is t if called
+interactively with a prefix argument, which means to pop to a
+window other than the selected one even if the buffer is already
+displayed in the selected window.
+
+If the window to show BUFFER is not on the selected
+frame, raise that window's frame and give it input focus.
+
+Optional third arg NORECORD non-nil means do not put this buffer
+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-switch-to buffer))
+ (set-buffer buffer)
+ (let* ((old-window (selected-window))
+ (old-frame (selected-frame))
+ (window (display-buffer buffer action))
+ (frame (window-frame window)))
+ ;; 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--special
+ 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.
+
+This function is intended for the `switch-to-buffer' family of
+commands since these need to omit the name of the current buffer
+from the list of completions and default values."
+ (let ((rbts-completion-table (internal-complete-buffer-except)))
+ (minibuffer-with-setup-hook
+ (lambda ()
+ (setq minibuffer-completion-table rbts-completion-table)
+ ;; Since rbts-completion-table is built dynamically, we
+ ;; can't just add it to the default value of
+ ;; icomplete-with-completion-tables, so we add it
+ ;; here manually.
+ (if (and (boundp 'icomplete-with-completion-tables)
+ (listp icomplete-with-completion-tables))
+ (set (make-local-variable 'icomplete-with-completion-tables)
+ (cons rbts-completion-table
+ icomplete-with-completion-tables))))
+ (read-buffer prompt (other-buffer (current-buffer))
+ (confirm-nonexistent-file-or-buffer)))))
+
+(defun window-normalize-buffer-to-switch-to (buffer-or-name)
+ "Normalize BUFFER-OR-NAME argument of buffer switching functions.
+If BUFFER-OR-NAME is nil, return the buffer returned by
+`other-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."
+ (if buffer-or-name
+ (or (get-buffer buffer-or-name)
+ (let ((buffer (get-buffer-create buffer-or-name)))
+ (set-buffer-major-mode buffer)
+ buffer))
+ (other-buffer)))
+
+(defun switch-to-buffer (buffer-or-name &optional norecord force-same-window)
+ "Switch to buffer BUFFER-OR-NAME in the selected window.
+If called interactively, prompt for the buffer name using the
+minibuffer. The variable `confirm-nonexistent-file-or-buffer'
+determines whether to request confirmation before creating a new
+buffer.
+
+BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
+nil. If BUFFER-OR-NAME is a string that does not identify an
+existing buffer, create a buffer with that name. If
+BUFFER-OR-NAME is nil, switch to the buffer returned by
+`other-buffer'.
+
+Optional argument NORECORD non-nil means do not put the buffer
+specified by BUFFER-OR-NAME at the front of the buffer list and
+do not make the window displaying it the most recently selected
+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.
+
+Return the buffer switched to."
+ (interactive
+ (list (read-buffer-to-switch "Switch to buffer: ") nil nil))
+ (let ((buffer (window-normalize-buffer-to-switch-to buffer-or-name)))
+ (if (null force-same-window)
+ (pop-to-buffer buffer display-buffer--same-window-action norecord)
(cond
- ((stringp entry)
- (display-buffer-alist-add
- `((name . ,entry))
- (list 'reuse-window (list 'reuse-window 'same))
- no-custom))
- ((consp entry)
- (display-buffer-alist-add
- `((name . ,(car entry)))
- (list 'reuse-window (list 'reuse-window 'same))
- no-custom))))
-
- ;; `reuse-window'
- (display-buffer-alist-add
- nil
- (list
- 'reuse-window
- (list 'reuse-window nil 'same
- (when (or display-buffer-reuse-frames pop-up-frames)
- ;; "0" (all visible and iconified frames) is hardcoded in
- ;; Emacs 23.
- 0))
- (unless (memq even-window-heights '(nil unset))
- (cons 'reuse-window-even-sizes t)))
- no-custom)
-
- ;; `display-buffer-mark-dedicated'
- (when display-buffer-mark-dedicated
- (display-buffer-alist-add
- nil
- (list
- (cons 'dedicated display-buffer-mark-dedicated))
- no-custom)))
-
- display-buffer-alist)
+ ;; Don't call set-window-buffer if it's not needed since it
+ ;; might signal an error (e.g. if the window is dedicated).
+ ((eq buffer (window-buffer)))
+ ((window-minibuffer-p)
+ (error "Cannot switch buffers in minibuffer window"))
+ ((eq (window-dedicated-p) t)
+ (error "Cannot switch buffers in a dedicated window"))
+ (t (set-window-buffer nil buffer)))
+
+ (unless norecord
+ (select-window (selected-window)))
+ (set-buffer buffer))))
+
+(defun switch-to-buffer-other-window (buffer-or-name &optional norecord)
+ "Select the buffer specified by BUFFER-OR-NAME in another window.
+BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
+nil. Return the buffer switched to.
+
+If called interactively, prompt for the buffer name using the
+minibuffer. The variable `confirm-nonexistent-file-or-buffer'
+determines whether to request confirmation before creating a new
+buffer.
+
+If BUFFER-OR-NAME is a string and does not identify an existing
+buffer, create a new buffer with that name. If BUFFER-OR-NAME is
+nil, switch to the buffer returned by `other-buffer'.
+
+Optional second argument NORECORD non-nil means do not put this
+buffer at the front of the list of recently selected ones.
+
+This uses the function `display-buffer' as a subroutine; see its
+documentation for additional customization information."
+ (interactive
+ (list (read-buffer-to-switch "Switch to buffer in other window: ")))
+ (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.
+BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
+nil. Return the buffer switched to.
+
+If called interactively, prompt for the buffer name using the
+minibuffer. The variable `confirm-nonexistent-file-or-buffer'
+determines whether to request confirmation before creating a new
+buffer.
+
+If BUFFER-OR-NAME is a string and does not identify an existing
+buffer, create a new buffer with that name. If BUFFER-OR-NAME is
+nil, switch to the buffer returned by `other-buffer'.
+
+Optional second arg NORECORD non-nil means do not put this
+buffer at the front of the list of recently selected ones.
+
+This uses the function `display-buffer' as a subroutine; see its
+documentation for additional customization information."
+ (interactive
+ (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
+ (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.
;; window and the current buffer when we're done.
(setq window (window-normalize-live-window window))
;; Can't resize a full height or fixed-size window.
- (unless (or (window-size-fixed-p window)
+ (unless (or (window-size-fixed-p window)
(window-full-height-p window))
;; `with-selected-window' should orderly restore the current buffer.
(with-selected-window window
;; We are in WINDOW's buffer now.
- (let* ( ;; Adjust MIN-HEIGHT.
+ (let* (;; Adjust MIN-HEIGHT.
(min-height
(if override
(window-min-size window nil window)
(with-current-buffer buffer-to-kill
(remove-hook 'kill-buffer-hook delete-window-hook t))))))
-(defun quit-window (&optional kill window)
- "Quit WINDOW and bury its buffer.
-With a prefix argument, kill the buffer instead. WINDOW defaults
-to the selected window.
-
-If WINDOW is non-nil, dedicated, or a minibuffer window, delete
-it and, if it's alone on its frame, its frame too. Otherwise, or
-if deleting WINDOW fails in any of the preceding cases, display
-another buffer in WINDOW using `switch-to-buffer'.
-
-Optional argument KILL non-nil means kill WINDOW's buffer.
-Otherwise, bury WINDOW's buffer, see `bury-buffer'."
- (interactive "P")
- (let ((buffer (window-buffer window)))
- (if (or window
- (window-minibuffer-p window)
- (window-dedicated-p window))
- ;; WINDOW is either non-nil, a minibuffer window, or dedicated;
- ;; try to delete it.
- (let* ((window (or window (selected-window)))
- (frame (window-frame window)))
- (if (frame-root-window-p window)
- ;; WINDOW is alone on its frame.
- (delete-frame frame)
- ;; There are other windows on its frame, delete WINDOW.
- (delete-window window)))
- ;; Otherwise, switch to another buffer in the selected window.
- (switch-to-buffer nil))
-
- ;; Deal with the buffer.
- (if kill
- (kill-buffer buffer)
- (bury-buffer buffer))))
\f
(defvar recenter-last-op nil
"Indicates the last recenter operation performed.
(< (window-width window) t-p-w-w)
t-p-w-w))))
\f
+;; Some of these are in tutorial--default-keys, so update that if you
+;; 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)