(byte-compile-dynamic)

[gnu-emacs] / lisp / hilit-chg.el

diff --git a/lisp/hilit-chg.el b/lisp/hilit-chg.el
index 4e9fbeb53f6e631a4b43844e5b67e0b2368845ff..d6408412c0b066afe6bcabb9ecb3f69f72aa6c5a 100644 (file)
--- a/lisp/hilit-chg.el
+++ b/lisp/hilit-chg.el
@@ -1,6 +1,7 @@
 ;;; hilit-chg.el --- minor mode displaying buffer changes with special face
 
 ;;; hilit-chg.el --- minor mode displaying buffer changes with special face
 

-;; Copyright (C) 1998, 2000, 2005  Free Software Foundation, Inc.
+;; Copyright (C) 1998, 2000, 2002, 2003, 2004,
+;;   2005, 2006 Free Software Foundation, Inc.

 
 ;; Author: Richard Sharman <rsharman@pobox.com>
 ;; Keywords: faces
 
 ;; Author: Richard Sharman <rsharman@pobox.com>
 ;; Keywords: faces


@@ -19,8 +20,8 @@
 
 ;; You should have received a copy of the GNU General Public License
 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
 
 ;; You should have received a copy of the GNU General Public License
 ;; along with GNU Emacs; see the file COPYING.  If not, write to the

-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.

 
 ;;; Commentary:
 
 
 ;;; Commentary:
 


@@ -49,9 +50,9 @@
 ;; either explicitly define each face by customizing
 ;; `highlight-changes-face-list'.  If, however, the faces differ from
 ;; the `highlight-changes' face only in the foreground color, you can simply set
 ;; either explicitly define each face by customizing
 ;; `highlight-changes-face-list'.  If, however, the faces differ from
 ;; the `highlight-changes' face only in the foreground color, you can simply set

-;; `highlight-changes-colours'.  If `highlight-changes-face-list' is nil when
+;; `highlight-changes-colors'.  If `highlight-changes-face-list' is nil when

 ;; the faces are required they will be constructed from
 ;; the faces are required they will be constructed from

-;; `highlight-changes-colours'.
+;; `highlight-changes-colors'.

 ;;
 ;;
 ;; When a Highlight Changes mode is on (either active or passive) you can go
 ;;
 ;;
 ;; When a Highlight Changes mode is on (either active or passive) you can go


@@ -81,11 +82,11 @@
 ;;
 ;; Example usage:
 ;; (defun my-highlight-changes-enable-hook ()
 ;;
 ;; Example usage:
 ;; (defun my-highlight-changes-enable-hook ()

-;;   (add-hook 'local-write-file-hooks 'highlight-changes-rotate-faces)
+;;   (add-hook 'write-file-functions 'highlight-changes-rotate-faces nil t)

 ;; )
 ;;
 ;; (defun my-highlight-changes-disable-hook ()
 ;; )
 ;;
 ;; (defun my-highlight-changes-disable-hook ()

-;;   (remove-hook 'local-write-file-hooks 'highlight-changes-rotate-faces)
+;;   (remove-hook 'write-file-functions 'highlight-changes-rotate-faces t)

 ;; )
 ;;
 ;; (add-hook 'highlight-changes-enable-hook 'my-highlight-changes-enable-hook)
 ;; )
 ;;
 ;; (add-hook 'highlight-changes-enable-hook 'my-highlight-changes-enable-hook)


@@ -213,7 +214,7 @@
 ;; indentation on inserts gets underlined (which can look pretty ugly!).
 
 (defface highlight-changes
 ;; indentation on inserts gets underlined (which can look pretty ugly!).
 
 (defface highlight-changes

-  '((((min-colors 88) (class color)) (:foreground "red1" ))
+  '((((min-colors 88) (class color)) (:foreground "red1"))

     (((class color)) (:foreground "red" ))
     (t (:inverse-video t)))
   "Face used for highlighting changes."
     (((class color)) (:foreground "red" ))
     (t (:inverse-video t)))
   "Face used for highlighting changes."


@@ -233,41 +234,44 @@
 
 
 
 
 
 

-;; A (not very good) default list of colours to rotate through.
+;; A (not very good) default list of colors to rotate through.

 ;;
 ;;

-(defcustom highlight-changes-colours
+(defcustom highlight-changes-colors

   (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"))
   (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'.
+  "*Colors used by `highlight-changes-rotate-faces'.

 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
 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
+colors then use this, if you want fancier faces then set

 `highlight-changes-face-list'."
   :type '(repeat color)
   :group 'highlight-changes)
 
 `highlight-changes-face-list'."
   :type '(repeat color)
   :group 'highlight-changes)
 

+(define-obsolete-variable-alias 'highlight-changes-colours
+                                'highlight-changes-colors "22.1")
+

 
 ;; If you invoke highlight-changes-mode with no argument, should it start in
 ;; active or passive mode?
 ;;
 (defcustom highlight-changes-initial-state 'active
 
 ;; If you invoke highlight-changes-mode with no argument, should it start in
 ;; active or passive mode?
 ;;
 (defcustom highlight-changes-initial-state 'active

-  "*What state (active or passive) `highlight-changes' should start in.
-This is used when `highlight-changes' is called with no argument.
+  "*What state (active or passive) Highlight Changes mode should start in.
+This is used when `highlight-changes-mode' is called with no argument.

 This variable must be set to one of the symbols `active' or `passive'."
   :type '(choice (const :tag "Active" active)
                 (const :tag "Passive" passive))
   :group 'highlight-changes)
 
 (defcustom highlight-changes-global-initial-state 'passive
 This variable must be set to one of the symbols `active' or `passive'."
   :type '(choice (const :tag "Active" active)
                 (const :tag "Passive" passive))
   :group 'highlight-changes)
 
 (defcustom highlight-changes-global-initial-state 'passive

-  "*What state `global-highlight-changes' should start in.
+  "*What state global Highlight Changes mode should start in.

 This is used if `global-highlight-changes' is called with no argument.
 This is used if `global-highlight-changes' is called with no argument.

-This variable must be set to either `active' or `passive'"
+This variable must be set to either `active' or `passive'."

   :type '(choice (const :tag "Active" active)
                 (const :tag "Passive" passive))
   :group 'highlight-changes)
   :type '(choice (const :tag "Active" active)
                 (const :tag "Passive" passive))
   :group 'highlight-changes)


@@ -299,13 +303,13 @@ 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.
 
 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 it is visiting a file and its name
-does not begin with ` ' or `*'.
+A value of 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).
 
 
 A value of nil means no buffers are suitable for `global-highlight-changes'
 \(effectively disabling the mode).
 

-Examples:
+Example:

         (c-mode c++-mode)
 means that Highlight Changes mode is turned on for buffers in C and C++
 modes only."
         (c-mode c++-mode)
 means that Highlight Changes mode is turned on for buffers in C and C++
 modes only."


@@ -362,7 +366,7 @@ remove it from existing buffers."
                  (copy-face 'highlight-changes new-name)
                (copy-face old-name new-name)
                ))
                  (copy-face 'highlight-changes new-name)
                (copy-face old-name new-name)
                ))

-           (setq new-list (append  (list new-name) new-list))
+           (setq new-list (append (list new-name) new-list))

            (setq n (1- n))
            (setq p (cdr p)))
          (if (equal new-list (widget-value w))
            (setq n (1- n))
            (setq p (cdr p)))
          (if (equal new-list (widget-value w))


@@ -381,16 +385,16 @@ remove it from existing buffers."
 (defcustom highlight-changes-face-list nil
   "*A list of faces used when rotating changes.
 Normally the variable is initialized to nil and the list is created from
 (defcustom highlight-changes-face-list nil
   "*A list of faces used when rotating changes.
 Normally the variable is initialized to nil and the list is created from

-`highlight-changes-colours' when needed.  However, you can set this variable
+`highlight-changes-colors' when needed.  However, you can set this variable

 to any list of faces.  You will have to do this if you want faces which
 to any list of faces.  You will have to do this if you want faces which

-don't just differ from the `highlight-changes' face by the foreground colour.
+don't just differ from the `highlight-changes' face by the foreground color.

 Otherwise, this list will be constructed when needed from
 Otherwise, this list will be constructed when needed from

-`highlight-changes-colours'."
+`highlight-changes-colors'."

   :type '(choice
          (repeat
            :notify hilit-chg-cust-fix-changes-face-list
            face  )
   :type '(choice
          (repeat
            :notify hilit-chg-cust-fix-changes-face-list
            face  )

-         (const :tag "Derive from highlight-changes-colours"  nil)
+         (const :tag "Derive from highlight-changes-colors"  nil)

          )
   :group 'highlight-changes)
 
          )
   :group 'highlight-changes)
 


@@ -415,7 +419,7 @@ Otherwise, this list will be constructed when needed from
 
 ;;; Functions...
 
 
 ;;; Functions...
 

-(defun hilit-chg-map-changes  (func &optional start-position end-position)
+(defun hilit-chg-map-changes (func &optional start-position end-position)

   "Call function FUNC for each region used by Highlight Changes mode."
   ;; if start-position is nil, (point-min) is used
   ;; if end-position is nil, (point-max) is used
   "Call function FUNC for each region used by Highlight Changes mode."
   ;; if start-position is nil, (point-min) is used
   ;; if end-position is nil, (point-max) is used


@@ -485,7 +489,7 @@ This is the opposite of `hilit-chg-display-changes'."
   "Fix change overlays in region between BEG and END.
 
 Ensure the overlays agree with the changes as determined from
   "Fix change overlays in region between BEG and END.
 
 Ensure the overlays agree with the changes as determined from

-the text properties of type `hilit-chg' ."
+the text properties of type `hilit-chg'."

   ;; Remove or alter overlays in region beg..end
   (let (ov-start ov-end         props q)
     ;; temp for debugging:
   ;; Remove or alter overlays in region beg..end
   (let (ov-start ov-end         props q)
     ;; temp for debugging:


@@ -517,7 +521,7 @@ the text properties of type `hilit-chg' ."
 This allows you to manually remove highlighting from uninteresting changes."
   (interactive "r")
   (let ((after-change-functions nil))
 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))
+    (remove-text-properties beg end '(hilit-chg nil))

     (hilit-chg-fixup beg end)))
 
 (defun hilit-chg-set-face-on-change (beg end leng-before
     (hilit-chg-fixup beg end)))
 
 (defun hilit-chg-set-face-on-change (beg end leng-before


@@ -638,12 +642,12 @@ Functions:
 \\[highlight-changes-remove-highlight] - remove the change face from the region
 \\[highlight-changes-rotate-faces] - rotate different \"ages\" of changes \
 through
 \\[highlight-changes-remove-highlight] - remove the change face from the region
 \\[highlight-changes-rotate-faces] - rotate different \"ages\" of changes \
 through

-       various faces.
+       various faces

 
 Hook variables:
 
 Hook variables:

-`highlight-changes-enable-hook'  - when enabling Highlight Changes mode.
+`highlight-changes-enable-hook'  - when enabling Highlight Changes mode

 `highlight-changes-toggle-hook'  - when entering active or passive state
 `highlight-changes-toggle-hook'  - when entering active or passive state

-`highlight-changes-disable-hook' - when turning off Highlight Changes mode."
+`highlight-changes-disable-hook' - when turning off Highlight Changes mode"

   (interactive "P")
   (if (or (display-color-p)
          (and (fboundp 'x-display-grayscale-p) (x-display-grayscale-p)))
   (interactive "P")
   (if (or (display-color-p)
          (and (fboundp 'x-display-grayscale-p) (x-display-grayscale-p)))


@@ -658,7 +662,7 @@ Hook variables:
              ;; an argument is given
              ((eq arg 'active)
               'active)
              ;; an argument is given
              ((eq arg 'active)
               'active)

-             ((eq arg  'passive)
+             ((eq arg 'passive)

               'passive)
              ((> (prefix-numeric-value arg) 0)
               'active)
               'passive)
              ((> (prefix-numeric-value arg) 0)
               'active)


@@ -731,7 +735,7 @@ Hook variables:
   ;; 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.
   ;; 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-colors)

            (n 1) name)
        (setq highlight-changes-face-list nil)
        (while p
            (n 1) name)
        (setq highlight-changes-face-list nil)
        (while p


@@ -778,11 +782,11 @@ of `highlight-changes-face-list', one level older changes are shown in
 face described by the second element, and so on.  Very old changes remain
 shown in the last face in the list.
 
 face described by the second element, and so on.  Very old changes remain
 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
-buffer to be saved):
+You can automatically rotate colors when the buffer is saved by adding
+this function to `write-file-functions' as a buffer-local value.  To do
+this, eval the following in the buffer to be saved:

 
 

-  \(add-hook 'local-write-file-hooks 'highlight-changes-rotate-faces)"
+  \(add-hook 'write-file-functions 'highlight-changes-rotate-faces nil t)"

   (interactive)
   ;; If not in active mode do nothing but don't complain because this
   ;; may be bound to a hook.
   (interactive)
   ;; If not in active mode do nothing but don't complain because this
   ;; may be bound to a hook.


@@ -797,8 +801,7 @@ buffer to be saved):
        ;; and display them all if active
        (if (eq highlight-changes-mode 'active)
            (hilit-chg-display-changes))))
        ;; and display them all if active
        (if (eq highlight-changes-mode 'active)
            (hilit-chg-display-changes))))

-  ;; This always returns nil so it is safe to use in
-  ;; local-write-file-hook
+  ;; This always returns nil so it is safe to use in write-file-functions

   nil)
 
 ;; ========================================================================
   nil)
 
 ;; ========================================================================


@@ -846,7 +849,7 @@ is non-nil."
 
       (setq change-a (car change-info))
       (setq change-b (car (cdr change-info)))
 
       (setq change-a (car change-info))
       (setq change-b (car (cdr change-info)))

-      
+

       (hilit-chg-make-list)
       (while change-a
        (setq a-start (nth 0 (car change-a)))
       (hilit-chg-make-list)
       (while change-a
        (setq a-start (nth 0 (car change-a)))


@@ -883,18 +886,18 @@ The default is the current buffer and the one in the next window.
 If either buffer is modified and is visiting a file, you are prompted
 to save the file.
 
 If either buffer is modified and is visiting a file, you are prompted
 to save the file.
 

-Unless the buffer is unmodified and visiting a file,  the buffer is
+Unless the buffer is unmodified and visiting a file, the buffer is

 written to a temporary file for comparison.
 
 If a buffer is read-only, differences will be highlighted but no property
 changes are made, so \\[highlight-changes-next-change] and
 \\[highlight-changes-previous-change] will not work."
   (interactive
 written to a temporary file for comparison.
 
 If a buffer is read-only, differences will be highlighted but no property
 changes are made, so \\[highlight-changes-next-change] and
 \\[highlight-changes-previous-change] will not work."
   (interactive

-   (list 
+   (list

     (get-buffer (read-buffer "buffer-a " (current-buffer) t))
     (get-buffer
      (read-buffer "buffer-b "
     (get-buffer (read-buffer "buffer-a " (current-buffer) t))
     (get-buffer
      (read-buffer "buffer-b "

-                 (window-buffer (next-window (selected-window))) t)))) 
+                 (window-buffer (next-window (selected-window))) t))))

   (let ((file-a (buffer-file-name buf-a))
        (file-b (buffer-file-name buf-b)))
     (highlight-markup-buffers buf-a file-a buf-b file-b)
   (let ((file-a (buffer-file-name buf-a))
        (file-b (buffer-file-name buf-b)))
     (highlight-markup-buffers buf-a file-a buf-b file-b)


@@ -921,10 +924,10 @@ changes are made, so \\[highlight-changes-next-change] and
               nil                      ;; default
               'yes                     ;; must exist
               (let ((f (buffer-file-name (current-buffer))))
               nil                      ;; default
               'yes                     ;; must exist
               (let ((f (buffer-file-name (current-buffer))))

-                (if f 
+                (if f

                     (progn
                       (setq f (make-backup-file-name f))
                     (progn
                       (setq f (make-backup-file-name f))

-                      (or (file-exists-p f) 
+                      (or (file-exists-p f)

                           (setq f nil)))
                   )
                 f))))
                           (setq f nil)))
                   )
                 f))))


@@ -956,9 +959,9 @@ changes are made, so \\[highlight-changes-next-change] and
   ;; which calls this function as a hook
   (defvar x)  ;; placate the byte-compiler
   (defvar y)
   ;; which calls this function as a hook
   (defvar x)  ;; placate the byte-compiler
   (defvar y)

-  (setq  e (current-buffer))
+  (setq e (current-buffer))

   (let ((n 0) extent p va vb a b)
   (let ((n 0) extent p va vb a b)

-    (setq  x nil  y nil)    ;; x and y are bound by hilit-chg-get-diff-info
+    (setq x nil y nil)    ;; x and y are bound by hilit-chg-get-diff-info

     (while (< n ediff-number-of-differences)
       (ediff-make-fine-diffs n)
       (setq va (ediff-get-fine-diff-vector n 'A))
     (while (< n ediff-number-of-differences)
       (ediff-make-fine-diffs n)
       (setq va (ediff-get-fine-diff-vector n 'A))


@@ -1044,7 +1047,7 @@ changes are made, so \\[highlight-changes-next-change] and
 When called interactively:
 - if no prefix, toggle global Highlight Changes mode on or off
 - if called with a positive prefix (or just C-u) turn it on in active mode
 When called interactively:
 - if no prefix, toggle global Highlight Changes mode on or off
 - if called with a positive prefix (or just C-u) turn it on in active mode

-- if called with a zero prefix  turn it on in passive mode
+- if called with a zero prefix turn it on in passive mode

 - if called with a negative prefix turn it off
 
 When called from a program:
 - if called with a negative prefix turn it off
 
 When called from a program:


@@ -1081,7 +1084,7 @@ variable `highlight-changes-global-changes-existing-buffers' is non-nil).
       (progn
        (if (eq arg 'active)
            (setq highlight-changes-global-initial-state 'active)
       (progn
        (if (eq arg 'active)
            (setq highlight-changes-global-initial-state 'active)

-         (if (eq arg  'passive)
+         (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"
              (setq highlight-changes-global-initial-state 'passive)))
        (setq global-highlight-changes t)
        (message "Turning ON Global Highlight Changes mode in %s state"


@@ -1107,9 +1110,9 @@ variable `highlight-changes-global-changes-existing-buffers' is non-nil).
 
 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
 
 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

-  `*' or ` ')
+  `*' or ` '),

 - the buffer's mode is suitable as per variable
 - the buffer's mode is suitable as per variable

-  `highlight-changes-global-modes'
+  `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
 - Highlight Changes mode is not already on for this buffer.
 
 This function is called from `hilit-chg-update-all-buffers' or


@@ -1127,7 +1130,7 @@ from `global-highlight-changes' when turning on global Highlight Changes mode."
               (memq major-mode highlight-changes-global-modes)))
            (t
             (and
               (memq major-mode highlight-changes-global-modes)))
            (t
             (and

-             (not (string-match "^[ *]"  (buffer-name)))
+             (not (string-match "^[ *]" (buffer-name)))

              (buffer-file-name))))
          (progn
            (hilit-chg-set value)
              (buffer-file-name))))
          (progn
            (hilit-chg-set value)


@@ -1142,14 +1145,27 @@ from `global-highlight-changes' when turning on global Highlight Changes mode."
 
 
 (defun hilit-chg-update-all-buffers (value)
 
 
 (defun hilit-chg-update-all-buffers (value)

-  (mapcar
+  (mapc

    (function (lambda (buffer)
               (with-current-buffer buffer
                 (if value
                     (hilit-chg-turn-on-maybe value)
                   (hilit-chg-turn-off-maybe))
                 )))
    (function (lambda (buffer)
               (with-current-buffer buffer
                 (if value
                     (hilit-chg-turn-on-maybe value)
                   (hilit-chg-turn-off-maybe))
                 )))

-   (buffer-list)))
+   (buffer-list))
+  nil)
+
+;;;; Desktop support.
+
+;; Called by `desktop-create-buffer' to restore `highlight-changes-mode'.
+(defun hilit-chg-desktop-restore (desktop-buffer-locals)
+  (highlight-changes-mode
+   (or (cdr (assq 'highlight-changes-mode desktop-buffer-locals)) 1)))
+
+(add-to-list 'desktop-minor-mode-handlers
+             '(highlight-changes-mode . hilit-chg-desktop-restore))
+
+(add-to-list 'desktop-locals-to-save 'highlight-changes-mode)

 
 ;; ===================== debug ==================
 ;; For debug & test use:
 
 ;; ===================== debug ==================
 ;; For debug & test use: