Commit | Line | Data |
---|---|---|
e8af40ee | 1 | ;;; hi-lock.el --- minor mode for interactive automatic highlighting |
abb2db1c | 2 | |
73b0cd50 | 3 | ;; Copyright (C) 2000-2011 Free Software Foundation, Inc. |
abb2db1c | 4 | |
4c120732 | 5 | ;; Author: David M. Koppelman <koppel@ece.lsu.edu> |
abb2db1c GM |
6 | ;; Keywords: faces, minor-mode, matching, display |
7 | ||
8 | ;; This file is part of GNU Emacs. | |
9 | ||
eb3fa2cf | 10 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
abb2db1c | 11 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
12 | ;; the Free Software Foundation, either version 3 of the License, or |
13 | ;; (at your option) any later version. | |
abb2db1c GM |
14 | |
15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
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 | |
eb3fa2cf | 21 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
abb2db1c | 22 | |
e8af40ee | 23 | ;;; Commentary: |
71296446 | 24 | ;; |
abb2db1c GM |
25 | ;; With the hi-lock commands text matching interactively entered |
26 | ;; regexp's can be highlighted. For example, `M-x highlight-regexp | |
27 | ;; RET clearly RET RET' will highlight all occurrences of `clearly' | |
28 | ;; using a yellow background face. New occurrences of `clearly' will | |
29 | ;; be highlighted as they are typed. `M-x unhighlight-regexp RET' | |
30 | ;; will remove the highlighting. Any existing face can be used for | |
31 | ;; highlighting and a set of appropriate faces is provided. The | |
32 | ;; regexps can be written into the current buffer in a form that will | |
c898bef7 CY |
33 | ;; be recognized the next time the corresponding file is read (when |
34 | ;; file patterns is turned on). | |
abb2db1c GM |
35 | ;; |
36 | ;; Applications: | |
37 | ;; | |
38 | ;; In program source code highlight a variable to quickly see all | |
39 | ;; places it is modified or referenced: | |
40 | ;; M-x highlight-regexp ground_contact_switches_closed RET RET | |
41 | ;; | |
42 | ;; In a shell or other buffer that is showing lots of program | |
43 | ;; output, highlight the parts of the output you're interested in: | |
44 | ;; M-x highlight-regexp Total execution time [0-9]+ RET hi-blue-b RET | |
45 | ;; | |
46 | ;; In buffers displaying tables, highlight the lines you're interested in: | |
47 | ;; M-x highlight-lines-matching-regexp January 2000 RET hi-black-b RET | |
48 | ;; | |
49 | ;; When writing text, highlight personal cliches. This can be | |
50 | ;; amusing. | |
108ee42b | 51 | ;; M-x highlight-phrase as can be seen RET RET |
abb2db1c | 52 | ;; |
108ee42b | 53 | ;; Setup: |
abb2db1c GM |
54 | ;; |
55 | ;; Put the following code in your .emacs file. This turns on | |
108ee42b | 56 | ;; hi-lock mode and adds a "Regexp Highlighting" entry |
abb2db1c GM |
57 | ;; to the edit menu. |
58 | ;; | |
71060bdd | 59 | ;; (global-hi-lock-mode 1) |
71296446 | 60 | ;; |
c898bef7 CY |
61 | ;; To enable the use of patterns found in files (presumably placed |
62 | ;; there by hi-lock) include the following in your .emacs file: | |
63 | ;; | |
64 | ;; (setq hi-lock-file-patterns-policy 'ask) | |
65 | ;; | |
66 | ;; If you get tired of being asked each time a file is loaded replace | |
06b1a5ef | 67 | ;; `ask' with a function that returns t if patterns should be read. |
c898bef7 | 68 | ;; |
abb2db1c GM |
69 | ;; You might also want to bind the hi-lock commands to more |
70 | ;; finger-friendly sequences: | |
71 | ||
72 | ;; (define-key hi-lock-map "\C-z\C-h" 'highlight-lines-matching-regexp) | |
73 | ;; (define-key hi-lock-map "\C-zi" 'hi-lock-find-patterns) | |
74 | ;; (define-key hi-lock-map "\C-zh" 'highlight-regexp) | |
108ee42b | 75 | ;; (define-key hi-lock-map "\C-zp" 'highlight-phrase) |
abb2db1c GM |
76 | ;; (define-key hi-lock-map "\C-zr" 'unhighlight-regexp) |
77 | ;; (define-key hi-lock-map "\C-zb" 'hi-lock-write-interactive-patterns)) | |
78 | ||
79 | ;; See the documentation for hi-lock-mode `C-h f hi-lock-mode' for | |
80 | ;; additional instructions. | |
81 | ||
82 | ;; Sample file patterns: | |
83 | ||
84 | ; Hi-lock: (("^;;; .*" (0 (quote hi-black-hb) t))) | |
85 | ; Hi-lock: ( ("make-variable-buffer-\\(local\\)" (0 font-lock-keyword-face)(1 'italic append))))) | |
86 | ; Hi-lock: end | |
87 | ||
88 | ;;; Code: | |
89 | ||
befe199d | 90 | (require 'font-lock) |
abb2db1c | 91 | |
f43eaaef | 92 | (defgroup hi-lock nil |
abb2db1c | 93 | "Interactively add and remove font-lock patterns for highlighting text." |
f43eaaef JL |
94 | :link '(custom-manual "(emacs)Highlight Interactively") |
95 | :group 'font-lock) | |
abb2db1c | 96 | |
abb2db1c GM |
97 | (defcustom hi-lock-file-patterns-range 10000 |
98 | "Limit of search in a buffer for hi-lock patterns. | |
8b730780 | 99 | When a file is visited and hi-lock mode is on, patterns starting |
abb2db1c GM |
100 | up to this limit are added to font-lock's patterns. See documentation |
101 | of functions `hi-lock-mode' and `hi-lock-find-patterns'." | |
102 | :type 'integer | |
f43eaaef | 103 | :group 'hi-lock) |
abb2db1c | 104 | |
81dc5714 JL |
105 | (defcustom hi-lock-highlight-range 200000 |
106 | "Size of area highlighted by hi-lock when font-lock not active. | |
107 | Font-lock is not active in buffers that do their own highlighting, | |
108 | such as the buffer created by `list-colors-display'. In those buffers | |
109 | hi-lock patterns will only be applied over a range of | |
110 | `hi-lock-highlight-range' characters. If font-lock is active then | |
111 | highlighting will be applied throughout the buffer." | |
112 | :type 'integer | |
113 | :group 'hi-lock) | |
114 | ||
abb2db1c GM |
115 | (defcustom hi-lock-exclude-modes |
116 | '(rmail-mode mime/viewer-mode gnus-article-mode) | |
117 | "List of major modes in which hi-lock will not run. | |
118 | For security reasons since font lock patterns can specify function | |
119 | calls." | |
f5bd8092 | 120 | :type '(repeat symbol) |
f43eaaef | 121 | :group 'hi-lock) |
abb2db1c | 122 | |
cf995676 | 123 | (defcustom hi-lock-file-patterns-policy 'ask |
c898bef7 | 124 | "Specify when hi-lock should use patterns found in file. |
06b1a5ef | 125 | If `ask', prompt when patterns found in buffer; if bound to a function, |
c898bef7 | 126 | use patterns when function returns t (function is called with patterns |
06b1a5ef | 127 | as first argument); if nil or `never' or anything else, don't use file |
176eb1f1 GM |
128 | patterns." |
129 | :type '(choice (const :tag "Do not use file patterns" never) | |
130 | (const :tag "Ask about file patterns" ask) | |
131 | (function :tag "Function to check file patterns")) | |
132 | :group 'hi-lock | |
133 | :version "22.1") | |
134 | ||
135 | ;; It can have a function value. | |
136 | (put 'hi-lock-file-patterns-policy 'risky-local-variable t) | |
abb2db1c GM |
137 | |
138 | (defgroup hi-lock-faces nil | |
139 | "Faces for hi-lock." | |
f43eaaef JL |
140 | :group 'hi-lock |
141 | :group 'faces) | |
abb2db1c GM |
142 | |
143 | (defface hi-yellow | |
e0d815a2 | 144 | '((((min-colors 88) (background dark)) |
ea81d57e DN |
145 | (:background "yellow1" :foreground "black")) |
146 | (((background dark)) (:background "yellow" :foreground "black")) | |
147 | (((min-colors 88)) (:background "yellow1")) | |
a0b8c939 | 148 | (t (:background "yellow"))) |
abb2db1c GM |
149 | "Default face for hi-lock mode." |
150 | :group 'hi-lock-faces) | |
151 | ||
152 | (defface hi-pink | |
16cdf141 | 153 | '((((background dark)) (:background "pink" :foreground "black")) |
a0b8c939 | 154 | (t (:background "pink"))) |
abb2db1c GM |
155 | "Face for hi-lock mode." |
156 | :group 'hi-lock-faces) | |
157 | ||
158 | (defface hi-green | |
e0d815a2 | 159 | '((((min-colors 88) (background dark)) |
ea81d57e DN |
160 | (:background "green1" :foreground "black")) |
161 | (((background dark)) (:background "green" :foreground "black")) | |
e0d815a2 | 162 | (((min-colors 88)) (:background "green1")) |
a0b8c939 | 163 | (t (:background "green"))) |
abb2db1c GM |
164 | "Face for hi-lock mode." |
165 | :group 'hi-lock-faces) | |
166 | ||
167 | (defface hi-blue | |
16cdf141 | 168 | '((((background dark)) (:background "light blue" :foreground "black")) |
a0b8c939 | 169 | (t (:background "light blue"))) |
abb2db1c GM |
170 | "Face for hi-lock mode." |
171 | :group 'hi-lock-faces) | |
172 | ||
173 | (defface hi-black-b | |
174 | '((t (:weight bold))) | |
175 | "Face for hi-lock mode." | |
176 | :group 'hi-lock-faces) | |
177 | ||
178 | (defface hi-blue-b | |
ea81d57e DN |
179 | '((((min-colors 88)) (:weight bold :foreground "blue1")) |
180 | (t (:weight bold :foreground "blue"))) | |
abb2db1c GM |
181 | "Face for hi-lock mode." |
182 | :group 'hi-lock-faces) | |
183 | ||
184 | (defface hi-green-b | |
ea81d57e DN |
185 | '((((min-colors 88)) (:weight bold :foreground "green1")) |
186 | (t (:weight bold :foreground "green"))) | |
abb2db1c GM |
187 | "Face for hi-lock mode." |
188 | :group 'hi-lock-faces) | |
189 | ||
190 | (defface hi-red-b | |
ea81d57e DN |
191 | '((((min-colors 88)) (:weight bold :foreground "red1")) |
192 | (t (:weight bold :foreground "red"))) | |
abb2db1c GM |
193 | "Face for hi-lock mode." |
194 | :group 'hi-lock-faces) | |
195 | ||
196 | (defface hi-black-hb | |
c3b27206 | 197 | '((t (:weight bold :height 1.67 :inherit variable-pitch))) |
abb2db1c GM |
198 | "Face for hi-lock mode." |
199 | :group 'hi-lock-faces) | |
200 | ||
201 | (defvar hi-lock-file-patterns nil | |
202 | "Patterns found in file for hi-lock. Should not be changed.") | |
203 | ||
204 | (defvar hi-lock-interactive-patterns nil | |
205 | "Patterns provided to hi-lock by user. Should not be changed.") | |
206 | ||
ef705f25 JL |
207 | (defvar hi-lock-face-defaults |
208 | '("hi-yellow" "hi-pink" "hi-green" "hi-blue" "hi-black-b" | |
209 | "hi-blue-b" "hi-red-b" "hi-green-b" "hi-black-hb") | |
210 | "Default faces for hi-lock interactive functions.") | |
abb2db1c | 211 | |
ef705f25 | 212 | ;(dolist (f hi-lock-face-defaults) (unless (facep f) (error "%s not a face" f))) |
abb2db1c | 213 | |
ef705f25 JL |
214 | (define-obsolete-variable-alias 'hi-lock-face-history |
215 | 'hi-lock-face-defaults | |
216 | "23.1") | |
217 | ||
218 | (define-obsolete-variable-alias 'hi-lock-regexp-history | |
219 | 'regexp-history | |
220 | "23.1") | |
abb2db1c GM |
221 | |
222 | (defvar hi-lock-file-patterns-prefix "Hi-lock" | |
c898bef7 | 223 | "Search target for finding hi-lock patterns at top of file.") |
abb2db1c | 224 | |
71060bdd | 225 | (defvar hi-lock-archaic-interface-message-used nil |
90756087 | 226 | "True if user alerted that `global-hi-lock-mode' is now the global switch. |
8b730780 | 227 | Earlier versions of hi-lock used `hi-lock-mode' as the global switch; |
90756087 | 228 | the message is issued if it appears that `hi-lock-mode' is used assuming |
71060bdd EZ |
229 | that older functionality. This variable avoids multiple reminders.") |
230 | ||
231 | (defvar hi-lock-archaic-interface-deduce nil | |
90756087 JL |
232 | "If non-nil, sometimes assume that `hi-lock-mode' means `global-hi-lock-mode'. |
233 | Assumption is made if `hi-lock-mode' used in the *scratch* buffer while | |
71060bdd EZ |
234 | a library is being loaded.") |
235 | ||
abb2db1c GM |
236 | (make-variable-buffer-local 'hi-lock-interactive-patterns) |
237 | (put 'hi-lock-interactive-patterns 'permanent-local t) | |
abb2db1c GM |
238 | (make-variable-buffer-local 'hi-lock-file-patterns) |
239 | (put 'hi-lock-file-patterns 'permanent-local t) | |
240 | ||
b016851c SM |
241 | (defvar hi-lock-menu |
242 | (let ((map (make-sparse-keymap "Hi Lock"))) | |
243 | (define-key-after map [highlight-regexp] | |
244 | '(menu-item "Highlight Regexp..." highlight-regexp | |
245 | :help "Highlight text matching PATTERN (a regexp).")) | |
246 | ||
247 | (define-key-after map [highlight-phrase] | |
248 | '(menu-item "Highlight Phrase..." highlight-phrase | |
249 | :help "Highlight text matching PATTERN (a regexp processed to match phrases).")) | |
250 | ||
251 | (define-key-after map [highlight-lines-matching-regexp] | |
252 | '(menu-item "Highlight Lines..." highlight-lines-matching-regexp | |
253 | :help "Highlight lines containing match of PATTERN (a regexp).")) | |
254 | ||
255 | (define-key-after map [unhighlight-regexp] | |
256 | '(menu-item "Remove Highlighting..." unhighlight-regexp | |
257 | :help "Remove previously entered highlighting pattern." | |
258 | :enable hi-lock-interactive-patterns)) | |
259 | ||
260 | (define-key-after map [hi-lock-write-interactive-patterns] | |
261 | '(menu-item "Patterns to Buffer" hi-lock-write-interactive-patterns | |
262 | :help "Insert interactively added REGEXPs into buffer at point." | |
263 | :enable hi-lock-interactive-patterns)) | |
264 | ||
265 | (define-key-after map [hi-lock-find-patterns] | |
266 | '(menu-item "Patterns from Buffer" hi-lock-find-patterns | |
267 | :help "Use patterns (if any) near top of buffer.")) | |
268 | map) | |
abb2db1c GM |
269 | "Menu for hi-lock mode.") |
270 | ||
b016851c SM |
271 | (defvar hi-lock-map |
272 | (let ((map (make-sparse-keymap "Hi Lock"))) | |
273 | (define-key map "\C-xwi" 'hi-lock-find-patterns) | |
274 | (define-key map "\C-xwl" 'highlight-lines-matching-regexp) | |
275 | (define-key map "\C-xwp" 'highlight-phrase) | |
276 | (define-key map "\C-xwh" 'highlight-regexp) | |
277 | (define-key map "\C-xwr" 'unhighlight-regexp) | |
278 | (define-key map "\C-xwb" 'hi-lock-write-interactive-patterns) | |
279 | map) | |
abb2db1c GM |
280 | "Key map for hi-lock.") |
281 | ||
abb2db1c GM |
282 | ;; Visible Functions |
283 | ||
abb2db1c | 284 | ;;;###autoload |
71060bdd | 285 | (define-minor-mode hi-lock-mode |
abb2db1c GM |
286 | "Toggle minor mode for interactively adding font-lock highlighting patterns. |
287 | ||
90756087 JL |
288 | If ARG positive, turn hi-lock on. Issuing a hi-lock command will also |
289 | turn hi-lock on. To turn hi-lock on in all buffers use | |
290 | `global-hi-lock-mode' or in your .emacs file (global-hi-lock-mode 1). | |
71060bdd EZ |
291 | When hi-lock is turned on, a \"Regexp Highlighting\" submenu is added |
292 | to the \"Edit\" menu. The commands in the submenu, which can be | |
293 | called interactively, are: | |
abb2db1c GM |
294 | |
295 | \\[highlight-regexp] REGEXP FACE | |
296 | Highlight matches of pattern REGEXP in current buffer with FACE. | |
297 | ||
108ee42b GM |
298 | \\[highlight-phrase] PHRASE FACE |
299 | Highlight matches of phrase PHRASE in current buffer with FACE. | |
300 | (PHRASE can be any REGEXP, but spaces will be replaced by matches | |
301 | to whitespace and initial lower-case letters will become case insensitive.) | |
71296446 | 302 | |
abb2db1c GM |
303 | \\[highlight-lines-matching-regexp] REGEXP FACE |
304 | Highlight lines containing matches of REGEXP in current buffer with FACE. | |
305 | ||
306 | \\[unhighlight-regexp] REGEXP | |
307 | Remove highlighting on matches of REGEXP in current buffer. | |
308 | ||
309 | \\[hi-lock-write-interactive-patterns] | |
c898bef7 | 310 | Write active REGEXPs into buffer as comments (if possible). They may |
abb2db1c GM |
311 | be read the next time file is loaded or when the \\[hi-lock-find-patterns] command |
312 | is issued. The inserted regexps are in the form of font lock keywords. | |
ee44464c | 313 | (See `font-lock-keywords'.) They may be edited and re-loaded with \\[hi-lock-find-patterns], |
869d3e17 JB |
314 | any valid `font-lock-keywords' form is acceptable. When a file is |
315 | loaded the patterns are read if `hi-lock-file-patterns-policy' is | |
c898bef7 CY |
316 | 'ask and the user responds y to the prompt, or if |
317 | `hi-lock-file-patterns-policy' is bound to a function and that | |
318 | function returns t. | |
abb2db1c GM |
319 | |
320 | \\[hi-lock-find-patterns] | |
321 | Re-read patterns stored in buffer (in the format produced by \\[hi-lock-write-interactive-patterns]). | |
322 | ||
c898bef7 CY |
323 | When hi-lock is started and if the mode is not excluded or patterns |
324 | rejected, the beginning of the buffer is searched for lines of the | |
325 | form: | |
abb2db1c | 326 | Hi-lock: FOO |
8b730780 JB |
327 | where FOO is a list of patterns. These are added to the font lock |
328 | keywords already present. The patterns must start before position | |
329 | \(number of characters into buffer) `hi-lock-file-patterns-range'. | |
330 | Patterns will be read until | |
abb2db1c | 331 | Hi-lock: end |
8b730780 | 332 | is found. A mode is excluded if it's in the list `hi-lock-exclude-modes'." |
963b2040 | 333 | :group 'hi-lock |
90756087 JL |
334 | :lighter (:eval (if (or hi-lock-interactive-patterns |
335 | hi-lock-file-patterns) | |
336 | " Hi" "")) | |
963b2040 CY |
337 | :global nil |
338 | :keymap hi-lock-map | |
71060bdd EZ |
339 | (when (and (equal (buffer-name) "*scratch*") |
340 | load-in-progress | |
32226619 | 341 | (not (called-interactively-p 'interactive)) |
71060bdd EZ |
342 | (not hi-lock-archaic-interface-message-used)) |
343 | (setq hi-lock-archaic-interface-message-used t) | |
344 | (if hi-lock-archaic-interface-deduce | |
345 | (global-hi-lock-mode hi-lock-mode) | |
346 | (warn | |
347 | "Possible archaic use of (hi-lock-mode). | |
348 | Use (global-hi-lock-mode 1) in .emacs to enable hi-lock for all buffers, | |
90756087 | 349 | use (hi-lock-mode 1) for individual buffers. For compatibility with Emacs |
71060bdd EZ |
350 | versions before 22 use the following in your .emacs file: |
351 | ||
352 | (if (functionp 'global-hi-lock-mode) | |
353 | (global-hi-lock-mode 1) | |
354 | (hi-lock-mode 1)) | |
355 | "))) | |
356 | (if hi-lock-mode | |
963b2040 CY |
357 | ;; Turned on. |
358 | (progn | |
e4d59066 | 359 | (unless font-lock-mode (font-lock-mode 1)) |
963b2040 CY |
360 | (define-key-after menu-bar-edit-menu [hi-lock] |
361 | (cons "Regexp Highlighting" hi-lock-menu)) | |
362 | (hi-lock-find-patterns) | |
e4d59066 | 363 | (add-hook 'font-lock-mode-hook 'hi-lock-font-lock-hook nil t)) |
abb2db1c | 364 | ;; Turned off. |
e4d59066 CY |
365 | (when (or hi-lock-interactive-patterns |
366 | hi-lock-file-patterns) | |
71060bdd | 367 | (when hi-lock-interactive-patterns |
e4d59066 CY |
368 | (font-lock-remove-keywords nil hi-lock-interactive-patterns) |
369 | (setq hi-lock-interactive-patterns nil)) | |
370 | (when hi-lock-file-patterns | |
371 | (font-lock-remove-keywords nil hi-lock-file-patterns) | |
372 | (setq hi-lock-file-patterns nil)) | |
81dc5714 JL |
373 | (remove-overlays nil nil 'hi-lock-overlay t) |
374 | (when font-lock-fontified (font-lock-fontify-buffer))) | |
963b2040 CY |
375 | (define-key-after menu-bar-edit-menu [hi-lock] nil) |
376 | (remove-hook 'font-lock-mode-hook 'hi-lock-font-lock-hook t))) | |
abb2db1c | 377 | |
963b2040 | 378 | ;;;###autoload |
98007d83 | 379 | (define-globalized-minor-mode global-hi-lock-mode |
71060bdd | 380 | hi-lock-mode turn-on-hi-lock-if-enabled |
9cb4bb45 | 381 | :group 'hi-lock) |
71060bdd | 382 | |
963b2040 | 383 | (defun turn-on-hi-lock-if-enabled () |
71060bdd | 384 | (setq hi-lock-archaic-interface-message-used t) |
963b2040 | 385 | (unless (memq major-mode hi-lock-exclude-modes) |
71060bdd | 386 | (hi-lock-mode 1))) |
abb2db1c GM |
387 | |
388 | ;;;###autoload | |
389 | (defalias 'highlight-lines-matching-regexp 'hi-lock-line-face-buffer) | |
390 | ;;;###autoload | |
391 | (defun hi-lock-line-face-buffer (regexp &optional face) | |
108ee42b | 392 | "Set face of all lines containing a match of REGEXP to FACE. |
abb2db1c GM |
393 | |
394 | Interactively, prompt for REGEXP then FACE. Buffer-local history | |
395 | list maintained for regexps, global history maintained for faces. | |
ef705f25 JL |
396 | \\<minibuffer-local-map>Use \\[previous-history-element] to retrieve previous history items, |
397 | and \\[next-history-element] to retrieve default values. | |
8b730780 | 398 | \(See info node `Minibuffer History'.)" |
abb2db1c GM |
399 | (interactive |
400 | (list | |
8677dea3 JL |
401 | (hi-lock-regexp-okay |
402 | (read-regexp "Regexp to highlight line" (car regexp-history))) | |
abb2db1c | 403 | (hi-lock-read-face-name))) |
597767da | 404 | (or (facep face) (setq face 'hi-yellow)) |
71060bdd | 405 | (unless hi-lock-mode (hi-lock-mode 1)) |
abb2db1c | 406 | (hi-lock-set-pattern |
b18f5523 SM |
407 | ;; The \\(?:...\\) grouping construct ensures that a leading ^, +, * or ? |
408 | ;; or a trailing $ in REGEXP will be interpreted correctly. | |
963b2040 | 409 | (concat "^.*\\(?:" regexp "\\).*$") face)) |
abb2db1c | 410 | |
108ee42b | 411 | |
abb2db1c GM |
412 | ;;;###autoload |
413 | (defalias 'highlight-regexp 'hi-lock-face-buffer) | |
414 | ;;;###autoload | |
415 | (defun hi-lock-face-buffer (regexp &optional face) | |
108ee42b | 416 | "Set face of each match of REGEXP to FACE. |
abb2db1c GM |
417 | |
418 | Interactively, prompt for REGEXP then FACE. Buffer-local history | |
419 | list maintained for regexps, global history maintained for faces. | |
ef705f25 JL |
420 | \\<minibuffer-local-map>Use \\[previous-history-element] to retrieve previous history items, |
421 | and \\[next-history-element] to retrieve default values. | |
8b730780 | 422 | \(See info node `Minibuffer History'.)" |
abb2db1c GM |
423 | (interactive |
424 | (list | |
8677dea3 JL |
425 | (hi-lock-regexp-okay |
426 | (read-regexp "Regexp to highlight" (car regexp-history))) | |
abb2db1c | 427 | (hi-lock-read-face-name))) |
597767da | 428 | (or (facep face) (setq face 'hi-yellow)) |
71060bdd | 429 | (unless hi-lock-mode (hi-lock-mode 1)) |
963b2040 | 430 | (hi-lock-set-pattern regexp face)) |
abb2db1c | 431 | |
108ee42b GM |
432 | ;;;###autoload |
433 | (defalias 'highlight-phrase 'hi-lock-face-phrase-buffer) | |
434 | ;;;###autoload | |
435 | (defun hi-lock-face-phrase-buffer (regexp &optional face) | |
436 | "Set face of each match of phrase REGEXP to FACE. | |
437 | ||
438 | Whitespace in REGEXP converted to arbitrary whitespace and initial | |
439 | lower-case letters made case insensitive." | |
440 | (interactive | |
441 | (list | |
442 | (hi-lock-regexp-okay | |
443 | (hi-lock-process-phrase | |
8677dea3 | 444 | (read-regexp "Phrase to highlight" (car regexp-history)))) |
108ee42b | 445 | (hi-lock-read-face-name))) |
597767da | 446 | (or (facep face) (setq face 'hi-yellow)) |
71060bdd | 447 | (unless hi-lock-mode (hi-lock-mode 1)) |
963b2040 | 448 | (hi-lock-set-pattern regexp face)) |
108ee42b | 449 | |
e8a11b22 | 450 | (declare-function x-popup-menu "menu.c" (position menu)) |
f2d9c15f | 451 | |
abb2db1c GM |
452 | ;;;###autoload |
453 | (defalias 'unhighlight-regexp 'hi-lock-unface-buffer) | |
454 | ;;;###autoload | |
455 | (defun hi-lock-unface-buffer (regexp) | |
108ee42b | 456 | "Remove highlighting of each match to REGEXP set by hi-lock. |
abb2db1c GM |
457 | |
458 | Interactively, prompt for REGEXP. Buffer-local history of inserted | |
459 | regexp's maintained. Will accept only regexps inserted by hi-lock | |
108ee42b | 460 | interactive functions. \(See `hi-lock-interactive-patterns'.\) |
abb2db1c | 461 | \\<minibuffer-local-must-match-map>Use \\[minibuffer-complete] to complete a partially typed regexp. |
cf667bc5 | 462 | \(See info node `Minibuffer History'.\)" |
abb2db1c | 463 | (interactive |
8d96c9a4 CY |
464 | (if (and (display-popup-menus-p) |
465 | (listp last-nonmenu-event) | |
466 | use-dialog-box) | |
cf667bc5 EZ |
467 | (catch 'snafu |
468 | (or | |
469 | (x-popup-menu | |
470 | t | |
471 | (cons | |
472 | `keymap | |
473 | (cons "Select Pattern to Unhighlight" | |
474 | (mapcar (lambda (pattern) | |
475 | (list (car pattern) | |
476 | (format | |
477 | "%s (%s)" (car pattern) | |
478 | (symbol-name | |
479 | (car | |
480 | (cdr (car (cdr (car (cdr pattern)))))))) | |
481 | (cons nil nil) | |
482 | (car pattern))) | |
483 | hi-lock-interactive-patterns)))) | |
484 | ;; If the user clicks outside the menu, meaning that they | |
485 | ;; change their mind, x-popup-menu returns nil, and | |
486 | ;; interactive signals a wrong number of arguments error. | |
487 | ;; To prevent that, we return an empty string, which will | |
488 | ;; effectively disable the rest of the function. | |
489 | (throw 'snafu '("")))) | |
abb2db1c GM |
490 | (let ((history-list (mapcar (lambda (p) (car p)) |
491 | hi-lock-interactive-patterns))) | |
492 | (unless hi-lock-interactive-patterns | |
493 | (error "No highlighting to remove")) | |
494 | (list | |
495 | (completing-read "Regexp to unhighlight: " | |
932c309e | 496 | hi-lock-interactive-patterns nil t |
abb2db1c GM |
497 | (car (car hi-lock-interactive-patterns)) |
498 | (cons 'history-list 1)))))) | |
499 | (let ((keyword (assoc regexp hi-lock-interactive-patterns))) | |
500 | (when keyword | |
501 | (font-lock-remove-keywords nil (list keyword)) | |
502 | (setq hi-lock-interactive-patterns | |
503 | (delq keyword hi-lock-interactive-patterns)) | |
81dc5714 JL |
504 | (remove-overlays |
505 | nil nil 'hi-lock-overlay-regexp (hi-lock-string-serialize regexp)) | |
506 | (when font-lock-fontified (font-lock-fontify-buffer))))) | |
abb2db1c GM |
507 | |
508 | ;;;###autoload | |
509 | (defun hi-lock-write-interactive-patterns () | |
510 | "Write interactively added patterns, if any, into buffer at point. | |
511 | ||
512 | Interactively added patterns are those normally specified using | |
513 | `highlight-regexp' and `highlight-lines-matching-regexp'; they can | |
514 | be found in variable `hi-lock-interactive-patterns'." | |
515 | (interactive) | |
597767da CY |
516 | (if (null hi-lock-interactive-patterns) |
517 | (error "There are no interactive patterns")) | |
518 | (let ((beg (point))) | |
ee44464c | 519 | (mapc |
abb2db1c | 520 | (lambda (pattern) |
90756087 JL |
521 | (insert (format "%s: (%s)\n" |
522 | hi-lock-file-patterns-prefix | |
523 | (prin1-to-string pattern)))) | |
597767da CY |
524 | hi-lock-interactive-patterns) |
525 | (comment-region beg (point))) | |
526 | (when (> (point) hi-lock-file-patterns-range) | |
527 | (warn "Inserted keywords not close enough to top of file"))) | |
abb2db1c GM |
528 | |
529 | ;; Implementation Functions | |
530 | ||
108ee42b GM |
531 | (defun hi-lock-process-phrase (phrase) |
532 | "Convert regexp PHRASE to a regexp that matches phrases. | |
533 | ||
534 | Blanks in PHRASE replaced by regexp that matches arbitrary whitespace | |
535 | and initial lower-case letters made case insensitive." | |
536 | (let ((mod-phrase nil)) | |
537 | (setq mod-phrase | |
538 | (replace-regexp-in-string | |
539 | "\\<[a-z]" (lambda (m) (format "[%s%s]" (upcase m) m)) phrase)) | |
540 | (setq mod-phrase | |
541 | (replace-regexp-in-string | |
542 | "\\s-+" "[ \t\n]+" mod-phrase nil t)))) | |
543 | ||
abb2db1c GM |
544 | (defun hi-lock-regexp-okay (regexp) |
545 | "Return REGEXP if it appears suitable for a font-lock pattern. | |
546 | ||
547 | Otherwise signal an error. A pattern that matches the null string is | |
548 | not suitable." | |
549 | (if (string-match regexp "") | |
550 | (error "Regexp cannot match an empty string") | |
551 | regexp)) | |
552 | ||
553 | (defun hi-lock-read-face-name () | |
554 | "Read face name from minibuffer with completion and history." | |
555 | (intern (completing-read | |
556 | "Highlight using face: " | |
557 | obarray 'facep t | |
ef705f25 | 558 | (cons (car hi-lock-face-defaults) |
abb2db1c GM |
559 | (let ((prefix |
560 | (try-completion | |
ef705f25 JL |
561 | (substring (car hi-lock-face-defaults) 0 1) |
562 | hi-lock-face-defaults))) | |
abb2db1c | 563 | (if (and (stringp prefix) |
ef705f25 | 564 | (not (equal prefix (car hi-lock-face-defaults)))) |
abb2db1c | 565 | (length prefix) 0))) |
ef705f25 JL |
566 | 'face-name-history |
567 | (cdr hi-lock-face-defaults)))) | |
abb2db1c | 568 | |
963b2040 CY |
569 | (defun hi-lock-set-pattern (regexp face) |
570 | "Highlight REGEXP with face FACE." | |
c58059f2 | 571 | (let ((pattern (list regexp (list 0 (list 'quote face) t)))) |
abb2db1c | 572 | (unless (member pattern hi-lock-interactive-patterns) |
963b2040 | 573 | (push pattern hi-lock-interactive-patterns) |
81dc5714 | 574 | (if font-lock-fontified |
c58059f2 DK |
575 | (progn |
576 | (font-lock-add-keywords nil (list pattern) t) | |
577 | (font-lock-fontify-buffer)) | |
81dc5714 JL |
578 | (let* ((serial (hi-lock-string-serialize regexp)) |
579 | (range-min (- (point) (/ hi-lock-highlight-range 2))) | |
580 | (range-max (+ (point) (/ hi-lock-highlight-range 2))) | |
581 | (search-start | |
582 | (max (point-min) | |
583 | (- range-min (max 0 (- range-max (point-max)))))) | |
584 | (search-end | |
585 | (min (point-max) | |
586 | (+ range-max (max 0 (- (point-min) range-min)))))) | |
587 | (save-excursion | |
588 | (goto-char search-start) | |
589 | (while (re-search-forward regexp search-end t) | |
590 | (let ((overlay (make-overlay (match-beginning 0) (match-end 0)))) | |
591 | (overlay-put overlay 'hi-lock-overlay t) | |
592 | (overlay-put overlay 'hi-lock-overlay-regexp serial) | |
593 | (overlay-put overlay 'face face)) | |
594 | (goto-char (match-end 0))))))))) | |
abb2db1c GM |
595 | |
596 | (defun hi-lock-set-file-patterns (patterns) | |
597 | "Replace file patterns list with PATTERNS and refontify." | |
108ee42b GM |
598 | (when (or hi-lock-file-patterns patterns) |
599 | (font-lock-remove-keywords nil hi-lock-file-patterns) | |
600 | (setq hi-lock-file-patterns patterns) | |
90756087 | 601 | (font-lock-add-keywords nil hi-lock-file-patterns t) |
e4d59066 | 602 | (font-lock-fontify-buffer))) |
abb2db1c GM |
603 | |
604 | (defun hi-lock-find-patterns () | |
605 | "Find patterns in current buffer for hi-lock." | |
606 | (interactive) | |
607 | (unless (memq major-mode hi-lock-exclude-modes) | |
608 | (let ((all-patterns nil) | |
609 | (target-regexp (concat "\\<" hi-lock-file-patterns-prefix ":"))) | |
610 | (save-excursion | |
62cec9fe SM |
611 | (save-restriction |
612 | (widen) | |
613 | (goto-char (point-min)) | |
614 | (re-search-forward target-regexp | |
615 | (+ (point) hi-lock-file-patterns-range) t) | |
616 | (beginning-of-line) | |
617 | (while (and (re-search-forward target-regexp (+ (point) 100) t) | |
618 | (not (looking-at "\\s-*end"))) | |
ed6773fa JB |
619 | (condition-case nil |
620 | (setq all-patterns (append (read (current-buffer)) all-patterns)) | |
621 | (error (message "Invalid pattern list expression at %d" | |
963b2040 | 622 | (line-number-at-pos))))))) |
c898bef7 CY |
623 | (when (and all-patterns |
624 | hi-lock-mode | |
625 | (cond | |
626 | ((eq this-command 'hi-lock-find-patterns) t) | |
627 | ((functionp hi-lock-file-patterns-policy) | |
628 | (funcall hi-lock-file-patterns-policy all-patterns)) | |
629 | ((eq hi-lock-file-patterns-policy 'ask) | |
630 | (y-or-n-p "Add patterns from this buffer to hi-lock? ")) | |
631 | (t nil))) | |
632 | (hi-lock-set-file-patterns all-patterns) | |
32226619 | 633 | (if (called-interactively-p 'interactive) |
c898bef7 | 634 | (message "Hi-lock added %d patterns." (length all-patterns))))))) |
abb2db1c GM |
635 | |
636 | (defun hi-lock-font-lock-hook () | |
8b730780 | 637 | "Add hi-lock patterns to font-lock's." |
c58059f2 DK |
638 | (when font-lock-fontified |
639 | (font-lock-add-keywords nil hi-lock-file-patterns t) | |
640 | (font-lock-add-keywords nil hi-lock-interactive-patterns t))) | |
abb2db1c | 641 | |
81dc5714 JL |
642 | (defvar hi-lock-string-serialize-hash |
643 | (make-hash-table :test 'equal) | |
644 | "Hash table used to assign unique numbers to strings.") | |
645 | ||
646 | (defvar hi-lock-string-serialize-serial 1 | |
647 | "Number assigned to last new string in call to `hi-lock-string-serialize'. | |
648 | A string is considered new if it had not previously been used in a call to | |
649 | `hi-lock-string-serialize'.") | |
650 | ||
651 | (defun hi-lock-string-serialize (string) | |
652 | "Return unique serial number for STRING." | |
653 | (interactive) | |
654 | (let ((val (gethash string hi-lock-string-serialize-hash))) | |
655 | (if val val | |
656 | (puthash string | |
657 | (setq hi-lock-string-serialize-serial | |
658 | (1+ hi-lock-string-serialize-serial)) | |
659 | hi-lock-string-serialize-hash) | |
660 | hi-lock-string-serialize-serial))) | |
661 | ||
869d3e17 JB |
662 | (defun hi-lock-unload-function () |
663 | "Unload the Hi-Lock library." | |
664 | (global-hi-lock-mode -1) | |
665 | ;; continue standard unloading | |
666 | nil) | |
667 | ||
abb2db1c GM |
668 | (provide 'hi-lock) |
669 | ||
670 | ;;; hi-lock.el ends here |