;; Highlight Changes mode in passive state while you make your changes, toggle
;; it on to active mode to see them, then toggle it back off to avoid
;; distraction.
-;;
+;;
;; When active, changes are displayed in `highlight-changes-face'. When
-;; text is deleted, the following character is displayed in
+;; text is deleted, the following character is displayed in
;; `highlight-changes-delete-face' face.
;;
;;
;; modes. The variable
;; `highlight-changes-mode' contains the new
;; state (`active' or `passive'.)
-;;
;;
-;;
+;;
+;;
;; Example usage:
;; (defun my-highlight-changes-enable-hook ()
;; (add-hook 'local-write-file-hooks 'highlight-changes-rotate-faces)
;; )
-;;
+;;
;; (defun my-highlight-changes-disable-hook ()
;; (remove-hook 'local-write-file-hooks 'highlight-changes-rotate-faces)
;; )
-;;
+;;
;; (add-hook 'highlight-changes-enable-hook 'my-highlight-changes-enable-hook)
;; (add-hook 'highlight-changes-disable-hook
;; 'my-highlight-changes-disable-hook)
;;
;; If you prefer to have it automatically invoked you can do it as
;; follows.
-;;
+;;
;; 1. Most modes have a major-hook, typically called MODE-hook. You
-;; can use `add-hook' to call `highlight-changes-mode'.
+;; can use `add-hook' to call `highlight-changes-mode'.
;;
;; Example:
;; (add-hook 'c-mode-hook 'highlight-changes-mode)
;;
;; If you want to make it start up in passive mode (regardless of the
;; setting of highlight-changes-initial-state):
-;; (add-hook 'emacs-lisp-mode-hook
+;; (add-hook 'emacs-lisp-mode-hook
;; (lambda ()
;; (highlight-changes-mode 'passive)))
;;
;; However, this cannot be done for Fundamental mode for there is no
;; such hook.
;;
-;; 2. You can use the function `global-highlight-changes'
+;; 2. You can use the function `global-highlight-changes'
;;
;; This function, which is fashioned after the way `global-font-lock' works,
;; toggles on or off global Highlight Changes mode. When activated, it turns
;; on Highlight Changes mode in all "suitable" existing buffers and will turn
;; it on in new "suitable" buffers to be created.
-;;
+;;
;; A buffer's "suitability" is determined by variable
-;; `highlight-changes-global-modes', as follows. If the variable is
+;; `highlight-changes-global-modes', as follows. If the variable is
;; * nil -- then no buffers are suitable;
;; * a function -- this function is called and the result is used. As
-;; an example, if the value is `buffer-file-name' then all buffers
+;; an example, if the value is `buffer-file-name' then all buffers
;; who are visiting files are suitable, but others (like dired
;; buffers) are not;
;; * a list -- then the buffer is suitable iff its mode is in the
-;; list, except if the first element is `not', in which case the test
+;; list, except if the first element is `not', in which case the test
;; is reversed (i.e. it is a list of unsuitable modes).
-;; * Otherwise, the buffer is suitable if its name does not begin with
+;; * Otherwise, the buffer is suitable if its name does not begin with
;; ` ' or `*' and if `buffer-file-name' returns true.
;;
;; highlight-changes-rotate-faces
;; highlight-compare-with-file
-;;
+;;
;; You can automatically rotate faces when the buffer is saved;
;; see function `highlight-changes-rotate-faces' for how to do this.
;;
;;; Bugs:
;; - the next-change and previous-change functions are too literal;
-;; they should find the next "real" change, in other words treat
+;; they should find the next "real" change, in other words treat
;; consecutive changes as one.
-;;; To do (maybe), notes, ...
+;;; To do (maybe), notes, ...
;; - having different faces for deletion and non-deletion: is it
;; really worth the hassle?
;; R Sharman (rsharman@magma.ca) Feb 1998:
;; - initial release as change-mode.
;; Jari Aalto <jari.aalto@ntc.nokia.com> Mar 1998
-;; - fixes for byte compile errors
+;; - fixes for byte compile errors
;; - use eval-and-compile for autoload
;; Marijn Ros <J.M.Ros@fys.ruu.nl> Mar 98
;; - suggested turning it on by default
;; A (not very good) default list of colours to rotate through.
;;
-(defcustom highlight-changes-colours
+(defcustom highlight-changes-colours
(if (eq (frame-parameter nil 'background-mode) 'light)
;; defaults for light background:
'( "magenta" "blue" "darkgreen" "chocolate" "sienna4" "NavyBlue")
;; defaults for dark background:
'("yellow" "magenta" "blue" "maroon" "firebrick" "green4" "DarkOrchid"))
"*Colours used by `highlight-changes-rotate-faces'.
-The newest rotated change will be displayed in the first element of this list,
+The newest rotated change will be displayed in the first element of this list,
the next older will be in the second element etc.
-This list is used if `highlight-changes-face-list' is nil, otherwise that
-variable overrides this list. If you only care about foreground
-colours then use this, if you want fancier faces then set
+This list is used if `highlight-changes-face-list' is nil, otherwise that
+variable overrides this list. If you only care about foreground
+colours then use this, if you want fancier faces then set
`highlight-changes-face-list'."
:type '(repeat color)
:group 'highlight-changes)
-
-;; If you invoke highlight-changes-mode with no argument, should it start in
+
+;; If you invoke highlight-changes-mode with no argument, should it start in
;; active or passive mode?
;;
(defcustom highlight-changes-initial-state 'active
:group 'highlight-changes)
;; The strings displayed in the mode-line for the minor mode:
-(defcustom highlight-changes-active-string nil
+(defcustom highlight-changes-active-string " +Chg"
"*The string used when Highlight Changes mode is in the active state.
-This should be set to nil if no indication is desired, or to
+This should be set to nil if no indication is desired, or to
a string with a leading space."
:type '(choice string
(const :tag "None" nil))
:group 'highlight-changes)
-(defcustom highlight-changes-passive-string " Chg"
+(defcustom highlight-changes-passive-string " -Chg"
"*The string used when Highlight Changes mode is in the passive state.
-This should be set to nil if no indication is desired, or to
+This should be set to nil if no indication is desired, or to
a string with a leading space."
:type '(choice string
(const :tag "None" nil))
(defcustom highlight-changes-global-modes t
"*Determine whether a buffer is suitable for global Highlight Changes mode.
-A function means that function is called: if it returns non-nil, the
-buffer is suitable.
+A function means call that function to decide: if it returns non-nil,
+the buffer is suitable.
-A list is a list of modes for which it is suitable, or a list whose
-first element is `not' followed by modes which are not suitable.
+A list means the elements are major modes suitable for Highlight
+Changes mode, or a list whose first element is `not' followed by major
+modes which are not suitable.
-t means the buffer is suitable if its name does not begin with ` ' nor
-`*' and the buffer has a filename.
+t means the buffer is suitable if it is visiting a file and its name
+does not begin with ` ' or `*'.
A value of nil means no buffers are suitable for `global-highlight-changes'
-(effectively disabling the mode).
+\(effectively disabling the mode).
Examples:
(c-mode c++-mode)
means that Highlight Changes mode is turned on for buffers in C and C++
modes only."
- :type '(choice
+ :type '(choice
(const :tag "all non-special buffers visiting files" t)
(set :menu-tag "specific modes" :tag "modes"
:value (not)
(defun hilit-chg-cust-fix-changes-face-list (w wc &optional event)
;; When customization function `highlight-changes-face-list' inserts a new
- ;; face it uses the default face. We don't want the user to modify this
- ;; face, so we rename the faces in the list on an insert. The rename is
+ ;; face it uses the default face. We don't want the user to modify this
+ ;; face, so we rename the faces in the list on an insert. The rename is
;; actually done by copying the faces so user-defined faces still remain
;; in the same order.
;; The notifying the parent is needed because without it changes to the
(if (eq old-name new-name)
nil
;; A new face has been inserted: we don't want to modify the
- ;; default face so copy it. Better, though, (I think) is to
+ ;; default face so copy it. Better, though, (I think) is to
;; make a new face have the same attributes as
;; highlight-changes-face .
(if (eq old-name 'default)
Otherwise, this list will be constructed when needed from
`highlight-changes-colours'."
:type '(choice
- (repeat
+ (repeat
:notify hilit-chg-cust-fix-changes-face-list
face )
(const :tag "Derive from highlight-changes-colours" nil)
(defun hilit-chg-make-ov (prop start end)
+ (or prop
+ (error "hilit-chg-make-ov: prop is nil"))
;; for the region make change overlays corresponding to
;; the text property 'hilit-chg
(let ((ov (make-overlay start end))
face)
- (or prop
- (error "hilit-chg-make-ov: prop is nil"))
(if (eq prop 'hilit-chg-delete)
(setq face 'highlight-changes-delete-face)
(setq face (nth 1 (member prop hilit-chg-list))))
(if face
(progn
- ;; We must mark the face, that is the purpose of the overlay
+ ;; We must mark the face, that is the purpose of the overlay
(overlay-put ov 'face face)
;; I don't think we need to set evaporate since we should
;; be controlling them!
(defun hilit-chg-hide-changes (&optional beg end)
"Remove face information for Highlight Changes mode.
-The overlay containing the face is removed, but the text property
+The overlay containing the face is removed, but the text property
containing the change information is retained.
This is the opposite of `hilit-chg-display-changes'."
Ensure the overlays agree with the changes as determined from
the text properties of type `hilit-chg' ."
;; Remove or alter overlays in region beg..end
- (let (p ov ov-start ov-end
- props q)
- (setq p (overlays-in beg end))
+ (let (ov-start ov-end props q)
;; temp for debugging:
;; (or (eq highlight-changes-mode 'active)
;; (error "hilit-chg-fixup called but Highlight Changes mode not active"))
- (while p
- (setq ov (car p))
- (setq ov-start (overlay-start ov))
- (setq ov-end (overlay-end ov))
- (if (< ov-start beg)
- (progn
- (move-overlay ov ov-start beg)
+ (dolist (ov (overlays-in beg end))
+ ;; Don't alter overlays that are not ours.
+ (when (overlay-get ov 'hilit-chg)
+ (let ((ov-start (overlay-start ov))
+ (ov-end (overlay-end ov)))
+ (if (< ov-start beg)
+ (progn
+ (move-overlay ov ov-start beg)
+ (if (> ov-end end)
+ (progn
+ (setq props (overlay-properties ov))
+ (setq ov (make-overlay end ov-end))
+ (while props
+ (overlay-put ov (car props)(car (cdr props)))
+ (setq props (cdr (cdr props)))))))
(if (> ov-end end)
- (progn
- (setq props (overlay-properties ov))
- (setq ov (make-overlay end ov-end))
- (while props
- (overlay-put ov (car props)(car (cdr props)))
- (setq props (cdr (cdr props)))))))
- (if (> ov-end end)
- (move-overlay ov end ov-end)
- (delete-overlay ov)))
- (setq p (cdr p)))
+ (move-overlay ov end ov-end)
+ (delete-overlay ov))))))
(hilit-chg-display-changes beg end)))
;;;###autoload
-(defun highlight-changes-remove-highlight (beg end)
- "Remove the change face from the region between BEG and END.
+(defun highlight-changes-remove-highlight (beg end)
+ "Remove the change face from the region between BEG and END.
This allows you to manually remove highlighting from uninteresting changes."
(interactive "r")
(let ((after-change-functions nil))
(remove-text-properties beg end '(hilit-chg nil))
(hilit-chg-fixup beg end)))
-(defun hilit-chg-set-face-on-change (beg end leng-before
- &optional no-proerty-change)
+(defun hilit-chg-set-face-on-change (beg end leng-before
+ &optional no-property-change)
"Record changes and optionally display them in a distinctive face.
`hilit-chg-set' adds this function to the `after-change-functions' hook."
;;
;;
;; We do NOT want to simply do this if this is an undo command, because
;; otherwise an undone change shows up as changed. While the properties
- ;; are automatically restored by undo, we must fix up the overlay.
+ ;; are automatically restored by undo, we must fix up the overlay.
(save-match-data
(let ((beg-decr 1) (end-incr 1)
(type 'hilit-chg)
;; deletion
(progn
;; The eolp and bolp tests are a kludge! But they prevent
- ;; rather nasty looking displays when deleting text at the end
- ;; of line, such as normal corrections as one is typing and
- ;; immediately makes a correction, and when deleting first
+ ;; rather nasty looking displays when deleting text at the end
+ ;; of line, such as normal corrections as one is typing and
+ ;; immediately makes a correction, and when deleting first
;; character of a line.
;;; (if (= leng-before 1)
;;; (if (eolp)
(setq end (min (+ end end-incr) (point-max)))
(setq type 'hilit-chg-delete))
;; Not a deletion.
- ;; Most of the time the following is not necessary, but
+ ;; Most of the time the following is not necessary, but
;; if the current text was marked as a deletion then
;; the old overlay is still in effect, so if we add some
- ;; text then remove the deletion marking, but set it to
+ ;; text then remove the deletion marking, but set it to
;; changed otherwise its highlighting disappears.
(if (eq (get-text-property end 'hilit-chg) 'hilit-chg-delete)
(progn
(put-text-property end (+ end 1) 'hilit-chg 'hilit-chg)
(if (eq highlight-changes-mode 'active)
(hilit-chg-fixup beg (+ end 1))))))
- (unless no-proerty-change
+ (unless no-property-change
(put-text-property beg end 'hilit-chg type))
- (if (or (eq highlight-changes-mode 'active) no-proerty-change)
+ (if (or (eq highlight-changes-mode 'active) no-property-change)
(hilit-chg-make-ov type beg end))))))
(defun hilit-chg-set (value)
(or buffer-read-only
(hilit-chg-hide-changes)))
(force-mode-line-update)
- (make-local-hook 'after-change-functions)
(add-hook 'after-change-functions 'hilit-chg-set-face-on-change nil t))
(defun hilit-chg-clear ()
(remove-hook 'after-change-functions 'hilit-chg-set-face-on-change t)
(let ((after-change-functions nil))
(hilit-chg-hide-changes)
- (hilit-chg-map-changes
+ (hilit-chg-map-changes
'(lambda (prop start stop)
(remove-text-properties start stop '(hilit-chg nil))))
)
(setq highlight-changes-mode nil)
(force-mode-line-update)
;; If we type: C-u -1 M-x highlight-changes-mode
- ;; we want to turn it off, but hilit-chg-post-command-hook
+ ;; we want to turn it off, but hilit-chg-post-command-hook
;; runs and that turns it back on!
(remove-hook 'post-command-hook 'hilit-chg-post-command-hook)))
(defun highlight-changes-mode (&optional arg)
"Toggle (or initially set) Highlight Changes mode.
-Without an argument:
+Without an argument:
If Highlight Changes mode is not enabled, then enable it (in either active
or passive state as determined by the variable
`highlight-changes-initial-state'); otherwise, toggle between active
Functions:
\\[highlight-changes-next-change] - move point to beginning of next change
-\\[highlight-changes-previous-change] - move to beginning of previous change
+\\[highlight-changes-previous-change] - move to beginning of previous change
\\[highlight-compare-with-file] - mark text as changed by comparing this
buffer with the contents of a file
\\[highlight-changes-remove-highlight] - remove the change face from the region
\\[highlight-changes-rotate-faces] - rotate different \"ages\" of changes \
-through
+through
various faces.
Hook variables:
(defun hilit-chg-make-list (&optional force)
"Construct `hilit-chg-list' and `highlight-changes-face-list'."
- ;; Constructs highlight-changes-face-list if necessary,
+ ;; Constructs highlight-changes-face-list if necessary,
;; and hilit-chg-list always:
;; Maybe this should always be called when rotating a face
;; so we pick up any changes?
(if (or (null highlight-changes-face-list) ; Don't do it if it
force) ; already exists unless FORCE non-nil.
- (let ((p highlight-changes-colours)
+ (let ((p highlight-changes-colours)
(n 1) name)
(setq highlight-changes-face-list nil)
(while p
(setq name (intern (format "highlight-changes-face-%d" n)))
(copy-face 'highlight-changes-face name)
(set-face-foreground name (car p))
- (setq highlight-changes-face-list
+ (setq highlight-changes-face-list
(append highlight-changes-face-list (list name)))
(setq p (cdr p))
(setq n (1+ n)))))
(setq hilit-chg-list (list 'hilit-chg 'highlight-changes-face))
(let ((p highlight-changes-face-list)
- (n 1)
+ (n 1)
last-category last-face)
(while p
(setq last-category (intern (format "change-%d" n)))
shown in the last face in the list.
You can automatically rotate colours when the buffer is saved
-by adding the following to `local-write-file-hooks', by evaling it in the
+by adding the following to `local-write-file-hooks', by evaling it in the
buffer to be saved):
\(add-hook 'local-write-file-hooks 'highlight-changes-rotate-faces)"
nil)
;; ========================================================================
-;; Comparing with an existing file.
+;; Comparing with an existing file.
;; This uses ediff to find the differences.
;;;###autoload
"" ;; directory
nil ;; default
'yes ;; must exist
- (let ((f (make-backup-file-name
+ (let ((f (make-backup-file-name
(or (buffer-file-name (current-buffer))
(error "no file for this buffer")))))
(if (file-exists-p f) f "")))))
(setq p (cdr p))
(setq q (cdr q)))
(if existing-buf
- (set-buffer-modified-p nil)
+ (set-buffer-modified-p nil)
(kill-buffer buf-b))))
(defun hilit-chg-get-diff-list-hk ()
- ;; x and y are dynamically bound by hilit-chg-get-diff-info
+ ;; x and y are dynamically bound by hilit-chg-get-diff-info
;; which calls this function as a hook
(defvar x) ;; placate the byte-compiler
(defvar y)
;; va is a vector if there are fine differences
(if va
(setq a (append va nil))
- ;; if not, get the unrefined difference
+ ;; if not, get the unrefined difference
(setq va (ediff-get-difference n 'A))
(setq a (list (elt va 0))))
;; a list a list
;; vb is a vector
(if vb
(setq b (append vb nil))
- ;; if not, get the unrefined difference
+ ;; if not, get the unrefined difference
(setq vb (ediff-get-difference n 'B))
(setq b (list (elt vb 0))))
;; b list a list
;; Global Highlight Changes mode is modeled after Global Font-lock mode.
;; Three hooks are used to gain control. When Global Changes Mode is
;; enabled, `find-file-hooks' and `change-major-mode-hook' are set.
-;; `find-file-hooks' is called when visiting a file, the new mode is
+;; `find-file-hooks' is called when visiting a file, the new mode is
;; known at this time.
;; `change-major-mode-hook' is called when a buffer is changing mode.
;; This could be because of finding a file in which case
;; `find-file-hooks' has already been called and has done its work.
;; However, it also catches the case where a new mode is being set by
;; the user. However, it is called from `kill-all-variables' and at
-;; this time the mode is the old mode, which is not what we want.
-;; So, our function temporarily sets `post-command-hook' which will
+;; this time the mode is the old mode, which is not what we want.
+;; So, our function temporarily sets `post-command-hook' which will
;; be called after the buffer has been completely set up (with the new
;; mode). It then removes the `post-command-hook'.
;; One other wrinkle - every M-x command runs the `change-major-mode-hook'
(defun hilit-chg-post-command-hook ()
;; This is called after changing a major mode, but also after each
- ;; M-x command, in which case the current buffer is a minibuffer.
- ;; In that case, do not act on it here, but don't turn it off
- ;; either, we will get called here again soon-after.
- ;; Also, don't enable it for other special buffers.
+ ;; M-x command, in which case the current buffer is a minibuffer.
+ ;; In that case, do not act on it here, but don't turn it off
+ ;; either, we will get called here again soon-after.
+ ;; Also, don't enable it for other special buffers.
(if (string-match "^[ *]" (buffer-name))
nil ;; (message "ignoring this post-command-hook")
(remove-hook 'post-command-hook 'hilit-chg-post-command-hook)
- ;; The following check isn't necessary, since
+ ;; The following check isn't necessary, since
;; hilit-chg-turn-on-maybe makes this check too.
(or highlight-changes-mode ;; don't turn it on if it already is
(hilit-chg-turn-on-maybe highlight-changes-global-initial-state))))
When called from a program:
- if ARG is nil or omitted, turn it off
-- if ARG is `active', turn it on in active mode
+- if ARG is `active', turn it on in active mode
- if ARG is `passive', turn it on in passive mode
-- otherwise just turn it on
+- otherwise just turn it on
When global Highlight Changes mode is enabled, Highlight Changes mode is turned
on for future \"suitable\" buffers (and for \"suitable\" existing buffers if
variable `highlight-changes-global-changes-existing-buffers' is non-nil).
\"Suitability\" is determined by variable `highlight-changes-global-modes'."
- (interactive
+ (interactive
(list
(cond
((null current-prefix-arg)
'passive)
;; negative interactive arg - turn it off
(t
- (setq global-highlight-changes nil)
+ (setq global-highlight-changes nil)
nil))))
(if arg
(if (eq arg 'passive)
(setq highlight-changes-global-initial-state 'passive)))
(setq global-highlight-changes t)
- (message "turning ON Global Highlight Changes mode in %s state"
+ (message "Turning ON Global Highlight Changes mode in %s state"
highlight-changes-global-initial-state)
(add-hook 'hilit-chg-major-mode-hook 'hilit-chg-major-mode-hook)
(add-hook 'find-file-hooks 'hilit-chg-check-global)
(if highlight-changes-global-changes-existing-buffers
- (hilit-chg-update-all-buffers
+ (hilit-chg-update-all-buffers
highlight-changes-global-initial-state)))
-
- (message "turning OFF global Highlight Changes mode")
+
+ (message "Turning OFF global Highlight Changes mode")
(remove-hook 'hilit-chg-major-mode-hook 'hilit-chg-major-mode-hook)
(remove-hook 'find-file-hooks 'hilit-chg-check-global)
(remove-hook 'post-command-hook
"Turn on Highlight Changes mode if it is appropriate for this buffer.
A buffer is appropriate for Highlight Changes mode if all these are true:
-- the buffer is not a special buffer (one whose name begins with
+- the buffer is not a special buffer (one whose name begins with
`*' or ` ')
- the buffer's mode is suitable as per variable
`highlight-changes-global-modes'
- Highlight Changes mode is not already on for this buffer.
-This function is called from `hilit-chg-update-all-buffers' or
+This function is called from `hilit-chg-update-all-buffers' or
from `global-highlight-changes' when turning on global Highlight Changes mode."
(or highlight-changes-mode ; do nothing if already on
(if
(not (memq major-mode (cdr highlight-changes-global-modes)))
(memq major-mode highlight-changes-global-modes)))
(t
- (and
+ (and
(not (string-match "^[ *]" (buffer-name)))
(buffer-file-name))))
(progn
(hilit-chg-set value)
(run-hooks 'highlight-changes-enable-hook)))))
-
+
(defun hilit-chg-turn-off-maybe ()
(if highlight-changes-mode
;; )
;; beg end
;; ))
-;;
+;;
;; ================== end of debug ===============
(provide 'hilit-chg)
HCoop / bpt / emacs.git / blobdiff