Commit | Line | Data |
---|---|---|
e8af40ee | 1 | ;;; hi-lock.el --- minor mode for interactive automatic highlighting |
abb2db1c | 2 | |
0d30b337 | 3 | ;; Copyright (C) 2000, 2001, 2002, 2003, 2004, |
409cc4a3 | 4 | ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
abb2db1c | 5 | |
c898bef7 | 6 | ;; Author: David M. Koppelman, koppel@ece.lsu.edu |
abb2db1c GM |
7 | ;; Keywords: faces, minor-mode, matching, display |
8 | ||
9 | ;; This file is part of GNU Emacs. | |
10 | ||
eb3fa2cf | 11 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
abb2db1c | 12 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
13 | ;; the Free Software Foundation, either version 3 of the License, or |
14 | ;; (at your option) any later version. | |
abb2db1c GM |
15 | |
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
eb3fa2cf | 22 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
abb2db1c | 23 | |
e8af40ee | 24 | ;;; Commentary: |
71296446 | 25 | ;; |
abb2db1c GM |
26 | ;; With the hi-lock commands text matching interactively entered |
27 | ;; regexp's can be highlighted. For example, `M-x highlight-regexp | |
28 | ;; RET clearly RET RET' will highlight all occurrences of `clearly' | |
29 | ;; using a yellow background face. New occurrences of `clearly' will | |
30 | ;; be highlighted as they are typed. `M-x unhighlight-regexp RET' | |
31 | ;; will remove the highlighting. Any existing face can be used for | |
32 | ;; highlighting and a set of appropriate faces is provided. The | |
33 | ;; regexps can be written into the current buffer in a form that will | |
c898bef7 CY |
34 | ;; be recognized the next time the corresponding file is read (when |
35 | ;; file patterns is turned on). | |
abb2db1c GM |
36 | ;; |
37 | ;; Applications: | |
38 | ;; | |
39 | ;; In program source code highlight a variable to quickly see all | |
40 | ;; places it is modified or referenced: | |
41 | ;; M-x highlight-regexp ground_contact_switches_closed RET RET | |
42 | ;; | |
43 | ;; In a shell or other buffer that is showing lots of program | |
44 | ;; output, highlight the parts of the output you're interested in: | |
45 | ;; M-x highlight-regexp Total execution time [0-9]+ RET hi-blue-b RET | |
46 | ;; | |
47 | ;; In buffers displaying tables, highlight the lines you're interested in: | |
48 | ;; M-x highlight-lines-matching-regexp January 2000 RET hi-black-b RET | |
49 | ;; | |
50 | ;; When writing text, highlight personal cliches. This can be | |
51 | ;; amusing. | |
108ee42b | 52 | ;; M-x highlight-phrase as can be seen RET RET |
abb2db1c | 53 | ;; |
108ee42b | 54 | ;; Setup: |
abb2db1c GM |
55 | ;; |
56 | ;; Put the following code in your .emacs file. This turns on | |
108ee42b | 57 | ;; hi-lock mode and adds a "Regexp Highlighting" entry |
abb2db1c GM |
58 | ;; to the edit menu. |
59 | ;; | |
71060bdd | 60 | ;; (global-hi-lock-mode 1) |
71296446 | 61 | ;; |
c898bef7 CY |
62 | ;; To enable the use of patterns found in files (presumably placed |
63 | ;; there by hi-lock) include the following in your .emacs file: | |
64 | ;; | |
65 | ;; (setq hi-lock-file-patterns-policy 'ask) | |
66 | ;; | |
67 | ;; If you get tired of being asked each time a file is loaded replace | |
06b1a5ef | 68 | ;; `ask' with a function that returns t if patterns should be read. |
c898bef7 | 69 | ;; |
abb2db1c GM |
70 | ;; You might also want to bind the hi-lock commands to more |
71 | ;; finger-friendly sequences: | |
72 | ||
73 | ;; (define-key hi-lock-map "\C-z\C-h" 'highlight-lines-matching-regexp) | |
74 | ;; (define-key hi-lock-map "\C-zi" 'hi-lock-find-patterns) | |
75 | ;; (define-key hi-lock-map "\C-zh" 'highlight-regexp) | |
108ee42b | 76 | ;; (define-key hi-lock-map "\C-zp" 'highlight-phrase) |
abb2db1c GM |
77 | ;; (define-key hi-lock-map "\C-zr" 'unhighlight-regexp) |
78 | ;; (define-key hi-lock-map "\C-zb" 'hi-lock-write-interactive-patterns)) | |
79 | ||
80 | ;; See the documentation for hi-lock-mode `C-h f hi-lock-mode' for | |
81 | ;; additional instructions. | |
82 | ||
83 | ;; Sample file patterns: | |
84 | ||
85 | ; Hi-lock: (("^;;; .*" (0 (quote hi-black-hb) t))) | |
86 | ; Hi-lock: ( ("make-variable-buffer-\\(local\\)" (0 font-lock-keyword-face)(1 'italic append))))) | |
87 | ; Hi-lock: end | |
88 | ||
89 | ;;; Code: | |
90 | ||
588aca27 | 91 | (eval-and-compile |
abb2db1c GM |
92 | (require 'font-lock)) |
93 | ||
f43eaaef | 94 | (defgroup hi-lock nil |
abb2db1c | 95 | "Interactively add and remove font-lock patterns for highlighting text." |
f43eaaef JL |
96 | :link '(custom-manual "(emacs)Highlight Interactively") |
97 | :group 'font-lock) | |
abb2db1c | 98 | |
abb2db1c GM |
99 | (defcustom hi-lock-file-patterns-range 10000 |
100 | "Limit of search in a buffer for hi-lock patterns. | |
8b730780 | 101 | When a file is visited and hi-lock mode is on, patterns starting |
abb2db1c GM |
102 | up to this limit are added to font-lock's patterns. See documentation |
103 | of functions `hi-lock-mode' and `hi-lock-find-patterns'." | |
104 | :type 'integer | |
f43eaaef | 105 | :group 'hi-lock) |
abb2db1c | 106 | |
81dc5714 JL |
107 | (defcustom hi-lock-highlight-range 200000 |
108 | "Size of area highlighted by hi-lock when font-lock not active. | |
109 | Font-lock is not active in buffers that do their own highlighting, | |
110 | such as the buffer created by `list-colors-display'. In those buffers | |
111 | hi-lock patterns will only be applied over a range of | |
112 | `hi-lock-highlight-range' characters. If font-lock is active then | |
113 | highlighting will be applied throughout the buffer." | |
114 | :type 'integer | |
115 | :group 'hi-lock) | |
116 | ||
abb2db1c GM |
117 | (defcustom hi-lock-exclude-modes |
118 | '(rmail-mode mime/viewer-mode gnus-article-mode) | |
119 | "List of major modes in which hi-lock will not run. | |
120 | For security reasons since font lock patterns can specify function | |
121 | calls." | |
f5bd8092 | 122 | :type '(repeat symbol) |
f43eaaef | 123 | :group 'hi-lock) |
abb2db1c | 124 | |
cf995676 | 125 | (defcustom hi-lock-file-patterns-policy 'ask |
c898bef7 | 126 | "Specify when hi-lock should use patterns found in file. |
06b1a5ef | 127 | If `ask', prompt when patterns found in buffer; if bound to a function, |
c898bef7 | 128 | use patterns when function returns t (function is called with patterns |
06b1a5ef | 129 | as first argument); if nil or `never' or anything else, don't use file |
176eb1f1 GM |
130 | patterns." |
131 | :type '(choice (const :tag "Do not use file patterns" never) | |
132 | (const :tag "Ask about file patterns" ask) | |
133 | (function :tag "Function to check file patterns")) | |
134 | :group 'hi-lock | |
135 | :version "22.1") | |
136 | ||
137 | ;; It can have a function value. | |
138 | (put 'hi-lock-file-patterns-policy 'risky-local-variable t) | |
abb2db1c GM |
139 | |
140 | (defgroup hi-lock-faces nil | |
141 | "Faces for hi-lock." | |
f43eaaef JL |
142 | :group 'hi-lock |
143 | :group 'faces) | |
abb2db1c GM |
144 | |
145 | (defface hi-yellow | |
e0d815a2 | 146 | '((((min-colors 88) (background dark)) |
ea81d57e DN |
147 | (:background "yellow1" :foreground "black")) |
148 | (((background dark)) (:background "yellow" :foreground "black")) | |
149 | (((min-colors 88)) (:background "yellow1")) | |
a0b8c939 | 150 | (t (:background "yellow"))) |
abb2db1c GM |
151 | "Default face for hi-lock mode." |
152 | :group 'hi-lock-faces) | |
153 | ||
154 | (defface hi-pink | |
16cdf141 | 155 | '((((background dark)) (:background "pink" :foreground "black")) |
a0b8c939 | 156 | (t (:background "pink"))) |
abb2db1c GM |
157 | "Face for hi-lock mode." |
158 | :group 'hi-lock-faces) | |
159 | ||
160 | (defface hi-green | |
e0d815a2 | 161 | '((((min-colors 88) (background dark)) |
ea81d57e DN |
162 | (:background "green1" :foreground "black")) |
163 | (((background dark)) (:background "green" :foreground "black")) | |
e0d815a2 | 164 | (((min-colors 88)) (:background "green1")) |
a0b8c939 | 165 | (t (:background "green"))) |
abb2db1c GM |
166 | "Face for hi-lock mode." |
167 | :group 'hi-lock-faces) | |
168 | ||
169 | (defface hi-blue | |
16cdf141 | 170 | '((((background dark)) (:background "light blue" :foreground "black")) |
a0b8c939 | 171 | (t (:background "light blue"))) |
abb2db1c GM |
172 | "Face for hi-lock mode." |
173 | :group 'hi-lock-faces) | |
174 | ||
175 | (defface hi-black-b | |
176 | '((t (:weight bold))) | |
177 | "Face for hi-lock mode." | |
178 | :group 'hi-lock-faces) | |
179 | ||
180 | (defface hi-blue-b | |
ea81d57e DN |
181 | '((((min-colors 88)) (:weight bold :foreground "blue1")) |
182 | (t (:weight bold :foreground "blue"))) | |
abb2db1c GM |
183 | "Face for hi-lock mode." |
184 | :group 'hi-lock-faces) | |
185 | ||
186 | (defface hi-green-b | |
ea81d57e DN |
187 | '((((min-colors 88)) (:weight bold :foreground "green1")) |
188 | (t (:weight bold :foreground "green"))) | |
abb2db1c GM |
189 | "Face for hi-lock mode." |
190 | :group 'hi-lock-faces) | |
191 | ||
192 | (defface hi-red-b | |
ea81d57e DN |
193 | '((((min-colors 88)) (:weight bold :foreground "red1")) |
194 | (t (:weight bold :foreground "red"))) | |
abb2db1c GM |
195 | "Face for hi-lock mode." |
196 | :group 'hi-lock-faces) | |
197 | ||
198 | (defface hi-black-hb | |
c3b27206 | 199 | '((t (:weight bold :height 1.67 :inherit variable-pitch))) |
abb2db1c GM |
200 | "Face for hi-lock mode." |
201 | :group 'hi-lock-faces) | |
202 | ||
203 | (defvar hi-lock-file-patterns nil | |
204 | "Patterns found in file for hi-lock. Should not be changed.") | |
205 | ||
206 | (defvar hi-lock-interactive-patterns nil | |
207 | "Patterns provided to hi-lock by user. Should not be changed.") | |
208 | ||
ef705f25 JL |
209 | (defvar hi-lock-face-defaults |
210 | '("hi-yellow" "hi-pink" "hi-green" "hi-blue" "hi-black-b" | |
211 | "hi-blue-b" "hi-red-b" "hi-green-b" "hi-black-hb") | |
212 | "Default faces for hi-lock interactive functions.") | |
abb2db1c | 213 | |
ef705f25 | 214 | ;(dolist (f hi-lock-face-defaults) (unless (facep f) (error "%s not a face" f))) |
abb2db1c | 215 | |
ef705f25 JL |
216 | (define-obsolete-variable-alias 'hi-lock-face-history |
217 | 'hi-lock-face-defaults | |
218 | "23.1") | |
219 | ||
220 | (define-obsolete-variable-alias 'hi-lock-regexp-history | |
221 | 'regexp-history | |
222 | "23.1") | |
abb2db1c GM |
223 | |
224 | (defvar hi-lock-file-patterns-prefix "Hi-lock" | |
c898bef7 | 225 | "Search target for finding hi-lock patterns at top of file.") |
abb2db1c | 226 | |
71060bdd | 227 | (defvar hi-lock-archaic-interface-message-used nil |
90756087 | 228 | "True if user alerted that `global-hi-lock-mode' is now the global switch. |
8b730780 | 229 | Earlier versions of hi-lock used `hi-lock-mode' as the global switch; |
90756087 | 230 | the message is issued if it appears that `hi-lock-mode' is used assuming |
71060bdd EZ |
231 | that older functionality. This variable avoids multiple reminders.") |
232 | ||
233 | (defvar hi-lock-archaic-interface-deduce nil | |
90756087 JL |
234 | "If non-nil, sometimes assume that `hi-lock-mode' means `global-hi-lock-mode'. |
235 | Assumption is made if `hi-lock-mode' used in the *scratch* buffer while | |
71060bdd EZ |
236 | a library is being loaded.") |
237 | ||
abb2db1c GM |
238 | (make-variable-buffer-local 'hi-lock-interactive-patterns) |
239 | (put 'hi-lock-interactive-patterns 'permanent-local t) | |
abb2db1c GM |
240 | (make-variable-buffer-local 'hi-lock-file-patterns) |
241 | (put 'hi-lock-file-patterns 'permanent-local t) | |
242 | ||
243 | (defvar hi-lock-menu (make-sparse-keymap "Hi Lock") | |
244 | "Menu for hi-lock mode.") | |
245 | ||
246 | (define-key-after hi-lock-menu [highlight-regexp] | |
247 | '(menu-item "Highlight Regexp..." highlight-regexp | |
248 | :help "Highlight text matching PATTERN (a regexp).")) | |
249 | ||
108ee42b GM |
250 | (define-key-after hi-lock-menu [highlight-phrase] |
251 | '(menu-item "Highlight Phrase..." highlight-phrase | |
252 | :help "Highlight text matching PATTERN (a regexp processed to match phrases).")) | |
253 | ||
abb2db1c GM |
254 | (define-key-after hi-lock-menu [highlight-lines-matching-regexp] |
255 | '(menu-item "Highlight Lines..." highlight-lines-matching-regexp | |
256 | :help "Highlight lines containing match of PATTERN (a regexp)..")) | |
257 | ||
258 | (define-key-after hi-lock-menu [unhighlight-regexp] | |
259 | '(menu-item "Remove Highlighting..." unhighlight-regexp | |
260 | :help "Remove previously entered highlighting pattern." | |
261 | :enable hi-lock-interactive-patterns)) | |
262 | ||
263 | (define-key-after hi-lock-menu [hi-lock-write-interactive-patterns] | |
264 | '(menu-item "Patterns to Buffer" hi-lock-write-interactive-patterns | |
265 | :help "Insert interactively added REGEXPs into buffer at point." | |
266 | :enable hi-lock-interactive-patterns)) | |
267 | ||
268 | (define-key-after hi-lock-menu [hi-lock-find-patterns] | |
269 | '(menu-item "Patterns from Buffer" hi-lock-find-patterns | |
270 | :help "Use patterns (if any) near top of buffer.")) | |
271 | ||
272 | (defvar hi-lock-map (make-sparse-keymap "Hi Lock") | |
273 | "Key map for hi-lock.") | |
274 | ||
275 | (define-key hi-lock-map "\C-xwi" 'hi-lock-find-patterns) | |
276 | (define-key hi-lock-map "\C-xwl" 'highlight-lines-matching-regexp) | |
108ee42b | 277 | (define-key hi-lock-map "\C-xwp" 'highlight-phrase) |
abb2db1c GM |
278 | (define-key hi-lock-map "\C-xwh" 'highlight-regexp) |
279 | (define-key hi-lock-map "\C-xwr" 'unhighlight-regexp) | |
280 | (define-key hi-lock-map "\C-xwb" 'hi-lock-write-interactive-patterns) | |
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 | |
341 | (not (interactive-p)) | |
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 | |
f2d9c15f GM |
450 | (declare-function x-popup-menu "xmenu.c" (position menu)) |
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 |
a2ab90da | 464 | (if (and (display-popup-menus-p) (not last-nonmenu-event)) |
cf667bc5 EZ |
465 | (catch 'snafu |
466 | (or | |
467 | (x-popup-menu | |
468 | t | |
469 | (cons | |
470 | `keymap | |
471 | (cons "Select Pattern to Unhighlight" | |
472 | (mapcar (lambda (pattern) | |
473 | (list (car pattern) | |
474 | (format | |
475 | "%s (%s)" (car pattern) | |
476 | (symbol-name | |
477 | (car | |
478 | (cdr (car (cdr (car (cdr pattern)))))))) | |
479 | (cons nil nil) | |
480 | (car pattern))) | |
481 | hi-lock-interactive-patterns)))) | |
482 | ;; If the user clicks outside the menu, meaning that they | |
483 | ;; change their mind, x-popup-menu returns nil, and | |
484 | ;; interactive signals a wrong number of arguments error. | |
485 | ;; To prevent that, we return an empty string, which will | |
486 | ;; effectively disable the rest of the function. | |
487 | (throw 'snafu '("")))) | |
abb2db1c GM |
488 | (let ((history-list (mapcar (lambda (p) (car p)) |
489 | hi-lock-interactive-patterns))) | |
490 | (unless hi-lock-interactive-patterns | |
491 | (error "No highlighting to remove")) | |
492 | (list | |
493 | (completing-read "Regexp to unhighlight: " | |
932c309e | 494 | hi-lock-interactive-patterns nil t |
abb2db1c GM |
495 | (car (car hi-lock-interactive-patterns)) |
496 | (cons 'history-list 1)))))) | |
497 | (let ((keyword (assoc regexp hi-lock-interactive-patterns))) | |
498 | (when keyword | |
499 | (font-lock-remove-keywords nil (list keyword)) | |
500 | (setq hi-lock-interactive-patterns | |
501 | (delq keyword hi-lock-interactive-patterns)) | |
81dc5714 JL |
502 | (remove-overlays |
503 | nil nil 'hi-lock-overlay-regexp (hi-lock-string-serialize regexp)) | |
504 | (when font-lock-fontified (font-lock-fontify-buffer))))) | |
abb2db1c GM |
505 | |
506 | ;;;###autoload | |
507 | (defun hi-lock-write-interactive-patterns () | |
508 | "Write interactively added patterns, if any, into buffer at point. | |
509 | ||
510 | Interactively added patterns are those normally specified using | |
511 | `highlight-regexp' and `highlight-lines-matching-regexp'; they can | |
512 | be found in variable `hi-lock-interactive-patterns'." | |
513 | (interactive) | |
597767da CY |
514 | (if (null hi-lock-interactive-patterns) |
515 | (error "There are no interactive patterns")) | |
516 | (let ((beg (point))) | |
ee44464c | 517 | (mapc |
abb2db1c | 518 | (lambda (pattern) |
90756087 JL |
519 | (insert (format "%s: (%s)\n" |
520 | hi-lock-file-patterns-prefix | |
521 | (prin1-to-string pattern)))) | |
597767da CY |
522 | hi-lock-interactive-patterns) |
523 | (comment-region beg (point))) | |
524 | (when (> (point) hi-lock-file-patterns-range) | |
525 | (warn "Inserted keywords not close enough to top of file"))) | |
abb2db1c GM |
526 | |
527 | ;; Implementation Functions | |
528 | ||
108ee42b GM |
529 | (defun hi-lock-process-phrase (phrase) |
530 | "Convert regexp PHRASE to a regexp that matches phrases. | |
531 | ||
532 | Blanks in PHRASE replaced by regexp that matches arbitrary whitespace | |
533 | and initial lower-case letters made case insensitive." | |
534 | (let ((mod-phrase nil)) | |
535 | (setq mod-phrase | |
536 | (replace-regexp-in-string | |
537 | "\\<[a-z]" (lambda (m) (format "[%s%s]" (upcase m) m)) phrase)) | |
538 | (setq mod-phrase | |
539 | (replace-regexp-in-string | |
540 | "\\s-+" "[ \t\n]+" mod-phrase nil t)))) | |
541 | ||
abb2db1c GM |
542 | (defun hi-lock-regexp-okay (regexp) |
543 | "Return REGEXP if it appears suitable for a font-lock pattern. | |
544 | ||
545 | Otherwise signal an error. A pattern that matches the null string is | |
546 | not suitable." | |
547 | (if (string-match regexp "") | |
548 | (error "Regexp cannot match an empty string") | |
549 | regexp)) | |
550 | ||
551 | (defun hi-lock-read-face-name () | |
552 | "Read face name from minibuffer with completion and history." | |
553 | (intern (completing-read | |
554 | "Highlight using face: " | |
555 | obarray 'facep t | |
ef705f25 | 556 | (cons (car hi-lock-face-defaults) |
abb2db1c GM |
557 | (let ((prefix |
558 | (try-completion | |
ef705f25 JL |
559 | (substring (car hi-lock-face-defaults) 0 1) |
560 | hi-lock-face-defaults))) | |
abb2db1c | 561 | (if (and (stringp prefix) |
ef705f25 | 562 | (not (equal prefix (car hi-lock-face-defaults)))) |
abb2db1c | 563 | (length prefix) 0))) |
ef705f25 JL |
564 | 'face-name-history |
565 | (cdr hi-lock-face-defaults)))) | |
abb2db1c | 566 | |
963b2040 CY |
567 | (defun hi-lock-set-pattern (regexp face) |
568 | "Highlight REGEXP with face FACE." | |
569 | (let ((pattern (list regexp (list 0 (list 'quote face) t)))) | |
abb2db1c | 570 | (unless (member pattern hi-lock-interactive-patterns) |
90756087 | 571 | (font-lock-add-keywords nil (list pattern) t) |
963b2040 | 572 | (push pattern hi-lock-interactive-patterns) |
81dc5714 JL |
573 | (if font-lock-fontified |
574 | (font-lock-fontify-buffer) | |
575 | (let* ((serial (hi-lock-string-serialize regexp)) | |
576 | (range-min (- (point) (/ hi-lock-highlight-range 2))) | |
577 | (range-max (+ (point) (/ hi-lock-highlight-range 2))) | |
578 | (search-start | |
579 | (max (point-min) | |
580 | (- range-min (max 0 (- range-max (point-max)))))) | |
581 | (search-end | |
582 | (min (point-max) | |
583 | (+ range-max (max 0 (- (point-min) range-min)))))) | |
584 | (save-excursion | |
585 | (goto-char search-start) | |
586 | (while (re-search-forward regexp search-end t) | |
587 | (let ((overlay (make-overlay (match-beginning 0) (match-end 0)))) | |
588 | (overlay-put overlay 'hi-lock-overlay t) | |
589 | (overlay-put overlay 'hi-lock-overlay-regexp serial) | |
590 | (overlay-put overlay 'face face)) | |
591 | (goto-char (match-end 0))))))))) | |
abb2db1c GM |
592 | |
593 | (defun hi-lock-set-file-patterns (patterns) | |
594 | "Replace file patterns list with PATTERNS and refontify." | |
108ee42b GM |
595 | (when (or hi-lock-file-patterns patterns) |
596 | (font-lock-remove-keywords nil hi-lock-file-patterns) | |
597 | (setq hi-lock-file-patterns patterns) | |
90756087 | 598 | (font-lock-add-keywords nil hi-lock-file-patterns t) |
e4d59066 | 599 | (font-lock-fontify-buffer))) |
abb2db1c GM |
600 | |
601 | (defun hi-lock-find-patterns () | |
602 | "Find patterns in current buffer for hi-lock." | |
603 | (interactive) | |
604 | (unless (memq major-mode hi-lock-exclude-modes) | |
605 | (let ((all-patterns nil) | |
606 | (target-regexp (concat "\\<" hi-lock-file-patterns-prefix ":"))) | |
607 | (save-excursion | |
62cec9fe SM |
608 | (save-restriction |
609 | (widen) | |
610 | (goto-char (point-min)) | |
611 | (re-search-forward target-regexp | |
612 | (+ (point) hi-lock-file-patterns-range) t) | |
613 | (beginning-of-line) | |
614 | (while (and (re-search-forward target-regexp (+ (point) 100) t) | |
615 | (not (looking-at "\\s-*end"))) | |
ed6773fa JB |
616 | (condition-case nil |
617 | (setq all-patterns (append (read (current-buffer)) all-patterns)) | |
618 | (error (message "Invalid pattern list expression at %d" | |
963b2040 | 619 | (line-number-at-pos))))))) |
c898bef7 CY |
620 | (when (and all-patterns |
621 | hi-lock-mode | |
622 | (cond | |
623 | ((eq this-command 'hi-lock-find-patterns) t) | |
624 | ((functionp hi-lock-file-patterns-policy) | |
625 | (funcall hi-lock-file-patterns-policy all-patterns)) | |
626 | ((eq hi-lock-file-patterns-policy 'ask) | |
627 | (y-or-n-p "Add patterns from this buffer to hi-lock? ")) | |
628 | (t nil))) | |
629 | (hi-lock-set-file-patterns all-patterns) | |
630 | (if (interactive-p) | |
631 | (message "Hi-lock added %d patterns." (length all-patterns))))))) | |
abb2db1c GM |
632 | |
633 | (defun hi-lock-font-lock-hook () | |
8b730780 | 634 | "Add hi-lock patterns to font-lock's." |
e4d59066 | 635 | (if font-lock-mode |
90756087 JL |
636 | (progn |
637 | (font-lock-add-keywords nil hi-lock-file-patterns t) | |
638 | (font-lock-add-keywords nil hi-lock-interactive-patterns t)) | |
71060bdd | 639 | (hi-lock-mode -1))) |
abb2db1c | 640 | |
81dc5714 JL |
641 | (defvar hi-lock-string-serialize-hash |
642 | (make-hash-table :test 'equal) | |
643 | "Hash table used to assign unique numbers to strings.") | |
644 | ||
645 | (defvar hi-lock-string-serialize-serial 1 | |
646 | "Number assigned to last new string in call to `hi-lock-string-serialize'. | |
647 | A string is considered new if it had not previously been used in a call to | |
648 | `hi-lock-string-serialize'.") | |
649 | ||
650 | (defun hi-lock-string-serialize (string) | |
651 | "Return unique serial number for STRING." | |
652 | (interactive) | |
653 | (let ((val (gethash string hi-lock-string-serialize-hash))) | |
654 | (if val val | |
655 | (puthash string | |
656 | (setq hi-lock-string-serialize-serial | |
657 | (1+ hi-lock-string-serialize-serial)) | |
658 | hi-lock-string-serialize-hash) | |
659 | hi-lock-string-serialize-serial))) | |
660 | ||
869d3e17 JB |
661 | (defun hi-lock-unload-function () |
662 | "Unload the Hi-Lock library." | |
663 | (global-hi-lock-mode -1) | |
664 | ;; continue standard unloading | |
665 | nil) | |
666 | ||
abb2db1c GM |
667 | (provide 'hi-lock) |
668 | ||
ffc30f4f | 669 | ;; arch-tag: d2e8fd07-4cc9-4c6f-a200-1e729bc54066 |
abb2db1c | 670 | ;;; hi-lock.el ends here |