Re: patch to hilight-chg not in emacs 22.1

[Richard Sharman <rsharman@pobox.com>]

[-- Attachment #1: Type: text/plain, Size: 1012 bytes --]

On 25-Apr-08, at 10:27 AM, Juanma Barranquero wrote:
> After this change:
>
> 2008-04-03  Richard Sharman  <rsharman@pobox.com>
> ...
> the file comments and the docstring of `highlight-changes-mode' still
> reference `highlight-changes-disable-hook', which seem not to exist
> anymore. I suppose that's an oversight and it should be obsoleted?
> (And also `highlight-changes-enable-hook', which weirdly enough still
> exists.)

You're right;  thanks.

Because define-minor-mode is used there is already a hook called  
highlight-changes-mode-hook that can be used to do both of the above  
functions.  I changed the documentation at the top of the file to use  
this hook.

I see there are also two other hooks generated: highlight-changes- 
mode-on-hook and highlight-changes-mode-off-hook,  but since the  
comment says "The on/off hooks are here for backward compatibility  
only." I thought it better not to document the fact that these are  
available.

Here is a patch against 1.52 and a Changelog file.


[-- Attachment #2: hilit-chg.el.cdif --]
[-- Type: application/octet-stream, Size: 4216 bytes --]

*** hilit-chg.el.1.52	Thu May  1 22:59:49 2008
--- hilit-chg.el	Thu May  1 23:04:27 2008
***************
*** 62,85 ****
  ;; You can automatically rotate faces when the buffer is saved;
  ;; see function `highlight-changes-rotate-faces' for how to do this.
  
! ;; There are two hooks used by `highlight-changes-mode':
! ;; `highlight-changes-enable-hook'  - is run when Highlight Changes mode
! ;;				    is enabled for a buffer.
! ;; `highlight-changes-disable-hook' - is run when Highlight Changes mode
! ;;				    is disabled for a buffer.
! 
! ;; Example usage:
! ;; (defun my-highlight-changes-enable-hook ()
! ;;   (add-hook 'write-file-functions 'highlight-changes-rotate-faces nil t)
! ;; )
! ;;
! ;; (defun my-highlight-changes-disable-hook ()
! ;;   (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-disable-hook
! ;;		'my-highlight-changes-disable-hook)
  
  
  ;;           Automatically enabling Highlight Changes mode
--- 62,78 ----
  ;; You can automatically rotate faces when the buffer is saved;
  ;; see function `highlight-changes-rotate-faces' for how to do this.
  
! ;; The hook `highlight-changes-mode-hook' is called when
! ;; Highlight Changes mode is turned on or off.
! ;; When it called,  variable `highlight-changes-mode' has been updated
! ;; to the new value.
  ;;
! ;; Example usage:
! ;; (defun my-highlight-changes-mode-hook ()
! ;;   (if highlight-changes-mode
! ;;       (add-hook 'write-file-functions 'highlight-changes-rotate-faces nil t)
! ;;     (remove-hook 'write-file-functions 'highlight-changes-rotate-faces t)
! ;;     ))
  
  
  ;;           Automatically enabling Highlight Changes mode
***************
*** 175,181 ****
  ;;   previous active/passive aspect of highlight-changes-mode.
  ;; - Removed highlight-changes-toggle-hook
  ;; - Put back eval-and-compile inadvertently dropped
! 
  
  ;;; Code:
  
--- 168,176 ----
  ;;   previous active/passive aspect of highlight-changes-mode.
  ;; - Removed highlight-changes-toggle-hook
  ;; - Put back eval-and-compile inadvertently dropped
! ;; May 2008
! ;; - Removed highlight-changes-disable-hook and highlight-changes-enable-hook
! ;;   because highlight-changes-mode-hook can do both.
  
  ;;; Code:
  
***************
*** 353,363 ****
  through	various faces.
  \\[highlight-compare-with-file] - mark text as changed by comparing this
  buffer with the contents of a file
! \\[highlight-compare-buffers] highlights differences between two buffers.
! 
! Hook variables:
! `highlight-changes-enable-hook': called when enabling Highlight Changes mode.
! `highlight-changes-disable-hook': called when disabling Highlight Changes mode."
    nil			;; init-value
    hilit-chg-string	;; lighter
    nil			;; keymap
--- 348,354 ----
  through	various faces.
  \\[highlight-compare-with-file] - mark text as changed by comparing this
  buffer with the contents of a file
! \\[highlight-compare-buffers] highlights differences between two buffers."
    nil			;; init-value
    hilit-chg-string	;; lighter
    nil			;; keymap
***************
*** 372,379 ****
  	    (setq highlight-changes-mode (not highlight-changes-mode)))
  	(if highlight-changes-mode
  	    ;; it is being turned on
- 	    ;; the hook has been moved into hilit-chg-set
- 	    ;; (run-hooks 'highlight-changes-enable-hook))
  	    (hilit-chg-set)
  	  ;; mode is turned off
  	  (hilit-chg-clear)))
--- 363,368 ----
***************
*** 634,641 ****
    (setq highlight-changes-visible-mode highlight-changes-visibility-initial-state)
    (hilit-chg-update)
    (force-mode-line-update)
!   (add-hook 'after-change-functions 'hilit-chg-set-face-on-change nil t)
!   (run-hooks 'highlight-changes-enable-hook))
  
  (defun hilit-chg-clear ()
    "Remove Highlight Changes mode for this buffer.
--- 623,629 ----
    (setq highlight-changes-visible-mode highlight-changes-visibility-initial-state)
    (hilit-chg-update)
    (force-mode-line-update)
!   (add-hook 'after-change-functions 'hilit-chg-set-face-on-change nil t))
  
  (defun hilit-chg-clear ()
    "Remove Highlight Changes mode for this buffer.

[-- Attachment #3: Type: text/plain, Size: 1 bytes --]



[-- Attachment #4: ChangeLog --]
[-- Type: application/octet-stream, Size: 516 bytes --]

2008-05-01  Richard Sharman  <rsharman@pobox.com>

	* hilit-chg.el 	(highlight-changes-mode): Removed references to
	hooks that no longer exist.  Because define-minor-mode is used the
	hook highlight-changes-mode-hook exists and can do what both the
	old hooks used to to.  The documentation at the top of the file
	was updated to demonstrate this.
	(highlight-changes-mode): Remove commented out call to a hook
	function that is no longer there.
	(hilit-chg-set): Remove running of highlight-changes-enable-hook.