;;; winner.el --- Restore old window configurations
-;; Copyright (C) 1997, 1998, 2001, 2004 Free Software Foundation. Inc.
+;; Copyright (C) 1997-1998, 2001-2013 Free Software Foundation, Inc.
;; Author: Ivar Rummelhoff <ivarru@math.uio.no>
;; Created: 27 Feb 1997
-;; Time-stamp: <2002-02-20 22:06:58 ivarru>
;; Keywords: convenience frames
;; This file is part of GNU Emacs.
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 2, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; 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.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
-(eval-when-compile
- (require 'cl))
+(eval-when-compile (require 'cl-lib))
-(eval-when-compile
- (cond
- ((eq (aref (emacs-version) 0) ?X)
- (defmacro winner-active-region ()
- '(region-active-p))
- (defsetf winner-active-region () (store)
- `(if ,store (zmacs-activate-region)
- (zmacs-deactivate-region))))
- (t (defmacro winner-active-region ()
- 'mark-active)
- (defsetf winner-active-region () (store)
- `(setq mark-active ,store)))) )
-
-\f(eval-and-compile
- (cond
- ((eq (aref (emacs-version) 0) ?X)
- (defalias 'winner-edges 'window-pixel-edges)
- (defsubst winner-window-list ()
- (remq (minibuffer-window)
- (window-list nil 0))))
- (t (defalias 'winner-edges 'window-edges)
- (defsubst winner-window-list ()
- (window-list nil 0)))) )
+(defun winner-active-region ()
+ (declare (gv-setter (lambda (store)
+ (if (featurep 'xemacs)
+ `(if ,store (zmacs-activate-region)
+ (zmacs-deactivate-region))
+ `(if ,store (activate-mark) (deactivate-mark))))))
+ (region-active-p))
-(require 'ring)
+(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))))
-(unless (fboundp 'defgroup)
- (defmacro defgroup (&rest rest)))
+(require 'ring)
(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.
-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)))
- :initialize 'custom-initialize-default
- :type 'boolean
- :group 'winner
- :require 'winner)
-
(defcustom winner-dont-bind-my-keys nil
- "If non-nil: Do not use `winner-mode-map' in Winner mode."
+ "Non-nil means do not bind keys in Winner mode."
:type 'boolean
:group 'winner)
:group 'winner)
(defcustom winner-boring-buffers '("*Completions*")
- "`winner-undo' will not restore windows displaying any of these \
-buffers.
+ "List of buffer names whose windows `winner-undo' will not restore.
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)
+\f
+;;;; Saving old configurations (internal variables and subroutines)
;;; Current configuration
(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)))))
+ (cl-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))))
+ (cl-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.
;; Consult `winner-currents'.
(defun winner-configuration (&optional frame)
(or (cdr (assq (or frame (selected-frame)) winner-currents))
- (letf (((selected-frame) frame))
+ (with-selected-frame frame
(winner-conf))))
;;; Saved configurations
-;; This variable contains the window cofiguration rings.
+;; This variable contains the window configuration rings.
;; The key in this alist is the frame.
(defvar winner-ring-alist nil)
;; 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)))
-\f;; If the same command is called several times in a row,
+\f
+;; If the same command is called several times in a row,
;; we only save one window configuration.
(defvar winner-last-command nil)
(defvar winner-last-frames nil)
-(defun winner-equal (a b)
+(defsubst winner-equal (a b)
"Check whether two Winner configurations (as produced by
`winner-conf') are equal."
(equal (cdr a) (cdr b)))
-\f;;;; Restoring configurations
+\f
+;;;; Restoring configurations
;; Works almost as `set-window-configuration',
;; but does not change the contents or the size of the minibuffer,
(let* ((miniwin (minibuffer-window))
(chosen (selected-window))
(minisize (window-height miniwin)))
- (letf (((window-buffer miniwin))
- ((window-point miniwin)))
+ (cl-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) )
+ (with-selected-window miniwin
(setf (window-height) minisize)))))
;; 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)))
+ (save-current-buffer
+ (cl-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.
+ ;; Returns nil if buf no longer exists.
(when (buffer-name buf)
(let ((entry (assq buf winner-point-alist)))
(cond
(entry
(or (cdr (assq win (cddr entry)))
(cdr (assq nil (cddr entry)))
- (letf (((current-buffer) buf))
+ (with-current-buffer buf
(push (cons nil (point)) (cddr entry))
(point))))
- (t (letf (((current-buffer) buf))
+ (t (with-current-buffer buf
(push (list buf
(cons (mark t) (winner-active-region))
(cons nil (point)))
winner-point-alist)
(point)))))))
-\f;; Make sure point does not end up in the minibuffer and delete
+\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
+;; (c.f. `winner-boring-buffers'). Return nil if 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)))
+ (cl-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
(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)))))
+ (save-current-buffer
+ (cl-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)
;;;; Winner mode (a minor mode)
(defcustom winner-mode-hook nil
- "Functions to run whenever Winner mode is turned on."
+ "Functions to run whenever Winner mode is turned on or off."
:type 'hook
:group 'winner)
-(defcustom winner-mode-leave-hook nil
+(define-obsolete-variable-alias 'winner-mode-leave-hook
+ 'winner-mode-off-hook "24.3")
+
+(defcustom winner-mode-off-hook nil
"Functions to run whenever Winner mode is turned off."
:type 'hook
:group 'winner)
-(defvar winner-mode-map nil "Keymap for Winner mode.")
+(defvar winner-mode-map
+ (let ((map (make-sparse-keymap)))
+ (unless winner-dont-bind-my-keys
+ (define-key map [(control c) left] 'winner-undo)
+ (define-key map [(control c) right] 'winner-redo))
+ map)
+ "Keymap for Winner mode.")
;; Check if `window-configuration-change-hook' is working.
(defun winner-hook-installed-p ()
\f
;;;###autoload
-(defun winner-mode (&optional arg)
- "Toggle Winner mode.
-With arg, turn Winner mode on if and only if arg is positive."
- (interactive "P")
- (let ((on-p (if arg (> (prefix-numeric-value arg) 0)
- (not winner-mode))))
- (cond
- ;; Turn mode on
- (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-conditionally)))
- (add-hook 'minibuffer-setup-hook 'winner-save-unconditionally)
- (setq winner-modified-list (frame-list))
- (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-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"))))))
+(define-minor-mode winner-mode nil :global t ; let d-m-m make the doc
+ (if winner-mode
+ (progn
+ (if (winner-hook-installed-p)
+ (progn
+ (add-hook 'window-configuration-change-hook 'winner-change-fun)
+ (add-hook 'post-command-hook 'winner-save-old-configurations))
+ (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))
+ (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-conditionally)
+ (remove-hook 'minibuffer-setup-hook 'winner-save-unconditionally)))
;; 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.
(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
+ (cl-incf winner-undo-counter) ; starting at 1
(when (and (winner-undo-this)
(not (window-minibuffer-p (selected-window))))
(message "Winner undo (%d / %d)"
-\f(defun winner-undo-this () ; The heart of winner undo.
- (loop
+\f
+(defun winner-undo-this () ; The heart of winner undo.
+ (cl-loop
(cond
((>= winner-undo-counter (ring-length winner-pending-undo-ring))
(message "No further window configuration undo information")
- (return nil))
+ (cl-return nil))
((and ; If possible configuration
(winner-set (ring-ref winner-pending-undo-ring
(let ((data (winner-win-data)))
(and (not (member data winner-undone-data))
(push data winner-undone-data))))
- (return t)) ; .. then everything is fine.
+ (cl-return t)) ; .. then everything is fine.
(t ;; Otherwise, discharge it (and try the next one).
(ring-remove winner-pending-undo-ring winner-undo-counter)))))
(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:
-
-(unless winner-mode-map
- (setq winner-mode-map (make-sparse-keymap))
- (define-key winner-mode-map [(control c) left] 'winner-undo)
- (define-key winner-mode-map [(control c) right] 'winner-redo))
-
-(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))
+ (t (error "Previous command was not a `winner-undo'"))))
(provide 'winner)
-
-;;; arch-tag: 686d1c1b-010e-42ca-a192-b5685112418f
;;; winner.el ends here
HCoop / bpt / emacs.git / blobdiff