Commit | Line | Data |
---|---|---|
853c1ffc | 1 | ;;; hi-lock.el --- minor mode for interactive automatic highlighting -*- lexical-binding: t -*- |
abb2db1c | 2 | |
acaf905b | 3 | ;; Copyright (C) 2000-2012 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 | 54 | ;; |
865fe16f | 55 | ;; Put the following code in your init 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 | 61 | ;; To enable the use of patterns found in files (presumably placed |
865fe16f | 62 | ;; there by hi-lock) include the following in your init file: |
c898bef7 CY |
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 | 137 | |
b85aec93 J |
138 | (defcustom hi-lock-auto-select-face nil |
139 | "Non-nil if highlighting commands should not prompt for face names. | |
140 | When non-nil, each hi-lock command will cycle through faces in | |
853c1ffc | 141 | `hi-lock-face-defaults' without prompting." |
b85aec93 J |
142 | :type 'boolean |
143 | :version "24.4") | |
144 | ||
abb2db1c GM |
145 | (defgroup hi-lock-faces nil |
146 | "Faces for hi-lock." | |
f43eaaef JL |
147 | :group 'hi-lock |
148 | :group 'faces) | |
abb2db1c GM |
149 | |
150 | (defface hi-yellow | |
e0d815a2 | 151 | '((((min-colors 88) (background dark)) |
ea81d57e DN |
152 | (:background "yellow1" :foreground "black")) |
153 | (((background dark)) (:background "yellow" :foreground "black")) | |
154 | (((min-colors 88)) (:background "yellow1")) | |
a0b8c939 | 155 | (t (:background "yellow"))) |
abb2db1c GM |
156 | "Default face for hi-lock mode." |
157 | :group 'hi-lock-faces) | |
158 | ||
159 | (defface hi-pink | |
16cdf141 | 160 | '((((background dark)) (:background "pink" :foreground "black")) |
a0b8c939 | 161 | (t (:background "pink"))) |
abb2db1c GM |
162 | "Face for hi-lock mode." |
163 | :group 'hi-lock-faces) | |
164 | ||
165 | (defface hi-green | |
e0d815a2 | 166 | '((((min-colors 88) (background dark)) |
ea81d57e DN |
167 | (:background "green1" :foreground "black")) |
168 | (((background dark)) (:background "green" :foreground "black")) | |
e0d815a2 | 169 | (((min-colors 88)) (:background "green1")) |
a0b8c939 | 170 | (t (:background "green"))) |
abb2db1c GM |
171 | "Face for hi-lock mode." |
172 | :group 'hi-lock-faces) | |
173 | ||
174 | (defface hi-blue | |
16cdf141 | 175 | '((((background dark)) (:background "light blue" :foreground "black")) |
a0b8c939 | 176 | (t (:background "light blue"))) |
abb2db1c GM |
177 | "Face for hi-lock mode." |
178 | :group 'hi-lock-faces) | |
179 | ||
180 | (defface hi-black-b | |
181 | '((t (:weight bold))) | |
182 | "Face for hi-lock mode." | |
183 | :group 'hi-lock-faces) | |
184 | ||
185 | (defface hi-blue-b | |
ea81d57e DN |
186 | '((((min-colors 88)) (:weight bold :foreground "blue1")) |
187 | (t (:weight bold :foreground "blue"))) | |
abb2db1c GM |
188 | "Face for hi-lock mode." |
189 | :group 'hi-lock-faces) | |
190 | ||
191 | (defface hi-green-b | |
ea81d57e DN |
192 | '((((min-colors 88)) (:weight bold :foreground "green1")) |
193 | (t (:weight bold :foreground "green"))) | |
abb2db1c GM |
194 | "Face for hi-lock mode." |
195 | :group 'hi-lock-faces) | |
196 | ||
197 | (defface hi-red-b | |
ea81d57e DN |
198 | '((((min-colors 88)) (:weight bold :foreground "red1")) |
199 | (t (:weight bold :foreground "red"))) | |
abb2db1c GM |
200 | "Face for hi-lock mode." |
201 | :group 'hi-lock-faces) | |
202 | ||
203 | (defface hi-black-hb | |
c3b27206 | 204 | '((t (:weight bold :height 1.67 :inherit variable-pitch))) |
abb2db1c GM |
205 | "Face for hi-lock mode." |
206 | :group 'hi-lock-faces) | |
207 | ||
2e4ad7e5 | 208 | (defvar-local hi-lock-file-patterns nil |
abb2db1c | 209 | "Patterns found in file for hi-lock. Should not be changed.") |
2e4ad7e5 | 210 | (put 'hi-lock-file-patterns 'permanent-local t) |
abb2db1c | 211 | |
2e4ad7e5 | 212 | (defvar-local hi-lock-interactive-patterns nil |
abb2db1c | 213 | "Patterns provided to hi-lock by user. Should not be changed.") |
2e4ad7e5 | 214 | (put 'hi-lock-interactive-patterns 'permanent-local t) |
abb2db1c | 215 | |
a52c0aa0 SM |
216 | (define-obsolete-variable-alias 'hi-lock-face-history |
217 | 'hi-lock-face-defaults "23.1") | |
ef705f25 JL |
218 | (defvar hi-lock-face-defaults |
219 | '("hi-yellow" "hi-pink" "hi-green" "hi-blue" "hi-black-b" | |
220 | "hi-blue-b" "hi-red-b" "hi-green-b" "hi-black-hb") | |
221 | "Default faces for hi-lock interactive functions.") | |
abb2db1c | 222 | |
ef705f25 JL |
223 | (define-obsolete-variable-alias 'hi-lock-regexp-history |
224 | 'regexp-history | |
225 | "23.1") | |
abb2db1c GM |
226 | |
227 | (defvar hi-lock-file-patterns-prefix "Hi-lock" | |
c898bef7 | 228 | "Search target for finding hi-lock patterns at top of file.") |
abb2db1c | 229 | |
71060bdd | 230 | (defvar hi-lock-archaic-interface-message-used nil |
90756087 | 231 | "True if user alerted that `global-hi-lock-mode' is now the global switch. |
8b730780 | 232 | Earlier versions of hi-lock used `hi-lock-mode' as the global switch; |
90756087 | 233 | the message is issued if it appears that `hi-lock-mode' is used assuming |
71060bdd EZ |
234 | that older functionality. This variable avoids multiple reminders.") |
235 | ||
236 | (defvar hi-lock-archaic-interface-deduce nil | |
90756087 JL |
237 | "If non-nil, sometimes assume that `hi-lock-mode' means `global-hi-lock-mode'. |
238 | Assumption is made if `hi-lock-mode' used in the *scratch* buffer while | |
71060bdd EZ |
239 | a library is being loaded.") |
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 |
06e21633 CY |
286 | "Toggle selective highlighting of patterns (Hi Lock mode). |
287 | With a prefix argument ARG, enable Hi Lock mode if ARG is | |
288 | positive, and disable it otherwise. If called from Lisp, enable | |
289 | the mode if ARG is omitted or nil. | |
290 | ||
a9f6f311 CY |
291 | Hi Lock mode is automatically enabled when you invoke any of the |
292 | highlighting commands listed below, such as \\[highlight-regexp]. | |
293 | To enable Hi Lock mode in all buffers, use `global-hi-lock-mode' | |
294 | or add (global-hi-lock-mode 1) to your init file. | |
295 | ||
296 | In buffers where Font Lock mode is enabled, patterns are | |
297 | highlighted using font lock. In buffers where Font Lock mode is | |
298 | disabled, patterns are applied using overlays; in this case, the | |
299 | highlighting will not be updated as you type. | |
300 | ||
301 | When Hi Lock mode is enabled, a \"Regexp Highlighting\" submenu | |
302 | is added to the \"Edit\" menu. The commands in the submenu, | |
303 | which can be called interactively, are: | |
abb2db1c GM |
304 | |
305 | \\[highlight-regexp] REGEXP FACE | |
306 | Highlight matches of pattern REGEXP in current buffer with FACE. | |
307 | ||
108ee42b GM |
308 | \\[highlight-phrase] PHRASE FACE |
309 | Highlight matches of phrase PHRASE in current buffer with FACE. | |
310 | (PHRASE can be any REGEXP, but spaces will be replaced by matches | |
311 | to whitespace and initial lower-case letters will become case insensitive.) | |
71296446 | 312 | |
abb2db1c GM |
313 | \\[highlight-lines-matching-regexp] REGEXP FACE |
314 | Highlight lines containing matches of REGEXP in current buffer with FACE. | |
315 | ||
316 | \\[unhighlight-regexp] REGEXP | |
317 | Remove highlighting on matches of REGEXP in current buffer. | |
318 | ||
319 | \\[hi-lock-write-interactive-patterns] | |
c898bef7 | 320 | Write active REGEXPs into buffer as comments (if possible). They may |
abb2db1c GM |
321 | be read the next time file is loaded or when the \\[hi-lock-find-patterns] command |
322 | is issued. The inserted regexps are in the form of font lock keywords. | |
ee44464c | 323 | (See `font-lock-keywords'.) They may be edited and re-loaded with \\[hi-lock-find-patterns], |
869d3e17 JB |
324 | any valid `font-lock-keywords' form is acceptable. When a file is |
325 | loaded the patterns are read if `hi-lock-file-patterns-policy' is | |
c898bef7 CY |
326 | 'ask and the user responds y to the prompt, or if |
327 | `hi-lock-file-patterns-policy' is bound to a function and that | |
328 | function returns t. | |
abb2db1c GM |
329 | |
330 | \\[hi-lock-find-patterns] | |
331 | Re-read patterns stored in buffer (in the format produced by \\[hi-lock-write-interactive-patterns]). | |
332 | ||
c898bef7 CY |
333 | When hi-lock is started and if the mode is not excluded or patterns |
334 | rejected, the beginning of the buffer is searched for lines of the | |
335 | form: | |
abb2db1c | 336 | Hi-lock: FOO |
a9f6f311 CY |
337 | |
338 | where FOO is a list of patterns. The patterns must start before | |
339 | position \(number of characters into buffer) | |
340 | `hi-lock-file-patterns-range'. Patterns will be read until | |
341 | Hi-lock: end is found. A mode is excluded if it's in the list | |
342 | `hi-lock-exclude-modes'." | |
963b2040 | 343 | :group 'hi-lock |
90756087 JL |
344 | :lighter (:eval (if (or hi-lock-interactive-patterns |
345 | hi-lock-file-patterns) | |
346 | " Hi" "")) | |
963b2040 CY |
347 | :global nil |
348 | :keymap hi-lock-map | |
71060bdd EZ |
349 | (when (and (equal (buffer-name) "*scratch*") |
350 | load-in-progress | |
32226619 | 351 | (not (called-interactively-p 'interactive)) |
71060bdd EZ |
352 | (not hi-lock-archaic-interface-message-used)) |
353 | (setq hi-lock-archaic-interface-message-used t) | |
354 | (if hi-lock-archaic-interface-deduce | |
355 | (global-hi-lock-mode hi-lock-mode) | |
356 | (warn | |
357 | "Possible archaic use of (hi-lock-mode). | |
358 | Use (global-hi-lock-mode 1) in .emacs to enable hi-lock for all buffers, | |
90756087 | 359 | use (hi-lock-mode 1) for individual buffers. For compatibility with Emacs |
865fe16f | 360 | versions before 22 use the following in your init file: |
71060bdd EZ |
361 | |
362 | (if (functionp 'global-hi-lock-mode) | |
363 | (global-hi-lock-mode 1) | |
364 | (hi-lock-mode 1)) | |
365 | "))) | |
366 | (if hi-lock-mode | |
963b2040 CY |
367 | ;; Turned on. |
368 | (progn | |
369 | (define-key-after menu-bar-edit-menu [hi-lock] | |
370 | (cons "Regexp Highlighting" hi-lock-menu)) | |
371 | (hi-lock-find-patterns) | |
e4d59066 | 372 | (add-hook 'font-lock-mode-hook 'hi-lock-font-lock-hook nil t)) |
abb2db1c | 373 | ;; Turned off. |
e4d59066 CY |
374 | (when (or hi-lock-interactive-patterns |
375 | hi-lock-file-patterns) | |
71060bdd | 376 | (when hi-lock-interactive-patterns |
e4d59066 CY |
377 | (font-lock-remove-keywords nil hi-lock-interactive-patterns) |
378 | (setq hi-lock-interactive-patterns nil)) | |
379 | (when hi-lock-file-patterns | |
380 | (font-lock-remove-keywords nil hi-lock-file-patterns) | |
381 | (setq hi-lock-file-patterns nil)) | |
81dc5714 JL |
382 | (remove-overlays nil nil 'hi-lock-overlay t) |
383 | (when font-lock-fontified (font-lock-fontify-buffer))) | |
963b2040 CY |
384 | (define-key-after menu-bar-edit-menu [hi-lock] nil) |
385 | (remove-hook 'font-lock-mode-hook 'hi-lock-font-lock-hook t))) | |
abb2db1c | 386 | |
963b2040 | 387 | ;;;###autoload |
98007d83 | 388 | (define-globalized-minor-mode global-hi-lock-mode |
71060bdd | 389 | hi-lock-mode turn-on-hi-lock-if-enabled |
9cb4bb45 | 390 | :group 'hi-lock) |
71060bdd | 391 | |
963b2040 | 392 | (defun turn-on-hi-lock-if-enabled () |
71060bdd | 393 | (setq hi-lock-archaic-interface-message-used t) |
963b2040 | 394 | (unless (memq major-mode hi-lock-exclude-modes) |
71060bdd | 395 | (hi-lock-mode 1))) |
abb2db1c GM |
396 | |
397 | ;;;###autoload | |
398 | (defalias 'highlight-lines-matching-regexp 'hi-lock-line-face-buffer) | |
399 | ;;;###autoload | |
400 | (defun hi-lock-line-face-buffer (regexp &optional face) | |
108ee42b | 401 | "Set face of all lines containing a match of REGEXP to FACE. |
a9f6f311 CY |
402 | Interactively, prompt for REGEXP then FACE, using a buffer-local |
403 | history list for REGEXP and a global history list for FACE. | |
abb2db1c | 404 | |
a9f6f311 CY |
405 | If Font Lock mode is enabled in the buffer, it is used to |
406 | highlight REGEXP. If Font Lock mode is disabled, overlays are | |
407 | used for highlighting; in this case, the highlighting will not be | |
408 | updated as you type." | |
abb2db1c GM |
409 | (interactive |
410 | (list | |
8677dea3 JL |
411 | (hi-lock-regexp-okay |
412 | (read-regexp "Regexp to highlight line" (car regexp-history))) | |
abb2db1c | 413 | (hi-lock-read-face-name))) |
597767da | 414 | (or (facep face) (setq face 'hi-yellow)) |
71060bdd | 415 | (unless hi-lock-mode (hi-lock-mode 1)) |
abb2db1c | 416 | (hi-lock-set-pattern |
b18f5523 SM |
417 | ;; The \\(?:...\\) grouping construct ensures that a leading ^, +, * or ? |
418 | ;; or a trailing $ in REGEXP will be interpreted correctly. | |
963b2040 | 419 | (concat "^.*\\(?:" regexp "\\).*$") face)) |
abb2db1c | 420 | |
108ee42b | 421 | |
abb2db1c GM |
422 | ;;;###autoload |
423 | (defalias 'highlight-regexp 'hi-lock-face-buffer) | |
424 | ;;;###autoload | |
425 | (defun hi-lock-face-buffer (regexp &optional face) | |
108ee42b | 426 | "Set face of each match of REGEXP to FACE. |
a9f6f311 CY |
427 | Interactively, prompt for REGEXP then FACE, using a buffer-local |
428 | history list for REGEXP and a global history list for FACE. | |
abb2db1c | 429 | |
a9f6f311 CY |
430 | If Font Lock mode is enabled in the buffer, it is used to |
431 | highlight REGEXP. If Font Lock mode is disabled, overlays are | |
432 | used for highlighting; in this case, the highlighting will not be | |
433 | updated as you type." | |
abb2db1c GM |
434 | (interactive |
435 | (list | |
8677dea3 JL |
436 | (hi-lock-regexp-okay |
437 | (read-regexp "Regexp to highlight" (car regexp-history))) | |
abb2db1c | 438 | (hi-lock-read-face-name))) |
597767da | 439 | (or (facep face) (setq face 'hi-yellow)) |
71060bdd | 440 | (unless hi-lock-mode (hi-lock-mode 1)) |
963b2040 | 441 | (hi-lock-set-pattern regexp face)) |
abb2db1c | 442 | |
108ee42b GM |
443 | ;;;###autoload |
444 | (defalias 'highlight-phrase 'hi-lock-face-phrase-buffer) | |
445 | ;;;###autoload | |
446 | (defun hi-lock-face-phrase-buffer (regexp &optional face) | |
447 | "Set face of each match of phrase REGEXP to FACE. | |
82ed3ab4 GM |
448 | If called interactively, replaces whitespace in REGEXP with |
449 | arbitrary whitespace and makes initial lower-case letters case-insensitive. | |
a9f6f311 CY |
450 | |
451 | If Font Lock mode is enabled in the buffer, it is used to | |
452 | highlight REGEXP. If Font Lock mode is disabled, overlays are | |
453 | used for highlighting; in this case, the highlighting will not be | |
454 | updated as you type." | |
108ee42b GM |
455 | (interactive |
456 | (list | |
457 | (hi-lock-regexp-okay | |
458 | (hi-lock-process-phrase | |
8677dea3 | 459 | (read-regexp "Phrase to highlight" (car regexp-history)))) |
108ee42b | 460 | (hi-lock-read-face-name))) |
597767da | 461 | (or (facep face) (setq face 'hi-yellow)) |
71060bdd | 462 | (unless hi-lock-mode (hi-lock-mode 1)) |
963b2040 | 463 | (hi-lock-set-pattern regexp face)) |
108ee42b | 464 | |
c868b919 J |
465 | (defun hi-lock-keyword->face (keyword) |
466 | (cadr (cadr (cadr keyword)))) ; Keyword looks like (REGEXP (0 'FACE) ...). | |
467 | ||
e8a11b22 | 468 | (declare-function x-popup-menu "menu.c" (position menu)) |
f2d9c15f | 469 | |
b85aec93 J |
470 | (defun hi-lock--regexps-at-point () |
471 | (let ((regexps '())) | |
472 | ;; When using overlays, there is no ambiguity on the best | |
473 | ;; choice of regexp. | |
853c1ffc SM |
474 | (let ((regexp (get-char-property (point) 'hi-lock-overlay-regexp))) |
475 | (when regexp (push regexp regexps))) | |
c868b919 J |
476 | ;; With font-locking on, check if the cursor is on a highlighted text. |
477 | (and (memq (face-at-point) | |
478 | (mapcar #'hi-lock-keyword->face hi-lock-interactive-patterns)) | |
479 | (let* ((hi-text | |
480 | (buffer-substring-no-properties | |
481 | (previous-single-property-change (point) 'face) | |
482 | (next-single-property-change (point) 'face)))) | |
483 | ;; Compute hi-lock patterns that match the | |
484 | ;; highlighted text at point. Use this later in | |
485 | ;; during completing-read. | |
486 | (dolist (hi-lock-pattern hi-lock-interactive-patterns) | |
487 | (let ((regexp (car hi-lock-pattern))) | |
488 | (if (string-match regexp hi-text) | |
489 | (push regexp regexps)))))) | |
2e4ad7e5 | 490 | regexps)) |
b85aec93 | 491 | |
c868b919 J |
492 | (defvar-local hi-lock--unused-faces nil |
493 | "List of faces that is not used and is available for highlighting new text. | |
494 | Face names from this list come from `hi-lock-face-defaults'.") | |
853c1ffc | 495 | |
abb2db1c GM |
496 | ;;;###autoload |
497 | (defalias 'unhighlight-regexp 'hi-lock-unface-buffer) | |
498 | ;;;###autoload | |
499 | (defun hi-lock-unface-buffer (regexp) | |
108ee42b | 500 | "Remove highlighting of each match to REGEXP set by hi-lock. |
a9f6f311 | 501 | Interactively, prompt for REGEXP, accepting only regexps |
b85aec93 J |
502 | previously inserted by hi-lock interactive functions. |
503 | If REGEXP is t (or if \\[universal-argument] was specified interactively), | |
504 | then remove all hi-lock highlighting." | |
abb2db1c | 505 | (interactive |
b85aec93 J |
506 | (cond |
507 | (current-prefix-arg (list t)) | |
508 | ((and (display-popup-menus-p) | |
509 | (listp last-nonmenu-event) | |
510 | use-dialog-box) | |
511 | (catch 'snafu | |
512 | (or | |
513 | (x-popup-menu | |
514 | t | |
515 | (cons | |
516 | `keymap | |
517 | (cons "Select Pattern to Unhighlight" | |
518 | (mapcar (lambda (pattern) | |
519 | (list (car pattern) | |
520 | (format | |
521 | "%s (%s)" (car pattern) | |
c868b919 | 522 | (hi-lock-keyword->face pattern)) |
b85aec93 J |
523 | (cons nil nil) |
524 | (car pattern))) | |
525 | hi-lock-interactive-patterns)))) | |
526 | ;; If the user clicks outside the menu, meaning that they | |
527 | ;; change their mind, x-popup-menu returns nil, and | |
528 | ;; interactive signals a wrong number of arguments error. | |
529 | ;; To prevent that, we return an empty string, which will | |
530 | ;; effectively disable the rest of the function. | |
531 | (throw 'snafu '(""))))) | |
532 | (t | |
533 | ;; Un-highlighting triggered via keyboard action. | |
534 | (unless hi-lock-interactive-patterns | |
535 | (error "No highlighting to remove")) | |
536 | ;; Infer the regexp to un-highlight based on cursor position. | |
2e4ad7e5 SM |
537 | (let* ((defaults (or (hi-lock--regexps-at-point) |
538 | (mapcar #'car hi-lock-interactive-patterns)))) | |
abb2db1c | 539 | (list |
b85aec93 J |
540 | (completing-read (if (null defaults) |
541 | "Regexp to unhighlight: " | |
542 | (format "Regexp to unhighlight (default %s): " | |
543 | (car defaults))) | |
544 | hi-lock-interactive-patterns | |
545 | nil t nil nil defaults)))))) | |
546 | (dolist (keyword (if (eq regexp t) hi-lock-interactive-patterns | |
547 | (list (assoc regexp hi-lock-interactive-patterns)))) | |
abb2db1c | 548 | (when keyword |
c868b919 | 549 | (let ((face (hi-lock-keyword->face keyword))) |
853c1ffc | 550 | ;; Make `face' the next one to use by default. |
c868b919 | 551 | (add-to-list 'hi-lock--unused-faces (face-name face))) |
abb2db1c GM |
552 | (font-lock-remove-keywords nil (list keyword)) |
553 | (setq hi-lock-interactive-patterns | |
554 | (delq keyword hi-lock-interactive-patterns)) | |
81dc5714 | 555 | (remove-overlays |
c868b919 | 556 | nil nil 'hi-lock-overlay-regexp (hi-lock--hashcons (car keyword))) |
81dc5714 | 557 | (when font-lock-fontified (font-lock-fontify-buffer))))) |
abb2db1c GM |
558 | |
559 | ;;;###autoload | |
560 | (defun hi-lock-write-interactive-patterns () | |
561 | "Write interactively added patterns, if any, into buffer at point. | |
562 | ||
563 | Interactively added patterns are those normally specified using | |
564 | `highlight-regexp' and `highlight-lines-matching-regexp'; they can | |
565 | be found in variable `hi-lock-interactive-patterns'." | |
566 | (interactive) | |
597767da CY |
567 | (if (null hi-lock-interactive-patterns) |
568 | (error "There are no interactive patterns")) | |
569 | (let ((beg (point))) | |
ee44464c | 570 | (mapc |
abb2db1c | 571 | (lambda (pattern) |
90756087 JL |
572 | (insert (format "%s: (%s)\n" |
573 | hi-lock-file-patterns-prefix | |
574 | (prin1-to-string pattern)))) | |
597767da CY |
575 | hi-lock-interactive-patterns) |
576 | (comment-region beg (point))) | |
577 | (when (> (point) hi-lock-file-patterns-range) | |
578 | (warn "Inserted keywords not close enough to top of file"))) | |
abb2db1c GM |
579 | |
580 | ;; Implementation Functions | |
581 | ||
108ee42b GM |
582 | (defun hi-lock-process-phrase (phrase) |
583 | "Convert regexp PHRASE to a regexp that matches phrases. | |
584 | ||
585 | Blanks in PHRASE replaced by regexp that matches arbitrary whitespace | |
586 | and initial lower-case letters made case insensitive." | |
587 | (let ((mod-phrase nil)) | |
82ed3ab4 | 588 | ;; FIXME fragile; better to just bind case-fold-search? (Bug#7161) |
108ee42b GM |
589 | (setq mod-phrase |
590 | (replace-regexp-in-string | |
1595ecfa GM |
591 | "\\(^\\|\\s-\\)\\([a-z]\\)" |
592 | (lambda (m) (format "%s[%s%s]" | |
593 | (match-string 1 m) | |
594 | (upcase (match-string 2 m)) | |
595 | (match-string 2 m))) phrase)) | |
82ed3ab4 | 596 | ;; FIXME fragile; better to use search-spaces-regexp? |
108ee42b GM |
597 | (setq mod-phrase |
598 | (replace-regexp-in-string | |
599 | "\\s-+" "[ \t\n]+" mod-phrase nil t)))) | |
600 | ||
abb2db1c GM |
601 | (defun hi-lock-regexp-okay (regexp) |
602 | "Return REGEXP if it appears suitable for a font-lock pattern. | |
603 | ||
604 | Otherwise signal an error. A pattern that matches the null string is | |
605 | not suitable." | |
606 | (if (string-match regexp "") | |
607 | (error "Regexp cannot match an empty string") | |
608 | regexp)) | |
609 | ||
610 | (defun hi-lock-read-face-name () | |
853c1ffc | 611 | "Return face for interactive highlighting. |
b85aec93 J |
612 | When `hi-lock-auto-select-face' is non-nil, just return the next face. |
613 | Otherwise, read face name from minibuffer with completion and history." | |
c868b919 J |
614 | (unless hi-lock-interactive-patterns |
615 | (setq hi-lock--unused-faces hi-lock-face-defaults)) | |
616 | (let* ((last-used-face | |
617 | (when hi-lock-interactive-patterns | |
618 | (face-name (hi-lock-keyword->face | |
619 | (car hi-lock-interactive-patterns))))) | |
620 | (defaults (append hi-lock--unused-faces | |
621 | (cdr (member last-used-face hi-lock-face-defaults)) | |
622 | hi-lock-face-defaults)) | |
623 | face) | |
853c1ffc | 624 | (if (and hi-lock-auto-select-face (not current-prefix-arg)) |
c868b919 J |
625 | (setq face (or (pop hi-lock--unused-faces) (car defaults))) |
626 | (setq face (completing-read | |
627 | (format "Highlight using face (default %s): " | |
628 | (car defaults)) | |
629 | obarray 'facep t nil 'face-name-history defaults)) | |
630 | ;; Update list of un-used faces. | |
631 | (setq hi-lock--unused-faces (remove face hi-lock--unused-faces)) | |
632 | ;; Grow the list of defaults. | |
633 | (add-to-list 'hi-lock-face-defaults face t)) | |
634 | (intern face))) | |
abb2db1c | 635 | |
963b2040 CY |
636 | (defun hi-lock-set-pattern (regexp face) |
637 | "Highlight REGEXP with face FACE." | |
853c1ffc SM |
638 | ;; Hashcons the regexp, so it can be passed to remove-overlays later. |
639 | (setq regexp (hi-lock--hashcons regexp)) | |
c58059f2 | 640 | (let ((pattern (list regexp (list 0 (list 'quote face) t)))) |
c868b919 J |
641 | ;; Refuse to highlight a text that is already highlighted. |
642 | (unless (assoc regexp hi-lock-interactive-patterns) | |
963b2040 | 643 | (push pattern hi-lock-interactive-patterns) |
a9f6f311 | 644 | (if font-lock-mode |
c58059f2 DK |
645 | (progn |
646 | (font-lock-add-keywords nil (list pattern) t) | |
647 | (font-lock-fontify-buffer)) | |
853c1ffc | 648 | (let* ((range-min (- (point) (/ hi-lock-highlight-range 2))) |
81dc5714 JL |
649 | (range-max (+ (point) (/ hi-lock-highlight-range 2))) |
650 | (search-start | |
651 | (max (point-min) | |
652 | (- range-min (max 0 (- range-max (point-max)))))) | |
653 | (search-end | |
654 | (min (point-max) | |
655 | (+ range-max (max 0 (- (point-min) range-min)))))) | |
656 | (save-excursion | |
657 | (goto-char search-start) | |
658 | (while (re-search-forward regexp search-end t) | |
659 | (let ((overlay (make-overlay (match-beginning 0) (match-end 0)))) | |
660 | (overlay-put overlay 'hi-lock-overlay t) | |
853c1ffc | 661 | (overlay-put overlay 'hi-lock-overlay-regexp regexp) |
81dc5714 JL |
662 | (overlay-put overlay 'face face)) |
663 | (goto-char (match-end 0))))))))) | |
abb2db1c GM |
664 | |
665 | (defun hi-lock-set-file-patterns (patterns) | |
666 | "Replace file patterns list with PATTERNS and refontify." | |
108ee42b GM |
667 | (when (or hi-lock-file-patterns patterns) |
668 | (font-lock-remove-keywords nil hi-lock-file-patterns) | |
669 | (setq hi-lock-file-patterns patterns) | |
90756087 | 670 | (font-lock-add-keywords nil hi-lock-file-patterns t) |
e4d59066 | 671 | (font-lock-fontify-buffer))) |
abb2db1c GM |
672 | |
673 | (defun hi-lock-find-patterns () | |
674 | "Find patterns in current buffer for hi-lock." | |
675 | (interactive) | |
676 | (unless (memq major-mode hi-lock-exclude-modes) | |
677 | (let ((all-patterns nil) | |
678 | (target-regexp (concat "\\<" hi-lock-file-patterns-prefix ":"))) | |
679 | (save-excursion | |
62cec9fe SM |
680 | (save-restriction |
681 | (widen) | |
682 | (goto-char (point-min)) | |
683 | (re-search-forward target-regexp | |
684 | (+ (point) hi-lock-file-patterns-range) t) | |
685 | (beginning-of-line) | |
686 | (while (and (re-search-forward target-regexp (+ (point) 100) t) | |
687 | (not (looking-at "\\s-*end"))) | |
ed6773fa JB |
688 | (condition-case nil |
689 | (setq all-patterns (append (read (current-buffer)) all-patterns)) | |
690 | (error (message "Invalid pattern list expression at %d" | |
963b2040 | 691 | (line-number-at-pos))))))) |
c898bef7 CY |
692 | (when (and all-patterns |
693 | hi-lock-mode | |
694 | (cond | |
695 | ((eq this-command 'hi-lock-find-patterns) t) | |
696 | ((functionp hi-lock-file-patterns-policy) | |
697 | (funcall hi-lock-file-patterns-policy all-patterns)) | |
698 | ((eq hi-lock-file-patterns-policy 'ask) | |
699 | (y-or-n-p "Add patterns from this buffer to hi-lock? ")) | |
700 | (t nil))) | |
701 | (hi-lock-set-file-patterns all-patterns) | |
32226619 | 702 | (if (called-interactively-p 'interactive) |
c898bef7 | 703 | (message "Hi-lock added %d patterns." (length all-patterns))))))) |
abb2db1c GM |
704 | |
705 | (defun hi-lock-font-lock-hook () | |
8b730780 | 706 | "Add hi-lock patterns to font-lock's." |
c58059f2 DK |
707 | (when font-lock-fontified |
708 | (font-lock-add-keywords nil hi-lock-file-patterns t) | |
709 | (font-lock-add-keywords nil hi-lock-interactive-patterns t))) | |
abb2db1c | 710 | |
853c1ffc SM |
711 | (defvar hi-lock--hashcons-hash |
712 | (make-hash-table :test 'equal :weakness t) | |
713 | "Hash table used to hash cons regexps.") | |
81dc5714 | 714 | |
853c1ffc SM |
715 | (defun hi-lock--hashcons (string) |
716 | "Return unique object equal to STRING." | |
717 | (or (gethash string hi-lock--hashcons-hash) | |
718 | (puthash string string hi-lock--hashcons-hash))) | |
81dc5714 | 719 | |
869d3e17 JB |
720 | (defun hi-lock-unload-function () |
721 | "Unload the Hi-Lock library." | |
722 | (global-hi-lock-mode -1) | |
723 | ;; continue standard unloading | |
724 | nil) | |
725 | ||
abb2db1c GM |
726 | (provide 'hi-lock) |
727 | ||
728 | ;;; hi-lock.el ends here |