winner.el 14 KB
Newer Older
1
;;; winner.el --- Restore old window configurations
Richard M. Stallman's avatar
Richard M. Stallman committed
2

3
;; Copyright (C) 1997-1998, 2001-2013 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4

Dave Love's avatar
Dave Love committed
5
;; Author: Ivar Rummelhoff <ivarru@math.uio.no>
Richard M. Stallman's avatar
Richard M. Stallman committed
6
;; Created: 27 Feb 1997
7
;; Keywords: convenience frames
Richard M. Stallman's avatar
Richard M. Stallman committed
8

Richard M. Stallman's avatar
Richard M. Stallman committed
9 10
;; This file is part of GNU Emacs.

11
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
15

Richard M. Stallman's avatar
Richard M. Stallman committed
16
;; GNU Emacs is distributed in the hope that it will be useful,
Richard M. Stallman's avatar
Richard M. Stallman committed
17 18 19 20 21
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
22
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
23 24

;;; Commentary:
25

26 27
;; Winner mode is a global minor mode that records the changes in the
;; window configuration (i.e. how the frames are partitioned into
28
;; windows) so that the changes can be "undone" using the command
29
;; `winner-undo'.  By default this one is bound to the key sequence
30 31
;; ctrl-c left.  If you change your mind (while undoing), you can
;; press ctrl-c right (calling `winner-redo').  Even though it uses
32 33 34 35
;; 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.

36 37
;; Winner mode was improved August 1998.
;; Further improvements February 2002.
38 39 40

;;; Code:

41 42 43 44 45 46 47
(eval-when-compile (require 'cl-lib))

(defun winner-active-region ()
  (declare (gv-setter (lambda (store)
                        (if (featurep 'xemacs)
                            `(if ,store (zmacs-activate-region)
                               (zmacs-deactivate-region))
48 49
                          `(if ,store (activate-mark) (deactivate-mark))))))
  (region-active-p))
Richard M. Stallman's avatar
Richard M. Stallman committed
50

51 52 53 54 55 56
(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))))
57

58
(require 'ring)
Richard M. Stallman's avatar
Richard M. Stallman committed
59

60 61 62
(defgroup winner nil
  "Restoring window configurations."
  :group 'windows)
63

Dave Love's avatar
Dave Love committed
64
(defcustom winner-dont-bind-my-keys nil
65
  "Non-nil means do not bind keys in Winner mode."
66
  :type  'boolean
Dave Love's avatar
Dave Love committed
67
  :group 'winner)
Richard M. Stallman's avatar
Richard M. Stallman committed
68

69 70 71
(defcustom winner-ring-size 200
  "Maximum number of stored window configurations per frame."
  :type  'integer
Dave Love's avatar
Dave Love committed
72
  :group 'winner)
Richard M. Stallman's avatar
Richard M. Stallman committed
73

74
(defcustom winner-boring-buffers '("*Completions*")
75
  "List of buffer names whose windows `winner-undo' will not restore.
76 77 78 79 80 81
You may want to include buffer names such as *Help*, *Apropos*,
*Buffer List*, *info* and *Compile-Log*."
  :type '(repeat string)
  :group 'winner)


82 83

;;;; Saving old configurations (internal variables and subroutines)
Richard M. Stallman's avatar
Richard M. Stallman committed
84

85

86
;;; Current configuration
87

88 89 90 91
;; List the windows according to their edges.
(defun winner-sorted-window-list ()
  (sort (winner-window-list)
        (lambda (x y)
92 93 94 95
          (cl-loop for a in (winner-edges x)
                   for b in (winner-edges y)
                   while (= a b)
                   finally return (< a b)))))
96

97
(defun winner-win-data ()
98
  ;; Essential properties of the windows in the selected frame.
99 100
  (cl-loop for win in (winner-sorted-window-list)
           collect (cons (winner-edges win) (window-buffer win))))
101

102
;; This variable is updated with the current window configuration
103
;; every time it changes.
104 105 106 107
(defvar winner-currents nil)

;; The current configuration (+ the buffers involved).
(defsubst winner-conf ()
108 109 110
  (cons (current-window-configuration)
        (winner-win-data)))

111 112

;; Save current configuration.
113
;; (Called below by `winner-save-old-configurations').
114 115 116 117 118 119 120 121 122
(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))
123
      (with-selected-frame frame
124 125
	(winner-conf))))

126 127


128 129
;;; Saved configurations

Juanma Barranquero's avatar
Juanma Barranquero committed
130
;; This variable contains the window configuration rings.
131
;; The key in this alist is the frame.
132
(defvar winner-ring-alist nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
133

134
;; Find the right ring.  If it does not exist, create one.
135 136
(defsubst winner-ring (frame)
  (or (cdr (assq frame winner-ring-alist))
137 138 139 140
      (let ((ring (make-ring winner-ring-size)))
        (ring-insert ring (winner-configuration frame))
        (push (cons frame ring) winner-ring-alist)
        ring)))
141

142 143

;; If the same command is called several times in a row,
144 145
;; we only save one window configuration.
(defvar winner-last-command nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
146

147 148
;; Frames affected by the previous command.
(defvar winner-last-frames nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
149

150

151
(defsubst winner-equal (a b)
152 153 154
  "Check whether two Winner configurations (as produced by
`winner-conf') are equal."
  (equal (cdr a) (cdr b)))
155 156


157
;; Save the current window configuration, if it has changed.
158
;; If so return frame, otherwise return nil.
159 160 161 162 163 164 165
(defun winner-insert-if-new (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)))
166 167
        ;; When the previous configuration was very similar,
        ;; keep only the latest.
168 169 170 171 172
	(ring-remove ring 0))
      (ring-insert ring conf)
      (push frame winner-last-frames)
      frame)))

173 174 175 176


;;; Hooks

177 178 179 180 181
;; Frames affected by the current command.
(defvar winner-modified-list nil)

;; Called whenever the window configuration changes
;; (a `window-configuration-change-hook').
182
(defun winner-change-fun ()
183 184
  (unless (or (memq (selected-frame) winner-modified-list)
              (/= 0 (minibuffer-depth)))
185
    (push (selected-frame) winner-modified-list)))
Richard M. Stallman's avatar
Richard M. Stallman committed
186

187 188
;; A `post-command-hook' for emacsen with
;; `window-configuration-change-hook'.
189
(defun winner-save-old-configurations ()
190 191 192 193 194 195 196 197 198 199
  (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'.
200
(defun winner-save-unconditionally ()
201 202 203 204 205
  (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))
206

207 208 209 210 211
;; 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)))
212 213 214



215 216

;;;; Restoring configurations
217 218

;; Works almost as `set-window-configuration',
219 220
;; but does not change the contents or the size of the minibuffer,
;; and tries to preserve the selected window.
221
(defun winner-set-conf (winconf)
222 223 224
  (let* ((miniwin  (minibuffer-window))
         (chosen   (selected-window))
         (minisize (window-height miniwin)))
225 226
    (cl-letf (((window-buffer miniwin))
              ((window-point  miniwin)))
227 228 229 230 231
      (set-window-configuration winconf))
    (cond
     ((window-live-p chosen) (select-window chosen))
     ((window-minibuffer-p (selected-window))
      (other-window 1)))
232
    (when (/= minisize (window-height miniwin))
233
      (with-selected-window miniwin
234 235
        (setf (window-height) minisize)))))

236 237 238 239 240 241 242 243 244 245


(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 ()
246
  (save-current-buffer
247 248 249 250 251 252 253 254 255 256
    (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)))
257 258 259

(defun winner-get-point (buf win)
  ;; Consult (and possibly extend) `winner-point-alist'.
Glenn Morris's avatar
Glenn Morris committed
260
  ;; Returns nil if buf no longer exists.
261 262 263 264 265 266
  (when (buffer-name buf)
    (let ((entry (assq buf winner-point-alist)))
      (cond
       (entry
	(or (cdr (assq win (cddr entry)))
	    (cdr (assq nil (cddr entry)))
267
	    (with-current-buffer buf
268 269
	      (push (cons nil (point)) (cddr entry))
	      (point))))
270
       (t (with-current-buffer buf
271 272 273 274 275 276
	    (push (list buf
			(cons (mark t) (winner-active-region))
			(cons nil (point)))
		  winner-point-alist)
	    (point)))))))

277 278

;; Make sure point does not end up in the minibuffer and delete
279
;; windows displaying dead or boring buffers
Glenn Morris's avatar
Glenn Morris committed
280
;; (c.f. `winner-boring-buffers').  Return nil if all the windows
281
;; should be deleted.  Preserve correct points and marks.
282
(defun winner-set (conf)
283
  ;; For the format of `conf', see `winner-conf'.
284
  (let* ((buffers nil)
285 286
	 (alive
          ;; Possibly update `winner-point-alist'
287 288 289 290 291
	  (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)))
292
    (winner-set-conf (car conf))
293 294 295 296 297 298 299 300 301 302 303 304
    (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
305
      (save-current-buffer
306 307 308 309 310
	(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)))))
311
      ;; Delete windows, whose buffers are dead or boring.
312 313
      ;; Return t if this is still a possible configuration.
      (or (null xwins)
314 315 316 317 318
	  (progn
            (mapc 'delete-window (cdr xwins)) ; delete all but one
            (unless (one-window-p t)
              (delete-window (car xwins))
              t))))))
319 320 321 322



;;;; Winner mode  (a minor mode)
Richard M. Stallman's avatar
Richard M. Stallman committed
323

Dave Love's avatar
Dave Love committed
324
(defcustom winner-mode-hook nil
325
  "Functions to run whenever Winner mode is turned on or off."
Dave Love's avatar
Dave Love committed
326
  :type 'hook
Dan Nicolaescu's avatar
Dan Nicolaescu committed
327
  :group 'winner)
Richard M. Stallman's avatar
Richard M. Stallman committed
328

329 330 331 332
(define-obsolete-variable-alias 'winner-mode-leave-hook
  'winner-mode-off-hook "24.3")

(defcustom winner-mode-off-hook nil
Dave Love's avatar
Dave Love committed
333 334
  "Functions to run whenever Winner mode is turned off."
  :type 'hook
Dan Nicolaescu's avatar
Dan Nicolaescu committed
335
  :group 'winner)
336

337 338
(defvar winner-mode-map
  (let ((map (make-sparse-keymap)))
339 340 341
    (unless winner-dont-bind-my-keys
      (define-key map [(control c) left] 'winner-undo)
      (define-key map [(control c) right] 'winner-redo))
342 343
    map)
  "Keymap for Winner mode.")
Richard M. Stallman's avatar
Richard M. Stallman committed
344

345 346

;;;###autoload
347 348 349
(define-minor-mode winner-mode nil :global t ; let d-m-m make the doc
  (if winner-mode
      (progn
350 351
        (add-hook 'window-configuration-change-hook 'winner-change-fun)
        (add-hook 'post-command-hook 'winner-save-old-configurations)
352 353 354 355 356 357
        (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 'minibuffer-setup-hook 'winner-save-unconditionally)))
Richard M. Stallman's avatar
Richard M. Stallman committed
358

359
;; Inspired by undo (simple.el)
Richard M. Stallman's avatar
Richard M. Stallman committed
360

361 362
(defvar winner-undo-frame nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
363
(defvar winner-pending-undo-ring nil
364
  "The ring currently used by `winner-undo'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
365 366 367
(defvar winner-undo-counter nil)
(defvar winner-undone-data  nil) ; There confs have been passed.

368
(defun winner-undo ()
369
  "Switch back to an earlier window configuration saved by Winner mode.
370 371
In other words, \"undo\" changes in window configuration."
  (interactive)
372 373
  (cond
   ((not winner-mode) (error "Winner mode is turned off"))
374 375
   (t (unless (and (eq last-command 'winner-undo)
 		   (eq winner-undo-frame (selected-frame)))
376
	(winner-save-conditionally)     ; current configuration->stack
377 378 379 380 381
 	(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))))
382
      (cl-incf winner-undo-counter)	; starting at 1
383 384 385 386 387
      (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)))))))
388 389 390



391 392

(defun winner-undo-this ()		; The heart of winner undo.
393
  (cl-loop
394 395 396
   (cond
    ((>= winner-undo-counter (ring-length winner-pending-undo-ring))
     (message "No further window configuration undo information")
397
     (cl-return nil))
398

399 400 401
    ((and				; If possible configuration
      (winner-set (ring-ref winner-pending-undo-ring
 			    winner-undo-counter))
402
                                        ; .. and new configuration
403 404 405
      (let ((data (winner-win-data)))
 	(and (not (member data winner-undone-data))
 	     (push data winner-undone-data))))
406
     (cl-return t))			; .. then everything is fine.
407
    (t ;; Otherwise, discharge it (and try the next one).
408
     (ring-remove winner-pending-undo-ring winner-undo-counter)))))
409

410 411

(defun winner-redo ()			; If you change your mind.
412 413 414 415 416
  "Restore a more recent window configuration saved by Winner mode."
  (interactive)
  (cond
   ((eq last-command 'winner-undo)
    (winner-set
417 418 419
     (if (zerop (minibuffer-depth))
         (ring-remove winner-pending-undo-ring 0)
       (ring-ref winner-pending-undo-ring 0)))
420 421
    (unless (eq (selected-window) (minibuffer-window))
      (message "Winner undid undo")))
422
   (t (error "Previous command was not a `winner-undo'"))))
423

Richard M. Stallman's avatar
Richard M. Stallman committed
424
(provide 'winner)
Richard M. Stallman's avatar
Richard M. Stallman committed
425
;;; winner.el ends here