diff options
| author | Frank Fischer <frank.fischer@mathematik.tu-chemnitz.de> | 2012-05-08 14:47:48 +0200 |
|---|---|---|
| committer | Frank Fischer <frank.fischer@mathematik.tu-chemnitz.de> | 2012-05-08 14:47:48 +0200 |
| commit | c077fcfc7fc460817ab278e0bb1d0a5258e17a28 (patch) | |
| tree | 0ff47c3a96ba92fbc7d778cfb5b5543600925898 /lib | |
| parent | d9b5b113a5fac249505235761e6e71156252e9f0 (diff) | |
Update lib/undo-tree.el to version 0.5.1
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/undo-tree.el | 1505 |
1 files changed, 1114 insertions, 391 deletions
diff --git a/lib/undo-tree.el b/lib/undo-tree.el index 4edfa9d..328edd1 100644 --- a/lib/undo-tree.el +++ b/lib/undo-tree.el @@ -1,16 +1,14 @@ - ;;; undo-tree.el --- Treat undo history as a tree - -;; Copyright (C) 2009-2011 Toby Cubitt +;; Copyright (C) 2009-2012 Free Software Foundation, Inc ;; Author: Toby Cubitt <toby-undo-tree@dr-qubit.org> -;; Version: 0.3 -;; Keywords: undo, redo, history, tree +;; Version: 0.5.1 +;; Keywords: convenience, files, undo, redo, history, tree ;; URL: http://www.dr-qubit.org/emacs.php -;; Git Repository: http://www.dr-qubit.org/git/undo-tree.git +;; Repository: http://www.dr-qubit.org/git/undo-tree.git -;; This file is NOT part of Emacs. +;; This file is part of Emacs. ;; ;; This file 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 @@ -23,7 +21,7 @@ ;; more details. ;; ;; You should have received a copy of the GNU General Public License along -;; with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. +;; with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. ;;; Commentary: @@ -76,10 +74,10 @@ ;; Quick-Start ;; =========== ;; -;; If you're the kind of person who likes jump in the car and drive, without -;; bothering to first figure out whether the button on the left dips the -;; headlights or operates the ejector seat (after all, you'll soon figure it -;; out when you push it), then here's the minimum you need to know: +;; If you're the kind of person who likes to jump in the car and drive, +;; without bothering to first figure out whether the button on the left dips +;; the headlights or operates the ejector seat (after all, you'll soon figure +;; it out when you push it), then here's the minimum you need to know: ;; ;; `undo-tree-mode' and `global-undo-tree-mode' ;; Enable undo-tree mode (either in the current buffer or globally). @@ -105,6 +103,7 @@ ;; Restore buffer state from register. ;; ;; +;; ;; In the undo-tree visualizer: ;; ;; <up> p C-p (`undo-tree-visualize-undo') @@ -119,26 +118,85 @@ ;; <right> f C-f (`undo-tree-visualize-switch-branch-right') ;; Switch to next undo-tree branch. ;; +;; <mouse-1> (`undo-tree-visualizer-mouse-set') +;; Set state to node at mouse click. +;; ;; t (`undo-tree-visualizer-toggle-timestamps') ;; Toggle display of time-stamps. ;; -;; q C-q (`undo-tree-visualizer-quit') +;; d (`undo-tree-visualizer-toggle-diff') +;; Toggle diff display. +;; +;; s (`undo-tree-visualizer-selection-mode') +;; Toggle keyboard selection mode. +;; +;; q (`undo-tree-visualizer-quit') ;; Quit undo-tree-visualizer. ;; +;; C-q (`undo-tree-visualizer-abort') +;; Abort undo-tree-visualizer. +;; ;; , < ;; Scroll left. ;; ;; . > ;; Scroll right. ;; -;; <pgup> +;; <pgup> M-v ;; Scroll up. ;; -;; <pgdown> +;; <pgdown> C-v ;; Scroll down. ;; ;; ;; +;; In visualizer selection mode: +;; +;; <up> p C-p (`undo-tree-visualizer-select-previous') +;; Select previous node. +;; +;; <down> n C-n (`undo-tree-visualizer-select-next') +;; Select next node. +;; +;; <left> b C-b (`undo-tree-visualizer-select-left') +;; Select left sibling node. +;; +;; <right> f C-f (`undo-tree-visualizer-select-right') +;; Select right sibling node. +;; +;; <pgup> M-v +;; Select node 10 above. +;; +;; <pgdown> C-v +;; Select node 10 below. +;; +;; <enter> (`undo-tree-visualizer-set') +;; Set state to selected node and exit selection mode. +;; +;; s (`undo-tree-visualizer-mode') +;; Exit selection mode. +;; +;; t (`undo-tree-visualizer-toggle-timestamps') +;; Toggle display of time-stamps. +;; +;; d (`undo-tree-visualizer-toggle-diff') +;; Toggle diff display. +;; +;; q (`undo-tree-visualizer-quit') +;; Quit undo-tree-visualizer. +;; +;; C-q (`undo-tree-visualizer-abort') +;; Abort undo-tree-visualizer. +;; +;; , < +;; Scroll left. +;; +;; . > +;; Scroll right. +;; +;; +;; +;; ;; Undo Systems ;; ============ ;; @@ -438,9 +496,12 @@ ;; diagrams, because `undo-tree-mode' includes an undo-tree visualizer which ;; draws them for you! In fact, it draws even better diagrams: it highlights ;; the node representing the current buffer state, it highlights the current -;; branch, and (by hitting "t") you can toggle the display of -;; time-stamps. (There's one other tiny difference: the visualizer puts the -;; most recent branch on the left rather than the right.) +;; branch, and you can toggle the display of time-stamps (by hitting "t") and +;; a diff of the undo changes (by hitting "d"). (There's one other tiny +;; difference: the visualizer puts the most recent branch on the left rather +;; than the right.) +;; +;; Bring up the undo tree visualizer whenever you want by hitting "C-x u". ;; ;; In the visualizer, the usual keys for moving up and down a buffer instead ;; move up and down the undo history tree (e.g. the up and down arrow keys, or @@ -448,10 +509,17 @@ ;; history you are visualizing) is updated as you move around the undo tree in ;; the visualizer. If you reach a branch point in the visualizer, the usual ;; keys for moving forward and backward in a buffer instead switch branch -;; (e.g. the left and right arrow keys, or "C-f" and "C-b"). And clicking with -;; the mouse on any node in the visualizer will take you directly to that -;; node, resetting the state of the parent buffer to the state represented by -;; that node. +;; (e.g. the left and right arrow keys, or "C-f" and "C-b"). +;; +;; Clicking with the mouse on any node in the visualizer will take you +;; directly to that node, resetting the state of the parent buffer to the +;; state represented by that node. +;; +;; You can also select nodes directly using the keyboard, by hitting "s" to +;; toggle selection mode. The usual motion keys now allow you to move around +;; the tree without changing the parent buffer. Hitting <enter> will reset the +;; state of the parent buffer to the state represented by the currently +;; selected node. ;; ;; It can be useful to see how long ago the parent buffer was in the state ;; represented by a particular node in the visualizer. Hitting "t" in the @@ -460,8 +528,24 @@ ;; somewhat later than the true times, especially if it's been a long time ;; since you last undid any changes.) ;; +;; To get some idea of what changes are represented by a given node in the +;; tree, it can be useful to see a diff of the changes. Hit "d" in the +;; visualizer to toggle a diff display. This normally displays a diff between +;; the current state and the previous one, i.e. it shows you the changes that +;; will be applied if you undo (move up the tree). However, the diff display +;; really comes into its own in the visualizer's selection mode (see above), +;; where it instead shows a diff between the current state and the currently +;; selected state, i.e. it shows you the changes that will be applied if you +;; reset to the selected state. +;; +;; (Note that the diff is generated by the Emacs `diff' command, and is +;; displayed using `diff-mode'. See the corresponding customization groups if +;; you want to customize the diff display.) +;; ;; Finally, hitting "q" will quit the visualizer, leaving the parent buffer in -;; whatever state you ended at. +;; whatever state you ended at. Hitting "C-q" will abort the visualizer, +;; returning the parent buffer to whatever state it was originally in when the +;; visualizer was . ;; ;; ;; @@ -470,7 +554,7 @@ ;; ;; Emacs allows a very useful and powerful method of undoing only selected ;; changes: when a region is active, only changes that affect the text within -;; that region will are undone. With the standard Emacs undo system, changes +;; that region will be undone. With the standard Emacs undo system, changes ;; produced by undoing-in-region naturally get added onto the end of the ;; linear undo history: ;; @@ -606,6 +690,100 @@ ;;; Change Log: ;; +;; Version 0.5.1 +;; * remove now unnecessary compatibility hack for `called-interactively-p' +;; +;; Version 0.5 +;; * implemented diff display in visualizer, toggled on and off using +;; `undo-tree-visualizer-toggle-diff' +;; * added `undo-tree-visualizer-diff' customization option, to display diff +;; by default +;; * added `called-interactively-p', `registerv-make', `registerv-data', +;; `diff-no-select' and `diff-file-local-copy' compatibility hacks for +;; older Emacsen +;; * split out core of `undo-tree-undo' and `undo-tree-redo' into internal +;; `undo-tree-undo-1' and `undo-tree-redo-1' functions, which now take an +;; additional optional argument to preserve timestamps +;; * preserve timestamps when generating diff for visualizer diff view +;; * fixed bug in `undo-tree-visualizer-select-left' and +;; `undo-tree-visualizer-select-right' when using selection mode whilst +;; timestamps are displayed +;; * fixed bug in `undo-tree-draw-node' caused by new registerv structure, +;; which prevented registers from being displayed in visualizer +;; * added `undo-tree-visualizer-relative-timestamps' option to make +;; visualizer display timestamps relative to current time +;; * use a function `undo-tree-make-history-save-file-name' function to +;; generate history save filename, allowing save file to be customized by +;; overriding this function +;; * clear visualizer data / kill visualizer in `undo-tree-save-history' +;; before saving history to file, otherwise markers in visualizer meta-data +;; cause read errors in `undo-tree-load-history' +;; * make `undo-tree-visualizer-timestamps' into defcustom, to allow +;; timestamps to be displayed by default +;; * use `undo-tree-visualizer-selected-node' to store currently selected node +;; in visualizer selection mode, instead of relying on point location, to +;; avoid errors if point was moved manually +;; * added `undo-tree-visualizer-abort' command to quit visualizer and return +;; to original state, stored in `undo-tree-visualizer-initial-node' +;; +;; Version 0.4 +;; * implemented persistent history storage: `undo-tree-save-history' and +;; `undo-tree-load-history' save and restore an undo tree to file, enabling +;; `undo-tree-auto-save-history' causes history to be saved and restored +;; automatically when saving or loading files +;; * renamed internal `make-undo-tree-<struct>' functions to +;; `undo-tree-make-<struct>' to avoid polluting name-space +;; * create proper registerv structure using `registerv-make' when storing +;; undo state in registers in `undo-tree-save-state-to-register' (and +;; `undo-tree-restore-state-from-register') +;; * suppress branch point messages when undo/redoing from `undo-tree-set' +;; * make various interactive commands signal an error if buffer is read-only +;; * let-bind `inhibit-read-only' instead of setting and restoring +;; `buffer-read-only' +;; * use non-nil `undo-tree-inhibit-kill-visualizer' instead of +;; `undo-in-progress' to inhibit `undo-tree-kill-visualizer', so that +;; undoing and redoing in parent buffer also kill visualizer +;; +;; Version 0.3.5 +;; * improved `undo-tree-switch-branch': display current branch number in +;; prompt, switch to other branch without prompting when there are only two, +;; and display message indicating new branch number after switching +;; +;; Version 0.3.4 +;; * set `permanent-local' property on `buffer-undo-tree', to prevent history +;; being discarded when switching major-mode +;; * added `undo-tree-enable-undo-in-region' customization option to allow +;; undo-in-region to be disabled. +;; * fixed bug in `undo-list-pop-changeset' which, through a subtle chain of +;; consequences, occasionally caused undo-tree-mode to lose large amounts of +;; undo history (thanks to Magnar Sveen for his sterling efforts in helping +;; track this down!) +;; +;; Version 0.3.3; +;; * added `term-mode' to `undo-tree-incompatible-major-modes' +;; +;; Version 0.3.2 +;; * added additional check in `undo-list-GCd-marker-elt-p' to guard against +;; undo elements being mis-identified as marker elements +;; * fixed bug in `undo-list-transfer-to-tree' +;; +;; Version 0.3.1 +;; * use `get-buffer-create' when creating the visualizer buffer in +;; `undo-tree-visualize', to fix bug caused by `global-undo-tree-mode' being +;; enabled in the visualizer when `default-major-mode' is set to something +;; other than `fundamental-mode' (thanks to Michael Heerdegen for suggesting +;; this fix) +;; * modified `turn-on-undo-tree-mode' to avoid turning on `undo-tree-mode' if +;; the buffer's `major-mode' implements its own undo system, by checking +;; whether `undo' is remapped, the default "C-/" or "C-_" bindings have been +;; overridden, or the `major-mode' is listed in +;; `undo-tree-incompatible-major-modes' +;; * discard position entries from `buffer-undo-list' changesets created by +;; undoing or redoing, to ensure point is always moved to where the change +;; is (standard Emacs `undo' also does this) +;; * fixed `undo-tree-draw-node' to use correct faces and indicate registers +;; when displaying timestamps in visualizer +;; ;; Version 0.3 ;; * implemented undo-in-region ;; * fixed bugs in `undo-list-transfer-to-tree' and @@ -688,16 +866,101 @@ ;;; Code: (eval-when-compile (require 'cl)) +(require 'diff) + + + +;;; ===================================================================== +;;; Compatibility hacks for older Emacsen -;; `characterp' isn't defined in Emacs versions <= 22 +;; `characterp' isn't defined in Emacs versions < 23 (unless (fboundp 'characterp) (defalias 'characterp 'char-valid-p)) -;; `region-active-p' isn't defined in Emacs versions <= 22 +;; `region-active-p' isn't defined in Emacs versions < 23 (unless (fboundp 'region-active-p) (defun region-active-p () (and transient-mark-mode mark-active))) +;; `registerv' defstruct isn't defined in Emacs versions < 24 +(unless (fboundp 'registerv-make) + (defmacro registerv-make (data &rest dummy) data)) + +(unless (fboundp 'registerv-data) + (defmacro registerv-data (data) data)) + + +;; `diff-no-select' and `diff-file-local-copy' aren't defined in Emacs +;; versions < 24 (copied and adapted from Emacs 24) +(unless (fboundp 'diff-no-select) + (defun diff-no-select (old new &optional switches no-async buf) + ;; Noninteractive helper for creating and reverting diff buffers + (unless (bufferp new) (setq new (expand-file-name new))) + (unless (bufferp old) (setq old (expand-file-name old))) + (or switches (setq switches diff-switches)) ; If not specified, use default. + (unless (listp switches) (setq switches (list switches))) + (or buf (setq buf (get-buffer-create "*Diff*"))) + (let* ((old-alt (diff-file-local-copy old)) + (new-alt (diff-file-local-copy new)) + (command + (mapconcat 'identity + `(,diff-command + ;; Use explicitly specified switches + ,@switches + ,@(mapcar #'shell-quote-argument + (nconc + (when (or old-alt new-alt) + (list "-L" (if (stringp old) + old (prin1-to-string old)) + "-L" (if (stringp new) + new (prin1-to-string new)))) + (list (or old-alt old) + (or new-alt new))))) + " ")) + (thisdir default-directory)) + (with-current-buffer buf + (setq buffer-read-only t) + (buffer-disable-undo (current-buffer)) + (let ((inhibit-read-only t)) + (erase-buffer)) + (buffer-enable-undo (current-buffer)) + (diff-mode) + (set (make-local-variable 'revert-buffer-function) + (lambda (_ignore-auto _noconfirm) + (diff-no-select old new switches no-async (current-buffer)))) + (setq default-directory thisdir) + (let ((inhibit-read-only t)) + (insert command "\n")) + (if (and (not no-async) (fboundp 'start-process)) + (let ((proc (start-process "Diff" buf shell-file-name + shell-command-switch command))) + (set-process-filter proc 'diff-process-filter) + (set-process-sentinel + proc (lambda (proc _msg) + (with-current-buffer (process-buffer proc) + (diff-sentinel (process-exit-status proc)) + (if old-alt (delete-file old-alt)) + (if new-alt (delete-file new-alt)))))) + ;; Async processes aren't available. + (let ((inhibit-read-only t)) + (diff-sentinel + (call-process shell-file-name nil buf nil + shell-command-switch command)) + (if old-alt (delete-file old-alt)) + (if new-alt (delete-file new-alt))))) + buf))) + +(unless (fboundp 'diff-file-local-copy) + (defun diff-file-local-copy (file-or-buf) + (if (bufferp file-or-buf) + (with-current-buffer file-or-buf + (let ((tempfile (make-temp-file "buffer-content-"))) + (write-region nil nil tempfile nil 'nomessage) + tempfile)) + (file-local-copy file-or-buf)))) + + + ;;; ===================================================================== ;;; Global variables and customization options @@ -705,6 +968,7 @@ (defvar buffer-undo-tree nil "Tree of undo entries in current buffer.") (make-variable-buffer-local 'buffer-undo-tree) +(put 'buffer-undo-tree 'permanent-local t) (defgroup undo-tree nil @@ -717,26 +981,88 @@ when `undo-tree-mode' is enabled." :group 'undo-tree :type 'string) -(defcustom undo-tree-visualizer-spacing 3 - "Horizontal spacing in undo-tree visualization. -Must be a postivie odd integer." + +(defcustom undo-tree-auto-save-history nil + "When non-nil, `undo-tree-mode' will save undo history to file +when a buffer is saved to file. + +It will automatically load undo history when a buffer is loaded +from file, if an undo save file exists. + +Undo-tree history is saved to a file called +\".<buffer-file-name>.~undo-tree\" in the same directory as the +file itself. + +WARNING! `undo-tree-auto-save-history' will not work properly in +Emacs versions prior to 24.1.50.1, so it cannot be enabled via +the customization interface in versions earlier than that one. To +ignore this warning and enable it regardless, set +`undo-tree-auto-save-history' to a non-nil value outside of +customize." :group 'undo-tree - :type '(integer - :match (lambda (w n) (and (integerp n) (> n 0) (= (mod n 2) 1))))) -(make-variable-buffer-local 'undo-tree-visualizer-spacing) + :type (if (version-list-< (version-to-list emacs-version) '(24 1 50 1)) + '(choice (const :tag "<disabled>" nil)) + 'boolean)) -(defvar undo-tree-map nil - "Keymap used in undo-tree-mode.") + +(defcustom undo-tree-visualizer-relative-timestamps t + "When non-nil, display times relative to current time +when displaying time stamps in visualizer. + +Otherwise, display absolute times." + :group 'undo-tree + :type 'boolean) + + +(defcustom undo-tree-visualizer-timestamps nil + "When non-nil, display time-stamps by default +in undo-tree visualizer. + +\\<undo-tree-visualizer-map>You can always toggle time-stamps on and off \ +using \\[undo-tree-visualizer-toggle-timestamps], regardless of the +setting of this variable." + :group 'undo-tree + :type 'boolean) +(make-variable-buffer-local 'undo-tree-visualizer-timestamps) + + +(defcustom undo-tree-visualizer-diff nil + "When non-nil, display diff by default in undo-tree visualizer. + +\\<undo-tree-visualizer-map>You can always toggle the diff display \ +using \\[undo-tree-visualizer-toggle-diff], regardless of the +setting of this variable." + :group 'undo-tree + :type 'boolean) +(make-variable-buffer-local 'undo-tree-visualizer-diff) + + +(defcustom undo-tree-incompatible-major-modes '(term-mode) + "List of major-modes in which `undo-tree-mode' should not be enabled. +\(See `turn-on-undo-tree-mode'.\)" + :group 'undo-tree + :type '(repeat symbol)) + + +(defcustom undo-tree-enable-undo-in-region t + "When non-nil, enable undo-in-region. + +When undo-in-region is enabled, undoing or redoing when the +region is active (in `transient-mark-mode') or with a prefix +argument (not in `transient-mark-mode') only undoes changes +within the current region." + :group 'undo-tree + :type 'boolean) (defface undo-tree-visualizer-default-face '((((class color)) :foreground "gray")) - "*Face used to draw undo-tree in visualizer." + "Face used to draw undo-tree in visualizer." :group 'undo-tree) (defface undo-tree-visualizer-current-face '((((class color)) :foreground "red")) - "*Face used to highlight current undo-tree node in visualizer." + "Face used to highlight current undo-tree node in visualizer." :group 'undo-tree) (defface undo-tree-visualizer-active-branch-face @@ -744,32 +1070,46 @@ Must be a postivie odd integer." (:foreground "white" :weight bold)) (((class color) (background light)) (:foreground "black" :weight bold))) - "*Face used to highlight active undo-tree branch -in visualizer." + "Face used to highlight active undo-tree branch in visualizer." :group 'undo-tree) (defface undo-tree-visualizer-register-face '((((class color)) :foreground "yellow")) - "*Face used to highlight undo-tree nodes saved to a register + "Face used to highlight undo-tree nodes saved to a register in visualizer." :group 'undo-tree) -(defvar undo-tree-visualizer-map nil - "Keymap used in undo-tree visualizer.") - -(defvar undo-tree-visualizer-selection-map nil - "Keymap used in undo-tree visualizer selection mode.") - (defvar undo-tree-visualizer-parent-buffer nil "Parent buffer in visualizer.") (make-variable-buffer-local 'undo-tree-visualizer-parent-buffer) -(defvar undo-tree-visualizer-timestamps nil - "Non-nil when visualizer is displaying time-stamps.") -(make-variable-buffer-local 'undo-tree-visualizer-timestamps) +;; stores current horizontal spacing needed for drawing undo-tree +(defvar undo-tree-visualizer-spacing nil) +(make-variable-buffer-local 'undo-tree-visualizer-spacing) + +;; calculate horizontal spacing required for drawing undo-tree with current +;; settings +(defsubst undo-tree-visualizer-calculate-spacing () + (if undo-tree-visualizer-timestamps + (if undo-tree-visualizer-relative-timestamps 9 13) + 3)) + +;; holds node that was current when visualizer was invoked +(defvar undo-tree-visualizer-initial-node nil) +(make-variable-buffer-local 'undo-tree-visualizer-initial-node) + +;; holds currently selected node in visualizer selection mode +(defvar undo-tree-visualizer-selected-node nil) +(make-variable-buffer-local 'undo-tree-visualizer-selected) + +;; dynamically bound to t when undoing from visualizer, to inhibit +;; `undo-tree-kill-visualizer' hook function in parent buffer +(defvar undo-tree-inhibit-kill-visualizer nil) + (defconst undo-tree-visualizer-buffer-name " *undo-tree*") +(defconst undo-tree-diff-buffer-name "*undo-tree Diff*") ;; prevent debugger being called on "No further redo information" (add-to-list 'debug-ignored-errors "^No further redo information") @@ -780,158 +1120,132 @@ in visualizer." ;;; ================================================================= ;;; Setup default keymaps +(defvar undo-tree-map nil + "Keymap used in undo-tree-mode.") + (unless undo-tree-map - (setq undo-tree-map (make-sparse-keymap)) - ;; remap `undo' and `undo-only' to `undo-tree-undo' - (define-key undo-tree-map [remap undo] 'undo-tree-undo) - (define-key undo-tree-map [remap undo-only] 'undo-tree-undo) - ;; bind standard undo bindings (since these match redo counterparts) - (define-key undo-tree-map (kbd "C-/") 'undo-tree-undo) - (define-key undo-tree-map "\C-_" 'undo-tree-undo) - ;; redo doesn't exist normally, so define our own keybindings - (define-key undo-tree-map (kbd "C-?") 'undo-tree-redo) - (define-key undo-tree-map (kbd "M-_") 'undo-tree-redo) - ;; just in case something has defined `redo'... - (define-key undo-tree-map [remap redo] 'undo-tree-redo) - ;; we use "C-x u" for the undo-tree visualizer - (define-key undo-tree-map (kbd "\C-x u") 'undo-tree-visualize) - ;; bind register commands - (define-key undo-tree-map (kbd "C-x r u") - 'undo-tree-save-state-to-register) - (define-key undo-tree-map (kbd "C-x r U") - 'undo-tree-restore-state-from-register)) + (let ((map (make-sparse-keymap))) + ;; remap `undo' and `undo-only' to `undo-tree-undo' + (define-key map [remap undo] 'undo-tree-undo) + (define-key map [remap undo-only] 'undo-tree-undo) + ;; bind standard undo bindings (since these match redo counterparts) + (define-key map (kbd "C-/") 'undo-tree-undo) + (define-key map "\C-_" 'undo-tree-undo) + ;; redo doesn't exist normally, so define our own keybindings + (define-key map (kbd "C-?") 'undo-tree-redo) + (define-key map (kbd "M-_") 'undo-tree-redo) + ;; just in case something has defined `redo'... + (define-key map [remap redo] 'undo-tree-redo) + ;; we use "C-x u" for the undo-tree visualizer + (define-key map (kbd "\C-x u") 'undo-tree-visualize) + ;; bind register commands + (define-key map (kbd "C-x r u") 'undo-tree-save-state-to-register) + (define-key map (kbd "C-x r U") 'undo-tree-restore-state-from-register) + ;; set keymap + (setq undo-tree-map map))) +(defvar undo-tree-visualizer-map nil + "Keymap used in undo-tree visualizer.") + (unless undo-tree-visualizer-map - (setq undo-tree-visualizer-map (make-keymap)) - ;; vertical motion keys undo/redo - (define-key undo-tree-visualizer-map [remap previous-line] - 'undo-tree-visualize-undo) - (define-key undo-tree-visualizer-map [remap next-line] - 'undo-tree-visualize-redo) - (define-key undo-tree-visualizer-map [up] - 'undo-tree-visualize-undo) - (define-key undo-tree-visualizer-map "p" - 'undo-tree-visualize-undo) - (define-key undo-tree-visualizer-map "\C-p" - 'undo-tree-visualize-undo) - (define-key undo-tree-visualizer-map [down] - 'undo-tree-visualize-redo) - (define-key undo-tree-visualizer-map "n" - 'undo-tree-visualize-redo) - (define-key undo-tree-visualizer-map "\C-n" - 'undo-tree-visualize-redo) - ;; horizontal motion keys switch branch - (define-key undo-tree-visualizer-map [remap forward-char] - 'undo-tree-visualize-switch-branch-right) - (define-key undo-tree-visualizer-map [remap backward-char] - 'undo-tree-visualize-switch-branch-left) - (define-key undo-tree-visualizer-map [right] - 'undo-tree-visualize-switch-branch-right) - (define-key undo-tree-visualizer-map "f" - 'undo-tree-visualize-switch-branch-right) - (define-key undo-tree-visualizer-map "\C-f" - 'undo-tree-visualize-switch-branch-right) - (define-key undo-tree-visualizer-map [left] - 'undo-tree-visualize-switch-branch-left) - (define-key undo-tree-visualizer-map "b" - 'undo-tree-visualize-switch-branch-left) - (define-key undo-tree-visualizer-map "\C-b" - 'undo-tree-visualize-switch-branch-left) - ;; mouse sets buffer state to node at click - (define-key undo-tree-visualizer-map [mouse-1] - 'undo-tree-visualizer-mouse-set) - ;; toggle timestamps - (define-key undo-tree-visualizer-map "t" - 'undo-tree-visualizer-toggle-timestamps) - ;; selection mode - (define-key undo-tree-visualizer-map "s" - 'undo-tree-visualizer-selection-mode) - ;; horizontal scrolling may be needed if the tree is very wide - (define-key undo-tree-visualizer-map "," - 'undo-tree-visualizer-scroll-left) - (define-key undo-tree-visualizer-map "." - 'undo-tree-visualizer-scroll-right) - (define-key undo-tree-visualizer-map "<" - 'undo-tree-visualizer-scroll-left) - (define-key undo-tree-visualizer-map ">" - 'undo-tree-visualizer-scroll-right) - ;; vertical scrolling may be needed if the tree is very tall - (define-key undo-tree-visualizer-map [next] 'scroll-up) - (define-key undo-tree-visualizer-map [prior] 'scroll-down) - ;; quit visualizer - (define-key undo-tree-visualizer-map "q" - 'undo-tree-visualizer-quit) - (define-key undo-tree-visualizer-map "\C-q" - 'undo-tree-visualizer-quit)) + (let ((map (make-sparse-keymap))) + ;; vertical motion keys undo/redo + (define-key map [remap previous-line] 'undo-tree-visualize-undo) + (define-key map [remap next-line] 'undo-tree-visualize-redo) + (define-key map [up] 'undo-tree-visualize-undo) + (define-key map "p" 'undo-tree-visualize-undo) + (define-key map "\C-p" 'undo-tree-visualize-undo) + (define-key map [down] 'undo-tree-visualize-redo) + (define-key map "n" 'undo-tree-visualize-redo) + (define-key map "\C-n" 'undo-tree-visualize-redo) + ;; horizontal motion keys switch branch + (define-key map [remap forward-char] + 'undo-tree-visualize-switch-branch-right) + (define-key map [remap backward-char] + 'undo-tree-visualize-switch-branch-left) + (define-key map [right] 'undo-tree-visualize-switch-branch-right) + (define-key map "f" 'undo-tree-visualize-switch-branch-right) + (define-key map "\C-f" 'undo-tree-visualize-switch-branch-right) + (define-key map [left] 'undo-tree-visualize-switch-branch-left) + (define-key map "b" 'undo-tree-visualize-switch-branch-left) + (define-key map "\C-b" 'undo-tree-visualize-switch-branch-left) + ;; mouse sets buffer state to node at click + (define-key map [mouse-1] 'undo-tree-visualizer-mouse-set) + ;; toggle timestamps + (define-key map "t" 'undo-tree-visualizer-toggle-timestamps) + ;; toggle diff + (define-key map "d" 'undo-tree-visualizer-toggle-diff) + ;; selection mode + (define-key map "s" 'undo-tree-visualizer-selection-mode) + ;; horizontal scrolling may be needed if the tree is very wide + (define-key map "," 'undo-tree-visualizer-scroll-left) + (define-key map "." 'undo-tree-visualizer-scroll-right) + (define-key map "<" 'undo-tree-visualizer-scroll-left) + (define-key map ">" 'undo-tree-visualizer-scroll-right) + ;; vertical scrolling may be needed if the tree is very tall + (define-key map [next] 'scroll-up) + (define-key map [prior] 'scroll-down) + ;; quit/abort visualizer + (define-key map "q" 'undo-tree-visualizer-quit) + (define-key map "\C-q" 'undo-tree-visualizer-abort) + ;; set keymap + (setq undo-tree-visualizer-map map))) +(defvar undo-tree-visualizer-selection-map nil + "Keymap used in undo-tree visualizer selection mode.") + (unless undo-tree-visualizer-selection-map - (setq undo-tree-visualizer-selection-map (make-keymap)) - ;; vertical motion keys move up and down tree - (define-key undo-tree-visualizer-selection-map [remap previous-line] - 'undo-tree-visualizer-select-previous) - (define-key undo-tree-visualizer-selection-map [remap next-line] - 'undo-tree-visualizer-select-next) - (define-key undo-tree-visualizer-selection-map [up] - 'undo-tree-visualizer-select-previous) - (define-key undo-tree-visualizer-selection-map "p" - 'undo-tree-visualizer-select-previous) - (define-key undo-tree-visualizer-selection-map "\C-p" - 'undo-tree-visualizer-select-previous) - (define-key undo-tree-visualizer-selection-map [down] - 'undo-tree-visualizer-select-next) - (define-key undo-tree-visualizer-selection-map "n" - 'undo-tree-visualizer-select-next) - (define-key undo-tree-visualizer-selection-map "\C-n" - 'undo-tree-visualizer-select-next) - ;; vertical scroll keys move up and down quickly - (define-key undo-tree-visualizer-selection-map [next] - (lambda () (interactive) (undo-tree-visualizer-select-next 10))) - (define-key undo-tree-visualizer-selection-map [prior] - (lambda () (interactive) (undo-tree-visualizer-select-previous 10))) - ;; horizontal motion keys move to left and right siblings - (define-key undo-tree-visualizer-selection-map [remap forward-char] - 'undo-tree-visualizer-select-right) - (define-key undo-tree-visualizer-selection-map [remap backward-char] - 'undo-tree-visualizer-select-left) - (define-key undo-tree-visualizer-selection-map [right] - 'undo-tree-visualizer-select-right) - (define-key undo-tree-visualizer-selection-map "f" - 'undo-tree-visualizer-select-right) - (define-key undo-tree-visualizer-selection-map "\C-f" - 'undo-tree-visualizer-select-right) - (define-key undo-tree-visualizer-selection-map [left] - 'undo-tree-visualizer-select-left) - (define-key undo-tree-visualizer-selection-map "b" - 'undo-tree-visualizer-select-left) - (define-key undo-tree-visualizer-selection-map "\C-b" - 'undo-tree-visualizer-select-left) - ;; horizontal scroll keys move left or right quickly - (define-key undo-tree-visualizer-selection-map "," - (lambda () (interactive) (undo-tree-visualizer-select-left 10))) - (define-key undo-tree-visualizer-selection-map "." - (lambda () (interactive) (undo-tree-visualizer-select-right 10))) - (define-key undo-tree-visualizer-selection-map "<" - (lambda () (interactive) (undo-tree-visualizer-select-left 10))) - (define-key undo-tree-visualizer-selection-map ">" - (lambda () (interactive) (undo-tree-visualizer-select-right 10))) - ;; mouse or <enter> sets buffer state to node at point/click - (define-key undo-tree-visualizer-selection-map "\r" - 'undo-tree-visualizer-set) - (define-key undo-tree-visualizer-selection-map [mouse-1] - 'undo-tree-visualizer-mouse-set) - ;; toggle timestamps - (define-key undo-tree-visualizer-selection-map "t" - 'undo-tree-visualizer-toggle-timestamps) - ;; quit visualizer selection mode - (define-key undo-tree-visualizer-selection-map "s" - 'undo-tree-visualizer-mode) - ;; quit visualizer - (define-key undo-tree-visualizer-selection-map "q" - 'undo-tree-visualizer-quit) - (define-key undo-tree-visualizer-selection-map "\C-q" - 'undo-tree-visualizer-quit)) + (let ((map (make-sparse-keymap))) + ;; vertical motion keys move up and down tree + (define-key map [remap previous-line] + 'undo-tree-visualizer-select-previous) + (define-key map [remap next-line] + 'undo-tree-visualizer-select-next) + (define-key map [up] 'undo-tree-visualizer-select-previous) + (define-key map "p" 'undo-tree-visualizer-select-previous) + (define-key map "\C-p" 'undo-tree-visualizer-select-previous) + (define-key map [down] 'undo-tree-visualizer-select-next) + (define-key map "n" 'undo-tree-visualizer-select-next) + (define-key map "\C-n" 'undo-tree-visualizer-select-next) + ;; vertical scroll keys move up and down quickly + (define-key map [next] + (lambda () (interactive) (undo-tree-visualizer-select-next 10))) + (define-key map [prior] + (lambda () (interactive) (undo-tree-visualizer-select-previous 10))) + ;; horizontal motion keys move to left and right siblings + (define-key map [remap forward-char] 'undo-tree-visualizer-select-right) + (define-key map [remap backward-char] 'undo-tree-visualizer-select-left) + (define-key map [right] 'undo-tree-visualizer-select-right) + (define-key map "f" 'undo-tree-visualizer-select-right) + (define-key map "\C-f" 'undo-tree-visualizer-select-right) + (define-key map [left] 'undo-tree-visualizer-select-left) + (define-key map "b" 'undo-tree-visualizer-select-left) + (define-key map "\C-b" 'undo-tree-visualizer-select-left) + ;; horizontal scroll keys move left or right quickly + (define-key map "," + (lambda () (interactive) (undo-tree-visualizer-select-left 10))) + (define-key map "." + (lambda () (interactive) (undo-tree-visualizer-select-right 10))) + (define-key map "<" + (lambda () (interactive) (undo-tree-visualizer-select-left 10))) + (define-key map ">" + (lambda () (interactive) (undo-tree-visualizer-select-right 10))) + ;; mouse or <enter> sets buffer state to node at point/click + (define-key map "\r" 'undo-tree-visualizer-set) + (define-key map [mouse-1] 'undo-tree-visualizer-mouse-set) + ;; toggle timestamps + (define-key map "t" 'undo-tree-visualizer-toggle-timestamps) + ;; toggle diff + (define-key map "d" 'undo-tree-visualizer-selection-toggle-diff) + ;; quit visualizer selection mode + (define-key map "s" 'undo-tree-visualizer-mode) + ;; quit visualizer + (define-key map "q" 'undo-tree-visualizer-quit) + (define-key map "\C-q" 'undo-tree-visualizer-abort) + ;; set keymap + (setq undo-tree-visualizer-selection-map map))) @@ -945,11 +1259,12 @@ in visualizer." (:constructor nil) (:constructor make-undo-tree (&aux - (root (make-undo-tree-node nil nil)) + (root (undo-tree-make-node nil nil)) (current root) (size 0) (object-pool (make-hash-table :test 'eq :weakness 'value)))) - (:copier nil)) + ;;(:copier nil) + ) root current size object-pool) @@ -958,13 +1273,13 @@ in visualizer." (undo-tree-node (:type vector) ; create unnamed struct (:constructor nil) - (:constructor make-undo-tree-node + (:constructor undo-tree-make-node (previous undo &optional redo &aux (timestamp (current-time)) (branch 0))) - (:constructor make-undo-tree-node-backwards + (:constructor undo-tree-make-node-backwards (next-node undo &optional redo &aux @@ -976,7 +1291,7 @@ in visualizer." (defmacro undo-tree-node-p (n) - (let ((len (length (make-undo-tree-node nil nil)))) + (let ((len (length (undo-tree-make-node nil nil)))) `(and (vectorp ,n) (= (length ,n) ,len)))) @@ -985,19 +1300,19 @@ in visualizer." (undo-tree-region-data (:type vector) ; create unnamed struct (:constructor nil) - (:constructor make-undo-tree-region-data + (:constructor undo-tree-make-region-data (&optional undo-beginning undo-end redo-beginning redo-end)) - (:constructor make-undo-tree-undo-region-data + (:constructor undo-tree-make-undo-region-data (undo-beginning undo-end)) - (:constructor make-undo-tree-redo-region-data + (:constructor undo-tree-make-redo-region-data (redo-beginning redo-end)) (:copier nil)) undo-beginning undo-end redo-beginning redo-end) (defmacro undo-tree-region-data-p (r) - (let ((len (length (make-undo-tree-region-data)))) + (let ((len (length (undo-tree-make-region-data)))) `(and (vectorp ,r) (= (length ,r) ,len)))) (defmacro undo-tree-node-clear-region-data (node) @@ -1034,7 +1349,7 @@ in visualizer." (unless (undo-tree-region-data-p r) (setf (undo-tree-node-meta-data ,node) (plist-put (undo-tree-node-meta-data ,node) :region - (setq r (make-undo-tree-region-data))))) + (setq r (undo-tree-make-region-data))))) (setf (undo-tree-region-data-undo-beginning r) ,val))) (defsetf undo-tree-node-undo-end (node) (val) @@ -1042,7 +1357,7 @@ in visualizer." (unless (undo-tree-region-data-p r) (setf (undo-tree-node-meta-data ,node) (plist-put (undo-tree-node-meta-data ,node) :region - (setq r (make-undo-tree-region-data))))) + (setq r (undo-tree-make-region-data))))) (setf (undo-tree-region-data-undo-end r) ,val))) (defsetf undo-tree-node-redo-beginning (node) (val) @@ -1050,7 +1365,7 @@ in visualizer." (unless (undo-tree-region-data-p r) (setf (undo-tree-node-meta-data ,node) (plist-put (undo-tree-node-meta-data ,node) :region - (setq r (make-undo-tree-region-data))))) + (setq r (undo-tree-make-region-data))))) (setf (undo-tree-region-data-redo-beginning r) ,val))) (defsetf undo-tree-node-redo-end (node) (val) @@ -1058,7 +1373,7 @@ in visualizer." (unless (undo-tree-region-data-p r) (setf (undo-tree-node-meta-data ,node) (plist-put (undo-tree-node-meta-data ,node) :region - (setq r (make-undo-tree-region-data))))) + (setq r (undo-tree-make-region-data))))) (setf (undo-tree-region-data-redo-end r) ,val))) @@ -1067,14 +1382,14 @@ in visualizer." (undo-tree-visualizer-data (:type vector) ; create unnamed struct (:constructor nil) - (:constructor make-undo-tree-visualizer-data + (:constructor undo-tree-make-visualizer-data (&optional lwidth cwidth rwidth marker)) (:copier nil)) lwidth cwidth rwidth marker) (defmacro undo-tree-visualizer-data-p (v) - (let ((len (length (make-undo-tree-visualizer-data)))) + (let ((len (length (undo-tree-make-visualizer-data)))) `(and (vectorp ,v) (= (length ,v) ,len)))) (defmacro undo-tree-node-clear-visualizer-data (node) @@ -1111,7 +1426,7 @@ in visualizer." (unless (undo-tree-visualizer-data-p v) (setf (undo-tree-node-meta-data ,node) (plist-put (undo-tree-node-meta-data ,node) :visualizer - (setq v (make-undo-tree-visualizer-data))))) + (setq v (undo-tree-make-visualizer-data))))) (setf (undo-tree-visualizer-data-lwidth v) ,val))) (defsetf undo-tree-node-cwidth (node) (val) @@ -1119,7 +1434,7 @@ in visualizer." (unless (undo-tree-visualizer-data-p v) (setf (undo-tree-node-meta-data ,node) (plist-put (undo-tree-node-meta-data ,node) :visualizer - (setq v (make-undo-tree-visualizer-data))))) + (setq v (undo-tree-make-visualizer-data))))) (setf (undo-tree-visualizer-data-cwidth v) ,val))) (defsetf undo-tree-node-rwidth (node) (val) @@ -1127,7 +1442,7 @@ in visualizer." (unless (undo-tree-visualizer-data-p v) (setf (undo-tree-node-meta-data ,node) (plist-put (undo-tree-node-meta-data ,node) :visualizer - (setq v (make-undo-tree-visualizer-data))))) + (setq v (undo-tree-make-visualizer-data))))) (setf (undo-tree-visualizer-data-rwidth v) ,val))) (defsetf undo-tree-node-marker (node) (val) @@ -1135,11 +1450,27 @@ in visualizer." (unless (undo-tree-visualizer-data-p v) (setf (undo-tree-node-meta-data ,node) (plist-put (undo-tree-node-meta-data ,node) :visualizer - (setq v (make-undo-tree-visualizer-data))))) + (setq v (undo-tree-make-visualizer-data))))) (setf (undo-tree-visualizer-data-marker v) ,val))) +(defstruct + (undo-tree-register-data + (:type vector) + (:constructor nil) + (:constructor undo-tree-make-register-data (buffer node))) + buffer node) + +(defun undo-tree-register-data-p (data) + (and (vectorp data) + (= (length data) 2) + (undo-tree-node-p (undo-tree-register-data-node data)))) + +(defun undo-tree-register-data-print-func (data) + (princ (format "an undo-tree state for buffer %s" + (undo-tree-register-data-buffer data)))) + (defmacro undo-tree-node-register (node) `(plist-get (undo-tree-node-meta-data ,node) :register)) @@ -1156,7 +1487,7 @@ in visualizer." (defun undo-tree-grow (undo) "Add an UNDO node to current branch of `buffer-undo-tree'." (let* ((current (undo-tree-current buffer-undo-tree)) - (new (make-undo-tree-node current undo))) + (new (undo-tree-make-node current undo))) (push new (undo-tree-node-next current)) (setf (undo-tree-current buffer-undo-tree) new))) @@ -1166,7 +1497,7 @@ in visualizer." Note that this will overwrite NODE's \"previous\" link, so should only be used on a detached NODE, never on nodes that are already part of `buffer-undo-tree'." - (let ((new (make-undo-tree-node-backwards node undo redo))) + (let ((new (undo-tree-make-node-backwards node undo redo))) (setf (undo-tree-node-previous node) new) new)) @@ -1236,7 +1567,7 @@ that are already part of `buffer-undo-tree'." (defun undo-tree-position (node list) "Find the first occurrence of NODE in LIST. Return the index of the matching item, or nil of not found. -Comparison is done with 'eq." +Comparison is done with `eq'." (let ((i 0)) (catch 'found (while (progn @@ -1266,7 +1597,18 @@ Comparison is done with 'eq." `(markerp (car-safe ,elt))) (defmacro undo-list-GCd-marker-elt-p (elt) - `(and (symbolp (car-safe ,elt)) (numberp (cdr-safe ,elt)))) + ;; Return t if ELT is a marker element whose marker has been moved to the + ;; object-pool, so may potentially have been garbage-collected. + ;; Note: Valid marker undo elements should be uniquely identified as cons + ;; cells with a symbol in the car (replacing the marker), and a number in + ;; the cdr. However, to guard against future changes to undo element + ;; formats, we perform an additional redundant check on the symbol name. + `(and (car-safe ,elt) + (symbolp (car ,elt)) + (let ((str (symbol-name (car ,elt)))) + (and (> (length str) 12) + (string= (substring str 0 12) "undo-tree-id"))) + (numberp (cdr-safe ,elt)))) (defun undo-tree-move-GC-elts-to-pool (elt) @@ -1307,17 +1649,25 @@ Comparison is done with 'eq." undo-list) -(defun undo-list-pop-changeset () - ;; Pop changeset from `buffer-undo-list'. - ;; discard undo boundaries at head of list - (while (null (car buffer-undo-list)) +(defun undo-list-pop-changeset (&optional discard-pos) + ;; Pop changeset from `buffer-undo-list'. If DISCARD-POS is non-nil, discard + ;; any position entries from changeset. + + ;; discard undo boundaries and (if DISCARD-POS is non-nil) position entries + ;; at head of undo list + (while (or (null (car buffer-undo-list)) + (and discard-pos (integerp (car buffer-undo-list)))) (setq buffer-undo-list (cdr buffer-undo-list))) - ;; pop elements up to next undo boundary - (unless (eq (car buffer-undo-list) 'undo-tree-canary) + ;; pop elements up to next undo boundary, discarding position entries if + ;; DISCARD-POS is non-nil + (if (eq (car buffer-undo-list) 'undo-tree-canary) + (push nil buffer-undo-list) (let* ((changeset (list (pop buffer-undo-list))) (p changeset)) (while (progn (undo-tree-move-GC-elts-to-pool (car p)) + (while (and discard-pos (integerp (car buffer-undo-list))) + (setq buffer-undo-list (cdr buffer-undo-list))) (car buffer-undo-list)) (setcdr p (list (pop buffer-undo-list))) (setq p (cdr p))) @@ -1353,16 +1703,13 @@ Comparison is done with 'eq." ;; if `buffer-undo-tree' is empty, create initial undo-tree (when (null buffer-undo-tree) (setq buffer-undo-tree (make-undo-tree))) ;; make sure there's a canary at end of `buffer-undo-list' - (if (null buffer-undo-list) - (setq buffer-undo-list '(nil undo-tree-canary)) - (let ((elt (last buffer-undo-list))) - (unless (eq (car elt) 'undo-tree-canary) - (setcdr elt '(nil undo-tree-canary))))) + (when (null buffer-undo-list) + (setq buffer-undo-list '(nil undo-tree-canary))) (unless (eq (cadr buffer-undo-list) 'undo-tree-canary) ;; create new node from first changeset in `buffer-undo-list', save old ;; `buffer-undo-tree' current node, and make new node the current node - (let* ((node (make-undo-tree-node nil (undo-list-pop-changeset))) + (let* ((node (undo-tree-make-node nil (undo-list-pop-changeset))) (splice (undo-tree-current buffer-undo-tree)) (size (undo-list-byte-size (undo-tree-node-undo node)))) (setf (undo-tree-current buffer-undo-tree) node) @@ -1386,7 +1733,8 @@ Comparison is done with 'eq." (setq node (undo-tree-grow-backwards node nil)) (setf (undo-tree-root buffer-undo-tree) node) (setq buffer-undo-list '(nil undo-tree-canary)) - (setf (undo-tree-size buffer-undo-tree) size))) + (setf (undo-tree-size buffer-undo-tree) size) + (setq buffer-undo-list '(nil undo-tree-canary)))) ;; discard undo history if necessary (undo-tree-discard-history))) @@ -1476,6 +1824,10 @@ Comparison is done with 'eq." nil) ;; discard root (t + ;; clear any register referring to root + (let ((r (undo-tree-node-register node))) + (when (and r (eq (get-register r) node)) + (set-register r nil))) ;; make child of root into new root (setq node (setf (undo-tree-root buffer-undo-tree) (car (undo-tree-node-next node)))) @@ -1498,6 +1850,10 @@ Comparison is done with 'eq." (let* ((parent (undo-tree-node-previous node)) (current (nth (undo-tree-node-branch parent) (undo-tree-node-next parent)))) + ;; clear any register referring to the discarded node + (let ((r (undo-tree-node-register node))) + (when (and r (eq (get-register r) node)) + (set-register r nil))) ;; update undo-tree size (decf (undo-tree-size buffer-undo-tree) (+ (undo-list-byte-size (undo-tree-node-undo node)) @@ -1748,7 +2104,7 @@ which is defined in the `warnings' library.\n") ;; (recognizable as first node with more than one branch) (let ((mark-active nil)) (while (= (length (undo-tree-node-next node)) 1) - (undo-tree-undo) + (undo-tree-undo-1) (setq fragment node node (undo-tree-current buffer-undo-tree)))) (when (eq splice node) (setq splice nil)) @@ -1762,11 +2118,11 @@ which is defined in the `warnings' library.\n") ;; if this is a new undo-in-region, initial FRAGMENT is a copy of all ;; nodes below the current one in the active branch ((undo-tree-node-next node) - (setq fragment (make-undo-tree-node nil nil) + (setq fragment (undo-tree-make-node nil nil) splice fragment) (while (setq node (nth (undo-tree-node-branch node) (undo-tree-node-next node))) - (push (make-undo-tree-node + (push (undo-tree-make-node splice (undo-copy-list (undo-tree-node-undo node)) (undo-copy-list (undo-tree-node-redo node))) @@ -1792,7 +2148,7 @@ which is defined in the `warnings' library.\n") (progn (setq fragment (undo-tree-grow-backwards fragment undo-list)) (unless splice (setq splice fragment))) - (setq fragment (make-undo-tree-node nil undo-list)) + (setq fragment (undo-tree-make-node nil undo-list)) (setq splice fragment)) (while elt @@ -1865,7 +2221,7 @@ which is defined in the `warnings' library.\n") (let ((mark-active nil)) (while (not (eq (undo-tree-current buffer-undo-tree) original-current)) - (undo-tree-redo))) + (undo-tree-redo-1))) nil) ; return nil to indicate failure ;; otherwise... @@ -1875,16 +2231,16 @@ which is defined in the `warnings' library.\n") (let ((mark-active nil) (current (undo-tree-current buffer-undo-tree))) (while (not (eq (undo-tree-current buffer-undo-tree) node)) - (undo-tree-undo)) + (undo-tree-undo-1)) (while (not (eq (undo-tree-current buffer-undo-tree) current)) - (undo-tree-redo))) + (undo-tree-redo-1))) (cond ;; if there's no remaining fragment, just create undo-in-region node ;; and attach it to parent of last node from which elements were ;; pulled ((null fragment) - (setq fragment (make-undo-tree-node node region-changeset)) + (setq fragment (undo-tree-make-node node region-changeset)) (push fragment (undo-tree-node-next node)) (setf (undo-tree-node-branch node) 0) ;; set current node to undo-in-region node @@ -1916,9 +2272,9 @@ which is defined in the `warnings' library.\n") (undo-tree-node-previous original-fragment)) (let ((mark-active nil)) (while (not (eq (undo-tree-current buffer-undo-tree) splice)) - (undo-tree-redo nil 'preserve-undo)))) + (undo-tree-redo-1 nil 'preserve-undo)))) ;; splice new undo-in-region node into fragment - (setq node (make-undo-tree-node nil region-changeset)) + (setq node (undo-tree-make-node nil region-changeset)) (undo-tree-splice-node node splice) ;; set current node to undo-in-region node (setf (undo-tree-current buffer-undo-tree) node))) @@ -1982,11 +2338,11 @@ which is defined in the `warnings' library.\n") ;; if this is a new redo-in-region, initial fragment is a copy of all ;; nodes below the current one in the active branch ((undo-tree-node-next node) - (setq fragment (make-undo-tree-node nil nil) + (setq fragment (undo-tree-make-node nil nil) splice fragment) (while (setq node (nth (undo-tree-node-branch node) (undo-tree-node-next node))) - (push (make-undo-tree-node + (push (undo-tree-make-node splice nil (undo-copy-list (undo-tree-node-redo node))) (undo-tree-node-next splice)) @@ -2082,7 +2438,7 @@ which is defined in the `warnings' library.\n") (setq fragment (if fragment (undo-tree-grow-backwards fragment nil region-changeset) - (make-undo-tree-node nil nil region-changeset))) + (undo-tree-make-node nil nil region-changeset))) (push fragment (undo-tree-node-next node)) (setf (undo-tree-node-branch node) 0 (undo-tree-node-previous fragment) node) @@ -2197,6 +2553,7 @@ of either NODE itself or some node above it in the tree." ;;; ===================================================================== ;;; Undo-tree commands +;;;###autoload (define-minor-mode undo-tree-mode "Toggle undo-tree mode. With no argument, this command toggles the mode. @@ -2218,24 +2575,75 @@ Within the undo-tree visualizer, the following keys are available: nil ; init value undo-tree-mode-lighter ; lighter undo-tree-map ; keymap - ;; if disabling `undo-tree-mode', rebuild `buffer-undo-list' from tree so - ;; Emacs undo can work - (unless undo-tree-mode - (undo-list-rebuild-from-tree) - (setq buffer-undo-tree nil))) - -(defun turn-on-undo-tree-mode () - "Enable undo-tree-mode." - (undo-tree-mode 1)) + (cond + ;; if enabling `undo-tree-mode', set up history-saving hooks if + ;; `undo-tree-auto-save-history' is enabled + (undo-tree-mode + (when undo-tree-auto-save-history + (add-hook 'write-file-functions 'undo-tree-save-history-hook nil t) + (add-hook 'find-file-hook 'undo-tree-load-history-hook nil t))) + ;; if disabling `undo-tree-mode', rebuild `buffer-undo-list' from tree so + ;; Emacs undo can work + (t + (undo-list-rebuild-from-tree) + (setq buffer-undo-tree nil) + (when undo-tree-auto-save-history + (remove-hook 'write-file-functions 'undo-tree-save-history-hook t) + (remove-hook 'find-file-hook 'undo-tree-load-history-hook t))))) + + +(defun turn-on-undo-tree-mode (&optional print-message) + "Enable `undo-tree-mode' in the current buffer, when appropriate. +Some major modes implement their own undo system, which should +not normally be overridden by `undo-tree-mode'. This command does +not enable `undo-tree-mode' in such buffers. If you want to force +`undo-tree-mode' to be enabled regardless, use (undo-tree-mode 1) +instead. + +The heuristic used to detect major modes in which +`undo-tree-mode' should not be used is to check whether either +the `undo' command has been remapped, or the default undo +keybindings (C-/ and C-_) have been overridden somewhere other +than in the global map. In addition, `undo-tree-mode' will not be +enabled if the buffer's `major-mode' appears in +`undo-tree-incompatible-major-modes'." + (interactive "p") + (if (or (key-binding [remap undo]) + (undo-tree-overridden-undo-bindings-p) + (memq major-mode undo-tree-incompatible-major-modes)) + (when print-message + (message "Buffer does not support undo-tree-mode;\ + undo-tree-mode NOT enabled")) + (undo-tree-mode 1))) + + +(defun undo-tree-overridden-undo-bindings-p () + "Returns t if default undo bindings are overridden, nil otherwise. +Checks if either of the default undo key bindings (\"C-/\" or +\"C-_\") are overridden in the current buffer by any keymap other +than the global one. (So global redefinitions of the default undo +key bindings do not count.)" + (let ((binding1 (lookup-key (current-global-map) [?\C-/])) + (binding2 (lookup-key (current-global-map) [?\C-_]))) + (global-set-key [?\C-/] 'undo) + (global-set-key [?\C-_] 'undo) + (unwind-protect + (or (and (key-binding [?\C-/]) + (not (eq (key-binding [?\C-/]) 'undo))) + (and (key-binding [?\C-_]) + (not (eq (key-binding [?\C-_]) 'undo)))) + (global-set-key [?\C-/] binding1) + (global-set-key [?\C-_] binding2)))) +;;;###autoload (define-globalized-minor-mode global-undo-tree-mode undo-tree-mode turn-on-undo-tree-mode) -(defun undo-tree-undo (&optional arg preserve-redo) +(defun undo-tree-undo (&optional arg) "Undo changes. Repeat this command to undo more changes. A numeric ARG serves as a repeat count. @@ -2243,17 +2651,28 @@ A numeric ARG serves as a repeat count. In Transient Mark mode when the mark is active, only undo changes within the current region. Similarly, when not in Transient Mark mode, just \\[universal-argument] as an argument limits undo to -changes within the current region. - -A non-nil PRESERVE-REDO causes the existing redo record to be -preserved, rather than replacing it with the new one generated by -undoing." +changes within the current region." (interactive "*P") ;; throw error if undo is disabled in buffer (when (eq buffer-undo-list t) (error "No undo information in this buffer")) - + (undo-tree-undo-1 arg) + ;; inform user if at branch point + (when (> (undo-tree-num-branches) 1) (message "Undo branch point!"))) + + +(defun undo-tree-undo-1 (&optional arg preserve-redo preserve-timestamps) + ;; Internal undo function. An active mark in `transient-mark-mode', or + ;; non-nil ARG otherwise, enables undo-in-region. Non-nil PRESERVE-REDO + ;; causes the existing redo record to be preserved, rather than replacing it + ;; with the new one generated by undoing. Non-nil PRESERVE-TIMESTAMPS + ;; disables updating of timestamps in visited undo-tree nodes. (This latter + ;; should *only* be used when temporarily visiting another undo state and + ;; immediately returning to the original state afterwards. Otherwise, it + ;; could cause history-discarding errors.) (let ((undo-in-progress t) - (undo-in-region (or (region-active-p) (and arg (not (numberp arg))))) + (undo-in-region (and undo-tree-enable-undo-in-region + (or (region-active-p) + (and arg (not (numberp arg)))))) pos current) ;; transfer entries accumulated in `buffer-undo-list' to ;; `buffer-undo-tree' @@ -2304,15 +2723,17 @@ undoing." (when (undo-tree-node-redo current) (decf (undo-tree-size buffer-undo-tree) (undo-list-byte-size (undo-tree-node-redo current)))) - (setf (undo-tree-node-redo current) (undo-list-pop-changeset)) + (setf (undo-tree-node-redo current) + (undo-list-pop-changeset 'discard-pos)) (incf (undo-tree-size buffer-undo-tree) (undo-list-byte-size (undo-tree-node-redo current)))) ;; rewind current node and update timestamp (setf (undo-tree-current buffer-undo-tree) - (undo-tree-node-previous (undo-tree-current buffer-undo-tree)) - (undo-tree-node-timestamp (undo-tree-current buffer-undo-tree)) - (current-time)) + (undo-tree-node-previous (undo-tree-current buffer-undo-tree))) + (unless preserve-timestamps + (setf (undo-tree-node-timestamp (undo-tree-current buffer-undo-tree)) + (current-time))) ;; if undoing-in-region, record current node, region and direction so we ;; can tell if undo-in-region is repeated, and re-activate mark if in @@ -2327,29 +2748,38 @@ undoing." (set-marker pos nil))) ;; undo deactivates mark unless undoing-in-region - (setq deactivate-mark (not undo-in-region)) - ;; inform user if at branch point - (when (> (undo-tree-num-branches) 1) (message "Undo branch point!")))) + (setq deactivate-mark (not undo-in-region)))) -(defun undo-tree-redo (&optional arg preserve-undo) +(defun undo-tree-redo (&optional arg) "Redo changes. A numeric ARG serves as a repeat count. In Transient Mark mode when the mark is active, only redo changes within the current region. Similarly, when not in Transient Mark mode, just \\[universal-argument] as an argument limits redo to -changes within the current region. - -A non-nil PRESERVE-UNDO causes the existing undo record to be -preserved, rather than replacing it with the new one generated by -redoing." - (interactive "p") +changes within the current region." + (interactive "*P") ;; throw error if undo is disabled in buffer (when (eq buffer-undo-list t) (error "No undo information in this buffer")) - + (undo-tree-redo-1 arg) + ;; inform user if at branch point + (when (> (undo-tree-num-branches) 1) (message "Undo branch point!"))) + + +(defun undo-tree-redo-1 (&optional arg preserve-undo preserve-timestamps) + ;; Internal redo function. An active mark in `transient-mark-mode', or + ;; non-nil ARG otherwise, enables undo-in-region. Non-nil PRESERVE-UNDO + ;; causes the existing redo record to be preserved, rather than replacing it + ;; with the new one generated by undoing. Non-nil PRESERVE-TIMESTAMPS + ;; disables updating of timestamps in visited undo-tree nodes. (This latter + ;; should *only* be used when temporarily visiting another undo state and + ;; immediately returning to the original state afterwards. Otherwise, it + ;; could cause history-discarding errors.) (let ((undo-in-progress t) - (redo-in-region (or (region-active-p) (and arg (not (numberp arg))))) + (redo-in-region (and undo-tree-enable-undo-in-region + (or (region-active-p) + (and arg (not (numberp arg)))))) pos current) ;; transfer entries accumulated in `buffer-undo-list' to ;; `buffer-undo-tree' @@ -2404,12 +2834,14 @@ redoing." (when (undo-tree-node-undo current) (decf (undo-tree-size buffer-undo-tree) (undo-list-byte-size (undo-tree-node-undo current)))) - (setf (undo-tree-node-undo current) (undo-list-pop-changeset)) + (setf (undo-tree-node-undo current) + (undo-list-pop-changeset 'discard-pos)) (incf (undo-tree-size buffer-undo-tree) (undo-list-byte-size (undo-tree-node-undo current)))) ;; update timestamp - (setf (undo-tree-node-timestamp current) (current-time)) + (unless preserve-timestamps + (setf (undo-tree-node-timestamp current) (current-time))) ;; if redoing-in-region, record current node, region and direction so we ;; can tell if redo-in-region is repeated, and re-activate mark if in @@ -2422,9 +2854,7 @@ redoing." (set-marker pos nil))) ;; redo deactivates the mark unless redoing-in-region - (setq deactivate-mark (not redo-in-region)) - ;; inform user if at branch point - (when (> (undo-tree-num-branches) 1) (message "Undo branch point!")))) + (setq deactivate-mark (not redo-in-region)))) @@ -2435,10 +2865,18 @@ using `undo-tree-redo'." (interactive (list (or (and prefix-arg (prefix-numeric-value prefix-arg)) (and (not (eq buffer-undo-list t)) (or (undo-list-transfer-to-tree) t) - (> (undo-tree-num-branches) 1) - (read-number - (format "Branch (0-%d): " - (1- (undo-tree-num-branches)))))))) + (let ((b (undo-tree-node-branch + (undo-tree-current + buffer-undo-tree)))) + (cond + ;; switch to other branch if only 2 + ((= (undo-tree-num-branches) 2) (- 1 b)) + ;; prompt if more than 2 + ((> (undo-tree-num-branches) 2) + (read-number + (format "Branch (0-%d, on %d): " + (1- (undo-tree-num-branches)) b))) + )))))) ;; throw error if undo is disabled in buffer (when (eq buffer-undo-list t) (error "No undo information in this buffer")) ;; sanity check branch number @@ -2449,12 +2887,17 @@ using `undo-tree-redo'." (undo-list-transfer-to-tree) ;; switch branch (setf (undo-tree-node-branch (undo-tree-current buffer-undo-tree)) - branch)) + branch) + (message "Switched to branch %d" branch)) -(defun undo-tree-set (node) +(defun undo-tree-set (node &optional preserve-timestamps) ;; Set buffer to state corresponding to NODE. Returns intersection point ;; between path back from current node and path back from selected NODE. + ;; Non-nil PRESERVE-TIMESTAMPS disables updating of timestamps in visited + ;; undo-tree nodes. (This should *only* be used when temporarily visiting + ;; another undo state and immediately returning to the original state + ;; afterwards. Otherwise, it could cause history-discarding errors.) (let ((path (make-hash-table :test 'eq)) (n node)) (puthash (undo-tree-root buffer-undo-tree) t path) @@ -2474,10 +2917,10 @@ using `undo-tree-redo'." (setq n (undo-tree-node-previous n))) ;; ascend tree until intersection node (while (not (eq (undo-tree-current buffer-undo-tree) n)) - (undo-tree-undo)) + (undo-tree-undo-1)) ;; descend tree until selected node (while (not (eq (undo-tree-current buffer-undo-tree) node)) - (undo-tree-redo)) + (undo-tree-redo-1)) n)) ; return intersection node @@ -2493,7 +2936,11 @@ Argument is a character, naming the register." ;; transfer entries accumulated in `buffer-undo-list' to `buffer-undo-tree' (undo-list-transfer-to-tree) ;; save current node to REGISTER - (set-register register (undo-tree-current buffer-undo-tree)) + (set-register + register (registerv-make + (undo-tree-make-register-data + (current-buffer) (undo-tree-current buffer-undo-tree)) + :print-func 'undo-tree-register-data-print-func)) ;; record REGISTER in current node, for visualizer (setf (undo-tree-node-register (undo-tree-current buffer-undo-tree)) register)) @@ -2504,19 +2951,126 @@ Argument is a character, naming the register." "Restore undo-tree state from REGISTER. The state must be saved using `undo-tree-save-state-to-register'. Argument is a character, naming the register." - (interactive "cRestore undo-tree state from register: ") + (interactive "*cRestore undo-tree state from register: ") ;; throw error if undo is disabled in buffer, or if register doesn't contain ;; an undo-tree node - (let ((node (get-register register))) + (let ((data (registerv-data (get-register register)))) (cond ((eq buffer-undo-list t) (error "No undo information in this buffer")) - ((not (undo-tree-node-p node)) - (error "Register doesn't contain undo-tree state"))) + ((not (undo-tree-register-data-p data)) + (error "Register doesn't contain undo-tree state")) + ((not (eq (current-buffer) (undo-tree-register-data-buffer data))) + (error "Register contains undo-tree state for a different buffer"))) ;; transfer entries accumulated in `buffer-undo-list' to `buffer-undo-tree' (undo-list-transfer-to-tree) ;; restore buffer state corresponding to saved node - (undo-tree-set node))) + (undo-tree-set (undo-tree-register-data-node data)))) + + + +(defun undo-tree-make-history-save-file-name () + (concat (file-name-directory (buffer-file-name)) + "." (file-name-nondirectory (buffer-file-name)) ".~undo-tree")) + + +(defun undo-tree-save-history (&optional filename overwrite) + "Store undo-tree history to file. + +If optional argument FILENAME is omitted, default save file is +\".<buffer-file-name>.~undo-tree\" if buffer is visiting a file. +Otherwise, prompt for one. + +If OVERWRITE is non-nil, any existing file will be overwritten +without asking for confirmation." + (interactive) + (condition-case nil + (undo-tree-kill-visualizer) + (error (undo-tree-clear-visualizer-data buffer-undo-tree))) + (undo-list-transfer-to-tree) + (let ((buff (current-buffer)) + (tree (copy-undo-tree buffer-undo-tree))) + ;; get filename + (unless filename + (setq filename + (if buffer-file-name + (undo-tree-make-history-save-file-name) + (expand-file-name (read-file-name "File to save in: ") nil)))) + (when (or (not (file-exists-p filename)) + overwrite + (yes-or-no-p (format "Overwrite \"%s\"? " filename))) + ;; discard undo-tree object pool before saving + (setf (undo-tree-object-pool tree) nil) + ;; print undo-tree to file + (with-temp-file filename + (prin1 (sha1 buff) (current-buffer)) + (terpri (current-buffer)) + (let ((print-circle t)) (prin1 tree (current-buffer))))))) + + + +(defun undo-tree-load-history (&optional filename noerror) + "Load undo-tree history from file. + +If optional argument FILENAME is null, default load file is +\".<buffer-file-name>.~undo-tree\" if buffer is visiting a file. +Otherwise, prompt for one. + +If optional argument NOERROR is non-nil, return nil instead of +signaling an error if file is not found." + (interactive) + ;; get filename + (unless filename + (setq filename + (if buffer-file-name + (undo-tree-make-history-save-file-name) + (expand-file-name (read-file-name "File to load from: ") nil)))) + + ;; attempt to read undo-tree from FILENAME + (catch 'load-error + (unless (file-exists-p filename) + (if noerror + (throw 'load-error nil) + (error "File \"%s\" does not exist; could not load undo-tree history" + filename))) + (let (buff tmp hash tree) + (setq buff (current-buffer)) + (with-temp-buffer + (insert-file-contents filename) + (goto-char (point-min)) + (condition-case nil + (setq hash (read (current-buffer))) + (error + (kill-buffer nil) + (funcall (if noerror 'message 'error) + "Error reading undo-tree history from \"%s\"" filename) + (throw 'load-error nil))) + (unless (string= (sha1 buff) hash) + (kill-buffer nil) + (funcall (if noerror 'message 'error) + "Buffer has been modified; could not load undo-tree history") + (throw 'load-error nil)) + (condition-case nil + (setq tree (read (current-buffer))) + (error + (kill-buffer nil) + (funcall (if noerror 'message 'error) + "Error reading undo-tree history from \"%s\"" filename) + (throw 'load-error nil))) + (kill-buffer nil)) + ;; initialise empty undo-tree object pool + (setf (undo-tree-object-pool tree) + (make-hash-table :test 'eq :weakness 'value)) + (setq buffer-undo-tree tree)))) + + + +;; Versions of save/load functions for use in hooks +(defun undo-tree-save-history-hook () + (undo-tree-save-history nil t) nil) + +(defun undo-tree-load-history-hook () + (undo-tree-load-history nil t)) @@ -2526,7 +3080,7 @@ Argument is a character, naming the register." (defun undo-tree-visualize () "Visualize the current buffer's undo tree." - (interactive) + (interactive "*") (deactivate-mark) ;; throw error if undo is disabled in buffer (when (eq buffer-undo-list t) (error "No undo information in this buffer")) @@ -2538,19 +3092,22 @@ Argument is a character, naming the register." (let ((undo-tree buffer-undo-tree) (buff (current-buffer)) (display-buffer-mark-dedicated 'soft)) - (switch-to-buffer-other-window undo-tree-visualizer-buffer-name) - (undo-tree-visualizer-mode) + (switch-to-buffer-other-window + (get-buffer-create undo-tree-visualizer-buffer-name)) (setq undo-tree-visualizer-parent-buffer buff) (setq buffer-undo-tree undo-tree) - (setq buffer-read-only nil) - (undo-tree-draw-tree undo-tree) - (setq buffer-read-only t))) + (setq undo-tree-visualizer-initial-node (undo-tree-current undo-tree)) + (setq undo-tree-visualizer-spacing + (undo-tree-visualizer-calculate-spacing)) + (when undo-tree-visualizer-diff (undo-tree-visualizer-show-diff)) + (undo-tree-visualizer-mode) + (let ((inhibit-read-only t)) (undo-tree-draw-tree undo-tree)))) (defun undo-tree-kill-visualizer (&rest dummy) ;; Kill visualizer. Added to `before-change-functions' hook of original ;; buffer when visualizer is invoked. - (unless undo-in-progress + (unless undo-tree-inhibit-kill-visualizer (unwind-protect (with-current-buffer undo-tree-visualizer-buffer-name (undo-tree-visualizer-quit))))) @@ -2567,8 +3124,10 @@ Argument is a character, naming the register." (max (/ (window-width) 2) (+ (undo-tree-node-char-lwidth (undo-tree-root undo-tree)) ;; add space for left part of left-most time-stamp - (if undo-tree-visualizer-timestamps 4 0) - 2))) ; left margin + (if undo-tree-visualizer-timestamps + (/ (- undo-tree-visualizer-spacing 4) 2) + 0) + 2))) ; left margin ;; draw undo-tree (let ((undo-tree-insert-face 'undo-tree-visualizer-default-face) (stack (list (undo-tree-root undo-tree))) @@ -2611,39 +3170,51 @@ Argument is a character, naming the register." (defun undo-tree-draw-node (node &optional current) ;; Draw symbol representing NODE in visualizer. (goto-char (undo-tree-node-marker node)) - ;; if displaying timestamps, represent node by timestamp - (if undo-tree-visualizer-timestamps - (progn - (backward-char 4) - (if current (undo-tree-insert ?*) (undo-tree-insert ? )) - (undo-tree-insert - (undo-tree-timestamp-to-string (undo-tree-node-timestamp node))) - (backward-char 5) - (move-marker (undo-tree-node-marker node) (point)) - (put-text-property (- (point) 3) (+ (point) 5) - 'undo-tree-node node)) + (when undo-tree-visualizer-timestamps + (backward-char (/ undo-tree-visualizer-spacing 2))) + + (let ((register (undo-tree-node-register node)) + node-string) + (unless (and register + (eq node (undo-tree-register-data-node + (registerv-data (get-register register))))) + (setq register nil)) ;; represent node by differentl symbols, depending on whether it's the ;; current node or is saved in a register - (let ((register (undo-tree-node-register node))) - (cond - (current - (let ((undo-tree-insert-face - (cons 'undo-tree-visualizer-current-face - (and (boundp 'undo-tree-insert-face) - (or (and (consp undo-tree-insert-face) - undo-tree-insert-face) - (list undo-tree-insert-face)))))) - (undo-tree-insert ?x))) - ((and register (eq node (get-register register))) - (let ((undo-tree-insert-face - (cons 'undo-tree-visualizer-register-face - (and (boundp 'undo-tree-insert-face) - (or (and (consp undo-tree-insert-face) - undo-tree-insert-face) - (list undo-tree-insert-face)))))) - (undo-tree-insert register))) - (t (undo-tree-insert ?o)))) - (backward-char 1) + (setq node-string + (cond + (undo-tree-visualizer-timestamps + (undo-tree-timestamp-to-string + (undo-tree-node-timestamp node) + undo-tree-visualizer-relative-timestamps + current register)) + (current "x") + (register (char-to-string register)) + (t "o"))) + + (cond + (current + (let ((undo-tree-insert-face + (cons 'undo-tree-visualizer-current-face + (and (boundp 'undo-tree-insert-face) + (or (and (consp undo-tree-insert-face) + undo-tree-insert-face) + (list undo-tree-insert-face)))))) + (undo-tree-insert node-string))) + (register + (let ((undo-tree-insert-face + (cons 'undo-tree-visualizer-register-face + (and (boundp 'undo-tree-insert-face) + (or (and (consp undo-tree-insert-face) + undo-tree-insert-face) + (list undo-tree-insert-face)))))) + (undo-tree-insert node-string))) + (t (undo-tree-insert node-string))) + + (backward-char (if undo-tree-visualizer-timestamps + (1+ (/ undo-tree-visualizer-spacing 2)) + 1)) + (move-marker (undo-tree-node-marker node) (point)) (put-text-property (point) (1+ (point)) 'undo-tree-node node))) @@ -2837,10 +3408,48 @@ Argument is a character, naming the register." (insert (make-string (- arg n) ? ))))) -(defun undo-tree-timestamp-to-string (timestamp) - ;; Convert TIMESTAMP to hh:mm:ss string. - (let ((time (decode-time timestamp))) - (format "%02d:%02d:%02d" (nth 2 time) (nth 1 time) (nth 0 time)))) +(defun undo-tree-timestamp-to-string + (timestamp &optional relative current register) + ;; Convert TIMESTAMP to string (either absolute or RELATVE time), indicating + ;; if it's the CURRENT node and/or has an associated REGISTER. + (if relative + ;; relative time + (let ((time (floor (float-time + (subtract-time (current-time) timestamp)))) + n) + (setq time + ;; years + (if (> (setq n (/ time 315360000)) 0) + (if (> n 999) "-ages" (format "-%dy" n)) + (setq time (% time 315360000)) + ;; days + (if (> (setq n (/ time 86400)) 0) + (format "-%dd" n) + (setq time (% time 86400)) + ;; hours + (if (> (setq n (/ time 3600)) 0) + (format "-%dh" n) + (setq time (% time 3600)) + ;; mins + (if (> (setq n (/ time 60)) 0) + (format "-%dm" n) + ;; secs + (format "-%ds" (% time 60))))))) + (setq time (concat + (if current "*" " ") + time + (if register (concat "[" (char-to-string register) "]") + " "))) + (setq n (length time)) + (if (< n 9) + (concat (make-string (- 9 n) ? ) time) + time)) + ;; absolute time + (concat (if current "*" " ") + (format-time-string "%H:%M:%S" timestamp) + (if register + (concat "[" (char-to-string register) "]") + " ")))) @@ -2866,39 +3475,43 @@ Within the undo-tree visualizer, the following keys are available: (use-local-map undo-tree-visualizer-map) (setq truncate-lines t) (setq cursor-type nil) - (setq buffer-read-only t)) + (setq buffer-read-only t) + (setq undo-tree-visualizer-selected-node nil) + (when undo-tree-visualizer-diff (undo-tree-visualizer-update-diff))) (defun undo-tree-visualize-undo (&optional arg) "Undo changes. A numeric ARG serves as a repeat count." (interactive "p") - (setq buffer-read-only nil) - (let ((undo-tree-insert-face 'undo-tree-visualizer-active-branch-face)) + (let ((undo-tree-insert-face 'undo-tree-visualizer-active-branch-face) + (inhibit-read-only t)) (undo-tree-draw-node (undo-tree-current buffer-undo-tree))) (switch-to-buffer-other-window undo-tree-visualizer-parent-buffer) (deactivate-mark) (unwind-protect - (undo-tree-undo arg) + (let ((undo-tree-inhibit-kill-visualizer t)) (undo-tree-undo arg)) (switch-to-buffer-other-window undo-tree-visualizer-buffer-name) - (undo-tree-draw-node (undo-tree-current buffer-undo-tree) 'current) - (setq buffer-read-only t))) + (let ((inhibit-read-only t)) + (undo-tree-draw-node (undo-tree-current buffer-undo-tree) 'current)) + (when undo-tree-visualizer-diff (undo-tree-visualizer-update-diff)))) (defun undo-tree-visualize-redo (&optional arg) "Redo changes. A numeric ARG serves as a repeat count." (interactive "p") - (setq buffer-read-only nil) - (let ((undo-tree-insert-face 'undo-tree-visualizer-active-branch-face)) + (let ((undo-tree-insert-face 'undo-tree-visualizer-active-branch-face) + (inhibit-read-only t)) (undo-tree-draw-node (undo-tree-current buffer-undo-tree))) (switch-to-buffer-other-window undo-tree-visualizer-parent-buffer) (deactivate-mark) (unwind-protect - (undo-tree-redo arg) + (let ((undo-tree-inhibit-kill-visualizer t)) (undo-tree-redo arg)) (switch-to-buffer-other-window undo-tree-visualizer-buffer-name) (goto-char (undo-tree-node-marker (undo-tree-current buffer-undo-tree))) - (undo-tree-draw-node (undo-tree-current buffer-undo-tree) 'current) - (setq buffer-read-only t))) + (let ((inhibit-read-only t)) + (undo-tree-draw-node (undo-tree-current buffer-undo-tree) 'current)) + (when undo-tree-visualizer-diff (undo-tree-visualizer-update-diff)))) (defun undo-tree-visualize-switch-branch-right (arg) @@ -2907,9 +3520,9 @@ This will affect which branch to descend when *redoing* changes using `undo-tree-redo' or `undo-tree-visualizer-redo'." (interactive "p") ;; un-highlight old active branch below current node - (setq buffer-read-only nil) (goto-char (undo-tree-node-marker (undo-tree-current buffer-undo-tree))) - (let ((undo-tree-insert-face 'undo-tree-visualizer-default-face)) + (let ((undo-tree-insert-face 'undo-tree-visualizer-default-face) + (inhibit-read-only t)) (undo-tree-highlight-active-branch (undo-tree-current buffer-undo-tree))) ;; increment branch (let ((branch (undo-tree-node-branch (undo-tree-current buffer-undo-tree)))) @@ -2919,13 +3532,13 @@ using `undo-tree-redo' or `undo-tree-visualizer-redo'." (1- (undo-tree-num-branches))) ((<= (+ branch arg) 0) 0) (t (+ branch arg)))) - ;; highlight new active branch below current node - (goto-char (undo-tree-node-marker (undo-tree-current buffer-undo-tree))) - (let ((undo-tree-insert-face 'undo-tree-visualizer-active-branch-face)) - (undo-tree-highlight-active-branch (undo-tree-current buffer-undo-tree))) - ;; re-highlight current node - (undo-tree-draw-node (undo-tree-current buffer-undo-tree) 'current) - (setq buffer-read-only t))) + (let ((inhibit-read-only t)) + ;; highlight new active branch below current node + (goto-char (undo-tree-node-marker (undo-tree-current buffer-undo-tree))) + (let ((undo-tree-insert-face 'undo-tree-visualizer-active-branch-face)) + (undo-tree-highlight-active-branch (undo-tree-current buffer-undo-tree))) + ;; re-highlight current node + (undo-tree-draw-node (undo-tree-current buffer-undo-tree) 'current)))) (defun undo-tree-visualize-switch-branch-left (arg) @@ -2944,12 +3557,25 @@ using `undo-tree-redo' or `undo-tree-visualizer-redo'." (unwind-protect (with-current-buffer undo-tree-visualizer-parent-buffer (remove-hook 'before-change-functions 'undo-tree-kill-visualizer t)) + ;; kill diff buffer, if any + (when undo-tree-visualizer-diff (undo-tree-visualizer-hide-diff)) (let ((parent undo-tree-visualizer-parent-buffer) window) + ;; kill visualizer buffer (kill-buffer nil) - (if (setq window (get-buffer-window parent)) - (select-window window) - (switch-to-buffer parent))))) + ;; switch back to parent buffer + (unwind-protect + (if (setq window (get-buffer-window parent)) + (select-window window) + (switch-to-buffer parent)))))) + + +(defun undo-tree-visualizer-abort () + "Quit the undo-tree visualizer and return buffer to original state." + (interactive) + (let ((node undo-tree-visualizer-initial-node)) + (undo-tree-visualizer-quit) + (undo-tree-set node))) (defun undo-tree-visualizer-set (&optional pos) @@ -2960,13 +3586,12 @@ at POS, or point if POS is nil." (let ((node (get-text-property pos 'undo-tree-node))) (when node ;; set parent buffer to state corresponding to node at POS - (set-buffer undo-tree-visualizer-parent-buffer) - (undo-tree-set node) - (set-buffer undo-tree-visualizer-buffer-name) - (setq buffer-read-only nil) + (switch-to-buffer-other-window undo-tree-visualizer-parent-buffer) + (let ((undo-tree-inhibit-kill-visualizer t)) (undo-tree-set node)) + (switch-to-buffer-other-window undo-tree-visualizer-buffer-name) ;; re-draw undo tree - (undo-tree-draw-tree buffer-undo-tree) - (setq buffer-read-only t)))) + (let ((inhibit-read-only t)) (undo-tree-draw-tree buffer-undo-tree)) + (when undo-tree-visualizer-diff (undo-tree-visualizer-update-diff))))) (defun undo-tree-visualizer-mouse-set (pos) @@ -2979,16 +3604,10 @@ at mouse event POS." (defun undo-tree-visualizer-toggle-timestamps () "Toggle display of time-stamps." (interactive) - (setq undo-tree-visualizer-spacing - (if (setq undo-tree-visualizer-timestamps - (not undo-tree-visualizer-timestamps)) - ;; need sufficient space if TIMESTAMP is set - (max 9 (default-value 'undo-tree-visualizer-spacing)) - (default-value 'undo-tree-visualizer-spacing))) + (setq undo-tree-visualizer-timestamps (not undo-tree-visualizer-timestamps)) + (setq undo-tree-visualizer-spacing (undo-tree-visualizer-calculate-spacing)) ;; redraw tree - (setq buffer-read-only nil) - (undo-tree-draw-tree buffer-undo-tree) - (setq buffer-read-only t)) + (let ((inhibit-read-only t)) (undo-tree-draw-tree buffer-undo-tree))) (defun undo-tree-visualizer-scroll-left (&optional arg) @@ -3012,61 +3631,165 @@ at mouse event POS." (setq major-mode 'undo-tree-visualizer-selection-mode) (setq mode-name "undo-tree-visualizer-selection-mode") (use-local-map undo-tree-visualizer-selection-map) - (setq cursor-type 'box)) + (setq cursor-type 'box) + (setq undo-tree-visualizer-selected-node + (undo-tree-current buffer-undo-tree)) + ;; erase diff (if any), as initially selected node is identical to current + (when undo-tree-visualizer-diff + (let ((buff (get-buffer undo-tree-diff-buffer-name)) + (inhibit-read-only t)) + (when buff (with-current-buffer buff (erase-buffer)))))) (defun undo-tree-visualizer-select-previous (&optional arg) "Move to previous node." (interactive "p") - (let ((node (get-text-property (point) 'undo-tree-node))) + (let ((node undo-tree-visualizer-selected-node)) (catch 'top (dotimes (i arg) (unless (undo-tree-node-previous node) (throw 'top t)) (setq node (undo-tree-node-previous node)))) - (goto-char (undo-tree-node-marker node)))) + (goto-char (undo-tree-node-marker node)) + (when (and undo-tree-visualizer-diff + (not (eq node undo-tree-visualizer-selected-node))) + (undo-tree-visualizer-update-diff node)) + (setq undo-tree-visualizer-selected-node node))) (defun undo-tree-visualizer-select-next (&optional arg) "Move to next node." (interactive "p") - (let ((node (get-text-property (point) 'undo-tree-node))) + (let ((node undo-tree-visualizer-selected-node)) (catch 'bottom (dotimes (i arg) (unless (nth (undo-tree-node-branch node) (undo-tree-node-next node)) (throw 'bottom t)) (setq node (nth (undo-tree-node-branch node) (undo-tree-node-next node))))) - (goto-char (undo-tree-node-marker node)))) + (goto-char (undo-tree-node-marker node)) + (when (and undo-tree-visualizer-diff + (not (eq node undo-tree-visualizer-selected-node))) + (undo-tree-visualizer-update-diff node)) + (setq undo-tree-visualizer-selected-node node))) (defun undo-tree-visualizer-select-right (&optional arg) "Move right to a sibling node." (interactive "p") - (let ((pos (point)) - (end (line-end-position)) - node) + (let ((node undo-tree-visualizer-selected-node) + end) + (goto-char (undo-tree-node-marker undo-tree-visualizer-selected-node)) + (setq end (line-end-position)) (catch 'end (dotimes (i arg) - (while (not node) + (while (or (null node) (eq node undo-tree-visualizer-selected-node)) (forward-char) (setq node (get-text-property (point) 'undo-tree-node)) (when (= (point) end) (throw 'end t))))) - (goto-char (if node (undo-tree-node-marker node) pos)))) + (goto-char (undo-tree-node-marker + (or node undo-tree-visualizer-selected-node))) + (when (and undo-tree-visualizer-diff node + (not (eq node undo-tree-visualizer-selected-node))) + (undo-tree-visualizer-update-diff node)) + (setq undo-tree-visualizer-selected-node node))) (defun undo-tree-visualizer-select-left (&optional arg) "Move left to a sibling node." (interactive "p") - (let ((pos (point)) - (beg (line-beginning-position)) - node) + (let ((node (get-text-property (point) 'undo-tree-node)) + beg) + (goto-char (undo-tree-node-marker undo-tree-visualizer-selected-node)) + (setq beg (line-beginning-position)) (catch 'beg (dotimes (i arg) - (while (not node) + (while (or (null node) (eq node undo-tree-visualizer-selected-node)) (backward-char) (setq node (get-text-property (point) 'undo-tree-node)) (when (= (point) beg) (throw 'beg t))))) - (goto-char (if node (undo-tree-node-marker node) pos)))) + (goto-char (undo-tree-node-marker + (or node undo-tree-visualizer-selected-node))) + (when (and undo-tree-visualizer-diff node + (not (eq node undo-tree-visualizer-selected-node))) + (undo-tree-visualizer-update-diff node)) + (setq undo-tree-visualizer-selected-node node))) + + + +;;; ===================================================================== +;;; Visualizer diff display + +(defun undo-tree-visualizer-toggle-diff () + "Toggle diff display in undo-tree visualizer." + (interactive) + (if undo-tree-visualizer-diff + (undo-tree-visualizer-hide-diff) + (undo-tree-visualizer-show-diff))) + + +(defun undo-tree-visualizer-selection-toggle-diff () + "Toggle diff display in undo-tree visualizer selection mode." + (interactive) + (if undo-tree-visualizer-diff + (undo-tree-visualizer-hide-diff) + (let ((node (get-text-property (point) 'undo-tree-node))) + (when node (undo-tree-visualizer-show-diff node))))) + + +(defun undo-tree-visualizer-show-diff (&optional node) + ;; show visualizer diff display + (setq undo-tree-visualizer-diff t) + (let ((buff (with-current-buffer undo-tree-visualizer-parent-buffer + (undo-tree-diff node))) + (display-buffer-mark-dedicated 'soft) + win) + (setq win (split-window)) + (set-window-buffer win buff) + (shrink-window-if-larger-than-buffer win))) + + +(defun undo-tree-visualizer-hide-diff () + ;; hide visualizer diff display + (setq undo-tree-visualizer-diff nil) + (let ((win (get-buffer-window undo-tree-diff-buffer-name))) + (when win (with-selected-window win (kill-buffer-and-window))))) + + +(defun undo-tree-diff (&optional node) + ;; Create diff between current state and NODE (or previous state, if NODE is + ;; null). Returns buffer containing diff. + (let (tmpfile buff) + ;; generate diff + (let ((undo-tree-inhibit-kill-visualizer t) + (current (undo-tree-current buffer-undo-tree))) + (undo-tree-set (or node (undo-tree-node-previous current) current) + 'preserve-timestamps) + (setq tmpfile (diff-file-local-copy (current-buffer))) + (undo-tree-set current 'preserve-timestamps)) + (setq buff (diff-no-select + (current-buffer) tmpfile nil 'noasync + (get-buffer-create undo-tree-diff-buffer-name))) + ;; delete process messages and useless headers from diff buffer + (with-current-buffer buff + (goto-char (point-min)) + (delete-region (point) (1+ (line-end-position 3))) + (goto-char (point-max)) + (forward-line -2) + (delete-region (point) (point-max)) + (setq cursor-type nil) + (setq buffer-read-only t)) + buff)) + + +(defun undo-tree-visualizer-update-diff (&optional node) + ;; update visualizer diff display to show diff between current state and + ;; NODE (or previous state, if NODE is null) + (with-current-buffer undo-tree-visualizer-parent-buffer + (undo-tree-diff node)) + (let ((win (get-buffer-window undo-tree-diff-buffer-name))) + (when win + (balance-windows) + (shrink-window-if-larger-than-buffer win)))) |
