-;;; winner.el --- Restore old window configurations
+;;; winner.el --- Restore old window configurations
-;; Copyright (C) 1997, 1998 Free Software Foundation. Inc.
+;; Copyright (C) 1997, 1998, 2001, 2002, 2003, 2004,
+;; 2005, 2006 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-03-05 19:01:37 ivarr>
-;; Keywords: windows
+;; Time-stamp: <2006-02-06 15:13:57 ttn>
+;; Keywords: convenience frames
;; This file is part of GNU Emacs.
;; 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:
;; Winner mode is a global minor mode that records the changes in the
;; window configuration (i.e. how the frames are partitioned into
-;; windows). This way the changes can be "undone" using the function
+;; 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.
-\f;;; Code:
+;; Winner mode was improved August 1998.
+;; Further improvements February 2002.
+
+;;; Code:
+
+(eval-when-compile
+ (require 'cl))
+
+
+(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))
+ `(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))))
-(eval-when-compile (require 'cl))
(require 'ring)
-(when (fboundp 'defgroup)
- (defgroup winner nil ; Customization by Dave Love
- "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
(defcustom winner-mode nil
- "Toggle winner-mode.
-This variable should be set only with \\[customize], which is equivalent
-to using the function `winner-mode'."
- :set #'(lambda (symbol value)
- (winner-mode (or value 0)))
+ "Toggle Winner mode.
+Setting this variable directly does not take effect;
+use either \\[customize] or the function `winner-mode'."
+ :set #'(lambda (symbol value) (funcall symbol (or value 0)))
:initialize 'custom-initialize-default
:type 'boolean
:group 'winner
: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)
+
+
+
+
+\f
+;;;; 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)))))
-\f;;;; Internal variables and subroutines
+(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
+;; every time it changes.
+(defvar winner-currents nil)
+
+;; The current configuration (+ the buffers involved).
+(defsubst winner-conf ()
+ (cons (current-window-configuration)
+ (winner-win-data)))
+
+
+;; Save current configuration.
+;; (Called below by `winner-save-old-configurations').
+(defun winner-remember ()
+ (let ((entry (assq (selected-frame) winner-currents)))
+ (if entry (setcdr entry (winner-conf))
+ (push (cons (selected-frame) (winner-conf))
+ winner-currents))))
+
+;; Consult `winner-currents'.
+(defun winner-configuration (&optional frame)
+ (or (cdr (assq (or frame (selected-frame)) winner-currents))
+ (letf (((selected-frame) frame))
+ (winner-conf))))
+
+
+
+;;; Saved configurations
;; This variable contains the window cofiguration rings.
;; The key in this alist is the frame.
;; 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)))
-(defvar winner-last-saviour nil)
+\f
+;; 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 and return
-;; frame, else return nil. If the last change was due to the same
-;; command, save only the latest configuration.
+
+;; Save the current window configuration, if it has changed.
+;; If so return frame, otherwise return nil.
(defun winner-insert-if-new (frame)
- (let ((conf (winner-configuration))
- (ring (winner-ring frame)))
- (cond
- ((winner-equal conf (ring-ref ring 0)) nil)
- (t (when (and (eq this-command (car winner-last-saviour))
- (memq frame (cdr winner-last-saviour)))
- (ring-remove ring 0))
- (ring-insert ring conf)
- frame))))
+ (unless (or (memq frame winner-last-frames)
+ (eq this-command 'winner-redo))
+ (let ((conf (winner-configuration frame))
+ (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)))
+
-(defvar winner-modified-list nil) ; Which frames have changed?
-;; This function is called when the window configuration changes.
+;;; 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
-(defun winner-save-new-configurations ()
- (setq winner-last-saviour
- (cons this-command
- (mapcar 'winner-insert-if-new winner-modified-list)))
- (setq winner-modified-list nil))
-
-;; For compatibility with other emacsen.
+;; A `post-command-hook' for emacsen with
+;; `window-configuration-change-hook'.
+(defun winner-save-old-configurations ()
+ (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 ()
- (setq winner-last-saviour
- (cons this-command
- (list (winner-insert-if-new (selected-frame))))))
+ (unless (eq this-command winner-last-command)
+ (setq winner-last-frames nil)
+ (setq winner-last-command this-command))
+ (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)))
+
-;; Arrgh. This is storing the same information twice.
-(defun winner-configuration (&optional frame)
- (if frame (letf (((selected-frame) frame)) (winner-configuration))
- (cons (current-window-configuration)
- (loop for w being the windows
- collect (window-buffer w)))))
\f
-;; The same as `set-window-configuration',
-;; but doesn't touch the minibuffer.
+;;;; Restoring configurations
+
+;; Works almost as `set-window-configuration',
+;; 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 ((min-sel (window-minibuffer-p (selected-window)))
- (minibuf (window-buffer (minibuffer-window)))
- (minipoint (letf ((selected-window) (minibuffer-window))
- (point)))
- win)
- (set-window-configuration winconf)
- (setq win (selected-window))
- (select-window (minibuffer-window))
- (set-window-buffer (minibuffer-window) minibuf)
- (goto-char minipoint)
+ (let* ((miniwin (minibuffer-window))
+ (chosen (selected-window))
+ (minisize (window-height miniwin)))
+ (letf (((window-buffer miniwin))
+ ((window-point miniwin)))
+ (set-window-configuration winconf))
(cond
- (min-sel)
- ((window-minibuffer-p win)
- (other-window 1))
- (t (select-window win)))))
-
-(defun winner-win-data () ; Information about the windows
- (loop for win being the windows
- unless (window-minibuffer-p win)
- collect (list (window-buffer win)
- (window-width win)
- (window-height win))))
-
-;; 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.
-(defun winner-set (conf)
- (let ((origpoints
- (save-excursion
- (loop for buf in (cdr conf)
- collect (if (buffer-name buf)
- (progn (set-buffer buf) (point))
- nil)))))
- (winner-set-conf (car conf))
- (let* ((win (selected-window))
- (xwins (loop for window being the windows
- for pos in origpoints
- unless (window-minibuffer-p window)
- if pos do (progn (select-window window)
- (goto-char pos))
- else collect window)))
- (select-window win)
- ;; Return t if possible configuration
+ ((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)
+;; `set-window-configuration' restores old points and marks. This is
+;; not what we want, so we make a list of the "real" (i.e. new) points
+;; and marks before undoing window configurations.
+;;
+;; Format of entries: (buffer (mark . mark-active) (window . point) ..)
+
+(defun winner-make-point-alist ()
+ (letf (((current-buffer)))
+ (loop with 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
- ((null xwins) t)
- ((progn (mapcar 'delete-window (cdr xwins))
- (one-window-p t))
- nil) ; No existing buffers
- (t (delete-window (car xwins)))))))
-
+ (entry
+ (or (cdr (assq win (cddr entry)))
+ (cdr (assq nil (cddr entry)))
+ (letf (((current-buffer) buf))
+ (push (cons nil (point)) (cddr entry))
+ (point))))
+ (t (letf (((current-buffer) buf))
+ (push (list buf
+ (cons (mark t) (winner-active-region))
+ (cons nil (point)))
+ winner-point-alist)
+ (point)))))))
-
-
-\f;;;; Winner mode (a minor mode)
+\f
+;; 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)
+ (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) ; 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
+ 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 or boring.
+ ;; Return t if this is still a possible configuration.
+ (or (null xwins)
+ (progn
+ (mapc 'delete-window (cdr xwins)) ; delete all but one
+ (unless (one-window-p t)
+ (delete-window (car xwins))
+ t))))))
+
+
+
+;;;; Winner mode (a minor mode)
(defcustom winner-mode-hook nil
"Functions to run whenever Winner mode is turned on."
: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)
(split-window)
winner-var)))
+\f
;;;###autoload
(defun winner-mode (&optional arg)
"Toggle Winner mode.
(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-new-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-new-configurations)
- (run-hooks 'winner-mode-hook))
+ (winner-save-old-configurations)
+ (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-new-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-old-configurations)
+ (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"))))))
-\f;; Inspired by undo (simple.el)
-(defun winner-undo (arg)
+;; Inspired by undo (simple.el)
+
+(defvar winner-undo-frame nil)
+
+(defvar winner-pending-undo-ring nil
+ "The ring currently used by `winner-undo'.")
+(defvar winner-undo-counter nil)
+(defvar winner-undone-data nil) ; There confs have been passed.
+
+(defun winner-undo ()
"Switch back to an earlier window configuration saved by Winner mode.
-In other words, \"undo\" changes in window configuration.
-With prefix arg, undo that many levels."
- (interactive "p")
+In other words, \"undo\" changes in window configuration."
+ (interactive)
(cond
((not winner-mode) (error "Winner mode is turned off"))
- ;; ((eq (selected-window) (minibuffer-window))
- ;; (error "No winner undo from minibuffer."))
- (t (setq this-command t)
- (unless (eq last-command 'winner-undo)
- (setq winner-pending-undo-ring (winner-ring (selected-frame)))
- (setq winner-undo-counter 0)
- (setq winner-undone-data (list (winner-win-data))))
- (incf winner-undo-counter arg)
- (winner-undo-this)
- (unless (window-minibuffer-p (selected-window))
- (message "Winner undo (%d)" winner-undo-counter))
- (setq this-command 'winner-undo))))
-
-(defvar winner-pending-undo-ring nil) ; The ring currently used by
- ; undo.
-(defvar winner-undo-counter nil)
-(defvar winner-undone-data nil) ; There confs have been passed.
+ (t (unless (and (eq last-command 'winner-undo)
+ (eq winner-undo-frame (selected-frame)))
+ (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)))
+ (setq winner-undo-counter 0)
+ (setq winner-undone-data (list (winner-win-data))))
+ (incf winner-undo-counter) ; starting at 1
+ (when (and (winner-undo-this)
+ (not (window-minibuffer-p (selected-window))))
+ (message "Winner undo (%d / %d)"
+ winner-undo-counter
+ (1- (ring-length winner-pending-undo-ring)))))))
-(defun winner-undo-this () ; The heart of winner undo.
- (if (>= winner-undo-counter (ring-length winner-pending-undo-ring))
- (error "No further window configuration undo information")
- (unless (and
- ;; Possible configuration
- (winner-set
- (ring-ref winner-pending-undo-ring
- winner-undo-counter))
- ;; New configuration
- (let ((data (winner-win-data)))
- (if (member data winner-undone-data) nil
- (push data winner-undone-data))))
- (ring-remove winner-pending-undo-ring winner-undo-counter)
- (winner-undo-this))))
-
-(defun winner-redo () ; If you change your mind.
+
+
+\f
+(defun winner-undo-this () ; The heart of winner undo.
+ (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
+ (let ((data (winner-win-data)))
+ (and (not (member data winner-undone-data))
+ (push data winner-undone-data))))
+ (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."
(interactive)
(cond
((eq last-command 'winner-undo)
- (ring-remove winner-pending-undo-ring 0)
(winner-set
- (ring-remove winner-pending-undo-ring 0))
- (or (eq (selected-window) (minibuffer-window))
- (message "Winner undid undo")))
- (t (error "Previous command was not a winner-undo"))))
-
-\f;;;; To be evaluated when the package is loaded:
+ (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'"))))
-(if (fboundp 'compare-window-configurations)
- (defalias 'winner-equal 'compare-window-configurations)
- (defalias 'winner-equal 'equal))
-
-(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