X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/70afcff36300615ce5f77258faac20301833be33..ec38bb4664eacfe1d91ae56c10aa03a5d6d1ca96:/lisp/winner.el

diff --git a/lisp/winner.el b/lisp/winner.el
index 4852e2992e..0fbd0221e4 100644
--- a/lisp/winner.el
+++ b/lisp/winner.el
@@ -1,12 +1,12 @@
 ;;; winner.el --- Restore old window configurations
 
-;; Copyright (C) 1997, 1998 Free Software Foundation. Inc.
+;; Copyright (C) 1997, 1998, 2001, 2002, 2003, 2004,
+;;   2005 Free Software Foundation. Inc.
 
-;; Author: Ivar Rummelhoff <ivarr@ifi.uio.no>
-;; Maintainer: Ivar Rummelhoff <ivarr@ifi.uio.no>
+;; Author: Ivar Rummelhoff <ivarru@math.uio.no>
 ;; Created: 27 Feb 1997
-;; Time-stamp: <1998-08-21 19:51:02 ivarr>
-;; Keywords: windows
+;; Time-stamp: <2002-02-20 22:06:58 ivarru>
+;; Keywords: convenience frames
 
 ;; This file is part of GNU Emacs.
 
@@ -22,8 +22,8 @@
 
 ;; You should have received a copy of the GNU General Public License
 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
 
 ;;; Commentary:
 
@@ -31,49 +31,58 @@
 ;; window configuration (i.e. how the frames are partitioned into
 ;; windows) so that the changes can be "undone" using the command
 ;; `winner-undo'.  By default this one is bound to the key sequence
-;; ctrl-x left.  If you change your mind (while undoing), you can
-;; press ctrl-x right (calling `winner-redo').  Even though it uses
+;; ctrl-c left.  If you change your mind (while undoing), you can
+;; press ctrl-c right (calling `winner-redo').  Even though it uses
 ;; some features of Emacs20.3, winner.el should also work with
 ;; Emacs19.34 and XEmacs20, provided that the installed version of
 ;; custom is not obsolete.
 
-;; Winner mode was improved august 1998.
+;; Winner mode was improved August 1998.
+;; Further improvements February 2002.
 
 ;;; Code:
 
 (eval-when-compile
-  (require 'cl)
+  (require 'cl))
 
-  (cond
-   ((eq (aref (emacs-version) 0) ?X)
-    (defmacro winner-active-region ()
-      '(region-active-p))
-    (defsetf winner-active-region () (store)
+
+(defmacro winner-active-region ()
+  (if (fboundp 'region-active-p)
+      '(region-active-p)
+    'mark-active))
+
+(defsetf winner-active-region () (store)
+  (if (fboundp 'zmacs-activate-region)
       `(if ,store (zmacs-activate-region)
-	 (zmacs-deactivate-region))))
-   (t (defmacro winner-active-region ()
-	'mark-active)
-      (defsetf winner-active-region () (store)
-	`(setq mark-active ,store)))) )
+	 (zmacs-deactivate-region))
+    `(setq mark-active ,store)))
+
+(defalias 'winner-edges
+  (if (featurep 'xemacs) 'window-pixel-edges 'window-edges))
+(defalias 'winner-window-list
+  (if (featurep 'xemacs)
+      (lambda () (delq (minibuffer-window) (window-list nil 0)))
+    (lambda () (window-list nil 0))))
 
 (require 'ring)
 
-(when (fboundp 'defgroup)
-  (defgroup winner nil
-    "Restoring window configurations."
-    :group 'windows))
+(unless (fboundp 'defgroup)
+  (defmacro defgroup (&rest rest)))
+
+(defgroup winner nil
+  "Restoring window configurations."
+  :group 'windows)
 
 (unless (fboundp 'defcustom)
   (defmacro defcustom (symbol &optional initvalue docs &rest rest)
     (list 'defvar symbol initvalue docs)))
 
-;;;###autoload
+;;;###autoload
 (defcustom winner-mode nil
-  "Toggle winner-mode.
+  "Toggle Winner mode.
 Setting this variable directly does not take effect;
 use either \\[customize] or the function `winner-mode'."
-  :set #'(lambda (symbol value)
-	   (winner-mode (or value 0)))
+  :set #'(lambda (symbol value) (funcall symbol (or value 0)))
   :initialize 'custom-initialize-default
   :type    'boolean
   :group   'winner
@@ -89,27 +98,48 @@ use either \\[customize] or the function `winner-mode'."
   :type  'integer
   :group 'winner)
 
+(defcustom winner-boring-buffers '("*Completions*")
+  "`winner-undo' will not restore windows displaying any of these buffers.
+You may want to include buffer names such as *Help*, *Apropos*,
+*Buffer List*, *info* and *Compile-Log*."
+  :type '(repeat string)
+  :group 'winner)
+
 
 
 
+
 ;;;; Saving old configurations (internal variables and subroutines)
 
+
+;;; Current configuration
+
+;; List the windows according to their edges.
+(defun winner-sorted-window-list ()
+  (sort (winner-window-list)
+        (lambda (x y)
+          (loop for a in (winner-edges x)
+                for b in (winner-edges y)
+                while (= a b)
+                finally return (< a b)))))
+
+(defun winner-win-data ()
+  ;; Essential properties of the windows in the selected frame.
+  (loop for win in (winner-sorted-window-list)
+        collect (cons (winner-edges win) (window-buffer win))))
+
 ;; This variable is updated with the current window configuration
-;; after every command, so that when command make changes in the
-;; window configuration, the last configuration can be saved.
+;; every time it changes.
 (defvar winner-currents nil)
 
 ;; The current configuration (+ the buffers involved).
 (defsubst winner-conf ()
-  (list (current-window-configuration)
-	(loop for w being the windows
-	      unless (window-minibuffer-p w)
-	      collect (window-buffer w)) ))
-;;	(if winner-testvar (incf winner-testvar) ; For debugging purposes
-;;	  (setq winner-testvar 0))))
+  (cons (current-window-configuration)
+        (winner-win-data)))
+
 
 ;; Save current configuration.
-;; (Called by `winner-save-old-configurations' below).
+;; (Called below by `winner-save-old-configurations').
 (defun winner-remember ()
   (let ((entry (assq (selected-frame) winner-currents)))
     (if entry (setcdr entry (winner-conf))
@@ -124,6 +154,8 @@ use either \\[customize] or the function `winner-mode'."
 
 
 
+;;; Saved configurations
+
 ;; This variable contains the window cofiguration rings.
 ;; The key in this alist is the frame.
 (defvar winner-ring-alist nil)
@@ -131,21 +163,28 @@ use either \\[customize] or the function `winner-mode'."
 ;; Find the right ring.  If it does not exist, create one.
 (defsubst winner-ring (frame)
   (or (cdr (assq frame winner-ring-alist))
-      (progn
-	(let ((ring (make-ring winner-ring-size)))
-	  (ring-insert ring (winner-configuration frame))
-	  (push (cons frame ring) winner-ring-alist)
-	  ring))))
+      (let ((ring (make-ring winner-ring-size)))
+        (ring-insert ring (winner-configuration frame))
+        (push (cons frame ring) winner-ring-alist)
+        ring)))
 
-;; If the same command is called several times in a row,
+
+;; If the same command is called several times in a row,
 ;; we only save one window configuration.
 (defvar winner-last-command nil)
 
 ;; Frames affected by the previous command.
 (defvar winner-last-frames nil)
 
+
+(defsubst winner-equal (a b)
+  "Check whether two Winner configurations (as produced by
+`winner-conf') are equal."
+  (equal (cdr a) (cdr b)))
+
+
 ;; Save the current window configuration, if it has changed.
-;; Then return frame, else return nil.
+;; If so return frame, otherwise return nil.
 (defun winner-insert-if-new (frame)
   (unless (or (memq frame winner-last-frames)
 	      (eq this-command 'winner-redo))
@@ -153,38 +192,40 @@ use either \\[customize] or the function `winner-mode'."
 	  (ring (winner-ring frame)))
       (when (and (not (ring-empty-p ring))
 		 (winner-equal conf (ring-ref ring 0)))
+        ;; When the previous configuration was very similar,
+        ;; keep only the latest.
 	(ring-remove ring 0))
       (ring-insert ring conf)
       (push frame winner-last-frames)
       frame)))
 
+
+
+;;; Hooks
+
 ;; Frames affected by the current command.
 (defvar winner-modified-list nil)
 
 ;; Called whenever the window configuration changes
 ;; (a `window-configuration-change-hook').
 (defun winner-change-fun ()
-  (unless (memq (selected-frame) winner-modified-list)
+  (unless (or (memq (selected-frame) winner-modified-list)
+              (/= 0 (minibuffer-depth)))
     (push (selected-frame) winner-modified-list)))
 
-
-;; For Emacs20 (a `post-command-hook').
+;; A `post-command-hook' for emacsen with
+;; `window-configuration-change-hook'.
 (defun winner-save-old-configurations ()
-  (unless (eq this-command winner-last-command)
-    (setq winner-last-frames nil)
-    (setq winner-last-command this-command))
-  (dolist (frame winner-modified-list)
-    (winner-insert-if-new frame))
-  (setq winner-modified-list nil)
-  ;;  (ir-trace ; For debugging purposes
-  ;;   "%S"
-  ;;   (loop with ring = (winner-ring (selected-frame))
-  ;;	 for i from 0 to (1- (ring-length ring))
-  ;;	 collect (caddr (ring-ref ring i))))
-  (winner-remember))
-
-;; For compatibility with other emacsen
-;; and called by `winner-undo' before "undoing".
+  (when (zerop (minibuffer-depth))
+    (unless (eq this-command winner-last-command)
+      (setq winner-last-frames nil)
+      (setq winner-last-command this-command))
+    (dolist (frame winner-modified-list)
+      (winner-insert-if-new frame))
+    (setq winner-modified-list nil)
+    (winner-remember)))
+
+;; A `minibuffer-setup-hook'.
 (defun winner-save-unconditionally ()
   (unless (eq this-command winner-last-command)
     (setq winner-last-frames nil)
@@ -192,30 +233,35 @@ use either \\[customize] or the function `winner-mode'."
   (winner-insert-if-new (selected-frame))
   (winner-remember))
 
+;; A `post-command-hook' for other emacsen.
+;; Also called by `winner-undo' before "undoing".
+(defun winner-save-conditionally ()
+  (when (zerop (minibuffer-depth))
+    (winner-save-unconditionally)))
 
 
 
-;;;; Restoring configurations
+
+;;;; Restoring configurations
 
 ;; Works almost as `set-window-configuration',
-;; but doesn't change the contents or the size of the minibuffer.
+;; but does not change the contents or the size of the minibuffer,
+;; and tries to preserve the selected window.
 (defun winner-set-conf (winconf)
-  (let ((miniwin (minibuffer-window))
-	(minisel (window-minibuffer-p (selected-window))))
-    (let ((minibuf   (window-buffer miniwin))
-	  (minipoint (window-point  miniwin))
-	  (minisize  (window-height miniwin)))
-      (set-window-configuration winconf)
-      (setf (window-buffer miniwin) minibuf
-	    (window-point  miniwin) minipoint)
-      (when (/= minisize (window-height miniwin)) 
-	(letf (((selected-window) miniwin) )
-	  ;; Clumsy due to cl-macs-limitation
-	  (setf (window-height) minisize)))
-      (cond
-       (minisel (select-window miniwin))
-       ((window-minibuffer-p (selected-window))
-	(other-window 1))))))
+  (let* ((miniwin  (minibuffer-window))
+         (chosen   (selected-window))
+         (minisize (window-height miniwin)))
+    (letf (((window-buffer miniwin))
+           ((window-point  miniwin)))
+      (set-window-configuration winconf))
+    (cond
+     ((window-live-p chosen) (select-window chosen))
+     ((window-minibuffer-p (selected-window))
+      (other-window 1)))
+    (when (/= minisize (window-height miniwin))
+      (letf (((selected-window) miniwin) )
+        (setf (window-height) minisize)))))
+
 
 
 (defvar winner-point-alist nil)
@@ -228,24 +274,19 @@ use either \\[customize] or the function `winner-mode'."
 (defun winner-make-point-alist ()
   (letf (((current-buffer)))
     (loop with alist
-	  with entry 
-	  for win being the windows
-	  do (cond
-	      ((window-minibuffer-p win))
-	      ((setq entry (assq win alist)) 
-	       ;; Update existing entry
-	       (push (cons win (window-point win))
-		     (cddr entry)))
-	      (t;; Else create new entry
-	       (push (list (set-buffer (window-buffer win))
-			   (cons (mark t) (winner-active-region))
-			   (cons win (window-point win)))
-		     alist)))
+	  for win in (winner-window-list)
+	  for entry =
+          (or (assq (window-buffer win) alist)
+              (car (push (list (set-buffer (window-buffer win))
+                               (cons (mark t) (winner-active-region)))
+                         alist)))
+	  do (push (cons win (window-point win))
+                   (cddr entry))
 	  finally return alist)))
 
-
 (defun winner-get-point (buf win)
   ;; Consult (and possibly extend) `winner-point-alist'.
+  ;; Returns nil iff buf no longer exists.
   (when (buffer-name buf)
     (let ((entry (assq buf winner-point-alist)))
       (cond
@@ -262,44 +303,48 @@ use either \\[customize] or the function `winner-mode'."
 		  winner-point-alist)
 	    (point)))))))
 
-;; Make sure point doesn't end up in the minibuffer and
-;; delete windows displaying dead buffers.  Return nil
-;; if and only if all the windows should have been deleted.
-;; Do not move neither points nor marks.
+
+;; Make sure point does not end up in the minibuffer and delete
+;; windows displaying dead or boring buffers
+;; (c.f. `winner-boring-buffers').  Return nil iff all the windows
+;; should be deleted.  Preserve correct points and marks.
 (defun winner-set (conf)
+  ;; For the format of `conf', see `winner-conf'.
   (let* ((buffers nil)
-	 (origpoints
-	  (loop for buf in (cadr conf)
+	 (alive
+          ;; Possibly update `winner-point-alist'
+	  (loop for buf in (mapcar 'cdr (cdr conf))
 		for pos = (winner-get-point buf nil)
 		if (and pos (not (memq buf buffers)))
 		do (push buf buffers)
 		collect pos)))
     (winner-set-conf (car conf))
-    (let (xwins) ; These windows should be deleted
-      (loop for win being the windows
-	    unless (window-minibuffer-p win)
-	    do (if (pop origpoints)
-		   (setf (window-point win)
-			 ;; Restore point
-			 (winner-get-point
-			  (window-buffer win)
-			  win))
-		 (push win xwins))) ; delete this window
-      ;; Restore mark
+    (let (xwins)                        ; to be deleted
+
+      ;; Restore points
+      (dolist (win (winner-sorted-window-list))
+        (unless (and (pop alive)
+                     (setf (window-point win)
+                           (winner-get-point (window-buffer win) win))
+                     (not (member (buffer-name (window-buffer win))
+                                  winner-boring-buffers)))
+          (push win xwins)))            ; delete this window
+
+      ;; Restore marks
       (letf (((current-buffer)))
-	(loop for buf in buffers 
+	(loop for buf in buffers
 	      for entry = (cadr (assq buf winner-point-alist))
 	      do (progn (set-buffer buf)
 			(set-mark (car entry))
 			(setf (winner-active-region) (cdr entry)))))
-      ;; Delete windows, whose buffers are dead.
+      ;; Delete windows, whose buffers are dead or boring.
       ;; Return t if this is still a possible configuration.
       (or (null xwins)
-	  (progn (mapcar 'delete-window (cdr xwins))
-		 (if (one-window-p t)
-		     nil  ; No windows left
-		   (progn (delete-window (car xwins))
-			  t)))))))
+	  (progn
+            (mapc 'delete-window (cdr xwins)) ; delete all but one
+            (unless (one-window-p t)
+              (delete-window (car xwins))
+              t))))))
 
 
 
@@ -315,9 +360,14 @@ use either \\[customize] or the function `winner-mode'."
   :type 'hook
   :group 'winner)
 
-(defvar winner-mode-map nil "Keymap for Winner mode.")
+(defvar winner-mode-map
+  (let ((map (make-sparse-keymap)))
+    (define-key map [(control c) left] 'winner-undo)
+    (define-key map [(control c) right] 'winner-redo)
+    map)
+  "Keymap for Winner mode.")
 
-;; Is `window-configuration-change-hook' working?
+;; Check if `window-configuration-change-hook' is working.
 (defun winner-hook-installed-p ()
   (save-window-excursion
     (let ((winner-var nil)
@@ -326,7 +376,8 @@ use either \\[customize] or the function `winner-mode'."
       (split-window)
       winner-var)))
 
-;;;###autoload
+
+;;;###autoload
 (defun winner-mode (&optional arg)
   "Toggle Winner mode.
 With arg, turn Winner mode on if and only if arg is positive."
@@ -335,31 +386,34 @@ With arg, turn Winner mode on if and only if arg is positive."
 		(not winner-mode))))
     (cond
      ;; Turn mode on
-     (on-p 
+     (on-p
       (setq winner-mode t)
       (cond
        ((winner-hook-installed-p)
 	(add-hook 'window-configuration-change-hook 'winner-change-fun)
-	(add-hook 'post-command-hook 'winner-save-old-configurations))
-       (t (add-hook 'post-command-hook 'winner-save-unconditionally)))
+      (add-hook 'post-command-hook 'winner-save-old-configurations))
+       (t (add-hook 'post-command-hook 'winner-save-conditionally)))
+      (add-hook 'minibuffer-setup-hook 'winner-save-unconditionally)
       (setq winner-modified-list (frame-list))
       (winner-save-old-configurations)
-      (run-hooks 'winner-mode-hook))
+      (run-hooks 'winner-mode-hook)
+      (when (interactive-p) (message "Winner mode enabled")))
      ;; Turn mode off
      (winner-mode
       (setq winner-mode nil)
       (remove-hook 'window-configuration-change-hook 'winner-change-fun)
       (remove-hook 'post-command-hook 'winner-save-old-configurations)
-      (remove-hook 'post-command-hook 'winner-save-unconditionally)
-      (run-hooks 'winner-mode-leave-hook)))
-    (force-mode-line-update)))
+      (remove-hook 'post-command-hook 'winner-save-conditionally)
+      (remove-hook 'minibuffer-setup-hook 'winner-save-unconditionally)
+      (run-hooks 'winner-mode-leave-hook)
+      (when (interactive-p) (message "Winner mode disabled"))))))
 
-;; Inspired by undo (simple.el)
+;; Inspired by undo (simple.el)
 
 (defvar winner-undo-frame nil)
 
 (defvar winner-pending-undo-ring nil
-  "The ring currently used by winner undo.")
+  "The ring currently used by `winner-undo'.")
 (defvar winner-undo-counter nil)
 (defvar winner-undone-data  nil) ; There confs have been passed.
 
@@ -371,7 +425,7 @@ In other words, \"undo\" changes in window configuration."
    ((not winner-mode) (error "Winner mode is turned off"))
    (t (unless (and (eq last-command 'winner-undo)
  		   (eq winner-undo-frame (selected-frame)))
-	(winner-save-unconditionally)	; current configuration->stack
+	(winner-save-conditionally)     ; current configuration->stack
  	(setq winner-undo-frame (selected-frame))
  	(setq winner-point-alist (winner-make-point-alist))
  	(setq winner-pending-undo-ring (winner-ring (selected-frame)))
@@ -383,34 +437,28 @@ In other words, \"undo\" changes in window configuration."
  	(message "Winner undo (%d / %d)"
  		 winner-undo-counter
  		 (1- (ring-length winner-pending-undo-ring)))))))
- 
-(defun winner-win-data () 
-  ;; Essential properties of the windows in the selected frame.
-  (loop for win being the windows
- 	unless (window-minibuffer-p win)
- 	collect (list (window-buffer win)
- 		      (window-width  win)
- 		      (window-height win))))
- 
+
+
+
 
 (defun winner-undo-this ()		; The heart of winner undo.
-  (loop 
+  (loop
    (cond
     ((>= winner-undo-counter (ring-length winner-pending-undo-ring))
      (message "No further window configuration undo information")
      (return nil))
- 
+
     ((and				; If possible configuration
       (winner-set (ring-ref winner-pending-undo-ring
  			    winner-undo-counter))
-      ;; .. and new configuration
+                                        ; .. and new configuration
       (let ((data (winner-win-data)))
  	(and (not (member data winner-undone-data))
  	     (push data winner-undone-data))))
-     (return t))			; .. then everything is all right.
-    (t					; Else; discharge it and try another one.
+     (return t))			; .. then everything is fine.
+    (t ;; Otherwise, discharge it (and try the next one).
      (ring-remove winner-pending-undo-ring winner-undo-counter)))))
- 
+
 
 (defun winner-redo ()			; If you change your mind.
   "Restore a more recent window configuration saved by Winner mode."
@@ -418,30 +466,20 @@ In other words, \"undo\" changes in window configuration."
   (cond
    ((eq last-command 'winner-undo)
     (winner-set
-     (ring-remove winner-pending-undo-ring 0))
+     (if (zerop (minibuffer-depth))
+         (ring-remove winner-pending-undo-ring 0)
+       (ring-ref winner-pending-undo-ring 0)))
     (unless (eq (selected-window) (minibuffer-window))
       (message "Winner undid undo")))
-   (t (error "Previous command was not a winner-undo"))))
-
-;;; To be evaluated when the package is loaded:
-
-(if (fboundp 'compare-window-configurations)
-    (defalias 'winner-equal 'compare-window-configurations)
-  (defalias 'winner-equal 'equal))
+   (t (error "Previous command was not a `winner-undo'"))))
 
-(unless winner-mode-map
-  (setq winner-mode-map (make-sparse-keymap))
-  (define-key winner-mode-map [(control x) left] 'winner-undo)
-  (define-key winner-mode-map [(control x) right] 'winner-redo))
+;;; To be evaluated when the package is loaded:
 
 (unless (or (assq 'winner-mode minor-mode-map-alist)
 	    winner-dont-bind-my-keys)
   (push (cons 'winner-mode winner-mode-map)
 	minor-mode-map-alist))
 
-(unless (assq 'winner-mode minor-mode-alist)
-  (push '(winner-mode " Win") minor-mode-alist))
-
 (provide 'winner)
-
+;; arch-tag: 686d1c1b-010e-42ca-a192-b5685112418f
 ;;; winner.el ends here