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