[Emacs-diffs] /srv/bzr/emacs/trunk r108484: Clean up and simplify buffer display routines.

[martin rudalics]

------------------------------------------------------------
revno: 108484
committer: martin rudalics <address@hidden>
branch nick: trunk
timestamp: Tue 2012-06-05 11:11:06 +0200
message:
  Clean up and simplify buffer display routines.
  
  * window.el (get-lru-window, get-mru-window, get-largest-window):
  New argument NOT-SELECTED to avoid picking the selected window.
  (window--display-buffer-1, window--display-buffer-2): Replace by
  new function window--display-buffer
  (display-buffer-same-window, display-buffer-reuse-window)
  (display-buffer-pop-up-frame, display-buffer-pop-up-window): Use
  window--display-buffer.
  (display-buffer-use-some-window): Remove temporary dedication
  hack by calling get-lru-window and get-largest-window with
  NOT-SELECTED argument non-nil.  Call window--display-buffer.
modified:
  etc/NEWS
  lisp/ChangeLog
  lisp/window.el

=== modified file 'etc/NEWS'
--- a/etc/NEWS  2012-06-04 01:05:17 +0000
+++ b/etc/NEWS  2012-06-05 09:11:06 +0000
@@ -340,6 +340,9 @@
 
 ** New error type and new function `user-error'.  Doesn't trigger the debugger.
 
+** The functions get-lru-window, get-mru-window and get-largest-window
+now accept a third argument to avoid chosing the selected window.
+
 ** Completion
 
 *** New function `completion-table-with-quoting' to handle completion

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2012-06-05 01:05:51 +0000
+++ b/lisp/ChangeLog    2012-06-05 09:11:06 +0000
@@ -1,3 +1,16 @@
+2012-06-05  Martin Rudalics  <address@hidden>
+
+       * window.el (get-lru-window, get-mru-window, get-largest-window):
+       New argument NOT-SELECTED to avoid picking the selected window.
+       (window--display-buffer-1, window--display-buffer-2): Replace by
+       new function window--display-buffer
+       (display-buffer-same-window, display-buffer-reuse-window)
+       (display-buffer-pop-up-frame, display-buffer-pop-up-window): Use
+       window--display-buffer.
+       (display-buffer-use-some-window): Remove temporary dedication
+       hack by calling get-lru-window and get-largest-window with
+       NOT-SELECTED argument non-nil.  Call window--display-buffer.
+
 2012-06-05  Glenn Morris  <address@hidden>
 
        * vc/vc-sccs.el (vc-sccs-workfile-unchanged-p):

=== modified file 'lisp/window.el'
--- a/lisp/window.el    2012-06-02 10:56:09 +0000
+++ b/lisp/window.el    2012-06-05 09:11:06 +0000
@@ -1256,12 +1256,14 @@
 
 (defalias 'some-window 'get-window-with-predicate)
 
-(defun get-lru-window (&optional all-frames dedicated)
+(defun get-lru-window (&optional all-frames dedicated not-selected)
    "Return the least recently used window on frames specified by ALL-FRAMES.
 Return a full-width window if possible.  A minibuffer window is
 never a candidate.  A dedicated window is never a candidate
 unless DEDICATED is non-nil, so if all windows are dedicated, the
 value is nil.  Avoid returning the selected window if possible.
+Optional argument NOT-SELECTED non-nil means never return the
+selected window.
 
 The following non-nil values of the optional argument ALL-FRAMES
 have special meanings:
@@ -1280,7 +1282,8 @@
 selected frame and no others."
    (let (best-window best-time second-best-window second-best-time time)
     (dolist (window (window-list-1 nil 'nomini all-frames))
-      (when (or dedicated (not (window-dedicated-p window)))
+      (when (and (or dedicated (not (window-dedicated-p window)))
+                (or (not not-selected) (not (eq window (selected-window)))))
        (setq time (window-use-time window))
        (if (or (eq window (selected-window))
                (not (window-full-width-p window)))
@@ -1292,9 +1295,12 @@
            (setq best-window window)))))
     (or best-window second-best-window)))
 
-(defun get-mru-window (&optional all-frames)
+(defun get-mru-window (&optional all-frames dedicated not-selected)
    "Return the most recently used window on frames specified by ALL-FRAMES.
-Do not return a minibuffer window.
+A minibuffer window is never a candidate.  A dedicated window is
+never a candidate unless DEDICATED is non-nil, so if all windows
+are dedicated, the value is nil.  Optional argument NOT-SELECTED
+non-nil means never return the selected window.
 
 The following non-nil values of the optional argument ALL-FRAMES
 have special meanings:
@@ -1314,16 +1320,19 @@
    (let (best-window best-time time)
     (dolist (window (window-list-1 nil 'nomini all-frames))
       (setq time (window-use-time window))
-      (when (or (not best-time) (> time best-time))
+      (when (and (or dedicated (not (window-dedicated-p window)))
+                (or (not not-selected) (not (eq window (selected-window))))
+                (or (not best-time) (> time best-time)))
        (setq best-time time)
        (setq best-window window)))
     best-window))
 
-(defun get-largest-window (&optional all-frames dedicated)
+(defun get-largest-window (&optional all-frames dedicated not-selected)
   "Return the largest window on frames specified by ALL-FRAMES.
 A minibuffer window is never a candidate.  A dedicated window is
 never a candidate unless DEDICATED is non-nil, so if all windows
-are dedicated, the value is nil.
+are dedicated, the value is nil.  Optional argument NOT-SELECTED
+non-nil means never return the selected window.
 
 The following non-nil values of the optional argument ALL-FRAMES
 have special meanings:
@@ -1343,7 +1352,8 @@
   (let ((best-size 0)
        best-window size)
     (dolist (window (window-list-1 nil 'nomini all-frames))
-      (when (or dedicated (not (window-dedicated-p window)))
+      (when (and (or dedicated (not (window-dedicated-p window)))
+                (or (not not-selected) (not (eq window (selected-window)))))
        (setq size (* (window-total-size window)
                      (window-total-size window t)))
        (when (> size best-size)
@@ -4253,17 +4263,11 @@
                special-display-buffer-names special-display-regexps)
           (display-buffer buffer)))
        ;; If no window yet, make one in a new frame.
-       (let* ((frame
-              (with-current-buffer buffer
-                (make-frame (append args special-display-frame-alist))))
-             (window (frame-selected-window frame)))
-        (display-buffer-record-window 'frame window buffer)
-         ;; FIXME: Use window--display-buffer-2?
-        (set-window-buffer window buffer)
-        ;; Reset list of WINDOW's previous buffers to nil.
-        (set-window-prev-buffers window nil)
-        (set-window-dedicated-p window t)
-        window)))))
+       (let ((frame
+             (with-current-buffer buffer
+               (make-frame (append args special-display-frame-alist)))))
+        (window--display-buffer
+         buffer (frame-selected-window frame) 'frame t))))))
 
 (defcustom special-display-function 'special-display-popup-frame
   "Function to call for displaying special buffers.
@@ -4574,30 +4578,34 @@
          (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)
+(defun window--display-buffer (buffer window type &optional dedicated)
   "Display BUFFER in WINDOW and make its frame visible.
-Set `window-dedicated-p' to DEDICATED if non-nil.
-Return WINDOW."
+TYPE must be one of the symbols `reuse', `window' or `frame' and
+is passed unaltered to `display-buffer-record-window'. Set
+`window-dedicated-p' to DEDICATED if non-nil.  Return WINDOW if
+BUFFER and WINDOW are live."
   (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)))
+    (let* ((frame (window-frame window))
+          (visible (frame-visible-p frame)))
+      (unless (eq buffer (window-buffer window))
+       (set-window-dedicated-p window nil)
+       (display-buffer-record-window type window buffer)
+       (set-window-buffer window buffer)
+       (when dedicated
+         (set-window-dedicated-p window dedicated))
+       (when (memq type '(window frame))
+         (set-window-prev-buffers window nil)))
+
+      (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)))
 
 ;; FIXME: Not implemented.
 ;; FIXME: By the way, there could be more levels of dedication:
@@ -4819,8 +4827,7 @@
   (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))))
+    (window--display-buffer buffer (selected-window) 'reuse)))
 
 (defun display-buffer--maybe-same-window (buffer alist)
   "Conditionally display BUFFER in the selected window.
@@ -4864,8 +4871,7 @@
                              (get-buffer-window-list buffer 'nomini
                                                      frames))))))
     (when window
-      (display-buffer-record-window 'reuse window buffer)
-      (window--display-buffer-1 window))))
+      (window--display-buffer buffer window 'reuse))))
 
 (defun display-buffer--special-action (buffer)
   "Return special display action for BUFFER, if any.
@@ -4891,11 +4897,8 @@
     (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 display-buffer-mark-dedicated)
-      ;; Reset list of WINDOW's previous buffers to nil.
-      (set-window-prev-buffers window nil)
-      window)))
+      (window--display-buffer
+       buffer window 'frame display-buffer-mark-dedicated))))
 
 (defun display-buffer-pop-up-window (buffer _alist)
   "Display BUFFER by popping up a new window.
@@ -4917,11 +4920,8 @@
                                 (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 display-buffer-mark-dedicated)
-      ;; Reset list of WINDOW's previous buffers to nil.
-      (set-window-prev-buffers window nil)
-      window)))
+      (window--display-buffer
+       buffer window 'window display-buffer-mark-dedicated))))
 
 (defun display-buffer--maybe-pop-up-frame-or-window (buffer alist)
   "Try displaying BUFFER based on `pop-up-frames' or `pop-up-windows'.
@@ -4943,40 +4943,26 @@
 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)))
+        (window
+         ;; Reuse an existing window.
+         (or (get-lru-window frame nil not-this-window)
+             (let ((window (get-buffer-window buffer 'visible)))
+               (unless (and not-this-window
+                            (eq window (selected-window)))
+                 window))
+             (get-largest-window 'visible nil not-this-window)
+             (let ((window (get-buffer-window buffer 0)))
+               (unless (and not-this-window
+                            (eq window (selected-window)))
+                 window))
+             (get-largest-window 0 not-this-window))))
     (when window
-      (display-buffer-record-window 'reuse window buffer)
       (window--even-window-heights window)
-      (window--display-buffer-2 buffer window))))
+      (window--display-buffer buffer window 'reuse))))
 
 ;;; 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