Commit | Line | Data |
---|---|---|
e287d328 RS |
1 | ;;; hilit-chg.el --- minor mode displaying buffer changes with special face |
2 | ||
67476fca | 3 | ;; Copyright (C) 1998, 2000, 2005 Free Software Foundation, Inc. |
e287d328 | 4 | |
08246f2e | 5 | ;; Author: Richard Sharman <rsharman@pobox.com> |
e287d328 RS |
6 | ;; Keywords: faces |
7 | ||
66236b77 KH |
8 | ;; This file is part of GNU Emacs. |
9 | ||
2be7dabc | 10 | ;; GNU Emacs is free software; you can redistribute it and/or modify |
e287d328 RS |
11 | ;; it under the terms of the GNU General Public License as published by |
12 | ;; the Free Software Foundation; either version 2, or (at your option) | |
13 | ;; any later version. | |
14 | ||
2be7dabc | 15 | ;; GNU Emacs is distributed in the hope that it will be useful, |
e287d328 RS |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | ;; GNU General Public License for more details. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
21 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
22 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 | ;; Boston, MA 02111-1307, USA. | |
24 | ||
e287d328 RS |
25 | ;;; Commentary: |
26 | ||
27 | ;; A minor mode: "Highlight Changes mode". | |
28 | ;; | |
29 | ||
30 | ;; Highlight Changes mode has 2 submodes: active and passive. | |
31 | ;; When active, changes to the buffer are displayed in a different face. | |
32 | ;; When passive, any existing displayed changes are saved and new ones | |
33 | ;; recorded but are not displayed differently. | |
34 | ;; Why active and passive? Having the changes visible can be handy when you | |
35 | ;; want the information but very distracting otherwise. So, you can keep | |
36 | ;; Highlight Changes mode in passive state while you make your changes, toggle | |
37 | ;; it on to active mode to see them, then toggle it back off to avoid | |
38 | ;; distraction. | |
71296446 | 39 | ;; |
e287d328 | 40 | ;; When active, changes are displayed in `highlight-changes-face'. When |
f6ec4635 | 41 | ;; text is deleted, the following character is displayed in |
e287d328 RS |
42 | ;; `highlight-changes-delete-face' face. |
43 | ;; | |
44 | ;; | |
45 | ;; You can "age" different sets of changes by using | |
3ec30bcb | 46 | ;; `highlight-changes-rotate-faces'. This rotates through a series |
e287d328 | 47 | ;; of different faces, so you can distinguish "new" changes from "older" |
00e25b96 | 48 | ;; changes. You can customize these "rotated" faces in two ways. You can |
e287d328 RS |
49 | ;; either explicitly define each face by customizing |
50 | ;; `highlight-changes-face-list'. If, however, the faces differ from | |
3ec30bcb | 51 | ;; `highlight-changes-face' only in the foreground color, you can simply set |
e287d328 RS |
52 | ;; `highlight-changes-colours'. If `highlight-changes-face-list' is nil when |
53 | ;; the faces are required they will be constructed from | |
54 | ;; `highlight-changes-colours'. | |
55 | ;; | |
56 | ;; | |
57 | ;; When a Highlight Changes mode is on (either active or passive) you can go | |
58 | ;; to the next or previous change with `highlight-changes-next-change' and | |
59 | ;; `highlight-changes-previous-change'. | |
60 | ;; | |
61 | ;; | |
99f08df4 KH |
62 | ;; You can also use the command highlight-compare-with-file to show changes |
63 | ;; in this file compared with another file (typically the previous version | |
f826bf67 EZ |
64 | ;; of the file). The command highlight-compare-buffers can be used to |
65 | ;; compare two buffers. | |
e287d328 RS |
66 | ;; |
67 | ;; | |
68 | ;; There are currently three hooks run by `highlight-changes-mode': | |
69 | ;; `highlight-changes-enable-hook' - is run when Highlight Changes mode | |
70 | ;; is initially enabled for a buffer. | |
71 | ;; `highlight-changes-disable-hook' - is run when Highlight Changes mode | |
72 | ;; is turned off. | |
73 | ;; `highlight-changes-toggle-hook' - is run each time `highlight-changes-mode' | |
74 | ;; is called. Typically this is when | |
75 | ;; toggling between active and passive | |
76 | ;; modes. The variable | |
77 | ;; `highlight-changes-mode' contains the new | |
78 | ;; state (`active' or `passive'.) | |
e287d328 | 79 | ;; |
71296446 JB |
80 | ;; |
81 | ;; | |
e287d328 RS |
82 | ;; Example usage: |
83 | ;; (defun my-highlight-changes-enable-hook () | |
84 | ;; (add-hook 'local-write-file-hooks 'highlight-changes-rotate-faces) | |
85 | ;; ) | |
71296446 | 86 | ;; |
e287d328 RS |
87 | ;; (defun my-highlight-changes-disable-hook () |
88 | ;; (remove-hook 'local-write-file-hooks 'highlight-changes-rotate-faces) | |
89 | ;; ) | |
71296446 | 90 | ;; |
e287d328 RS |
91 | ;; (add-hook 'highlight-changes-enable-hook 'my-highlight-changes-enable-hook) |
92 | ;; (add-hook 'highlight-changes-disable-hook | |
93 | ;; 'my-highlight-changes-disable-hook) | |
94 | ||
95 | ||
3ec30bcb | 96 | ;; Explicit vs. Implicit |
e287d328 RS |
97 | ;; |
98 | ||
99 | ;; Normally, Highlight Changes mode is turned on explicitly in a buffer. | |
100 | ;; | |
101 | ;; If you prefer to have it automatically invoked you can do it as | |
102 | ;; follows. | |
71296446 | 103 | ;; |
e287d328 | 104 | ;; 1. Most modes have a major-hook, typically called MODE-hook. You |
71296446 | 105 | ;; can use `add-hook' to call `highlight-changes-mode'. |
e287d328 RS |
106 | ;; |
107 | ;; Example: | |
108 | ;; (add-hook 'c-mode-hook 'highlight-changes-mode) | |
109 | ;; | |
110 | ;; If you want to make it start up in passive mode (regardless of the | |
111 | ;; setting of highlight-changes-initial-state): | |
71296446 | 112 | ;; (add-hook 'emacs-lisp-mode-hook |
e287d328 RS |
113 | ;; (lambda () |
114 | ;; (highlight-changes-mode 'passive))) | |
115 | ;; | |
116 | ;; However, this cannot be done for Fundamental mode for there is no | |
117 | ;; such hook. | |
118 | ;; | |
71296446 | 119 | ;; 2. You can use the function `global-highlight-changes' |
e287d328 RS |
120 | ;; |
121 | ;; This function, which is fashioned after the way `global-font-lock' works, | |
122 | ;; toggles on or off global Highlight Changes mode. When activated, it turns | |
3ec30bcb | 123 | ;; on Highlight Changes mode in all "suitable" existing buffers and will turn |
e287d328 | 124 | ;; it on in new "suitable" buffers to be created. |
71296446 | 125 | ;; |
e287d328 | 126 | ;; A buffer's "suitability" is determined by variable |
f6ec4635 | 127 | ;; `highlight-changes-global-modes', as follows. If the variable is |
e287d328 RS |
128 | ;; * nil -- then no buffers are suitable; |
129 | ;; * a function -- this function is called and the result is used. As | |
f6ec4635 | 130 | ;; an example, if the value is `buffer-file-name' then all buffers |
e287d328 RS |
131 | ;; who are visiting files are suitable, but others (like dired |
132 | ;; buffers) are not; | |
72f7b362 | 133 | ;; * a list -- then the buffer is suitable iff its mode is in the |
f6ec4635 | 134 | ;; list, except if the first element is `not', in which case the test |
e287d328 | 135 | ;; is reversed (i.e. it is a list of unsuitable modes). |
f6ec4635 | 136 | ;; * Otherwise, the buffer is suitable if its name does not begin with |
e287d328 RS |
137 | ;; ` ' or `*' and if `buffer-file-name' returns true. |
138 | ;; | |
139 | ||
140 | ||
141 | ||
142 | ;; Possible bindings: | |
143 | ;; (global-set-key '[C-right] 'highlight-changes-next-change) | |
144 | ;; (global-set-key '[C-left] 'highlight-changes-previous-change) | |
145 | ;; | |
146 | ;; Other interactive functions (which could be bound if desired): | |
147 | ;; highlight-changes-mode | |
148 | ;; highlight-changes-remove-highlight | |
149 | ;; highlight-changes-rotate-faces | |
99f08df4 | 150 | ;; highlight-compare-with-file |
f826bf67 | 151 | ;; highlight-compare-buffers |
e287d328 | 152 | |
71296446 | 153 | ;; |
e287d328 RS |
154 | ;; You can automatically rotate faces when the buffer is saved; |
155 | ;; see function `highlight-changes-rotate-faces' for how to do this. | |
156 | ;; | |
157 | ||
158 | ||
159 | ;;; Bugs: | |
160 | ||
161 | ;; - the next-change and previous-change functions are too literal; | |
f6ec4635 | 162 | ;; they should find the next "real" change, in other words treat |
e287d328 RS |
163 | ;; consecutive changes as one. |
164 | ||
165 | ||
f6ec4635 | 166 | ;;; To do (maybe), notes, ... |
e287d328 RS |
167 | |
168 | ;; - having different faces for deletion and non-deletion: is it | |
169 | ;; really worth the hassle? | |
170 | ;; - should have better hooks: when should they be run? | |
99f08df4 KH |
171 | ;; - highlight-compare-with-file should allow RCS files - e.g. nice to be |
172 | ;; able to say show changes compared with version 2.1. | |
e287d328 RS |
173 | ;; - Maybe we should have compare-with-buffer as well. (When I tried |
174 | ;; a while back I ran into a problem with ediff-buffers-internal.) | |
175 | ||
176 | ||
177 | ;;; History: | |
178 | ||
f826bf67 | 179 | ;; R Sharman (rsharman@pobox.com) Feb 1998: |
e287d328 | 180 | ;; - initial release as change-mode. |
e287d328 | 181 | ;; Jari Aalto <jari.aalto@ntc.nokia.com> Mar 1998 |
71296446 | 182 | ;; - fixes for byte compile errors |
e287d328 RS |
183 | ;; - use eval-and-compile for autoload |
184 | ;; Marijn Ros <J.M.Ros@fys.ruu.nl> Mar 98 | |
185 | ;; - suggested turning it on by default | |
e287d328 RS |
186 | ;; Eric Ludlam <zappo@gnu.org> Suggested using overlays. |
187 | ;; July 98 | |
188 | ;; - global mode and various stuff added | |
189 | ;; - Changed to use overlays | |
190 | ;; August 98 | |
3ec30bcb | 191 | ;; - renamed to Highlight Changes mode. |
f826bf67 EZ |
192 | ;; Dec 2003 |
193 | ;; - Use require for ediff stuff | |
194 | ;; - Added highlight-compare-buffers | |
e287d328 RS |
195 | |
196 | ;;; Code: | |
197 | ||
e287d328 RS |
198 | (require 'wid-edit) |
199 | ||
200 | ;; ====================== Customization ======================= | |
201 | (defgroup highlight-changes nil | |
202 | "Highlight Changes mode." | |
a7845785 | 203 | :version "20.4" |
e287d328 RS |
204 | :group 'faces) |
205 | ||
206 | ||
207 | ;; Face information: How the changes appear. | |
208 | ||
209 | ;; Defaults for face: red foreground, no change to background, | |
210 | ;; and underlined if a change is because of a deletion. | |
3ec30bcb | 211 | ;; Note: underlining is helpful in that it shows up changes in white space. |
e287d328 RS |
212 | ;; However, having it set for non-delete changes can be annoying because all |
213 | ;; indentation on inserts gets underlined (which can look pretty ugly!). | |
214 | ||
215 | (defface highlight-changes-face | |
216 | '((((class color)) (:foreground "red" )) | |
217 | (t (:inverse-video t))) | |
218 | "Face used for highlighting changes." | |
3ec30bcb | 219 | :group 'highlight-changes) |
e287d328 RS |
220 | |
221 | ;; This looks pretty ugly, actually. Maybe the underline should be removed. | |
222 | (defface highlight-changes-delete-face | |
223 | '((((class color)) (:foreground "red" :underline t)) | |
224 | (t (:inverse-video t))) | |
225 | "Face used for highlighting deletions." | |
3ec30bcb | 226 | :group 'highlight-changes) |
e287d328 RS |
227 | |
228 | ||
229 | ||
230 | ;; A (not very good) default list of colours to rotate through. | |
231 | ;; | |
71296446 | 232 | (defcustom highlight-changes-colours |
e287d328 RS |
233 | (if (eq (frame-parameter nil 'background-mode) 'light) |
234 | ;; defaults for light background: | |
235 | '( "magenta" "blue" "darkgreen" "chocolate" "sienna4" "NavyBlue") | |
236 | ;; defaults for dark background: | |
237 | '("yellow" "magenta" "blue" "maroon" "firebrick" "green4" "DarkOrchid")) | |
238 | "*Colours used by `highlight-changes-rotate-faces'. | |
f6ec4635 | 239 | The newest rotated change will be displayed in the first element of this list, |
e287d328 RS |
240 | the next older will be in the second element etc. |
241 | ||
f6ec4635 JB |
242 | This list is used if `highlight-changes-face-list' is nil, otherwise that |
243 | variable overrides this list. If you only care about foreground | |
244 | colours then use this, if you want fancier faces then set | |
e287d328 | 245 | `highlight-changes-face-list'." |
3ec30bcb GM |
246 | :type '(repeat color) |
247 | :group 'highlight-changes) | |
71296446 | 248 | |
e287d328 | 249 | |
f6ec4635 | 250 | ;; If you invoke highlight-changes-mode with no argument, should it start in |
e287d328 RS |
251 | ;; active or passive mode? |
252 | ;; | |
253 | (defcustom highlight-changes-initial-state 'active | |
254 | "*What state (active or passive) `highlight-changes' should start in. | |
255 | This is used when `highlight-changes' is called with no argument. | |
256 | This variable must be set to one of the symbols `active' or `passive'." | |
257 | :type '(choice (const :tag "Active" active) | |
258 | (const :tag "Passive" passive)) | |
3ec30bcb | 259 | :group 'highlight-changes) |
e287d328 RS |
260 | |
261 | (defcustom highlight-changes-global-initial-state 'passive | |
262 | "*What state `global-highlight-changes' should start in. | |
263 | This is used if `global-highlight-changes' is called with no argument. | |
264 | This variable must be set to either `active' or `passive'" | |
265 | :type '(choice (const :tag "Active" active) | |
266 | (const :tag "Passive" passive)) | |
3ec30bcb | 267 | :group 'highlight-changes) |
e287d328 RS |
268 | |
269 | ;; The strings displayed in the mode-line for the minor mode: | |
e711842f | 270 | (defcustom highlight-changes-active-string " +Chg" |
e287d328 | 271 | "*The string used when Highlight Changes mode is in the active state. |
f6ec4635 | 272 | This should be set to nil if no indication is desired, or to |
e287d328 RS |
273 | a string with a leading space." |
274 | :type '(choice string | |
275 | (const :tag "None" nil)) | |
3ec30bcb | 276 | :group 'highlight-changes) |
e287d328 | 277 | |
e711842f | 278 | (defcustom highlight-changes-passive-string " -Chg" |
e287d328 | 279 | "*The string used when Highlight Changes mode is in the passive state. |
f6ec4635 | 280 | This should be set to nil if no indication is desired, or to |
e287d328 RS |
281 | a string with a leading space." |
282 | :type '(choice string | |
283 | (const :tag "None" nil)) | |
3ec30bcb | 284 | :group 'highlight-changes) |
e287d328 RS |
285 | |
286 | (defcustom highlight-changes-global-modes t | |
287 | "*Determine whether a buffer is suitable for global Highlight Changes mode. | |
288 | ||
e711842f RS |
289 | A function means call that function to decide: if it returns non-nil, |
290 | the buffer is suitable. | |
e287d328 | 291 | |
e711842f RS |
292 | A list means the elements are major modes suitable for Highlight |
293 | Changes mode, or a list whose first element is `not' followed by major | |
294 | modes which are not suitable. | |
e287d328 | 295 | |
e711842f RS |
296 | t means the buffer is suitable if it is visiting a file and its name |
297 | does not begin with ` ' or `*'. | |
e287d328 | 298 | |
3ec30bcb | 299 | A value of nil means no buffers are suitable for `global-highlight-changes' |
852a8571 | 300 | \(effectively disabling the mode). |
e287d328 RS |
301 | |
302 | Examples: | |
303 | (c-mode c++-mode) | |
304 | means that Highlight Changes mode is turned on for buffers in C and C++ | |
305 | modes only." | |
71296446 | 306 | :type '(choice |
e287d328 RS |
307 | (const :tag "all non-special buffers visiting files" t) |
308 | (set :menu-tag "specific modes" :tag "modes" | |
309 | :value (not) | |
310 | (const :tag "All except these" not) | |
311 | (repeat :tag "Modes" :inline t (symbol :tag "mode"))) | |
312 | (function :menu-tag "determined by function" | |
313 | :value buffer-file-name) | |
314 | (const :tag "none" nil) | |
315 | ) | |
3ec30bcb | 316 | :group 'highlight-changes) |
e287d328 RS |
317 | |
318 | (defvar global-highlight-changes nil) | |
319 | ||
320 | (defcustom highlight-changes-global-changes-existing-buffers nil | |
3ec30bcb GM |
321 | "*If non-nil, toggling global Highlight Changes mode affects existing buffers. |
322 | Normally, `global-highlight-changes' affects only new buffers (to be | |
323 | created). However, if `highlight-changes-global-changes-existing-buffers' | |
324 | is non-nil, then turning on `global-highlight-changes' will turn on | |
325 | Highlight Changes mode in suitable buffers, and turning the mode off will | |
e287d328 RS |
326 | remove it from existing buffers." |
327 | :type 'boolean | |
328 | :group 'highlight-changes) | |
329 | ||
330 | (defun hilit-chg-cust-fix-changes-face-list (w wc &optional event) | |
331 | ;; When customization function `highlight-changes-face-list' inserts a new | |
f6ec4635 JB |
332 | ;; face it uses the default face. We don't want the user to modify this |
333 | ;; face, so we rename the faces in the list on an insert. The rename is | |
e287d328 RS |
334 | ;; actually done by copying the faces so user-defined faces still remain |
335 | ;; in the same order. | |
336 | ;; The notifying the parent is needed because without it changes to the | |
337 | ;; faces are saved but not to the actual list itself. | |
338 | (let ((old-list (widget-value w))) | |
339 | (if (member 'default old-list) | |
340 | (let | |
341 | ((p (reverse old-list)) | |
342 | (n (length old-list)) | |
343 | new-name old-name | |
344 | (new-list nil) | |
345 | ) | |
346 | (while p | |
347 | (setq old-name (car p)) | |
348 | (setq new-name (intern (format "highlight-changes-face-%d" n))) | |
349 | (if (eq old-name new-name) | |
350 | nil | |
351 | ;; A new face has been inserted: we don't want to modify the | |
f6ec4635 | 352 | ;; default face so copy it. Better, though, (I think) is to |
e287d328 RS |
353 | ;; make a new face have the same attributes as |
354 | ;; highlight-changes-face . | |
355 | (if (eq old-name 'default) | |
356 | (copy-face 'highlight-changes-face new-name) | |
357 | (copy-face old-name new-name) | |
358 | )) | |
359 | (setq new-list (append (list new-name) new-list)) | |
360 | (setq n (1- n)) | |
361 | (setq p (cdr p))) | |
362 | (if (equal new-list (widget-value w)) | |
363 | nil ;; (message "notify: no change!") | |
364 | (widget-value-set w new-list) | |
365 | (widget-setup) | |
366 | ) | |
367 | ) | |
368 | ;; (message "notify: no default here!") | |
369 | )) | |
370 | (let ((parent (widget-get w :parent))) | |
371 | (when parent | |
3ec30bcb | 372 | (widget-apply parent :notify w event)))) |
e287d328 RS |
373 | |
374 | ||
375 | (defcustom highlight-changes-face-list nil | |
3ec30bcb | 376 | "*A list of faces used when rotating changes. |
e287d328 RS |
377 | Normally the variable is initialized to nil and the list is created from |
378 | `highlight-changes-colours' when needed. However, you can set this variable | |
379 | to any list of faces. You will have to do this if you want faces which | |
380 | don't just differ from `highlight-changes-face' by the foreground colour. | |
381 | Otherwise, this list will be constructed when needed from | |
382 | `highlight-changes-colours'." | |
383 | :type '(choice | |
71296446 | 384 | (repeat |
e287d328 RS |
385 | :notify hilit-chg-cust-fix-changes-face-list |
386 | face ) | |
387 | (const :tag "Derive from highlight-changes-colours" nil) | |
388 | ) | |
3ec30bcb | 389 | :group 'highlight-changes) |
e287d328 RS |
390 | |
391 | ;; ======================================================================== | |
392 | ||
393 | ;; These shouldn't be changed! | |
394 | ||
395 | (defvar highlight-changes-mode nil) | |
396 | (defvar hilit-chg-list nil) | |
397 | (defvar hilit-chg-string " ??") | |
398 | (or (assq 'highlight-changes-mode minor-mode-alist) | |
399 | (setq minor-mode-alist | |
400 | (cons '(highlight-changes-mode hilit-chg-string) minor-mode-alist) | |
401 | )) | |
402 | (make-variable-buffer-local 'highlight-changes-mode) | |
403 | (make-variable-buffer-local 'hilit-chg-string) | |
404 | ||
405 | ||
f826bf67 EZ |
406 | (require 'ediff-init) |
407 | (require 'ediff-util) | |
e287d328 RS |
408 | |
409 | ||
410 | ;;; Functions... | |
411 | ||
412 | (defun hilit-chg-map-changes (func &optional start-position end-position) | |
413 | "Call function FUNC for each region used by Highlight Changes mode." | |
414 | ;; if start-position is nil, (point-min) is used | |
415 | ;; if end-position is nil, (point-max) is used | |
416 | ;; FUNC is called with 3 params: property start stop | |
417 | (let ((start (or start-position (point-min))) | |
418 | (limit (or end-position (point-max))) | |
419 | prop end) | |
420 | (while (and start (< start limit)) | |
421 | (setq prop (get-text-property start 'hilit-chg)) | |
422 | (setq end (text-property-not-all start limit 'hilit-chg prop)) | |
423 | (if prop | |
424 | (funcall func prop start (or end limit))) | |
3ec30bcb | 425 | (setq start end)))) |
e287d328 RS |
426 | |
427 | ||
428 | (defun hilit-chg-display-changes (&optional beg end) | |
429 | "Display face information for Highlight Changes mode. | |
430 | ||
3ec30bcb GM |
431 | An overlay containing a change face is added from the information |
432 | in the text property of type `hilit-chg'. | |
e287d328 | 433 | |
3ec30bcb | 434 | This is the opposite of `hilit-chg-hide-changes'." |
e287d328 RS |
435 | (hilit-chg-map-changes 'hilit-chg-make-ov beg end)) |
436 | ||
437 | ||
438 | (defun hilit-chg-make-ov (prop start end) | |
f87d9934 RS |
439 | (or prop |
440 | (error "hilit-chg-make-ov: prop is nil")) | |
e287d328 RS |
441 | ;; for the region make change overlays corresponding to |
442 | ;; the text property 'hilit-chg | |
443 | (let ((ov (make-overlay start end)) | |
444 | face) | |
e287d328 RS |
445 | (if (eq prop 'hilit-chg-delete) |
446 | (setq face 'highlight-changes-delete-face) | |
447 | (setq face (nth 1 (member prop hilit-chg-list)))) | |
448 | (if face | |
449 | (progn | |
f6ec4635 | 450 | ;; We must mark the face, that is the purpose of the overlay |
e287d328 RS |
451 | (overlay-put ov 'face face) |
452 | ;; I don't think we need to set evaporate since we should | |
453 | ;; be controlling them! | |
454 | (overlay-put ov 'evaporate t) | |
455 | ;; We set the change property so we can tell this is one | |
456 | ;; of our overlays (so we don't delete someone else's). | |
457 | (overlay-put ov 'hilit-chg t) | |
458 | ) | |
3ec30bcb | 459 | (error "hilit-chg-make-ov: no face for prop: %s" prop)))) |
e287d328 RS |
460 | |
461 | (defun hilit-chg-hide-changes (&optional beg end) | |
462 | "Remove face information for Highlight Changes mode. | |
463 | ||
f6ec4635 | 464 | The overlay containing the face is removed, but the text property |
e287d328 RS |
465 | containing the change information is retained. |
466 | ||
3ec30bcb | 467 | This is the opposite of `hilit-chg-display-changes'." |
e287d328 RS |
468 | (let ((start (or beg (point-min))) |
469 | (limit (or end (point-max))) | |
470 | p ov) | |
471 | (setq p (overlays-in start limit)) | |
472 | (while p | |
473 | ;; don't delete the overlay if it isn't ours! | |
474 | (if (overlay-get (car p) 'hilit-chg) | |
475 | (delete-overlay (car p))) | |
3ec30bcb | 476 | (setq p (cdr p))))) |
e287d328 RS |
477 | |
478 | (defun hilit-chg-fixup (beg end) | |
3ec30bcb | 479 | "Fix change overlays in region between BEG and END. |
e287d328 RS |
480 | |
481 | Ensure the overlays agree with the changes as determined from | |
482 | the text properties of type `hilit-chg' ." | |
483 | ;; Remove or alter overlays in region beg..end | |
f87d9934 | 484 | (let (ov-start ov-end props q) |
e287d328 RS |
485 | ;; temp for debugging: |
486 | ;; (or (eq highlight-changes-mode 'active) | |
487 | ;; (error "hilit-chg-fixup called but Highlight Changes mode not active")) | |
f87d9934 RS |
488 | (dolist (ov (overlays-in beg end)) |
489 | ;; Don't alter overlays that are not ours. | |
490 | (when (overlay-get ov 'hilit-chg) | |
491 | (let ((ov-start (overlay-start ov)) | |
492 | (ov-end (overlay-end ov))) | |
493 | (if (< ov-start beg) | |
494 | (progn | |
495 | (move-overlay ov ov-start beg) | |
496 | (if (> ov-end end) | |
497 | (progn | |
498 | (setq props (overlay-properties ov)) | |
499 | (setq ov (make-overlay end ov-end)) | |
500 | (while props | |
501 | (overlay-put ov (car props)(car (cdr props))) | |
502 | (setq props (cdr (cdr props))))))) | |
e287d328 | 503 | (if (> ov-end end) |
f87d9934 RS |
504 | (move-overlay ov end ov-end) |
505 | (delete-overlay ov)))))) | |
3ec30bcb | 506 | (hilit-chg-display-changes beg end))) |
e287d328 RS |
507 | |
508 | ;;;###autoload | |
71296446 JB |
509 | (defun highlight-changes-remove-highlight (beg end) |
510 | "Remove the change face from the region between BEG and END. | |
e287d328 RS |
511 | This allows you to manually remove highlighting from uninteresting changes." |
512 | (interactive "r") | |
513 | (let ((after-change-functions nil)) | |
514 | (remove-text-properties beg end '(hilit-chg nil)) | |
515 | (hilit-chg-fixup beg end))) | |
516 | ||
71296446 | 517 | (defun hilit-chg-set-face-on-change (beg end leng-before |
f87d9934 | 518 | &optional no-property-change) |
e287d328 RS |
519 | "Record changes and optionally display them in a distinctive face. |
520 | `hilit-chg-set' adds this function to the `after-change-functions' hook." | |
521 | ;; | |
522 | ;; This function is called by the `after-change-functions' hook, which | |
523 | ;; is how we are notified when text is changed. | |
99f08df4 | 524 | ;; It is also called from `highlight-compare-with-file'. |
e287d328 RS |
525 | ;; |
526 | ;; We do NOT want to simply do this if this is an undo command, because | |
527 | ;; otherwise an undone change shows up as changed. While the properties | |
f6ec4635 | 528 | ;; are automatically restored by undo, we must fix up the overlay. |
e287d328 RS |
529 | (save-match-data |
530 | (let ((beg-decr 1) (end-incr 1) | |
531 | (type 'hilit-chg) | |
532 | old) | |
533 | (if undo-in-progress | |
534 | (if (eq highlight-changes-mode 'active) | |
535 | (hilit-chg-fixup beg end)) | |
536 | (if (and (= beg end) (> leng-before 0)) | |
537 | ;; deletion | |
538 | (progn | |
539 | ;; The eolp and bolp tests are a kludge! But they prevent | |
71296446 | 540 | ;; rather nasty looking displays when deleting text at the end |
f6ec4635 JB |
541 | ;; of line, such as normal corrections as one is typing and |
542 | ;; immediately makes a correction, and when deleting first | |
e287d328 RS |
543 | ;; character of a line. |
544 | ;;; (if (= leng-before 1) | |
545 | ;;; (if (eolp) | |
546 | ;;; (setq beg-decr 0 end-incr 0) | |
547 | ;;; (if (bolp) | |
548 | ;;; (setq beg-decr 0)))) | |
549 | ;;; (setq beg (max (- beg beg-decr) (point-min))) | |
550 | (setq end (min (+ end end-incr) (point-max))) | |
551 | (setq type 'hilit-chg-delete)) | |
552 | ;; Not a deletion. | |
f6ec4635 | 553 | ;; Most of the time the following is not necessary, but |
e287d328 RS |
554 | ;; if the current text was marked as a deletion then |
555 | ;; the old overlay is still in effect, so if we add some | |
f6ec4635 | 556 | ;; text then remove the deletion marking, but set it to |
e287d328 RS |
557 | ;; changed otherwise its highlighting disappears. |
558 | (if (eq (get-text-property end 'hilit-chg) 'hilit-chg-delete) | |
559 | (progn | |
560 | (remove-text-properties end (+ end 1) '(hilit-chg nil)) | |
561 | (put-text-property end (+ end 1) 'hilit-chg 'hilit-chg) | |
562 | (if (eq highlight-changes-mode 'active) | |
563 | (hilit-chg-fixup beg (+ end 1)))))) | |
f87d9934 | 564 | (unless no-property-change |
e287d328 | 565 | (put-text-property beg end 'hilit-chg type)) |
f87d9934 | 566 | (if (or (eq highlight-changes-mode 'active) no-property-change) |
3ec30bcb | 567 | (hilit-chg-make-ov type beg end)))))) |
e287d328 RS |
568 | |
569 | (defun hilit-chg-set (value) | |
570 | "Turn on Highlight Changes mode for this buffer." | |
571 | (setq highlight-changes-mode value) | |
572 | (remove-hook 'after-change-functions 'hilit-chg-set-face-on-change t) | |
573 | (hilit-chg-make-list) | |
574 | (if (eq highlight-changes-mode 'active) | |
575 | (progn | |
576 | (setq hilit-chg-string highlight-changes-active-string) | |
577 | (or buffer-read-only | |
578 | (hilit-chg-display-changes))) | |
579 | ;; mode is passive | |
580 | (setq hilit-chg-string highlight-changes-passive-string) | |
581 | (or buffer-read-only | |
3ec30bcb | 582 | (hilit-chg-hide-changes))) |
e287d328 | 583 | (force-mode-line-update) |
3ec30bcb | 584 | (add-hook 'after-change-functions 'hilit-chg-set-face-on-change nil t)) |
e287d328 RS |
585 | |
586 | (defun hilit-chg-clear () | |
587 | "Remove Highlight Changes mode for this buffer. | |
588 | This removes all saved change information." | |
589 | (if buffer-read-only | |
590 | ;; We print the buffer name because this function could be called | |
591 | ;; on many buffers from `global-highlight-changes'. | |
592 | (message "Cannot remove highlighting from read-only mode buffer %s" | |
593 | (buffer-name)) | |
594 | (remove-hook 'after-change-functions 'hilit-chg-set-face-on-change t) | |
595 | (let ((after-change-functions nil)) | |
596 | (hilit-chg-hide-changes) | |
71296446 | 597 | (hilit-chg-map-changes |
e287d328 RS |
598 | '(lambda (prop start stop) |
599 | (remove-text-properties start stop '(hilit-chg nil)))) | |
600 | ) | |
601 | (setq highlight-changes-mode nil) | |
602 | (force-mode-line-update) | |
603 | ;; If we type: C-u -1 M-x highlight-changes-mode | |
f6ec4635 | 604 | ;; we want to turn it off, but hilit-chg-post-command-hook |
e287d328 | 605 | ;; runs and that turns it back on! |
3ec30bcb | 606 | (remove-hook 'post-command-hook 'hilit-chg-post-command-hook))) |
e287d328 RS |
607 | |
608 | ;;;###autoload | |
609 | (defun highlight-changes-mode (&optional arg) | |
610 | "Toggle (or initially set) Highlight Changes mode. | |
611 | ||
71296446 | 612 | Without an argument: |
3ec30bcb GM |
613 | If Highlight Changes mode is not enabled, then enable it (in either active |
614 | or passive state as determined by the variable | |
615 | `highlight-changes-initial-state'); otherwise, toggle between active | |
616 | and passive state. | |
e287d328 | 617 | |
3ec30bcb GM |
618 | With an argument ARG: |
619 | If ARG is positive, set state to active; | |
620 | If ARG is zero, set state to passive; | |
621 | If ARG is negative, disable Highlight Changes mode completely. | |
e287d328 | 622 | |
3ec30bcb | 623 | Active state - means changes are shown in a distinctive face. |
e287d328 RS |
624 | Passive state - means changes are kept and new ones recorded but are |
625 | not displayed in a different face. | |
626 | ||
627 | Functions: | |
628 | \\[highlight-changes-next-change] - move point to beginning of next change | |
71296446 | 629 | \\[highlight-changes-previous-change] - move to beginning of previous change |
99f08df4 KH |
630 | \\[highlight-compare-with-file] - mark text as changed by comparing this |
631 | buffer with the contents of a file | |
e287d328 RS |
632 | \\[highlight-changes-remove-highlight] - remove the change face from the region |
633 | \\[highlight-changes-rotate-faces] - rotate different \"ages\" of changes \ | |
71296446 | 634 | through |
e287d328 RS |
635 | various faces. |
636 | ||
e287d328 | 637 | Hook variables: |
3ec30bcb GM |
638 | `highlight-changes-enable-hook' - when enabling Highlight Changes mode. |
639 | `highlight-changes-toggle-hook' - when entering active or passive state | |
640 | `highlight-changes-disable-hook' - when turning off Highlight Changes mode." | |
e287d328 | 641 | (interactive "P") |
e7a903e8 EZ |
642 | (if (or (display-color-p) |
643 | (and (fboundp 'x-display-grayscale-p) (x-display-grayscale-p))) | |
e287d328 RS |
644 | (let ((was-on highlight-changes-mode) |
645 | (new-highlight-changes-mode | |
646 | (cond | |
647 | ((null arg) | |
648 | ;; no arg => toggle (or set to active initially) | |
649 | (if highlight-changes-mode | |
650 | (if (eq highlight-changes-mode 'active) 'passive 'active) | |
651 | highlight-changes-initial-state)) | |
652 | ;; an argument is given | |
653 | ((eq arg 'active) | |
654 | 'active) | |
655 | ((eq arg 'passive) | |
656 | 'passive) | |
657 | ((> (prefix-numeric-value arg) 0) | |
658 | 'active) | |
659 | ((< (prefix-numeric-value arg) 0) | |
660 | nil) | |
661 | (t | |
3ec30bcb | 662 | 'passive)))) |
e287d328 RS |
663 | (if new-highlight-changes-mode |
664 | ;; mode is turned on -- but may be passive | |
665 | (progn | |
666 | (hilit-chg-set new-highlight-changes-mode) | |
667 | (or was-on | |
668 | ;; run highlight-changes-enable-hook once | |
669 | (run-hooks 'highlight-changes-enable-hook)) | |
670 | (run-hooks 'highlight-changes-toggle-hook)) | |
671 | ;; mode is turned off | |
672 | (run-hooks 'highlight-changes-disable-hook) | |
3ec30bcb GM |
673 | (hilit-chg-clear))) |
674 | (message "Highlight Changes mode requires color or grayscale display"))) | |
e287d328 RS |
675 | |
676 | ;;;###autoload | |
677 | (defun highlight-changes-next-change () | |
678 | "Move to the beginning of the next change, if in Highlight Changes mode." | |
679 | (interactive) | |
680 | (if highlight-changes-mode | |
681 | (let ((start (point)) | |
682 | prop) | |
683 | (setq prop (get-text-property (point) 'hilit-chg)) | |
684 | (if prop | |
685 | ;; we are in a change | |
686 | (setq start (next-single-property-change (point) 'hilit-chg))) | |
687 | (if start | |
688 | (setq start (next-single-property-change start 'hilit-chg))) | |
689 | (if start | |
690 | (goto-char start) | |
691 | (message "no next change"))) | |
692 | (message "This buffer is not in Highlight Changes mode."))) | |
693 | ||
694 | ||
695 | ;;;###autoload | |
696 | (defun highlight-changes-previous-change () | |
697 | "Move to the beginning of the previous change, if in Highlight Changes mode." | |
698 | (interactive) | |
699 | (if highlight-changes-mode | |
700 | (let ( (start (point)) (prop nil) ) | |
701 | (or (bobp) | |
702 | (setq prop (get-text-property (1- (point)) 'hilit-chg))) | |
703 | (if prop | |
704 | ;; we are in a change | |
705 | (setq start (previous-single-property-change (point) 'hilit-chg))) | |
706 | (if start | |
707 | (setq start (previous-single-property-change start 'hilit-chg))) | |
708 | ;; special handling for the case where (point-min) is a change | |
709 | (if start | |
710 | (setq start (or (previous-single-property-change start 'hilit-chg) | |
711 | (if (get-text-property (point-min) 'hilit-chg) | |
712 | (point-min))))) | |
713 | (if start | |
714 | (goto-char start) | |
715 | (message "no previous change"))) | |
716 | (message "This buffer is not in Highlight Changes mode."))) | |
717 | ||
e287d328 RS |
718 | ;; ======================================================================== |
719 | ||
e287d328 | 720 | (defun hilit-chg-make-list (&optional force) |
3ec30bcb | 721 | "Construct `hilit-chg-list' and `highlight-changes-face-list'." |
f6ec4635 | 722 | ;; Constructs highlight-changes-face-list if necessary, |
e287d328 RS |
723 | ;; and hilit-chg-list always: |
724 | ;; Maybe this should always be called when rotating a face | |
725 | ;; so we pick up any changes? | |
726 | (if (or (null highlight-changes-face-list) ; Don't do it if it | |
727 | force) ; already exists unless FORCE non-nil. | |
71296446 | 728 | (let ((p highlight-changes-colours) |
e287d328 RS |
729 | (n 1) name) |
730 | (setq highlight-changes-face-list nil) | |
731 | (while p | |
732 | (setq name (intern (format "highlight-changes-face-%d" n))) | |
733 | (copy-face 'highlight-changes-face name) | |
734 | (set-face-foreground name (car p)) | |
71296446 | 735 | (setq highlight-changes-face-list |
e287d328 RS |
736 | (append highlight-changes-face-list (list name))) |
737 | (setq p (cdr p)) | |
738 | (setq n (1+ n))))) | |
739 | (setq hilit-chg-list (list 'hilit-chg 'highlight-changes-face)) | |
740 | (let ((p highlight-changes-face-list) | |
71296446 | 741 | (n 1) |
e287d328 RS |
742 | last-category last-face) |
743 | (while p | |
744 | (setq last-category (intern (format "change-%d" n))) | |
745 | ;; (setq last-face (intern (format "highlight-changes-face-%d" n))) | |
746 | (setq last-face (car p)) | |
747 | (setq hilit-chg-list | |
748 | (append hilit-chg-list | |
749 | (list last-category last-face))) | |
750 | (setq p (cdr p)) | |
751 | (setq n (1+ n))) | |
752 | (setq hilit-chg-list | |
753 | (append hilit-chg-list | |
3ec30bcb | 754 | (list last-category last-face))))) |
e287d328 RS |
755 | |
756 | (defun hilit-chg-bump-change (prop start end) | |
3ec30bcb | 757 | "Increment (age) the Highlight Changes mode text property." |
e287d328 RS |
758 | (let ( new-prop ) |
759 | (if (eq prop 'hilit-chg-delete) | |
760 | (setq new-prop (nth 2 hilit-chg-list)) | |
3ec30bcb | 761 | (setq new-prop (nth 2 (member prop hilit-chg-list)))) |
e287d328 RS |
762 | (if prop |
763 | (put-text-property start end 'hilit-chg new-prop) | |
3ec30bcb | 764 | (message "%d-%d unknown property %s not changed" start end prop)))) |
e287d328 RS |
765 | |
766 | ;;;###autoload | |
767 | (defun highlight-changes-rotate-faces () | |
768 | "Rotate the faces used by Highlight Changes mode. | |
769 | ||
3ec30bcb GM |
770 | Current changes are displayed in the face described by the first element |
771 | of `highlight-changes-face-list', one level older changes are shown in | |
e287d328 RS |
772 | face described by the second element, and so on. Very old changes remain |
773 | shown in the last face in the list. | |
774 | ||
775 | You can automatically rotate colours when the buffer is saved | |
f6ec4635 | 776 | by adding the following to `local-write-file-hooks', by evaling it in the |
e287d328 | 777 | buffer to be saved): |
3ec30bcb GM |
778 | |
779 | \(add-hook 'local-write-file-hooks 'highlight-changes-rotate-faces)" | |
e287d328 RS |
780 | (interactive) |
781 | ;; If not in active mode do nothing but don't complain because this | |
782 | ;; may be bound to a hook. | |
783 | (if (eq highlight-changes-mode 'active) | |
784 | (let ((after-change-functions nil)) | |
785 | ;; ensure hilit-chg-list is made and up to date | |
786 | (hilit-chg-make-list) | |
787 | ;; remove our existing overlays | |
788 | (hilit-chg-hide-changes) | |
789 | ;; for each change text property, increment it | |
790 | (hilit-chg-map-changes 'hilit-chg-bump-change) | |
791 | ;; and display them all if active | |
792 | (if (eq highlight-changes-mode 'active) | |
3ec30bcb | 793 | (hilit-chg-display-changes)))) |
e287d328 RS |
794 | ;; This always returns nil so it is safe to use in |
795 | ;; local-write-file-hook | |
796 | nil) | |
797 | ||
e287d328 | 798 | ;; ======================================================================== |
f826bf67 EZ |
799 | ;; Comparing buffers/files |
800 | ;; These use ediff to find the differences. | |
801 | ||
802 | (defun highlight-markup-buffers | |
803 | (buf-a file-a buf-b file-b &optional markup-a-only) | |
804 | "Get differences between two buffers and set highlight changes. | |
805 | Both buffers are done unless optional parameter MARKUP-A-ONLY | |
806 | is non-nil." | |
807 | (save-window-excursion | |
808 | (let* (change-info | |
809 | change-a change-b | |
810 | a-start a-end len-a | |
811 | b-start b-end len-b | |
812 | (bufa-modified (buffer-modified-p buf-a)) | |
813 | (bufb-modified (buffer-modified-p buf-b)) | |
814 | (buf-a-read-only (with-current-buffer buf-a buffer-read-only)) | |
815 | (buf-b-read-only (with-current-buffer buf-b buffer-read-only)) | |
816 | temp-a temp-b) | |
817 | (if (and file-a bufa-modified) | |
818 | (if (y-or-n-p (format "Save buffer %s? " buf-a)) | |
819 | (with-current-buffer buf-a | |
820 | (save-buffer) | |
821 | (setq bufa-modified (buffer-modified-p buf-a))) | |
822 | (setq file-a nil))) | |
823 | (or file-a | |
824 | (setq temp-a (setq file-a (ediff-make-temp-file buf-a nil)))) | |
825 | ||
826 | (if (and file-b bufb-modified) | |
827 | (if (y-or-n-p (format "Save buffer %s? " buf-b)) | |
828 | (with-current-buffer buf-b | |
829 | (save-buffer) | |
830 | (setq bufb-modified (buffer-modified-p buf-b))) | |
831 | (setq file-b nil))) | |
832 | (or file-b | |
833 | (setq temp-b (setq file-b (ediff-make-temp-file buf-b nil)))) | |
834 | (set-buffer buf-a) | |
835 | (highlight-changes-mode 'active) | |
836 | (or markup-a-only (with-current-buffer buf-b | |
837 | (highlight-changes-mode 'active))) | |
838 | (setq change-info (hilit-chg-get-diff-info buf-a file-a buf-b file-b)) | |
839 | ||
840 | ||
841 | (setq change-a (car change-info)) | |
842 | (setq change-b (car (cdr change-info))) | |
843 | ||
844 | (hilit-chg-make-list) | |
845 | (while change-a | |
846 | (setq a-start (nth 0 (car change-a))) | |
847 | (setq a-end (nth 1 (car change-a))) | |
848 | (setq b-start (nth 0 (car change-b))) | |
849 | (setq b-end (nth 1 (car change-b))) | |
850 | (setq len-a (- a-end a-start)) | |
851 | (setq len-b (- b-end b-start)) | |
852 | (set-buffer buf-a) | |
853 | (hilit-chg-set-face-on-change a-start a-end len-b buf-a-read-only) | |
854 | (or markup-a-only | |
855 | (with-current-buffer buf-b | |
856 | (hilit-chg-set-face-on-change b-start b-end len-a | |
857 | buf-b-read-only) | |
858 | )) | |
859 | (setq change-a (cdr change-a)) | |
860 | (setq change-b (cdr change-b))) | |
861 | (or bufa-modified | |
862 | (with-current-buffer buf-a (set-buffer-modified-p nil))) | |
863 | (or bufb-modified | |
864 | (with-current-buffer buf-b (set-buffer-modified-p nil))) | |
865 | (if temp-a | |
866 | (delete-file temp-a)) | |
867 | (if temp-b | |
868 | (delete-file temp-b))) | |
869 | )) | |
870 | ||
871 | ;;;###autoload | |
872 | (defun highlight-compare-buffers (buf-a buf-b) | |
873 | "Compare two buffers and highlight the differences. | |
874 | ||
875 | The default is the current buffer and the one in the next window. | |
876 | ||
877 | If either buffer is modified and is visiting a file, you are prompted | |
878 | to save the file. | |
879 | ||
880 | Unless the buffer is unmodified and visiting a file, the buffer is | |
881 | written to a temporary file for comparison. | |
882 | ||
883 | If a buffer is read-only, differences will be highlighted but no property | |
884 | changes are made, so \\[highlight-changes-next-change] and | |
885 | \\[highlight-changes-previous-change] will not work." | |
886 | (interactive | |
887 | (list | |
888 | (get-buffer (read-buffer "buffer-a " (current-buffer) t)) | |
889 | (get-buffer | |
890 | (read-buffer "buffer-b " | |
891 | (window-buffer (next-window (selected-window))) t)))) | |
892 | (let ((file-a (buffer-file-name buf-a)) | |
893 | (file-b (buffer-file-name buf-b))) | |
894 | (highlight-markup-buffers buf-a file-a buf-b file-b) | |
895 | )) | |
e287d328 RS |
896 | |
897 | ;;;###autoload | |
b32e3ef8 KH |
898 | (defun highlight-compare-with-file (file-b) |
899 | "Compare this buffer with a file, and highlight differences. | |
e287d328 | 900 | |
3ec30bcb GM |
901 | If the buffer has a backup filename, it is used as the default when |
902 | this function is called interactively. | |
e287d328 | 903 | |
3ec30bcb GM |
904 | If the current buffer is visiting the file being compared against, it |
905 | also will have its differences highlighted. Otherwise, the file is | |
906 | read in temporarily but the buffer is deleted. | |
e287d328 | 907 | |
3ec30bcb GM |
908 | If the buffer is read-only, differences will be highlighted but no property |
909 | changes are made, so \\[highlight-changes-next-change] and | |
e287d328 RS |
910 | \\[highlight-changes-previous-change] will not work." |
911 | (interactive (list | |
912 | (read-file-name | |
913 | "File to compare with? " ;; prompt | |
914 | "" ;; directory | |
915 | nil ;; default | |
916 | 'yes ;; must exist | |
f826bf67 EZ |
917 | (let ((f (buffer-file-name (current-buffer)))) |
918 | (if f | |
919 | (progn | |
920 | (setq f (make-backup-file-name f)) | |
921 | (or (file-exists-p f) | |
922 | (setq f nil))) | |
923 | ) | |
924 | f)))) | |
e287d328 | 925 | (let* ((buf-a (current-buffer)) |
e287d328 RS |
926 | (file-a (buffer-file-name)) |
927 | (existing-buf (get-file-buffer file-b)) | |
928 | (buf-b (or existing-buf | |
929 | (find-file-noselect file-b))) | |
f826bf67 EZ |
930 | (buf-b-read-only (with-current-buffer buf-b buffer-read-only))) |
931 | (highlight-markup-buffers buf-a file-a buf-b file-b (not existing-buf)) | |
932 | (unless existing-buf | |
933 | (kill-buffer buf-b)) | |
934 | )) | |
e287d328 RS |
935 | |
936 | ||
937 | (defun hilit-chg-get-diff-info (buf-a file-a buf-b file-b) | |
938 | (let ((e nil) x y) ;; e is set by function hilit-chg-get-diff-list-hk | |
939 | (ediff-setup buf-a file-a buf-b file-b | |
940 | nil nil ; buf-c file-C | |
941 | 'hilit-chg-get-diff-list-hk | |
942 | (list (cons 'ediff-job-name 'something)) | |
943 | ) | |
944 | (ediff-with-current-buffer e (ediff-really-quit nil)) | |
945 | (list x y))) | |
946 | ||
947 | ||
948 | (defun hilit-chg-get-diff-list-hk () | |
71296446 | 949 | ;; x and y are dynamically bound by hilit-chg-get-diff-info |
e287d328 RS |
950 | ;; which calls this function as a hook |
951 | (defvar x) ;; placate the byte-compiler | |
952 | (defvar y) | |
953 | (setq e (current-buffer)) | |
954 | (let ((n 0) extent p va vb a b) | |
955 | (setq x nil y nil) ;; x and y are bound by hilit-chg-get-diff-info | |
956 | (while (< n ediff-number-of-differences) | |
957 | (ediff-make-fine-diffs n) | |
958 | (setq va (ediff-get-fine-diff-vector n 'A)) | |
959 | ;; va is a vector if there are fine differences | |
960 | (if va | |
961 | (setq a (append va nil)) | |
f6ec4635 | 962 | ;; if not, get the unrefined difference |
e287d328 | 963 | (setq va (ediff-get-difference n 'A)) |
3ec30bcb | 964 | (setq a (list (elt va 0)))) |
e287d328 RS |
965 | ;; a list a list |
966 | (setq p a) | |
967 | (while p | |
968 | (setq extent (list (overlay-start (car p)) | |
969 | (overlay-end (car p)))) | |
970 | (setq p (cdr p)) | |
3ec30bcb | 971 | (setq x (append x (list extent) )));; while p |
e287d328 RS |
972 | ;; |
973 | (setq vb (ediff-get-fine-diff-vector n 'B)) | |
974 | ;; vb is a vector | |
975 | (if vb | |
976 | (setq b (append vb nil)) | |
f6ec4635 | 977 | ;; if not, get the unrefined difference |
e287d328 | 978 | (setq vb (ediff-get-difference n 'B)) |
3ec30bcb | 979 | (setq b (list (elt vb 0)))) |
e287d328 RS |
980 | ;; b list a list |
981 | (setq p b) | |
982 | (while p | |
983 | (setq extent (list (overlay-start (car p)) | |
984 | (overlay-end (car p)))) | |
985 | (setq p (cdr p)) | |
3ec30bcb GM |
986 | (setq y (append y (list extent) ))) |
987 | (setq n (1+ n)));; while | |
e287d328 RS |
988 | ;; ediff-quit doesn't work here. |
989 | ;; No point in returning a value, since this is a hook function. | |
990 | )) | |
991 | ||
992 | ;; ======================= automatic stuff ============== | |
993 | ||
3ec30bcb | 994 | ;; Global Highlight Changes mode is modeled after Global Font-lock mode. |
e287d328 RS |
995 | ;; Three hooks are used to gain control. When Global Changes Mode is |
996 | ;; enabled, `find-file-hooks' and `change-major-mode-hook' are set. | |
f6ec4635 | 997 | ;; `find-file-hooks' is called when visiting a file, the new mode is |
e287d328 RS |
998 | ;; known at this time. |
999 | ;; `change-major-mode-hook' is called when a buffer is changing mode. | |
1000 | ;; This could be because of finding a file in which case | |
1001 | ;; `find-file-hooks' has already been called and has done its work. | |
1002 | ;; However, it also catches the case where a new mode is being set by | |
1003 | ;; the user. However, it is called from `kill-all-variables' and at | |
f6ec4635 JB |
1004 | ;; this time the mode is the old mode, which is not what we want. |
1005 | ;; So, our function temporarily sets `post-command-hook' which will | |
e287d328 RS |
1006 | ;; be called after the buffer has been completely set up (with the new |
1007 | ;; mode). It then removes the `post-command-hook'. | |
1008 | ;; One other wrinkle - every M-x command runs the `change-major-mode-hook' | |
1009 | ;; so we ignore this by examining the buffer name. | |
1010 | ||
1011 | ||
1012 | (defun hilit-chg-major-mode-hook () | |
3ec30bcb | 1013 | (add-hook 'post-command-hook 'hilit-chg-post-command-hook)) |
e287d328 RS |
1014 | |
1015 | (defun hilit-chg-post-command-hook () | |
1016 | ;; This is called after changing a major mode, but also after each | |
f6ec4635 JB |
1017 | ;; M-x command, in which case the current buffer is a minibuffer. |
1018 | ;; In that case, do not act on it here, but don't turn it off | |
71296446 | 1019 | ;; either, we will get called here again soon-after. |
f6ec4635 | 1020 | ;; Also, don't enable it for other special buffers. |
e287d328 RS |
1021 | (if (string-match "^[ *]" (buffer-name)) |
1022 | nil ;; (message "ignoring this post-command-hook") | |
1023 | (remove-hook 'post-command-hook 'hilit-chg-post-command-hook) | |
71296446 | 1024 | ;; The following check isn't necessary, since |
e287d328 RS |
1025 | ;; hilit-chg-turn-on-maybe makes this check too. |
1026 | (or highlight-changes-mode ;; don't turn it on if it already is | |
3ec30bcb | 1027 | (hilit-chg-turn-on-maybe highlight-changes-global-initial-state)))) |
e287d328 RS |
1028 | |
1029 | (defun hilit-chg-check-global () | |
1030 | ;; This is called from the find file hook. | |
1031 | (hilit-chg-turn-on-maybe highlight-changes-global-initial-state)) | |
1032 | ||
1033 | ||
e287d328 RS |
1034 | ;;;###autoload |
1035 | (defun global-highlight-changes (&optional arg) | |
1036 | "Turn on or off global Highlight Changes mode. | |
1037 | ||
1038 | When called interactively: | |
1039 | - if no prefix, toggle global Highlight Changes mode on or off | |
1040 | - if called with a positive prefix (or just C-u) turn it on in active mode | |
1041 | - if called with a zero prefix turn it on in passive mode | |
1042 | - if called with a negative prefix turn it off | |
1043 | ||
1044 | When called from a program: | |
1045 | - if ARG is nil or omitted, turn it off | |
f6ec4635 | 1046 | - if ARG is `active', turn it on in active mode |
3ec30bcb | 1047 | - if ARG is `passive', turn it on in passive mode |
71296446 | 1048 | - otherwise just turn it on |
e287d328 RS |
1049 | |
1050 | When global Highlight Changes mode is enabled, Highlight Changes mode is turned | |
1051 | on for future \"suitable\" buffers (and for \"suitable\" existing buffers if | |
1052 | variable `highlight-changes-global-changes-existing-buffers' is non-nil). | |
3ec30bcb | 1053 | \"Suitability\" is determined by variable `highlight-changes-global-modes'." |
e287d328 | 1054 | |
71296446 | 1055 | (interactive |
e287d328 RS |
1056 | (list |
1057 | (cond | |
1058 | ((null current-prefix-arg) | |
1059 | ;; no arg => toggle it on/off | |
1060 | (setq global-highlight-changes (not global-highlight-changes))) | |
1061 | ;; positive interactive arg - turn it on as active | |
1062 | ((> (prefix-numeric-value current-prefix-arg) 0) | |
1063 | (setq global-highlight-changes t) | |
1064 | 'active) | |
1065 | ;; zero interactive arg - turn it on as passive | |
1066 | ((= (prefix-numeric-value current-prefix-arg) 0) | |
1067 | (setq global-highlight-changes t) | |
1068 | 'passive) | |
1069 | ;; negative interactive arg - turn it off | |
1070 | (t | |
71296446 | 1071 | (setq global-highlight-changes nil) |
e287d328 RS |
1072 | nil)))) |
1073 | ||
1074 | (if arg | |
1075 | (progn | |
1076 | (if (eq arg 'active) | |
1077 | (setq highlight-changes-global-initial-state 'active) | |
1078 | (if (eq arg 'passive) | |
1079 | (setq highlight-changes-global-initial-state 'passive))) | |
1080 | (setq global-highlight-changes t) | |
79ccae1e | 1081 | (message "Turning ON Global Highlight Changes mode in %s state" |
e287d328 RS |
1082 | highlight-changes-global-initial-state) |
1083 | (add-hook 'hilit-chg-major-mode-hook 'hilit-chg-major-mode-hook) | |
1084 | (add-hook 'find-file-hooks 'hilit-chg-check-global) | |
1085 | (if highlight-changes-global-changes-existing-buffers | |
71296446 | 1086 | (hilit-chg-update-all-buffers |
3ec30bcb | 1087 | highlight-changes-global-initial-state))) |
71296446 | 1088 | |
79ccae1e | 1089 | (message "Turning OFF global Highlight Changes mode") |
e287d328 RS |
1090 | (remove-hook 'hilit-chg-major-mode-hook 'hilit-chg-major-mode-hook) |
1091 | (remove-hook 'find-file-hooks 'hilit-chg-check-global) | |
1092 | (remove-hook 'post-command-hook | |
1093 | 'hilit-chg-post-command-hook) | |
1094 | (remove-hook 'find-file-hooks 'hilit-chg-check-global) | |
1095 | (if highlight-changes-global-changes-existing-buffers | |
3ec30bcb | 1096 | (hilit-chg-update-all-buffers nil)))) |
e287d328 RS |
1097 | |
1098 | ||
1099 | (defun hilit-chg-turn-on-maybe (value) | |
1100 | "Turn on Highlight Changes mode if it is appropriate for this buffer. | |
1101 | ||
1102 | A buffer is appropriate for Highlight Changes mode if all these are true: | |
71296446 | 1103 | - the buffer is not a special buffer (one whose name begins with |
e287d328 | 1104 | `*' or ` ') |
3ec30bcb GM |
1105 | - the buffer's mode is suitable as per variable |
1106 | `highlight-changes-global-modes' | |
e287d328 RS |
1107 | - Highlight Changes mode is not already on for this buffer. |
1108 | ||
71296446 | 1109 | This function is called from `hilit-chg-update-all-buffers' or |
3ec30bcb | 1110 | from `global-highlight-changes' when turning on global Highlight Changes mode." |
e287d328 RS |
1111 | (or highlight-changes-mode ; do nothing if already on |
1112 | (if | |
1113 | (cond | |
1114 | ((null highlight-changes-global-modes) | |
1115 | nil) | |
1116 | ((functionp highlight-changes-global-modes) | |
1117 | (funcall highlight-changes-global-modes)) | |
1118 | ((listp highlight-changes-global-modes) | |
1119 | (if (eq (car-safe highlight-changes-global-modes) 'not) | |
1120 | (not (memq major-mode (cdr highlight-changes-global-modes))) | |
1121 | (memq major-mode highlight-changes-global-modes))) | |
1122 | (t | |
71296446 | 1123 | (and |
e287d328 | 1124 | (not (string-match "^[ *]" (buffer-name))) |
3ec30bcb | 1125 | (buffer-file-name)))) |
e287d328 RS |
1126 | (progn |
1127 | (hilit-chg-set value) | |
3ec30bcb | 1128 | (run-hooks 'highlight-changes-enable-hook))))) |
71296446 | 1129 | |
e287d328 RS |
1130 | |
1131 | (defun hilit-chg-turn-off-maybe () | |
1132 | (if highlight-changes-mode | |
1133 | (progn | |
1134 | (run-hooks 'highlight-changes-disable-hook) | |
1135 | (hilit-chg-clear)))) | |
1136 | ||
1137 | ||
e287d328 RS |
1138 | (defun hilit-chg-update-all-buffers (value) |
1139 | (mapcar | |
1140 | (function (lambda (buffer) | |
1141 | (with-current-buffer buffer | |
1142 | (if value | |
1143 | (hilit-chg-turn-on-maybe value) | |
1144 | (hilit-chg-turn-off-maybe)) | |
1145 | ))) | |
1146 | (buffer-list))) | |
1147 | ||
1148 | ;; ===================== debug ================== | |
1149 | ;; For debug & test use: | |
1150 | ;; | |
1151 | ;; (defun hilit-chg-debug-show (&optional beg end) | |
1152 | ;; (interactive) | |
1153 | ;; (message "--- hilit-chg-debug-show ---") | |
1154 | ;; (hilit-chg-map-changes '(lambda (prop start end) | |
1155 | ;; (message "%d-%d: %s" start end prop) | |
1156 | ;; ) | |
1157 | ;; beg end | |
1158 | ;; )) | |
71296446 | 1159 | ;; |
e287d328 RS |
1160 | ;; ================== end of debug =============== |
1161 | ||
e287d328 | 1162 | (provide 'hilit-chg) |
e287d328 | 1163 | |
67476fca | 1164 | ;; arch-tag: de00301d-5bad-44da-aa82-e0e010b0c463 |
fdbd749a | 1165 | ;;; hilit-chg.el ends here |