Commit | Line | Data |
---|---|---|
876f2438 SM |
1 | ;;; font-lock.el --- Electric font lock mode |
2 | ||
7ae3cc71 | 3 | ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, |
55d0f066 | 4 | ;; 2000, 2001, 2002, 2003, 2004 2005 Free Software Foundation, Inc. |
030f4a35 | 5 | |
0279f991 | 6 | ;; Author: jwz, then rms, then sm |
030f4a35 RS |
7 | ;; Maintainer: FSF |
8 | ;; Keywords: languages, faces | |
9 | ||
10 | ;; This file is part of GNU Emacs. | |
11 | ||
12 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
13 | ;; it under the terms of the GNU General Public License as published by | |
14 | ;; the Free Software Foundation; either version 2, or (at your option) | |
15 | ;; any later version. | |
16 | ||
17 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
23 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
24 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
25 | ;; Boston, MA 02111-1307, USA. | |
030f4a35 | 26 | |
030f4a35 RS |
27 | ;;; Commentary: |
28 | ||
b89e1134 SM |
29 | ;; Font Lock mode is a minor mode that causes your comments to be displayed in |
30 | ;; one face, strings in another, reserved words in another, and so on. | |
030f4a35 RS |
31 | ;; |
32 | ;; Comments will be displayed in `font-lock-comment-face'. | |
33 | ;; Strings will be displayed in `font-lock-string-face'. | |
a1eb1cf1 | 34 | ;; Regexps are used to display selected patterns in other faces. |
030f4a35 | 35 | ;; |
9bfbb130 SM |
36 | ;; To make the text you type be fontified, use M-x font-lock-mode RET. |
37 | ;; When this minor mode is on, the faces of the current line are updated with | |
38 | ;; every insertion or deletion. | |
030f4a35 | 39 | ;; |
a2b8e66b | 40 | ;; To turn Font Lock mode on automatically, add this to your ~/.emacs file: |
030f4a35 | 41 | ;; |
b89e1134 | 42 | ;; (add-hook 'emacs-lisp-mode-hook 'turn-on-font-lock) |
030f4a35 | 43 | ;; |
a2b8e66b SM |
44 | ;; Or if you want to turn Font Lock mode on in many modes: |
45 | ;; | |
46 | ;; (global-font-lock-mode t) | |
47 | ;; | |
9bfbb130 SM |
48 | ;; Fontification for a particular mode may be available in a number of levels |
49 | ;; of decoration. The higher the level, the more decoration, but the more time | |
50 | ;; it takes to fontify. See the variable `font-lock-maximum-decoration', and | |
5aa29679 RS |
51 | ;; also the variable `font-lock-maximum-size'. Support modes for Font Lock |
52 | ;; mode can be used to speed up Font Lock mode. See `font-lock-support-mode'. | |
98f84f52 | 53 | \f |
56fcbd7e SM |
54 | ;;; How Font Lock mode fontifies: |
55 | ||
56 | ;; When Font Lock mode is turned on in a buffer, it (a) fontifies the entire | |
57 | ;; buffer and (b) installs one of its fontification functions on one of the | |
58 | ;; hook variables that are run by Emacs after every buffer change (i.e., an | |
59 | ;; insertion or deletion). Fontification means the replacement of `face' text | |
60 | ;; properties in a given region; Emacs displays text with these `face' text | |
61 | ;; properties appropriately. | |
62 | ;; | |
63 | ;; Fontification normally involves syntactic (i.e., strings and comments) and | |
ac6e572c SM |
64 | ;; regexp (i.e., keywords and everything else) passes. There are actually |
65 | ;; three passes; (a) the syntactic keyword pass, (b) the syntactic pass and (c) | |
66 | ;; the keyword pass. Confused? | |
67 | ;; | |
68 | ;; The syntactic keyword pass places `syntax-table' text properties in the | |
69 | ;; buffer according to the variable `font-lock-syntactic-keywords'. It is | |
70 | ;; necessary because Emacs' syntax table is not powerful enough to describe all | |
71 | ;; the different syntactic constructs required by the sort of people who decide | |
72 | ;; that a single quote can be syntactic or not depending on the time of day. | |
73 | ;; (What sort of person could decide to overload the meaning of a quote?) | |
74 | ;; Obviously the syntactic keyword pass must occur before the syntactic pass. | |
75 | ;; | |
76 | ;; The syntactic pass places `face' text properties in the buffer according to | |
77 | ;; syntactic context, i.e., according to the buffer's syntax table and buffer | |
78 | ;; text's `syntax-table' text properties. It involves using a syntax parsing | |
79 | ;; function to determine the context of different parts of a region of text. A | |
80 | ;; syntax parsing function is necessary because generally strings and/or | |
81 | ;; comments can span lines, and so the context of a given region is not | |
82 | ;; necessarily apparent from the content of that region. Because the keyword | |
83 | ;; pass only works within a given region, it is not generally appropriate for | |
84 | ;; syntactic fontification. This is the first fontification pass that makes | |
85 | ;; changes visible to the user; it fontifies strings and comments. | |
86 | ;; | |
87 | ;; The keyword pass places `face' text properties in the buffer according to | |
88 | ;; the variable `font-lock-keywords'. It involves searching for given regexps | |
89 | ;; (or calling given search functions) within the given region. This is the | |
90 | ;; second fontification pass that makes changes visible to the user; it | |
91 | ;; fontifies language reserved words, etc. | |
92 | ;; | |
93 | ;; Oh, and the answer is, "Yes, obviously just about everything should be done | |
94 | ;; in a single syntactic pass, but the only syntactic parser available | |
95 | ;; understands only strings and comments." Perhaps one day someone will write | |
96 | ;; some syntactic parsers for common languages and a son-of-font-lock.el could | |
97 | ;; use them rather then relying so heavily on the keyword (regexp) pass. | |
56fcbd7e | 98 | |
c1f2ffc8 SM |
99 | ;;; How Font Lock mode supports modes or is supported by modes: |
100 | ||
101 | ;; Modes that support Font Lock mode do so by defining one or more variables | |
102 | ;; whose values specify the fontification. Font Lock mode knows of these | |
103 | ;; variable names from (a) the buffer local variable `font-lock-defaults', if | |
104 | ;; non-nil, or (b) the global variable `font-lock-defaults-alist', if the major | |
105 | ;; mode has an entry. (Font Lock mode is set up via (a) where a mode's | |
106 | ;; patterns are distributed with the mode's package library, and (b) where a | |
107 | ;; mode's patterns are distributed with font-lock.el itself. An example of (a) | |
108 | ;; is Pascal mode, an example of (b) is Lisp mode. Normally, the mechanism is | |
109 | ;; (a); (b) is used where it is not clear which package library should contain | |
110 | ;; the pattern definitions.) Font Lock mode chooses which variable to use for | |
111 | ;; fontification based on `font-lock-maximum-decoration'. | |
56fcbd7e SM |
112 | ;; |
113 | ;; Font Lock mode fontification behaviour can be modified in a number of ways. | |
114 | ;; See the below comments and the comments distributed throughout this file. | |
c1f2ffc8 SM |
115 | |
116 | ;;; Constructing patterns: | |
117 | ||
98f84f52 SM |
118 | ;; See the documentation for the variable `font-lock-keywords'. |
119 | ;; | |
ac6e572c SM |
120 | ;; Efficient regexps for use as MATCHERs for `font-lock-keywords' and |
121 | ;; `font-lock-syntactic-keywords' can be generated via the function | |
afa18a4e | 122 | ;; `regexp-opt'. |
98f84f52 | 123 | |
c1f2ffc8 SM |
124 | ;;; Adding patterns for modes that already support Font Lock: |
125 | ||
126 | ;; Though Font Lock highlighting patterns already exist for many modes, it's | |
127 | ;; likely there's something that you want fontified that currently isn't, even | |
128 | ;; at the maximum fontification level. You can add highlighting patterns via | |
129 | ;; `font-lock-add-keywords'. For example, say in some C | |
130 | ;; header file you #define the token `and' to expand to `&&', etc., to make | |
131 | ;; your C code almost readable. In your ~/.emacs there could be: | |
98f84f52 | 132 | ;; |
c1f2ffc8 | 133 | ;; (font-lock-add-keywords 'c-mode '("\\<\\(and\\|or\\|not\\)\\>")) |
98f84f52 | 134 | ;; |
c1f2ffc8 SM |
135 | ;; Some modes provide specific ways to modify patterns based on the values of |
136 | ;; other variables. For example, additional C types can be specified via the | |
137 | ;; variable `c-font-lock-extra-types'. | |
138 | ||
139 | ;;; Adding patterns for modes that do not support Font Lock: | |
140 | ||
141 | ;; Not all modes support Font Lock mode. If you (as a user of the mode) add | |
142 | ;; patterns for a new mode, you must define in your ~/.emacs a variable or | |
143 | ;; variables that specify regexp fontification. Then, you should indicate to | |
144 | ;; Font Lock mode, via the mode hook setting `font-lock-defaults', exactly what | |
145 | ;; support is required. For example, say Foo mode should have the following | |
146 | ;; regexps fontified case-sensitively, and comments and strings should not be | |
147 | ;; fontified automagically. In your ~/.emacs there could be: | |
98f84f52 | 148 | ;; |
c1f2ffc8 SM |
149 | ;; (defvar foo-font-lock-keywords |
150 | ;; '(("\\<\\(one\\|two\\|three\\)\\>" . font-lock-keyword-face) | |
151 | ;; ("\\<\\(four\\|five\\|six\\)\\>" . font-lock-type-face)) | |
152 | ;; "Default expressions to highlight in Foo mode.") | |
98f84f52 | 153 | ;; |
c1f2ffc8 | 154 | ;; (add-hook 'foo-mode-hook |
e9476ca8 CW |
155 | ;; (lambda () |
156 | ;; (make-local-variable 'font-lock-defaults) | |
157 | ;; (setq font-lock-defaults '(foo-font-lock-keywords t)))) | |
c1f2ffc8 SM |
158 | |
159 | ;;; Adding Font Lock support for modes: | |
160 | ||
161 | ;; Of course, it would be better that the mode already supports Font Lock mode. | |
162 | ;; The package author would do something similar to above. The mode must | |
163 | ;; define at the top-level a variable or variables that specify regexp | |
164 | ;; fontification. Then, the mode command should indicate to Font Lock mode, | |
165 | ;; via `font-lock-defaults', exactly what support is required. For example, | |
166 | ;; say Bar mode should have the following regexps fontified case-insensitively, | |
167 | ;; and comments and strings should be fontified automagically. In bar.el there | |
168 | ;; could be: | |
98f84f52 | 169 | ;; |
c1f2ffc8 SM |
170 | ;; (defvar bar-font-lock-keywords |
171 | ;; '(("\\<\\(uno\\|due\\|tre\\)\\>" . font-lock-keyword-face) | |
172 | ;; ("\\<\\(quattro\\|cinque\\|sei\\)\\>" . font-lock-type-face)) | |
173 | ;; "Default expressions to highlight in Bar mode.") | |
98f84f52 | 174 | ;; |
c1f2ffc8 | 175 | ;; and within `bar-mode' there could be: |
98f84f52 | 176 | ;; |
c1f2ffc8 SM |
177 | ;; (make-local-variable 'font-lock-defaults) |
178 | ;; (setq font-lock-defaults '(bar-font-lock-keywords nil t)) | |
98f84f52 | 179 | \f |
9bfbb130 SM |
180 | ;; What is fontification for? You might say, "It's to make my code look nice." |
181 | ;; I think it should be for adding information in the form of cues. These cues | |
182 | ;; should provide you with enough information to both (a) distinguish between | |
183 | ;; different items, and (b) identify the item meanings, without having to read | |
184 | ;; the items and think about it. Therefore, fontification allows you to think | |
185 | ;; less about, say, the structure of code, and more about, say, why the code | |
186 | ;; doesn't work. Or maybe it allows you to think less and drift off to sleep. | |
187 | ;; | |
188 | ;; So, here are my opinions/advice/guidelines: | |
5e9e032a | 189 | ;; |
7d7d915a SM |
190 | ;; - Highlight conceptual objects, such as function and variable names, and |
191 | ;; different objects types differently, i.e., (a) and (b) above, highlight | |
192 | ;; function names differently to variable names. | |
193 | ;; - Keep the faces distinct from each other as far as possible. | |
194 | ;; i.e., (a) above. | |
9bfbb130 SM |
195 | ;; - Use the same face for the same conceptual object, across all modes. |
196 | ;; i.e., (b) above, all modes that have items that can be thought of as, say, | |
197 | ;; keywords, should be highlighted with the same face, etc. | |
9bfbb130 SM |
198 | ;; - Make the face attributes fit the concept as far as possible. |
199 | ;; i.e., function names might be a bold colour such as blue, comments might | |
200 | ;; be a bright colour such as red, character strings might be brown, because, | |
201 | ;; err, strings are brown (that was not the reason, please believe me). | |
202 | ;; - Don't use a non-nil OVERRIDE unless you have a good reason. | |
203 | ;; Only use OVERRIDE for special things that are easy to define, such as the | |
204 | ;; way `...' quotes are treated in strings and comments in Emacs Lisp mode. | |
205 | ;; Don't use it to, say, highlight keywords in commented out code or strings. | |
206 | ;; - Err, that's it. | |
a1eb1cf1 | 207 | \f |
2e6a15fc SM |
208 | ;;; Code: |
209 | ||
8259bf10 SM |
210 | (require 'syntax) |
211 | ||
2273c36b | 212 | ;; Define core `font-lock' group. |
6497a8f8 | 213 | (defgroup font-lock '((jit-lock custom-group)) |
55015061 SM |
214 | "Font Lock mode text highlighting package." |
215 | :link '(custom-manual "(emacs)Font Lock") | |
63e20d60 | 216 | :link '(custom-manual "(elisp)Font Lock Mode") |
55015061 SM |
217 | :group 'faces) |
218 | ||
2273c36b SM |
219 | (defgroup font-lock-highlighting-faces nil |
220 | "Faces for highlighting text." | |
55015061 | 221 | :prefix "font-lock-" |
2273c36b SM |
222 | :group 'font-lock) |
223 | ||
224 | (defgroup font-lock-extra-types nil | |
225 | "Extra mode-specific type names for highlighting declarations." | |
226 | :group 'font-lock) | |
227 | ||
ac6e572c | 228 | ;; Define support mode groups here to impose `font-lock' group order. |
2273c36b SM |
229 | (defgroup fast-lock nil |
230 | "Font Lock support mode to cache fontification." | |
2273c36b SM |
231 | :load 'fast-lock |
232 | :group 'font-lock) | |
233 | ||
234 | (defgroup lazy-lock nil | |
235 | "Font Lock support mode to fontify lazily." | |
2273c36b | 236 | :load 'lazy-lock |
55015061 SM |
237 | :group 'font-lock) |
238 | \f | |
9bfbb130 SM |
239 | ;; User variables. |
240 | ||
4fffc071 | 241 | (defcustom font-lock-maximum-size 256000 |
23a0e11b SM |
242 | "*Maximum size of a buffer for buffer fontification. |
243 | Only buffers less than this can be fontified when Font Lock mode is turned on. | |
244 | If nil, means size is irrelevant. | |
245 | If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE), | |
246 | where MAJOR-MODE is a symbol or t (meaning the default). For example: | |
247 | ((c-mode . 256000) (c++-mode . 256000) (rmail-mode . 1048576)) | |
248 | means that the maximum size is 250K for buffers in C or C++ modes, one megabyte | |
249 | for buffers in Rmail mode, and size is irrelevant otherwise." | |
250 | :type '(choice (const :tag "none" nil) | |
251 | (integer :tag "size") | |
252 | (repeat :menu-tag "mode specific" :tag "mode specific" | |
253 | :value ((t . nil)) | |
254 | (cons :tag "Instance" | |
255 | (radio :tag "Mode" | |
256 | (const :tag "all" t) | |
257 | (symbol :tag "name")) | |
258 | (radio :tag "Size" | |
259 | (const :tag "none" nil) | |
260 | (integer :tag "size"))))) | |
55015061 | 261 | :group 'font-lock) |
9bfbb130 | 262 | |
55015061 | 263 | (defcustom font-lock-maximum-decoration t |
2d9cdda8 | 264 | "*Maximum decoration level for fontification. |
9bfbb130 SM |
265 | If nil, use the default decoration (typically the minimum available). |
266 | If t, use the maximum decoration available. | |
267 | If a number, use that level of decoration (or if not available the maximum). | |
268 | If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL), | |
269 | where MAJOR-MODE is a symbol or t (meaning the default). For example: | |
5aa29679 RS |
270 | ((c-mode . t) (c++-mode . 2) (t . 1)) |
271 | means use the maximum decoration available for buffers in C mode, level 2 | |
55015061 | 272 | decoration for buffers in C++ mode, and level 1 decoration otherwise." |
b34aa0a3 SM |
273 | :type '(choice (const :tag "default" nil) |
274 | (const :tag "maximum" t) | |
275 | (integer :tag "level" 1) | |
276 | (repeat :menu-tag "mode specific" :tag "mode specific" | |
277 | :value ((t . t)) | |
278 | (cons :tag "Instance" | |
279 | (radio :tag "Mode" | |
280 | (const :tag "all" t) | |
281 | (symbol :tag "name")) | |
282 | (radio :tag "Decoration" | |
283 | (const :tag "default" nil) | |
019f00d8 | 284 | (const :tag "maximum" t) |
b34aa0a3 | 285 | (integer :tag "level" 1))))) |
55015061 SM |
286 | :group 'font-lock) |
287 | ||
4fffc071 | 288 | (defcustom font-lock-verbose 0 |
23a0e11b SM |
289 | "*If non-nil, means show status messages for buffer fontification. |
290 | If a number, only buffers greater than this size have fontification messages." | |
291 | :type '(choice (const :tag "never" nil) | |
4fffc071 SM |
292 | (other :tag "always" t) |
293 | (integer :tag "size")) | |
55015061 | 294 | :group 'font-lock) |
f9d0b1ed RS |
295 | |
296 | (defcustom font-lock-lines-before 1 | |
297 | "*Number of lines before the changed text to include in refontification." | |
298 | :type 'integer | |
299 | :group 'font-lock | |
300 | :version "22.1") | |
9bfbb130 | 301 | \f |
1c172af4 SM |
302 | |
303 | ;; Originally these variable values were face names such as `bold' etc. | |
304 | ;; Now we create our own faces, but we keep these variables for compatibility | |
305 | ;; and they give users another mechanism for changing face appearance. | |
306 | ;; We now allow a FACENAME in `font-lock-keywords' to be any expression that | |
307 | ;; returns a face. So the easiest thing is to continue using these variables, | |
308 | ;; rather than sometimes evaling FACENAME and sometimes not. sm. | |
309 | (defvar font-lock-comment-face 'font-lock-comment-face | |
310 | "Face name to use for comments.") | |
311 | ||
9177dd93 | 312 | (defvar font-lock-comment-delimiter-face 'font-lock-comment-delimiter-face |
4403a969 | 313 | "Face name to use for comment delimiters.") |
9177dd93 | 314 | |
1c172af4 SM |
315 | (defvar font-lock-string-face 'font-lock-string-face |
316 | "Face name to use for strings.") | |
317 | ||
318 | (defvar font-lock-doc-face 'font-lock-doc-face | |
319 | "Face name to use for documentation.") | |
320 | ||
321 | (defvar font-lock-keyword-face 'font-lock-keyword-face | |
322 | "Face name to use for keywords.") | |
323 | ||
324 | (defvar font-lock-builtin-face 'font-lock-builtin-face | |
325 | "Face name to use for builtins.") | |
326 | ||
327 | (defvar font-lock-function-name-face 'font-lock-function-name-face | |
328 | "Face name to use for function names.") | |
329 | ||
330 | (defvar font-lock-variable-name-face 'font-lock-variable-name-face | |
331 | "Face name to use for variable names.") | |
332 | ||
333 | (defvar font-lock-type-face 'font-lock-type-face | |
334 | "Face name to use for type and class names.") | |
335 | ||
336 | (defvar font-lock-constant-face 'font-lock-constant-face | |
337 | "Face name to use for constant and label names.") | |
338 | ||
339 | (defvar font-lock-warning-face 'font-lock-warning-face | |
340 | "Face name to use for things that should stand out.") | |
341 | ||
5d27cf9f DP |
342 | (defvar font-lock-negation-char-face 'font-lock-negation-char-face |
343 | "Face name to use for easy to overlook negation. | |
344 | This can be an \"!\" or the \"n\" in \"ifndef\".") | |
345 | ||
d654cab8 SM |
346 | (defvar font-lock-preprocessor-face 'font-lock-preprocessor-face |
347 | "Face name to use for preprocessor directives.") | |
348 | ||
9087b271 JB |
349 | (defvar font-lock-reference-face 'font-lock-constant-face) |
350 | (make-obsolete-variable 'font-lock-reference-face 'font-lock-constant-face) | |
1c172af4 | 351 | |
9bfbb130 SM |
352 | ;; Fontification variables: |
353 | ||
030f4a35 | 354 | (defvar font-lock-keywords nil |
ac6e572c | 355 | "A list of the keywords to highlight. |
69968400 RS |
356 | There are two kinds of values: user-level, and compiled. |
357 | ||
358 | A user-level keywords list is what a major mode or the user would | |
359 | set up. Normally the list would come from `font-lock-defaults'. | |
360 | through selection of a fontification level and evaluation of any | |
361 | contained expressions. You can also alter it by calling | |
362 | `font-lock-add-keywords' or `font-lock-remove-keywords' with MODE = nil. | |
363 | ||
364 | Each element in a user-level keywords list should have one of these forms: | |
a1eb1cf1 | 365 | |
826b2925 SM |
366 | MATCHER |
367 | (MATCHER . MATCH) | |
368 | (MATCHER . FACENAME) | |
369 | (MATCHER . HIGHLIGHT) | |
370 | (MATCHER HIGHLIGHT ...) | |
a078558d | 371 | (eval . FORM) |
a1eb1cf1 | 372 | |
558371ba | 373 | where MATCHER can be either the regexp to search for, or the function name to |
f9c0bc2e SM |
374 | call to make the search (called with one argument, the limit of the search; |
375 | it should return non-nil, move point, and set `match-data' appropriately iff | |
376 | it succeeds; like `re-search-forward' would). | |
558371ba | 377 | MATCHER regexps can be generated via the function `regexp-opt'. |
9bfbb130 | 378 | |
a078558d SM |
379 | FORM is an expression, whose value should be a keyword element, evaluated when |
380 | the keyword is (first) used in a buffer. This feature can be used to provide a | |
381 | keyword that can only be generated when Font Lock mode is actually turned on. | |
382 | ||
558371ba SM |
383 | HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED. |
384 | ||
9c8de95c SM |
385 | For highlighting single items, for example each instance of the word \"foo\", |
386 | typically only MATCH-HIGHLIGHT is required. | |
d9f7b2d3 | 387 | However, if an item or (typically) items are to be highlighted following the |
9c8de95c SM |
388 | instance of another item (the anchor), for example each instance of the |
389 | word \"bar\" following the word \"anchor\" then MATCH-ANCHORED may be required. | |
9bfbb130 SM |
390 | |
391 | MATCH-HIGHLIGHT should be of the form: | |
392 | ||
5d27cf9f | 393 | (MATCH FACENAME [OVERRIDE [LAXMATCH]]) |
9bfbb130 | 394 | |
558371ba SM |
395 | MATCH is the subexpression of MATCHER to be highlighted. FACENAME is an |
396 | expression whose value is the face name to use. Face default attributes | |
397 | can be modified via \\[customize]. Instead of a face, FACENAME can | |
67b4790b | 398 | evaluate to a property list of the form (face FACE PROP1 VAL1 PROP2 VAL2 ...) |
558371ba | 399 | in which case all the listed text-properties will be set rather than |
67b4790b | 400 | just FACE. In such a case, you will most likely want to put those |
558371ba SM |
401 | properties in `font-lock-extra-managed-props' or to override |
402 | `font-lock-unfontify-region-function'. | |
a1eb1cf1 | 403 | |
2d63aa67 | 404 | OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification can |
9bfbb130 SM |
405 | be overwritten. If `keep', only parts not already fontified are highlighted. |
406 | If `prepend' or `append', existing fontification is merged with the new, in | |
407 | which the new or existing fontification, respectively, takes precedence. | |
d9f7b2d3 | 408 | If LAXMATCH is non-nil, no error is signaled if there is no MATCH in MATCHER. |
a1eb1cf1 | 409 | |
9bfbb130 SM |
410 | For example, an element of the form highlights (if not already highlighted): |
411 | ||
9c8de95c | 412 | \"\\\\\\=<foo\\\\\\=>\" discrete occurrences of \"foo\" in the value of the |
876f2438 | 413 | variable `font-lock-keyword-face'. |
9c8de95c | 414 | (\"fu\\\\(bar\\\\)\" . 1) substring \"bar\" within all occurrences of \"fubar\" in |
9bfbb130 SM |
415 | the value of `font-lock-keyword-face'. |
416 | (\"fubar\" . fubar-face) Occurrences of \"fubar\" in the value of `fubar-face'. | |
417 | (\"foo\\\\|bar\" 0 foo-bar-face t) | |
9c8de95c | 418 | occurrences of either \"foo\" or \"bar\" in the value |
9bfbb130 | 419 | of `foo-bar-face', even if already highlighted. |
844a6a46 | 420 | (fubar-match 1 fubar-face) |
9c8de95c | 421 | the first subexpression within all occurrences of |
844a6a46 SM |
422 | whatever the function `fubar-match' finds and matches |
423 | in the value of `fubar-face'. | |
9bfbb130 SM |
424 | |
425 | MATCH-ANCHORED should be of the form: | |
426 | ||
427 | (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...) | |
428 | ||
9c8de95c SM |
429 | where MATCHER is a regexp to search for or the function name to call to make |
430 | the search, as for MATCH-HIGHLIGHT above, but with one exception; see below. | |
876f2438 SM |
431 | PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after |
432 | the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be | |
433 | used to initialise before, and cleanup after, MATCHER is used. Typically, | |
434 | PRE-MATCH-FORM is used to move to some position relative to the original | |
435 | MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might | |
67b4790b | 436 | be used to move back, before resuming with MATCH-ANCHORED's parent's MATCHER. |
9bfbb130 SM |
437 | |
438 | For example, an element of the form highlights (if not already highlighted): | |
439 | ||
876f2438 | 440 | (\"\\\\\\=<anchor\\\\\\=>\" (0 anchor-face) (\"\\\\\\=<item\\\\\\=>\" nil nil (0 item-face))) |
9bfbb130 | 441 | |
9c8de95c | 442 | discrete occurrences of \"anchor\" in the value of `anchor-face', and subsequent |
876f2438 SM |
443 | discrete occurrences of \"item\" (on the same line) in the value of `item-face'. |
444 | (Here PRE-MATCH-FORM and POST-MATCH-FORM are nil. Therefore \"item\" is | |
445 | initially searched for starting from the end of the match of \"anchor\", and | |
67b4790b | 446 | searching for subsequent instances of \"anchor\" resumes from where searching |
876f2438 | 447 | for \"item\" concluded.) |
9bfbb130 | 448 | |
56fcbd7e SM |
449 | The above-mentioned exception is as follows. The limit of the MATCHER search |
450 | defaults to the end of the line after PRE-MATCH-FORM is evaluated. | |
451 | However, if PRE-MATCH-FORM returns a position greater than the position after | |
452 | PRE-MATCH-FORM is evaluated, that position is used as the limit of the search. | |
453 | It is generally a bad idea to return a position greater than the end of the | |
454 | line, i.e., cause the MATCHER search to span lines. | |
455 | ||
6e1d0d15 SM |
456 | These regular expressions can match text which spans lines, although |
457 | it is better to avoid it if possible since updating them while editing | |
458 | text is slower, and it is not guaranteed to be always correct when using | |
459 | support modes like jit-lock or lazy-lock. | |
a1eb1cf1 | 460 | |
2d63aa67 SM |
461 | This variable is set by major modes via the variable `font-lock-defaults'. |
462 | Be careful when composing regexps for this list; a poorly written pattern can | |
69968400 RS |
463 | dramatically slow things down! |
464 | ||
465 | A compiled keywords list starts with t. It is produced internal | |
466 | by `font-lock-compile-keywords' from a user-level keywords list. | |
467 | Its second element is the user-level keywords list that was | |
468 | compiled. The remaining elements have the same form as | |
469 | user-level keywords, but normally their values have been | |
470 | optimized.") | |
030f4a35 | 471 | |
c1f2ffc8 | 472 | (defvar font-lock-keywords-alist nil |
0003d2e3 LK |
473 | "Alist of additional `font-lock-keywords' elements for major modes. |
474 | ||
475 | Each element has the form (MODE KEYWORDS . APPEND). | |
476 | `font-lock-set-defaults' adds the elements in the list KEYWORDS to | |
477 | `font-lock-keywords' when Font Lock is turned on in major mode MODE. | |
478 | ||
479 | If APPEND is nil, KEYWORDS are added at the beginning of | |
480 | `font-lock-keywords'. If it is `set', they are used to replace the | |
481 | value of `font-lock-keywords'. If APPEND is any other non-nil value, | |
482 | they are added at the end. | |
483 | ||
76f5e2af GM |
484 | This is normally set via `font-lock-add-keywords' and |
485 | `font-lock-remove-keywords'.") | |
486 | ||
487 | (defvar font-lock-removed-keywords-alist nil | |
0003d2e3 LK |
488 | "Alist of `font-lock-keywords' elements to be removed for major modes. |
489 | ||
490 | Each element has the form (MODE . KEYWORDS). `font-lock-set-defaults' | |
491 | removes the elements in the list KEYWORDS from `font-lock-keywords' | |
492 | when Font Lock is turned on in major mode MODE. | |
493 | ||
76f5e2af GM |
494 | This is normally set via `font-lock-add-keywords' and |
495 | `font-lock-remove-keywords'.") | |
c1f2ffc8 | 496 | |
9bfbb130 | 497 | (defvar font-lock-keywords-only nil |
d46c21ec SM |
498 | "*Non-nil means Font Lock should not fontify comments or strings. |
499 | This is normally set via `font-lock-defaults'.") | |
b89e1134 | 500 | |
030f4a35 | 501 | (defvar font-lock-keywords-case-fold-search nil |
d46c21ec SM |
502 | "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive. |
503 | This is normally set via `font-lock-defaults'.") | |
1087f198 | 504 | (make-variable-buffer-local 'font-lock-keywords-case-fold-search) |
030f4a35 | 505 | |
c0a6a9fe SM |
506 | (defvar font-lock-syntactically-fontified 0 |
507 | "Point up to which `font-lock-syntactic-keywords' has been applied. | |
508 | If nil, this is ignored, in which case the syntactic fontification may | |
509 | sometimes be slightly incorrect.") | |
510 | (make-variable-buffer-local 'font-lock-syntactically-fontified) | |
511 | ||
1c172af4 SM |
512 | (defvar font-lock-syntactic-face-function |
513 | (lambda (state) | |
514 | (if (nth 3 state) font-lock-string-face font-lock-comment-face)) | |
515 | "Function to determine which face to use when fontifying syntactically. | |
516 | The function is called with a single parameter (the state as returned by | |
517 | `parse-partial-sexp' at the beginning of the region to highlight) and | |
8ba81e93 | 518 | should return a face. This is normally set via `font-lock-defaults'.") |
1c172af4 | 519 | |
ac6e572c SM |
520 | (defvar font-lock-syntactic-keywords nil |
521 | "A list of the syntactic keywords to highlight. | |
522 | Can be the list or the name of a function or variable whose value is the list. | |
523 | See `font-lock-keywords' for a description of the form of this list; | |
524 | the differences are listed below. MATCH-HIGHLIGHT should be of the form: | |
525 | ||
526 | (MATCH SYNTAX OVERRIDE LAXMATCH) | |
527 | ||
5299cb8e SM |
528 | where SYNTAX can be a string (as taken by `modify-syntax-entry'), a syntax |
529 | table, a cons cell (as returned by `string-to-syntax') or an expression whose | |
530 | value is such a form. OVERRIDE cannot be `prepend' or `append'. | |
ac6e572c | 531 | |
9c8de95c SM |
532 | For example, an element of the form highlights syntactically: |
533 | ||
5299cb8e | 534 | (\"\\\\$\\\\(#\\\\)\" 1 \".\") |
9c8de95c | 535 | |
5299cb8e SM |
536 | a hash character when following a dollar character, with a SYNTAX of |
537 | \".\" (meaning punctuation syntax). Assuming that the buffer syntax table does | |
9c8de95c SM |
538 | specify hash characters to have comment start syntax, the element will only |
539 | highlight hash characters that do not follow dollar characters as comments | |
540 | syntactically. | |
541 | ||
542 | (\"\\\\('\\\\).\\\\('\\\\)\" | |
5299cb8e SM |
543 | (1 \"\\\"\") |
544 | (2 \"\\\"\")) | |
9c8de95c | 545 | |
5299cb8e SM |
546 | both single quotes which surround a single character, with a SYNTAX of |
547 | \"\\\"\" (meaning string quote syntax). Assuming that the buffer syntax table | |
9c8de95c SM |
548 | does not specify single quotes to have quote syntax, the element will only |
549 | highlight single quotes of the form 'c' as strings syntactically. | |
550 | Other forms, such as foo'bar or 'fubar', will not be highlighted as strings. | |
551 | ||
ac6e572c SM |
552 | This is normally set via `font-lock-defaults'.") |
553 | ||
b056da51 | 554 | (defvar font-lock-syntax-table nil |
799761f0 | 555 | "Non-nil means use this syntax table for fontifying. |
d46c21ec SM |
556 | If this is nil, the major mode's syntax table is used. |
557 | This is normally set via `font-lock-defaults'.") | |
558 | ||
559 | (defvar font-lock-beginning-of-syntax-function nil | |
fc896a92 RS |
560 | "*Non-nil means use this function to move back outside all constructs. |
561 | When called with no args it should move point backward to a place which | |
562 | is not in a string or comment and not within any bracket-pairs (or else, | |
563 | a place such that any bracket-pairs outside it can be ignored for Emacs | |
564 | syntax analysis and fontification). | |
565 | ||
822b23b0 LK |
566 | If this is nil, Font Lock uses `syntax-begin-function' to move back |
567 | outside of any comment, string, or sexp. This variable is semi-obsolete; | |
568 | we recommend setting `syntax-begin-function' instead. | |
569 | ||
570 | This is normally set via `font-lock-defaults'.") | |
b056da51 | 571 | |
a078558d SM |
572 | (defvar font-lock-mark-block-function nil |
573 | "*Non-nil means use this function to mark a block of text. | |
574 | When called with no args it should leave point at the beginning of any | |
575 | enclosing textual block and mark at the end. | |
576 | This is normally set via `font-lock-defaults'.") | |
577 | ||
a2b8e66b SM |
578 | (defvar font-lock-fontify-buffer-function 'font-lock-default-fontify-buffer |
579 | "Function to use for fontifying the buffer. | |
580 | This is normally set via `font-lock-defaults'.") | |
581 | ||
582 | (defvar font-lock-unfontify-buffer-function 'font-lock-default-unfontify-buffer | |
583 | "Function to use for unfontifying the buffer. | |
584 | This is used when turning off Font Lock mode. | |
585 | This is normally set via `font-lock-defaults'.") | |
586 | ||
587 | (defvar font-lock-fontify-region-function 'font-lock-default-fontify-region | |
588 | "Function to use for fontifying a region. | |
589 | It should take two args, the beginning and end of the region, and an optional | |
0edd2744 LK |
590 | third arg VERBOSE. If VERBOSE is non-nil, the function should print status |
591 | messages. This is normally set via `font-lock-defaults'.") | |
a2b8e66b SM |
592 | |
593 | (defvar font-lock-unfontify-region-function 'font-lock-default-unfontify-region | |
594 | "Function to use for unfontifying a region. | |
595 | It should take two args, the beginning and end of the region. | |
596 | This is normally set via `font-lock-defaults'.") | |
597 | ||
598 | (defvar font-lock-inhibit-thing-lock nil | |
599 | "List of Font Lock mode related modes that should not be turned on. | |
019f00d8 | 600 | Currently, valid mode names are `fast-lock-mode', `jit-lock-mode' and |
e7f07c2c | 601 | `lazy-lock-mode'. This is normally set via `font-lock-defaults'.") |
a2b8e66b | 602 | |
f8115798 SM |
603 | (defvar font-lock-multiline nil |
604 | "Whether font-lock should cater to multiline keywords. | |
605 | If nil, don't try to handle multiline patterns. | |
606 | If t, always handle multiline patterns. | |
607 | If `undecided', don't try to handle multiline patterns until you see one. | |
608 | Major/minor modes can set this variable if they know which option applies.") | |
609 | ||
610 | (defvar font-lock-fontified nil) ; Whether we have fontified the buffer. | |
030f4a35 | 611 | \f |
5aa29679 RS |
612 | ;; Font Lock mode. |
613 | ||
614 | (eval-when-compile | |
2e6a15fc | 615 | ;; |
5aa29679 | 616 | ;; We don't do this at the top-level as we only use non-autoloaded macros. |
2e6a15fc SM |
617 | (require 'cl) |
618 | ;; | |
619 | ;; Borrowed from lazy-lock.el. | |
620 | ;; We use this to preserve or protect things when modifying text properties. | |
621 | (defmacro save-buffer-state (varlist &rest body) | |
622 | "Bind variables according to VARLIST and eval BODY restoring buffer state." | |
7b7a23f4 EZ |
623 | (let ((modified (make-symbol "modified"))) |
624 | `(let* ,(append varlist | |
886c13f1 | 625 | `((,modified (buffer-modified-p)) |
7b7a23f4 EZ |
626 | (buffer-undo-list t) |
627 | (inhibit-read-only t) | |
628 | (inhibit-point-motion-hooks t) | |
629 | (inhibit-modification-hooks t) | |
630 | deactivate-mark | |
631 | buffer-file-name | |
632 | buffer-file-truename)) | |
633 | (progn | |
634 | ,@body) | |
635 | (unless ,modified | |
636 | (restore-buffer-modified-p nil))))) | |
e0e277ff | 637 | (put 'save-buffer-state 'lisp-indent-function 1) |
afa18a4e | 638 | (def-edebug-spec save-buffer-state let) |
e0e277ff SM |
639 | ;; |
640 | ;; Shut up the byte compiler. | |
1c172af4 | 641 | (defvar font-lock-face-attributes)) ; Obsolete but respected if set. |
030f4a35 | 642 | |
f8115798 SM |
643 | ;;;###autoload |
644 | (defun font-lock-mode-internal (arg) | |
645 | ;; Turn on Font Lock mode. | |
646 | (when arg | |
647 | (add-hook 'after-change-functions 'font-lock-after-change-function t t) | |
648 | (font-lock-set-defaults) | |
649 | (font-lock-turn-on-thing-lock) | |
650 | ;; Fontify the buffer if we have to. | |
651 | (let ((max-size (font-lock-value-in-major-mode font-lock-maximum-size))) | |
652 | (cond (font-lock-fontified | |
653 | nil) | |
654 | ((or (null max-size) (> max-size (buffer-size))) | |
655 | (font-lock-fontify-buffer)) | |
656 | (font-lock-verbose | |
657 | (message "Fontifying %s...buffer size greater than font-lock-maximum-size" | |
658 | (buffer-name)))))) | |
659 | ;; Turn off Font Lock mode. | |
660 | (unless font-lock-mode | |
661 | (remove-hook 'after-change-functions 'font-lock-after-change-function t) | |
662 | (font-lock-unfontify-buffer) | |
663 | (font-lock-turn-off-thing-lock))) | |
664 | ||
c1f2ffc8 | 665 | ;;;###autoload |
041470d2 SM |
666 | (defun font-lock-add-keywords (mode keywords &optional append) |
667 | "Add highlighting KEYWORDS for MODE. | |
8ba81e93 | 668 | |
041470d2 | 669 | MODE should be a symbol, the major mode command name, such as `c-mode' |
1c626aaf | 670 | or nil. If nil, highlighting keywords are added for the current buffer. |
c1f2ffc8 SM |
671 | KEYWORDS should be a list; see the variable `font-lock-keywords'. |
672 | By default they are added at the beginning of the current highlighting list. | |
673 | If optional argument APPEND is `set', they are used to replace the current | |
2d63aa67 SM |
674 | highlighting list. If APPEND is any other non-nil value, they are added at the |
675 | end of the current highlighting list. | |
c1f2ffc8 SM |
676 | |
677 | For example: | |
678 | ||
679 | (font-lock-add-keywords 'c-mode | |
680 | '((\"\\\\\\=<\\\\(FIXME\\\\):\" 1 font-lock-warning-face prepend) | |
681 | (\"\\\\\\=<\\\\(and\\\\|or\\\\|not\\\\)\\\\\\=>\" . font-lock-keyword-face))) | |
682 | ||
683 | adds two fontification patterns for C mode, to fontify `FIXME:' words, even in | |
2d63aa67 SM |
684 | comments, and to fontify `and', `or' and `not' words as keywords. |
685 | ||
bed88438 LT |
686 | The above procedure will only add the keywords for C mode, not |
687 | for modes derived from C mode. To add them for derived modes too, | |
688 | pass nil for MODE and add the call to c-mode-hook. | |
689 | ||
690 | For example: | |
691 | ||
692 | (add-hook 'c-mode-hook | |
693 | (lambda () | |
694 | (font-lock-add-keywords 'c-mode | |
695 | '((\"\\\\\\=<\\\\(FIXME\\\\):\" 1 font-lock-warning-face prepend) | |
696 | (\"\\\\\\=<\\\\(and\\\\|or\\\\|not\\\\)\\\\\\=>\" . | |
697 | font-lock-keyword-face))))) | |
698 | ||
699 | The above procedure may fail to add keywords to derived modes if | |
700 | some involved major mode does not follow the standard conventions. | |
701 | File a bug report if this happens, so the major mode can be corrected. | |
558371ba | 702 | |
8c2d6a44 | 703 | Note that some modes have specialized support for additional patterns, e.g., |
2d63aa67 SM |
704 | see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types', |
705 | `objc-font-lock-extra-types' and `java-font-lock-extra-types'." | |
041470d2 SM |
706 | (cond (mode |
707 | ;; If MODE is non-nil, add the KEYWORDS and APPEND spec to | |
c1f2ffc8 SM |
708 | ;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them. |
709 | (let ((spec (cons keywords append)) cell) | |
041470d2 | 710 | (if (setq cell (assq mode font-lock-keywords-alist)) |
76f5e2af GM |
711 | (if (eq append 'set) |
712 | (setcdr cell (list spec)) | |
713 | (setcdr cell (append (cdr cell) (list spec)))) | |
714 | (push (list mode spec) font-lock-keywords-alist))) | |
715 | ;; Make sure that `font-lock-removed-keywords-alist' does not | |
716 | ;; contain the new keywords. | |
717 | (font-lock-update-removed-keyword-alist mode keywords append)) | |
6e1d0d15 SM |
718 | (t |
719 | ;; Otherwise set or add the keywords now. | |
bed88438 LT |
720 | ;; This is a no-op if it has been done already in this buffer |
721 | ;; for the correct major mode. | |
6e1d0d15 | 722 | (font-lock-set-defaults) |
69968400 RS |
723 | (let ((was-compiled (eq (car font-lock-keywords) t))) |
724 | ;; Bring back the user-level (uncompiled) keywords. | |
725 | (if was-compiled | |
726 | (setq font-lock-keywords (cadr font-lock-keywords))) | |
727 | ;; Now modify or replace them. | |
728 | (if (eq append 'set) | |
729 | (setq font-lock-keywords keywords) | |
730 | (font-lock-remove-keywords nil keywords) ;to avoid duplicates | |
731 | (let ((old (if (eq (car-safe font-lock-keywords) t) | |
732 | (cdr font-lock-keywords) | |
733 | font-lock-keywords))) | |
734 | (setq font-lock-keywords (if append | |
735 | (append old keywords) | |
736 | (append keywords old))))) | |
737 | ;; If the keywords were compiled before, compile them again. | |
738 | (if was-compiled | |
739 | (set (make-local-variable 'font-lock-keywords) | |
5ac71493 | 740 | (font-lock-compile-keywords font-lock-keywords t))))))) |
3708dfe9 | 741 | |
6e1d0d15 | 742 | (defun font-lock-update-removed-keyword-alist (mode keywords append) |
95965740 | 743 | "Update `font-lock-removed-keywords-alist' when adding new KEYWORDS to MODE." |
76f5e2af GM |
744 | ;; When font-lock is enabled first all keywords in the list |
745 | ;; `font-lock-keywords-alist' are added, then all keywords in the | |
746 | ;; list `font-lock-removed-keywords-alist' are removed. If a | |
747 | ;; keyword was once added, removed, and then added again it must be | |
748 | ;; removed from the removed-keywords list. Otherwise the second add | |
749 | ;; will not take effect. | |
6e1d0d15 | 750 | (let ((cell (assq mode font-lock-removed-keywords-alist))) |
76f5e2af GM |
751 | (if cell |
752 | (if (eq append 'set) | |
753 | ;; A new set of keywords is defined. Forget all about | |
754 | ;; our old keywords that should be removed. | |
755 | (setq font-lock-removed-keywords-alist | |
756 | (delq cell font-lock-removed-keywords-alist)) | |
757 | ;; Delete all previously removed keywords. | |
758 | (dolist (kword keywords) | |
759 | (setcdr cell (delete kword (cdr cell)))) | |
6e1d0d15 | 760 | ;; Delete the mode cell if empty. |
76f5e2af GM |
761 | (if (null (cdr cell)) |
762 | (setq font-lock-removed-keywords-alist | |
763 | (delq cell font-lock-removed-keywords-alist))))))) | |
764 | ||
765 | ;; Written by Anders Lindgren <andersl@andersl.com>. | |
766 | ;; | |
767 | ;; Case study: | |
768 | ;; (I) The keywords are removed from a major mode. | |
769 | ;; In this case the keyword could be local (i.e. added earlier by | |
770 | ;; `font-lock-add-keywords'), global, or both. | |
771 | ;; | |
772 | ;; (a) In the local case we remove the keywords from the variable | |
773 | ;; `font-lock-keywords-alist'. | |
774 | ;; | |
775 | ;; (b) The actual global keywords are not known at this time. | |
776 | ;; All keywords are added to `font-lock-removed-keywords-alist', | |
777 | ;; when font-lock is enabled those keywords are removed. | |
778 | ;; | |
779 | ;; Note that added keywords are taken out of the list of removed | |
780 | ;; keywords. This ensure correct operation when the same keyword | |
781 | ;; is added and removed several times. | |
782 | ;; | |
783 | ;; (II) The keywords are removed from the current buffer. | |
3708dfe9 | 784 | ;;;###autoload |
6e1d0d15 SM |
785 | (defun font-lock-remove-keywords (mode keywords) |
786 | "Remove highlighting KEYWORDS for MODE. | |
3708dfe9 | 787 | |
6e1d0d15 | 788 | MODE should be a symbol, the major mode command name, such as `c-mode' |
558371ba SM |
789 | or nil. If nil, highlighting keywords are removed for the current buffer. |
790 | ||
bed88438 LT |
791 | To make the removal apply to modes derived from MODE as well, |
792 | pass nil for MODE and add the call to MODE-hook. This may fail | |
793 | for some derived modes if some involved major mode does not | |
794 | follow the standard conventions. File a bug report if this | |
795 | happens, so the major mode can be corrected." | |
6e1d0d15 SM |
796 | (cond (mode |
797 | ;; Remove one keyword at the time. | |
798 | (dolist (keyword keywords) | |
799 | (let ((top-cell (assq mode font-lock-keywords-alist))) | |
800 | ;; If MODE is non-nil, remove the KEYWORD from | |
76f5e2af GM |
801 | ;; `font-lock-keywords-alist'. |
802 | (when top-cell | |
803 | (dolist (keyword-list-append-pair (cdr top-cell)) | |
804 | ;; `keywords-list-append-pair' is a cons with a list of | |
805 | ;; keywords in the car top-cell and the original append | |
806 | ;; argument in the cdr top-cell. | |
807 | (setcar keyword-list-append-pair | |
808 | (delete keyword (car keyword-list-append-pair)))) | |
809 | ;; Remove keyword list/append pair when the keyword list | |
810 | ;; is empty and append doesn't specify `set'. (If it | |
811 | ;; should be deleted then previously deleted keywords | |
812 | ;; would appear again.) | |
813 | (let ((cell top-cell)) | |
814 | (while (cdr cell) | |
815 | (if (and (null (car (car (cdr cell)))) | |
816 | (not (eq (cdr (car (cdr cell))) 'set))) | |
817 | (setcdr cell (cdr (cdr cell))) | |
818 | (setq cell (cdr cell))))) | |
819 | ;; Final cleanup, remove major mode cell if last keyword | |
820 | ;; was deleted. | |
821 | (if (null (cdr top-cell)) | |
822 | (setq font-lock-keywords-alist | |
823 | (delq top-cell font-lock-keywords-alist)))) | |
824 | ;; Remember the keyword in case it is not local. | |
6e1d0d15 | 825 | (let ((cell (assq mode font-lock-removed-keywords-alist))) |
76f5e2af GM |
826 | (if cell |
827 | (unless (member keyword (cdr cell)) | |
828 | (nconc cell (list keyword))) | |
6e1d0d15 SM |
829 | (push (cons mode (list keyword)) |
830 | font-lock-removed-keywords-alist)))))) | |
831 | (t | |
832 | ;; Otherwise remove it immediately. | |
833 | (font-lock-set-defaults) | |
69968400 RS |
834 | (let ((was-compiled (eq (car font-lock-keywords) t))) |
835 | ;; Bring back the user-level (uncompiled) keywords. | |
836 | (if was-compiled | |
837 | (setq font-lock-keywords (cadr font-lock-keywords))) | |
838 | ||
839 | ;; Edit them. | |
840 | (setq font-lock-keywords (copy-sequence font-lock-keywords)) | |
841 | (dolist (keyword keywords) | |
842 | (setq font-lock-keywords | |
843 | (delete keyword font-lock-keywords))) | |
844 | ||
845 | ;; If the keywords were compiled before, compile them again. | |
846 | (if was-compiled | |
847 | (set (make-local-variable 'font-lock-keywords) | |
5ac71493 | 848 | (font-lock-compile-keywords font-lock-keywords t))))))) |
a2b8e66b | 849 | \f |
2d63aa67 SM |
850 | ;;; Font Lock Support mode. |
851 | ||
5aa29679 RS |
852 | ;; This is the code used to interface font-lock.el with any of its add-on |
853 | ;; packages, and provide the user interface. Packages that have their own | |
854 | ;; local buffer fontification functions (see below) may have to call | |
855 | ;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer' | |
856 | ;; themselves. | |
857 | ||
5f999b0b | 858 | (defcustom font-lock-support-mode 'jit-lock-mode |
5aa29679 RS |
859 | "*Support mode for Font Lock mode. |
860 | Support modes speed up Font Lock mode by being choosy about when fontification | |
e7f07c2c GM |
861 | occurs. Known support modes are Fast Lock mode (symbol `fast-lock-mode'), |
862 | Lazy Lock mode (symbol `lazy-lock-mode'), and Just-in-time Lock mode (symbol | |
863 | `jit-lock-mode'. See those modes for more info. | |
5aa29679 RS |
864 | If nil, means support for Font Lock mode is never performed. |
865 | If a symbol, use that support mode. | |
866 | If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE), | |
867 | where MAJOR-MODE is a symbol or t (meaning the default). For example: | |
868 | ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode)) | |
869 | means that Fast Lock mode is used to support Font Lock mode for buffers in C or | |
870 | C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise. | |
871 | ||
55015061 | 872 | The value of this variable is used when Font Lock mode is turned on." |
b34aa0a3 SM |
873 | :type '(choice (const :tag "none" nil) |
874 | (const :tag "fast lock" fast-lock-mode) | |
875 | (const :tag "lazy lock" lazy-lock-mode) | |
e7f07c2c | 876 | (const :tag "jit lock" jit-lock-mode) |
b34aa0a3 | 877 | (repeat :menu-tag "mode specific" :tag "mode specific" |
1c172af4 | 878 | :value ((t . jit-lock-mode)) |
b34aa0a3 SM |
879 | (cons :tag "Instance" |
880 | (radio :tag "Mode" | |
881 | (const :tag "all" t) | |
882 | (symbol :tag "name")) | |
39df451b SM |
883 | (radio :tag "Support" |
884 | (const :tag "none" nil) | |
b34aa0a3 | 885 | (const :tag "fast lock" fast-lock-mode) |
e7f07c2c GM |
886 | (const :tag "lazy lock" lazy-lock-mode) |
887 | (const :tag "JIT lock" jit-lock-mode))) | |
b34aa0a3 | 888 | )) |
c69e5fcd | 889 | :version "21.1" |
55015061 | 890 | :group 'font-lock) |
5aa29679 | 891 | |
7f0d55f2 SM |
892 | (defvar fast-lock-mode) |
893 | (defvar lazy-lock-mode) | |
894 | (defvar jit-lock-mode) | |
2e6a15fc | 895 | |
5aa29679 RS |
896 | (defun font-lock-turn-on-thing-lock () |
897 | (let ((thing-mode (font-lock-value-in-major-mode font-lock-support-mode))) | |
898 | (cond ((eq thing-mode 'fast-lock-mode) | |
899 | (fast-lock-mode t)) | |
900 | ((eq thing-mode 'lazy-lock-mode) | |
e7f07c2c GM |
901 | (lazy-lock-mode t)) |
902 | ((eq thing-mode 'jit-lock-mode) | |
28a53bc1 SM |
903 | ;; Prepare for jit-lock |
904 | (remove-hook 'after-change-functions | |
905 | 'font-lock-after-change-function t) | |
906 | (set (make-local-variable 'font-lock-fontify-buffer-function) | |
fd612dd9 | 907 | 'jit-lock-refontify) |
c711faac | 908 | ;; Don't fontify eagerly (and don't abort if the buffer is large). |
28a53bc1 SM |
909 | (set (make-local-variable 'font-lock-fontified) t) |
910 | ;; Use jit-lock. | |
911 | (jit-lock-register 'font-lock-fontify-region | |
912 | (not font-lock-keywords-only)))))) | |
5aa29679 | 913 | |
5aa29679 | 914 | (defun font-lock-turn-off-thing-lock () |
7f0d55f2 | 915 | (cond ((and (boundp 'fast-lock-mode) fast-lock-mode) |
1c172af4 | 916 | (fast-lock-mode -1)) |
7f0d55f2 | 917 | ((and (boundp 'jit-lock-mode) jit-lock-mode) |
28a53bc1 SM |
918 | (jit-lock-unregister 'font-lock-fontify-region) |
919 | ;; Reset local vars to the non-jit-lock case. | |
920 | (kill-local-variable 'font-lock-fontify-buffer-function)) | |
7f0d55f2 | 921 | ((and (boundp 'lazy-lock-mode) lazy-lock-mode) |
1c172af4 | 922 | (lazy-lock-mode -1)))) |
5aa29679 RS |
923 | |
924 | (defun font-lock-after-fontify-buffer () | |
7f0d55f2 | 925 | (cond ((and (boundp 'fast-lock-mode) fast-lock-mode) |
5aa29679 | 926 | (fast-lock-after-fontify-buffer)) |
13f0d185 SM |
927 | ;; Useless now that jit-lock intercepts font-lock-fontify-buffer. -sm |
928 | ;; (jit-lock-mode | |
929 | ;; (jit-lock-after-fontify-buffer)) | |
7f0d55f2 | 930 | ((and (boundp 'lazy-lock-mode) lazy-lock-mode) |
5aa29679 RS |
931 | (lazy-lock-after-fontify-buffer)))) |
932 | ||
933 | (defun font-lock-after-unfontify-buffer () | |
7f0d55f2 | 934 | (cond ((and (boundp 'fast-lock-mode) fast-lock-mode) |
5aa29679 | 935 | (fast-lock-after-unfontify-buffer)) |
13f0d185 SM |
936 | ;; Useless as well. It's only called when: |
937 | ;; - turning off font-lock: it does not matter if we leave spurious | |
938 | ;; `fontified' text props around since jit-lock-mode is also off. | |
939 | ;; - font-lock-default-fontify-buffer fails: this is not run | |
940 | ;; any more anyway. -sm | |
5e9e032a | 941 | ;; |
13f0d185 SM |
942 | ;; (jit-lock-mode |
943 | ;; (jit-lock-after-unfontify-buffer)) | |
7f0d55f2 | 944 | ((and (boundp 'lazy-lock-mode) lazy-lock-mode) |
5aa29679 RS |
945 | (lazy-lock-after-unfontify-buffer)))) |
946 | ||
2d63aa67 | 947 | ;;; End of Font Lock Support mode. |
5aa29679 | 948 | \f |
2d63aa67 | 949 | ;;; Fontification functions. |
a1eb1cf1 | 950 | |
56fcbd7e SM |
951 | ;; Rather than the function, e.g., `font-lock-fontify-region' containing the |
952 | ;; code to fontify a region, the function runs the function whose name is the | |
953 | ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally, | |
954 | ;; the value of this variable is, e.g., `font-lock-default-fontify-region' | |
955 | ;; which does contain the code to fontify a region. However, the value of the | |
956 | ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could | |
957 | ;; do anything. The indirection of the fontification functions gives major | |
958 | ;; modes the capability of modifying the way font-lock.el fontifies. Major | |
959 | ;; modes can modify the values of, e.g., `font-lock-fontify-region-function', | |
960 | ;; via the variable `font-lock-defaults'. | |
961 | ;; | |
962 | ;; For example, Rmail mode sets the variable `font-lock-defaults' so that | |
963 | ;; font-lock.el uses its own function for buffer fontification. This function | |
964 | ;; makes fontification be on a message-by-message basis and so visiting an | |
965 | ;; RMAIL file is much faster. A clever implementation of the function might | |
966 | ;; fontify the headers differently than the message body. (It should, and | |
967 | ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can | |
968 | ;; you?) This hints at a more interesting use... | |
969 | ;; | |
970 | ;; Languages that contain text normally contained in different major modes | |
971 | ;; could define their own fontification functions that treat text differently | |
972 | ;; depending on its context. For example, Perl mode could arrange that here | |
973 | ;; docs are fontified differently than Perl code. Or Yacc mode could fontify | |
974 | ;; rules one way and C code another. Neat! | |
975 | ;; | |
976 | ;; A further reason to use the fontification indirection feature is when the | |
977 | ;; default syntactual fontification, or the default fontification in general, | |
978 | ;; is not flexible enough for a particular major mode. For example, perhaps | |
55015061 SM |
979 | ;; comments are just too hairy for `font-lock-fontify-syntactically-region' to |
980 | ;; cope with. You need to write your own version of that function, e.g., | |
981 | ;; `hairy-fontify-syntactically-region', and make your own version of | |
982 | ;; `hairy-fontify-region' call that function before calling | |
56fcbd7e SM |
983 | ;; `font-lock-fontify-keywords-region' for the normal regexp fontification |
984 | ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el | |
985 | ;; would call your region fontification function instead of its own. For | |
55015061 | 986 | ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line |
56fcbd7e SM |
987 | ;; directives correctly and cleanly. (It is the same problem as fontifying |
988 | ;; multi-line strings and comments; regexps are not appropriate for the job.) | |
989 | ||
a1eb1cf1 | 990 | ;;;###autoload |
030f4a35 | 991 | (defun font-lock-fontify-buffer () |
019f00d8 | 992 | "Fontify the current buffer the way the function `font-lock-mode' would." |
030f4a35 | 993 | (interactive) |
a2b8e66b SM |
994 | (let ((font-lock-verbose (or font-lock-verbose (interactive-p)))) |
995 | (funcall font-lock-fontify-buffer-function))) | |
996 | ||
997 | (defun font-lock-unfontify-buffer () | |
998 | (funcall font-lock-unfontify-buffer-function)) | |
999 | ||
1000 | (defun font-lock-fontify-region (beg end &optional loudly) | |
1001 | (funcall font-lock-fontify-region-function beg end loudly)) | |
1002 | ||
1003 | (defun font-lock-unfontify-region (beg end) | |
516eb29c SM |
1004 | (save-buffer-state nil |
1005 | (funcall font-lock-unfontify-region-function beg end))) | |
a2b8e66b SM |
1006 | |
1007 | (defun font-lock-default-fontify-buffer () | |
5aa29679 RS |
1008 | (let ((verbose (if (numberp font-lock-verbose) |
1009 | (> (buffer-size) font-lock-verbose) | |
1010 | font-lock-verbose))) | |
79f238c9 | 1011 | (with-temp-message |
1787769b SM |
1012 | (when verbose |
1013 | (format "Fontifying %s..." (buffer-name))) | |
79f238c9 SM |
1014 | ;; Make sure we have the right `font-lock-keywords' etc. |
1015 | (unless font-lock-mode | |
1016 | (font-lock-set-defaults)) | |
1017 | ;; Make sure we fontify etc. in the whole buffer. | |
1018 | (save-restriction | |
1019 | (widen) | |
1020 | (condition-case nil | |
1021 | (save-excursion | |
1022 | (save-match-data | |
1023 | (font-lock-fontify-region (point-min) (point-max) verbose) | |
1024 | (font-lock-after-fontify-buffer) | |
1025 | (setq font-lock-fontified t))) | |
1026 | ;; We don't restore the old fontification, so it's best to unfontify. | |
8259bf10 | 1027 | (quit (font-lock-unfontify-buffer))))))) |
7d7d915a | 1028 | |
a2b8e66b | 1029 | (defun font-lock-default-unfontify-buffer () |
56fcbd7e | 1030 | ;; Make sure we unfontify etc. in the whole buffer. |
a2b8e66b SM |
1031 | (save-restriction |
1032 | (widen) | |
1033 | (font-lock-unfontify-region (point-min) (point-max)) | |
271c888a | 1034 | (font-lock-after-unfontify-buffer) |
a2b8e66b | 1035 | (setq font-lock-fontified nil))) |
9bfbb130 | 1036 | |
7f0d55f2 SM |
1037 | (defvar font-lock-dont-widen nil |
1038 | "If non-nil, font-lock will work on the non-widened buffer. | |
1039 | Useful for things like RMAIL and Info where the whole buffer is not | |
1040 | a very meaningful entity to highlight.") | |
1041 | ||
a2b8e66b | 1042 | (defun font-lock-default-fontify-region (beg end loudly) |
ac6e572c | 1043 | (save-buffer-state |
8a2a6535 SM |
1044 | ((parse-sexp-lookup-properties |
1045 | (or parse-sexp-lookup-properties font-lock-syntactic-keywords)) | |
ac6e572c | 1046 | (old-syntax-table (syntax-table))) |
876f2438 | 1047 | (unwind-protect |
a078558d | 1048 | (save-restriction |
7f0d55f2 | 1049 | (unless font-lock-dont-widen (widen)) |
876f2438 | 1050 | ;; Use the fontification syntax table, if any. |
2e6a15fc SM |
1051 | (when font-lock-syntax-table |
1052 | (set-syntax-table font-lock-syntax-table)) | |
fb0e4f8a RS |
1053 | ;; check to see if we should expand the beg/end area for |
1054 | ;; proper multiline matches | |
f9261020 GM |
1055 | (when (and font-lock-multiline |
1056 | (> beg (point-min)) | |
28a53bc1 SM |
1057 | (get-text-property (1- beg) 'font-lock-multiline)) |
1058 | ;; We are just after or in a multiline match. | |
1059 | (setq beg (or (previous-single-property-change | |
1060 | beg 'font-lock-multiline) | |
ba22aeff SM |
1061 | (point-min))) |
1062 | (goto-char beg) | |
1063 | (setq beg (line-beginning-position))) | |
111c181e GM |
1064 | (when font-lock-multiline |
1065 | (setq end (or (text-property-any end (point-max) | |
1066 | 'font-lock-multiline nil) | |
1067 | (point-max)))) | |
ba22aeff | 1068 | (goto-char end) |
724a330f | 1069 | (setq end (line-beginning-position 2)) |
876f2438 | 1070 | ;; Now do the fontification. |
2e6a15fc | 1071 | (font-lock-unfontify-region beg end) |
ac6e572c SM |
1072 | (when font-lock-syntactic-keywords |
1073 | (font-lock-fontify-syntactic-keywords-region beg end)) | |
2e6a15fc | 1074 | (unless font-lock-keywords-only |
876f2438 SM |
1075 | (font-lock-fontify-syntactically-region beg end loudly)) |
1076 | (font-lock-fontify-keywords-region beg end loudly)) | |
1077 | ;; Clean up. | |
2e6a15fc | 1078 | (set-syntax-table old-syntax-table)))) |
9bfbb130 SM |
1079 | |
1080 | ;; The following must be rethought, since keywords can override fontification. | |
1081 | ; ;; Now scan for keywords, but not if we are inside a comment now. | |
1082 | ; (or (and (not font-lock-keywords-only) | |
019f00d8 | 1083 | ; (let ((state (parse-partial-sexp beg end nil nil |
9bfbb130 SM |
1084 | ; font-lock-cache-state))) |
1085 | ; (or (nth 4 state) (nth 7 state)))) | |
1086 | ; (font-lock-fontify-keywords-region beg end)) | |
1087 | ||
8259bf10 SM |
1088 | (defvar font-lock-extra-managed-props nil |
1089 | "Additional text properties managed by font-lock. | |
1090 | This is used by `font-lock-default-unfontify-region' to decide | |
4c02ca46 | 1091 | what properties to clear before refontifying a region.") |
8259bf10 | 1092 | |
a2b8e66b | 1093 | (defun font-lock-default-unfontify-region (beg end) |
516eb29c SM |
1094 | (remove-list-of-text-properties |
1095 | beg end (append | |
1096 | font-lock-extra-managed-props | |
1097 | (if font-lock-syntactic-keywords | |
1098 | '(syntax-table face font-lock-multiline) | |
1099 | '(face font-lock-multiline))))) | |
9bfbb130 SM |
1100 | |
1101 | ;; Called when any modification is made to buffer text. | |
1102 | (defun font-lock-after-change-function (beg end old-len) | |
14e2791a RS |
1103 | (let ((inhibit-point-motion-hooks t) |
1104 | (inhibit-quit t)) | |
46f26fcf SM |
1105 | (save-excursion |
1106 | (save-match-data | |
1107 | ;; Rescan between start of lines enclosing the region. | |
1108 | (font-lock-fontify-region | |
f9d0b1ed RS |
1109 | (progn (goto-char beg) |
1110 | (forward-line (- font-lock-lines-before)) (point)) | |
46f26fcf | 1111 | (progn (goto-char end) (forward-line 1) (point))))))) |
a2b8e66b | 1112 | |
a078558d SM |
1113 | (defun font-lock-fontify-block (&optional arg) |
1114 | "Fontify some lines the way `font-lock-fontify-buffer' would. | |
1115 | The lines could be a function or paragraph, or a specified number of lines. | |
a078558d | 1116 | If ARG is given, fontify that many lines before and after point, or 16 lines if |
a465832f SM |
1117 | no ARG is given and `font-lock-mark-block-function' is nil. |
1118 | If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to | |
1119 | delimit the region to fontify." | |
a078558d | 1120 | (interactive "P") |
46f26fcf SM |
1121 | (let ((inhibit-point-motion-hooks t) font-lock-beginning-of-syntax-function |
1122 | deactivate-mark) | |
a078558d SM |
1123 | ;; Make sure we have the right `font-lock-keywords' etc. |
1124 | (if (not font-lock-mode) (font-lock-set-defaults)) | |
a2b8e66b SM |
1125 | (save-excursion |
1126 | (save-match-data | |
1127 | (condition-case error-data | |
a078558d SM |
1128 | (if (or arg (not font-lock-mark-block-function)) |
1129 | (let ((lines (if arg (prefix-numeric-value arg) 16))) | |
1130 | (font-lock-fontify-region | |
1131 | (save-excursion (forward-line (- lines)) (point)) | |
1132 | (save-excursion (forward-line lines) (point)))) | |
1133 | (funcall font-lock-mark-block-function) | |
1134 | (font-lock-fontify-region (point) (mark))) | |
6c0fc428 | 1135 | ((error quit) (message "Fontifying block...%s" error-data))))))) |
a078558d | 1136 | |
7f0d55f2 | 1137 | (if (boundp 'facemenu-keymap) |
2d526287 | 1138 | (define-key facemenu-keymap "\M-o" 'font-lock-fontify-block)) |
2d63aa67 SM |
1139 | |
1140 | ;;; End of Fontification functions. | |
9bfbb130 | 1141 | \f |
9bfbb130 SM |
1142 | ;;; Additional text property functions. |
1143 | ||
1c626aaf SM |
1144 | ;; The following text property functions should be builtins. This means they |
1145 | ;; should be written in C and put with all the other text property functions. | |
1146 | ;; In the meantime, those that are used by font-lock.el are defined in Lisp | |
1147 | ;; below and given a `font-lock-' prefix. Those that are not used are defined | |
1148 | ;; in Lisp below and commented out. sm. | |
9bfbb130 | 1149 | |
1c626aaf | 1150 | (defun font-lock-prepend-text-property (start end prop value &optional object) |
9bfbb130 SM |
1151 | "Prepend to one property of the text from START to END. |
1152 | Arguments PROP and VALUE specify the property and value to prepend to the value | |
1c626aaf | 1153 | already in place. The resulting property values are always lists. |
9bfbb130 SM |
1154 | Optional argument OBJECT is the string or buffer containing the text." |
1155 | (let ((val (if (listp value) value (list value))) next prev) | |
1156 | (while (/= start end) | |
1157 | (setq next (next-single-property-change start prop object end) | |
1158 | prev (get-text-property start prop object)) | |
1c626aaf SM |
1159 | (put-text-property start next prop |
1160 | (append val (if (listp prev) prev (list prev))) | |
1161 | object) | |
9bfbb130 SM |
1162 | (setq start next)))) |
1163 | ||
1c626aaf | 1164 | (defun font-lock-append-text-property (start end prop value &optional object) |
9bfbb130 SM |
1165 | "Append to one property of the text from START to END. |
1166 | Arguments PROP and VALUE specify the property and value to append to the value | |
1c626aaf | 1167 | already in place. The resulting property values are always lists. |
9bfbb130 SM |
1168 | Optional argument OBJECT is the string or buffer containing the text." |
1169 | (let ((val (if (listp value) value (list value))) next prev) | |
1170 | (while (/= start end) | |
1171 | (setq next (next-single-property-change start prop object end) | |
1172 | prev (get-text-property start prop object)) | |
1c626aaf SM |
1173 | (put-text-property start next prop |
1174 | (append (if (listp prev) prev (list prev)) val) | |
1175 | object) | |
9bfbb130 | 1176 | (setq start next)))) |
1c626aaf SM |
1177 | |
1178 | (defun font-lock-fillin-text-property (start end prop value &optional object) | |
1179 | "Fill in one property of the text from START to END. | |
1180 | Arguments PROP and VALUE specify the property and value to put where none are | |
1181 | already in place. Therefore existing property values are not overwritten. | |
1182 | Optional argument OBJECT is the string or buffer containing the text." | |
1183 | (let ((start (text-property-any start end prop nil object)) next) | |
1184 | (while start | |
1185 | (setq next (next-single-property-change start prop object end)) | |
1186 | (put-text-property start next prop value object) | |
1187 | (setq start (text-property-any next end prop nil object))))) | |
1188 | ||
1189 | ;; For completeness: this is to `remove-text-properties' as `put-text-property' | |
1190 | ;; is to `add-text-properties', etc. | |
1191 | ;(defun remove-text-property (start end property &optional object) | |
1192 | ; "Remove a property from text from START to END. | |
1193 | ;Argument PROPERTY is the property to remove. | |
1194 | ;Optional argument OBJECT is the string or buffer containing the text. | |
1195 | ;Return t if the property was actually removed, nil otherwise." | |
1196 | ; (remove-text-properties start end (list property) object)) | |
1197 | ||
1198 | ;; For consistency: maybe this should be called `remove-single-property' like | |
1199 | ;; `next-single-property-change' (not `next-single-text-property-change'), etc. | |
1200 | ;(defun remove-single-text-property (start end prop value &optional object) | |
1201 | ; "Remove a specific property value from text from START to END. | |
1202 | ;Arguments PROP and VALUE specify the property and value to remove. The | |
1203 | ;resulting property values are not equal to VALUE nor lists containing VALUE. | |
1204 | ;Optional argument OBJECT is the string or buffer containing the text." | |
1205 | ; (let ((start (text-property-not-all start end prop nil object)) next prev) | |
1206 | ; (while start | |
1207 | ; (setq next (next-single-property-change start prop object end) | |
1208 | ; prev (get-text-property start prop object)) | |
1209 | ; (cond ((and (symbolp prev) (eq value prev)) | |
1210 | ; (remove-text-property start next prop object)) | |
1211 | ; ((and (listp prev) (memq value prev)) | |
1212 | ; (let ((new (delq value prev))) | |
1213 | ; (cond ((null new) | |
1214 | ; (remove-text-property start next prop object)) | |
1215 | ; ((= (length new) 1) | |
1216 | ; (put-text-property start next prop (car new) object)) | |
1217 | ; (t | |
1218 | ; (put-text-property start next prop new object)))))) | |
1219 | ; (setq start (text-property-not-all next end prop nil object))))) | |
2d63aa67 SM |
1220 | |
1221 | ;;; End of Additional text property functions. | |
9bfbb130 | 1222 | \f |
ac6e572c SM |
1223 | ;;; Syntactic regexp fontification functions. |
1224 | ||
1225 | ;; These syntactic keyword pass functions are identical to those keyword pass | |
1226 | ;; functions below, with the following exceptions; (a) they operate on | |
1227 | ;; `font-lock-syntactic-keywords' of course, (b) they are all `defun' as speed | |
1228 | ;; is less of an issue, (c) eval of property value does not occur JIT as speed | |
1229 | ;; is less of an issue, (d) OVERRIDE cannot be `prepend' or `append' as it | |
1230 | ;; makes no sense for `syntax-table' property values, (e) they do not do it | |
1231 | ;; LOUDLY as it is not likely to be intensive. | |
1232 | ||
1233 | (defun font-lock-apply-syntactic-highlight (highlight) | |
1234 | "Apply HIGHLIGHT following a match. | |
1235 | HIGHLIGHT should be of the form MATCH-HIGHLIGHT, | |
1236 | see `font-lock-syntactic-keywords'." | |
1237 | (let* ((match (nth 0 highlight)) | |
1238 | (start (match-beginning match)) (end (match-end match)) | |
1239 | (value (nth 1 highlight)) | |
1240 | (override (nth 2 highlight))) | |
8259bf10 SM |
1241 | (if (not start) |
1242 | ;; No match but we might not signal an error. | |
1243 | (or (nth 3 highlight) | |
1244 | (error "No match %d in highlight %S" match highlight)) | |
1245 | (when (and (consp value) (not (numberp (car value)))) | |
1246 | (setq value (eval value))) | |
1247 | (when (stringp value) (setq value (string-to-syntax value))) | |
1248 | ;; Flush the syntax-cache. I believe this is not necessary for | |
1249 | ;; font-lock's use of syntax-ppss, but I'm not 100% sure and it can | |
1250 | ;; still be necessary for other users of syntax-ppss anyway. | |
1251 | (syntax-ppss-after-change-function start) | |
1252 | (cond | |
1253 | ((not override) | |
1254 | ;; Cannot override existing fontification. | |
1255 | (or (text-property-not-all start end 'syntax-table nil) | |
1256 | (put-text-property start end 'syntax-table value))) | |
1257 | ((eq override t) | |
1258 | ;; Override existing fontification. | |
1259 | (put-text-property start end 'syntax-table value)) | |
1260 | ((eq override 'keep) | |
1261 | ;; Keep existing fontification. | |
1262 | (font-lock-fillin-text-property start end 'syntax-table value)))))) | |
ac6e572c SM |
1263 | |
1264 | (defun font-lock-fontify-syntactic-anchored-keywords (keywords limit) | |
1265 | "Fontify according to KEYWORDS until LIMIT. | |
1266 | KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords', | |
1267 | LIMIT can be modified by the value of its PRE-MATCH-FORM." | |
1268 | (let ((matcher (nth 0 keywords)) (lowdarks (nthcdr 3 keywords)) highlights | |
1269 | ;; Evaluate PRE-MATCH-FORM. | |
1270 | (pre-match-value (eval (nth 1 keywords)))) | |
1271 | ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line. | |
1272 | (if (and (numberp pre-match-value) (> pre-match-value (point))) | |
1273 | (setq limit pre-match-value) | |
6e1d0d15 | 1274 | (setq limit (line-end-position))) |
ac6e572c SM |
1275 | (save-match-data |
1276 | ;; Find an occurrence of `matcher' before `limit'. | |
1277 | (while (if (stringp matcher) | |
1278 | (re-search-forward matcher limit t) | |
1279 | (funcall matcher limit)) | |
1280 | ;; Apply each highlight to this instance of `matcher'. | |
1281 | (setq highlights lowdarks) | |
1282 | (while highlights | |
1283 | (font-lock-apply-syntactic-highlight (car highlights)) | |
1284 | (setq highlights (cdr highlights))))) | |
1285 | ;; Evaluate POST-MATCH-FORM. | |
1286 | (eval (nth 2 keywords)))) | |
1287 | ||
1288 | (defun font-lock-fontify-syntactic-keywords-region (start end) | |
1289 | "Fontify according to `font-lock-syntactic-keywords' between START and END. | |
1290 | START should be at the beginning of a line." | |
c0a6a9fe SM |
1291 | ;; Ensure the beginning of the file is properly syntactic-fontified. |
1292 | (when (and font-lock-syntactically-fontified | |
1293 | (< font-lock-syntactically-fontified start)) | |
1294 | (setq start (max font-lock-syntactically-fontified (point-min))) | |
1295 | (setq font-lock-syntactically-fontified end)) | |
ac6e572c SM |
1296 | ;; If `font-lock-syntactic-keywords' is a symbol, get the real keywords. |
1297 | (when (symbolp font-lock-syntactic-keywords) | |
1298 | (setq font-lock-syntactic-keywords (font-lock-eval-keywords | |
1299 | font-lock-syntactic-keywords))) | |
1300 | ;; If `font-lock-syntactic-keywords' is not compiled, compile it. | |
1301 | (unless (eq (car font-lock-syntactic-keywords) t) | |
1302 | (setq font-lock-syntactic-keywords (font-lock-compile-keywords | |
1303 | font-lock-syntactic-keywords))) | |
1304 | ;; Get down to business. | |
1305 | (let ((case-fold-search font-lock-keywords-case-fold-search) | |
0715d1a4 | 1306 | (keywords (cddr font-lock-syntactic-keywords)) |
ac6e572c SM |
1307 | keyword matcher highlights) |
1308 | (while keywords | |
1309 | ;; Find an occurrence of `matcher' from `start' to `end'. | |
1310 | (setq keyword (car keywords) matcher (car keyword)) | |
1311 | (goto-char start) | |
1312 | (while (if (stringp matcher) | |
1313 | (re-search-forward matcher end t) | |
1314 | (funcall matcher end)) | |
1315 | ;; Apply each highlight to this instance of `matcher', which may be | |
1316 | ;; specific highlights or more keywords anchored to `matcher'. | |
1317 | (setq highlights (cdr keyword)) | |
1318 | (while highlights | |
1319 | (if (numberp (car (car highlights))) | |
1320 | (font-lock-apply-syntactic-highlight (car highlights)) | |
1321 | (font-lock-fontify-syntactic-anchored-keywords (car highlights) | |
1322 | end)) | |
1323 | (setq highlights (cdr highlights)))) | |
1324 | (setq keywords (cdr keywords))))) | |
1325 | ||
1326 | ;;; End of Syntactic regexp fontification functions. | |
1327 | \f | |
1328 | ;;; Syntactic fontification functions. | |
1329 | ||
7435a76b RS |
1330 | (defvar font-lock-comment-start-skip nil |
1331 | "If non-nil, Font Lock mode uses this instead of `comment-start-skip'.") | |
1332 | ||
1333 | (defvar font-lock-comment-end-skip nil | |
1334 | "If non-nil, Font Lock mode uses this instead of `comment-end'.") | |
1335 | ||
8259bf10 | 1336 | (defun font-lock-fontify-syntactically-region (start end &optional loudly ppss) |
ac6e572c SM |
1337 | "Put proper face on each string and comment between START and END. |
1338 | START should be at the beginning of a line." | |
90cbc9cd | 1339 | (let ((comment-end-regexp |
7435a76b RS |
1340 | (or font-lock-comment-end-skip |
1341 | (regexp-quote | |
1342 | (replace-regexp-in-string "^ *" "" comment-end)))) | |
90cbc9cd | 1343 | state face beg) |
ac6e572c SM |
1344 | (if loudly (message "Fontifying %s... (syntactically...)" (buffer-name))) |
1345 | (goto-char start) | |
1346 | ;; | |
7ae3cc71 | 1347 | ;; Find the `start' state. |
47fc2db3 | 1348 | (setq state (or ppss (syntax-ppss start))) |
ac6e572c SM |
1349 | ;; |
1350 | ;; Find each interesting place between here and `end'. | |
8259bf10 SM |
1351 | (while |
1352 | (progn | |
1353 | (when (or (nth 3 state) (nth 4 state)) | |
1354 | (setq face (funcall font-lock-syntactic-face-function state)) | |
1355 | (setq beg (max (nth 8 state) start)) | |
1356 | (setq state (parse-partial-sexp (point) end nil nil state | |
1357 | 'syntax-table)) | |
a4479657 | 1358 | (when face (put-text-property beg (point) 'face face)) |
90cbc9cd | 1359 | (when (and (eq face 'font-lock-comment-face) |
7435a76b RS |
1360 | (or font-lock-comment-start-skip |
1361 | comment-start-skip)) | |
a4479657 RS |
1362 | ;; Find the comment delimiters |
1363 | ;; and use font-lock-comment-delimiter-face for them. | |
1364 | (save-excursion | |
1365 | (goto-char beg) | |
7435a76b RS |
1366 | (if (looking-at (or font-lock-comment-start-skip |
1367 | comment-start-skip)) | |
a4479657 | 1368 | (put-text-property beg (match-end 0) 'face |
90cbc9cd | 1369 | font-lock-comment-delimiter-face))) |
a1594703 | 1370 | (if (looking-back comment-end-regexp (point-at-bol) t) |
a4479657 | 1371 | (put-text-property (match-beginning 0) (point) 'face |
90cbc9cd | 1372 | font-lock-comment-delimiter-face)))) |
6ce66ffe SM |
1373 | (< (point) end)) |
1374 | (setq state (parse-partial-sexp (point) end nil nil state | |
1375 | 'syntax-table))))) | |
ac6e572c SM |
1376 | |
1377 | ;;; End of Syntactic fontification functions. | |
1378 | \f | |
1379 | ;;; Keyword regexp fontification functions. | |
9bfbb130 SM |
1380 | |
1381 | (defsubst font-lock-apply-highlight (highlight) | |
1382 | "Apply HIGHLIGHT following a match. | |
1383 | HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'." | |
1384 | (let* ((match (nth 0 highlight)) | |
1385 | (start (match-beginning match)) (end (match-end match)) | |
1386 | (override (nth 2 highlight))) | |
8259bf10 SM |
1387 | (if (not start) |
1388 | ;; No match but we might not signal an error. | |
1389 | (or (nth 3 highlight) | |
1390 | (error "No match %d in highlight %S" match highlight)) | |
1391 | (let ((val (eval (nth 1 highlight)))) | |
1392 | (when (eq (car-safe val) 'face) | |
1393 | (add-text-properties start end (cddr val)) | |
1394 | (setq val (cadr val))) | |
1395 | (cond | |
a5f48305 | 1396 | ((not (or val (eq override t))) |
6b7f3491 SM |
1397 | ;; If `val' is nil, don't do anything. It is important to do it |
1398 | ;; explicitly, because when adding nil via things like | |
1399 | ;; font-lock-append-text-property, the property is actually | |
1400 | ;; changed from <face> to (<face>) which is undesirable. --Stef | |
1401 | nil) | |
8259bf10 SM |
1402 | ((not override) |
1403 | ;; Cannot override existing fontification. | |
1404 | (or (text-property-not-all start end 'face nil) | |
1405 | (put-text-property start end 'face val))) | |
1406 | ((eq override t) | |
1407 | ;; Override existing fontification. | |
1408 | (put-text-property start end 'face val)) | |
1409 | ((eq override 'prepend) | |
1410 | ;; Prepend to existing fontification. | |
1411 | (font-lock-prepend-text-property start end 'face val)) | |
1412 | ((eq override 'append) | |
1413 | ;; Append to existing fontification. | |
1414 | (font-lock-append-text-property start end 'face val)) | |
1415 | ((eq override 'keep) | |
1416 | ;; Keep existing fontification. | |
1417 | (font-lock-fillin-text-property start end 'face val))))))) | |
9bfbb130 SM |
1418 | |
1419 | (defsubst font-lock-fontify-anchored-keywords (keywords limit) | |
1420 | "Fontify according to KEYWORDS until LIMIT. | |
56fcbd7e SM |
1421 | KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords', |
1422 | LIMIT can be modified by the value of its PRE-MATCH-FORM." | |
1423 | (let ((matcher (nth 0 keywords)) (lowdarks (nthcdr 3 keywords)) highlights | |
fb0e4f8a | 1424 | (lead-start (match-beginning 0)) |
56fcbd7e SM |
1425 | ;; Evaluate PRE-MATCH-FORM. |
1426 | (pre-match-value (eval (nth 1 keywords)))) | |
1427 | ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line. | |
fb0e4f8a | 1428 | (if (not (and (numberp pre-match-value) (> pre-match-value (point)))) |
6e1d0d15 | 1429 | (setq limit (line-end-position)) |
fb0e4f8a | 1430 | (setq limit pre-match-value) |
ba22aeff | 1431 | (when (and font-lock-multiline (>= limit (line-beginning-position 2))) |
fb0e4f8a | 1432 | ;; this is a multiline anchored match |
ba22aeff SM |
1433 | ;; (setq font-lock-multiline t) |
1434 | (put-text-property (if (= limit (line-beginning-position 2)) | |
1435 | (1- limit) | |
1436 | (min lead-start (point))) | |
1437 | limit | |
28a53bc1 | 1438 | 'font-lock-multiline t))) |
9bfbb130 | 1439 | (save-match-data |
876f2438 | 1440 | ;; Find an occurrence of `matcher' before `limit'. |
afa18a4e SM |
1441 | (while (and (< (point) limit) |
1442 | (if (stringp matcher) | |
1443 | (re-search-forward matcher limit t) | |
1444 | (funcall matcher limit))) | |
876f2438 | 1445 | ;; Apply each highlight to this instance of `matcher'. |
9bfbb130 SM |
1446 | (setq highlights lowdarks) |
1447 | (while highlights | |
1448 | (font-lock-apply-highlight (car highlights)) | |
1449 | (setq highlights (cdr highlights))))) | |
876f2438 | 1450 | ;; Evaluate POST-MATCH-FORM. |
9bfbb130 SM |
1451 | (eval (nth 2 keywords)))) |
1452 | ||
1453 | (defun font-lock-fontify-keywords-region (start end &optional loudly) | |
1454 | "Fontify according to `font-lock-keywords' between START and END. | |
7f0d55f2 SM |
1455 | START should be at the beginning of a line. |
1456 | LOUDLY, if non-nil, allows progress-meter bar." | |
ac6e572c | 1457 | (unless (eq (car font-lock-keywords) t) |
2d5eba0e SM |
1458 | (setq font-lock-keywords |
1459 | (font-lock-compile-keywords font-lock-keywords t))) | |
9bfbb130 | 1460 | (let ((case-fold-search font-lock-keywords-case-fold-search) |
69968400 | 1461 | (keywords (cddr font-lock-keywords)) |
9bfbb130 | 1462 | (bufname (buffer-name)) (count 0) |
b71813cb | 1463 | (pos (make-marker)) |
876f2438 SM |
1464 | keyword matcher highlights) |
1465 | ;; | |
1466 | ;; Fontify each item in `font-lock-keywords' from `start' to `end'. | |
1467 | (while keywords | |
1468 | (if loudly (message "Fontifying %s... (regexps..%s)" bufname | |
2e6a15fc | 1469 | (make-string (incf count) ?.))) |
9bfbb130 | 1470 | ;; |
876f2438 SM |
1471 | ;; Find an occurrence of `matcher' from `start' to `end'. |
1472 | (setq keyword (car keywords) matcher (car keyword)) | |
1473 | (goto-char start) | |
e7f07c2c GM |
1474 | (while (and (< (point) end) |
1475 | (if (stringp matcher) | |
1476 | (re-search-forward matcher end t) | |
1477 | (funcall matcher end))) | |
041470d2 | 1478 | (when (and font-lock-multiline |
ba22aeff SM |
1479 | (>= (point) |
1480 | (save-excursion (goto-char (match-beginning 0)) | |
1481 | (forward-line 1) (point)))) | |
fb0e4f8a | 1482 | ;; this is a multiline regexp match |
ba22aeff SM |
1483 | ;; (setq font-lock-multiline t) |
1484 | (put-text-property (if (= (point) | |
1485 | (save-excursion | |
1486 | (goto-char (match-beginning 0)) | |
1487 | (forward-line 1) (point))) | |
1488 | (1- (point)) | |
1489 | (match-beginning 0)) | |
1490 | (point) | |
fb0e4f8a | 1491 | 'font-lock-multiline t)) |
876f2438 SM |
1492 | ;; Apply each highlight to this instance of `matcher', which may be |
1493 | ;; specific highlights or more keywords anchored to `matcher'. | |
1494 | (setq highlights (cdr keyword)) | |
1495 | (while highlights | |
1496 | (if (numberp (car (car highlights))) | |
1497 | (font-lock-apply-highlight (car highlights)) | |
b71813cb SM |
1498 | (set-marker pos (point)) |
1499 | (font-lock-fontify-anchored-keywords (car highlights) end) | |
1500 | ;; Ensure forward progress. `pos' is a marker because anchored | |
1501 | ;; keyword may add/delete text (this happens e.g. in grep.el). | |
1502 | (if (< (point) pos) (goto-char pos))) | |
876f2438 | 1503 | (setq highlights (cdr highlights)))) |
b71813cb SM |
1504 | (setq keywords (cdr keywords))) |
1505 | (set-marker pos nil))) | |
2d63aa67 | 1506 | |
ac6e572c | 1507 | ;;; End of Keyword regexp fontification functions. |
9bfbb130 SM |
1508 | \f |
1509 | ;; Various functions. | |
1510 | ||
2d5eba0e | 1511 | (defun font-lock-compile-keywords (keywords &optional regexp) |
69968400 RS |
1512 | "Compile KEYWORDS into the form (t KEYWORDS COMPILED...) |
1513 | Here each COMPILED is of the form (MATCHER HIGHLIGHT ...) as shown in the | |
2d5eba0e SM |
1514 | `font-lock-keywords' doc string. |
1515 | If REGEXP is non-nil, it means these keywords are used for | |
1516 | `font-lock-keywords' rather than for `font-lock-syntactic-keywords'." | |
55015061 SM |
1517 | (if (eq (car-safe keywords) t) |
1518 | keywords | |
69968400 RS |
1519 | (setq keywords |
1520 | (cons t (cons keywords | |
1521 | (mapcar 'font-lock-compile-keyword keywords)))) | |
2d5eba0e SM |
1522 | (if (and regexp |
1523 | (eq (or syntax-begin-function | |
1524 | font-lock-beginning-of-syntax-function) | |
1525 | 'beginning-of-defun) | |
1526 | (not beginning-of-defun-function)) | |
1527 | ;; Try to detect when a string or comment contains something that | |
1528 | ;; looks like a defun and would thus confuse font-lock. | |
1529 | (nconc keywords | |
1530 | `((,(if defun-prompt-regexp | |
1531 | (concat "^\\(?:" defun-prompt-regexp "\\)?\\s(") | |
1532 | "^\\s(") | |
1533 | (0 | |
048aac39 | 1534 | (if (memq (get-text-property (match-beginning 0) 'face) |
2d5eba0e SM |
1535 | '(font-lock-string-face font-lock-doc-face |
1536 | font-lock-comment-face)) | |
1537 | font-lock-warning-face) | |
1538 | prepend))))) | |
1539 | keywords)) | |
a2b8e66b SM |
1540 | |
1541 | (defun font-lock-compile-keyword (keyword) | |
c1f2ffc8 | 1542 | (cond ((nlistp keyword) ; MATCHER |
a2b8e66b | 1543 | (list keyword '(0 font-lock-keyword-face))) |
c1f2ffc8 | 1544 | ((eq (car keyword) 'eval) ; (eval . FORM) |
a2b8e66b | 1545 | (font-lock-compile-keyword (eval (cdr keyword)))) |
c1f2ffc8 SM |
1546 | ((eq (car-safe (cdr keyword)) 'quote) ; (MATCHER . 'FORM) |
1547 | ;; If FORM is a FACENAME then quote it. Otherwise ignore the quote. | |
1548 | (if (symbolp (nth 2 keyword)) | |
1549 | (list (car keyword) (list 0 (cdr keyword))) | |
1550 | (font-lock-compile-keyword (cons (car keyword) (nth 2 keyword))))) | |
1551 | ((numberp (cdr keyword)) ; (MATCHER . MATCH) | |
a2b8e66b | 1552 | (list (car keyword) (list (cdr keyword) 'font-lock-keyword-face))) |
c1f2ffc8 | 1553 | ((symbolp (cdr keyword)) ; (MATCHER . FACENAME) |
a2b8e66b | 1554 | (list (car keyword) (list 0 (cdr keyword)))) |
c1f2ffc8 | 1555 | ((nlistp (nth 1 keyword)) ; (MATCHER . HIGHLIGHT) |
a2b8e66b | 1556 | (list (car keyword) (cdr keyword))) |
c1f2ffc8 | 1557 | (t ; (MATCHER HIGHLIGHT ...) |
a2b8e66b | 1558 | keyword))) |
d46c21ec | 1559 | |
ac6e572c | 1560 | (defun font-lock-eval-keywords (keywords) |
019f00d8 | 1561 | "Evalulate KEYWORDS if a function (funcall) or variable (eval) name." |
46f26fcf SM |
1562 | (if (listp keywords) |
1563 | keywords | |
1564 | (font-lock-eval-keywords (if (fboundp keywords) | |
1565 | (funcall keywords) | |
1566 | (eval keywords))))) | |
ac6e572c | 1567 | |
343204bd | 1568 | (defun font-lock-value-in-major-mode (alist) |
019f00d8 DL |
1569 | "Return value in ALIST for `major-mode', or ALIST if it is not an alist. |
1570 | Structure is ((MAJOR-MODE . VALUE) ...) where MAJOR-MODE may be t." | |
343204bd SM |
1571 | (if (consp alist) |
1572 | (cdr (or (assq major-mode alist) (assq t alist))) | |
1573 | alist)) | |
1574 | ||
d46c21ec | 1575 | (defun font-lock-choose-keywords (keywords level) |
019f00d8 DL |
1576 | "Return LEVELth element of KEYWORDS. |
1577 | A LEVEL of nil is equal to a LEVEL of 0, a LEVEL of t is equal to | |
1578 | \(1- (length KEYWORDS))." | |
fd612dd9 | 1579 | (cond ((not (and (listp keywords) (symbolp (car keywords)))) |
343204bd SM |
1580 | keywords) |
1581 | ((numberp level) | |
1582 | (or (nth level keywords) (car (reverse keywords)))) | |
1583 | ((eq level t) | |
1584 | (car (reverse keywords))) | |
1585 | (t | |
1586 | (car keywords)))) | |
d46c21ec | 1587 | |
f8115798 SM |
1588 | (defvar font-lock-set-defaults nil) ; Whether we have set up defaults. |
1589 | ||
bed88438 | 1590 | (defvar font-lock-mode-major-mode) |
f8115798 SM |
1591 | (defun font-lock-set-defaults () |
1592 | "Set fontification defaults appropriately for this mode. | |
1593 | Sets various variables using `font-lock-defaults' (or, if nil, using | |
1594 | `font-lock-defaults-alist') and `font-lock-maximum-decoration'." | |
bed88438 LT |
1595 | ;; Set fontification defaults iff not previously set for correct major mode. |
1596 | (unless (and font-lock-set-defaults | |
1597 | (eq font-lock-mode-major-mode major-mode)) | |
12245009 | 1598 | (setq font-lock-mode-major-mode major-mode) |
f8115798 SM |
1599 | (set (make-local-variable 'font-lock-set-defaults) t) |
1600 | (make-local-variable 'font-lock-fontified) | |
1601 | (make-local-variable 'font-lock-multiline) | |
1602 | (let* ((defaults (or font-lock-defaults | |
7ea820e9 RS |
1603 | (cdr (assq major-mode |
1604 | (with-no-warnings | |
1605 | font-lock-defaults-alist))))) | |
f8115798 SM |
1606 | (keywords |
1607 | (font-lock-choose-keywords (nth 0 defaults) | |
1608 | (font-lock-value-in-major-mode font-lock-maximum-decoration))) | |
1609 | (local (cdr (assq major-mode font-lock-keywords-alist))) | |
1610 | (removed-keywords | |
1611 | (cdr-safe (assq major-mode font-lock-removed-keywords-alist)))) | |
1612 | (set (make-local-variable 'font-lock-defaults) defaults) | |
1613 | ;; Syntactic fontification? | |
1614 | (when (nth 1 defaults) | |
1615 | (set (make-local-variable 'font-lock-keywords-only) t)) | |
1616 | ;; Case fold during regexp fontification? | |
1617 | (when (nth 2 defaults) | |
1618 | (set (make-local-variable 'font-lock-keywords-case-fold-search) t)) | |
1619 | ;; Syntax table for regexp and syntactic fontification? | |
1620 | (when (nth 3 defaults) | |
1621 | (set (make-local-variable 'font-lock-syntax-table) | |
1622 | (copy-syntax-table (syntax-table))) | |
1623 | (dolist (selem (nth 3 defaults)) | |
1624 | ;; The character to modify may be a single CHAR or a STRING. | |
1625 | (let ((syntax (cdr selem))) | |
1626 | (dolist (char (if (numberp (car selem)) | |
1627 | (list (car selem)) | |
1628 | (mapcar 'identity (car selem)))) | |
1629 | (modify-syntax-entry char syntax font-lock-syntax-table))))) | |
1630 | ;; Syntax function for syntactic fontification? | |
1631 | (when (nth 4 defaults) | |
1632 | (set (make-local-variable 'font-lock-beginning-of-syntax-function) | |
1633 | (nth 4 defaults))) | |
1634 | ;; Variable alist? | |
1635 | (dolist (x (nthcdr 5 defaults)) | |
1636 | (set (make-local-variable (car x)) (cdr x))) | |
69968400 | 1637 | ;; Set up `font-lock-keywords' last because its value might depend |
f8115798 SM |
1638 | ;; on other settings (e.g. font-lock-compile-keywords uses |
1639 | ;; font-lock-beginning-of-syntax-function). | |
1640 | (set (make-local-variable 'font-lock-keywords) | |
69968400 | 1641 | (font-lock-eval-keywords keywords)) |
f8115798 SM |
1642 | ;; Local fontification? |
1643 | (while local | |
1644 | (font-lock-add-keywords nil (car (car local)) (cdr (car local))) | |
1645 | (setq local (cdr local))) | |
1646 | (when removed-keywords | |
69968400 RS |
1647 | (font-lock-remove-keywords nil removed-keywords)) |
1648 | ;; Now compile the keywords. | |
1649 | (unless (eq (car font-lock-keywords) t) | |
1650 | (set (make-local-variable 'font-lock-keywords) | |
e2850f3f | 1651 | (font-lock-compile-keywords font-lock-keywords t)))))) |
030f4a35 | 1652 | \f |
2d63aa67 | 1653 | ;;; Colour etc. support. |
9bfbb130 | 1654 | |
2273c36b | 1655 | ;; Originally face attributes were specified via `font-lock-face-attributes'. |
23a0e11b | 1656 | ;; Users then changed the default face attributes by setting that variable. |
2273c36b SM |
1657 | ;; However, we try and be back-compatible and respect its value if set except |
1658 | ;; for faces where M-x customize has been used to save changes for the face. | |
1659 | (when (boundp 'font-lock-face-attributes) | |
1660 | (let ((face-attributes font-lock-face-attributes)) | |
1661 | (while face-attributes | |
1662 | (let* ((face-attribute (pop face-attributes)) | |
1663 | (face (car face-attribute))) | |
1664 | ;; Rustle up a `defface' SPEC from a `font-lock-face-attributes' entry. | |
1665 | (unless (get face 'saved-face) | |
1666 | (let ((foreground (nth 1 face-attribute)) | |
1667 | (background (nth 2 face-attribute)) | |
1668 | (bold-p (nth 3 face-attribute)) | |
1669 | (italic-p (nth 4 face-attribute)) | |
1670 | (underline-p (nth 5 face-attribute)) | |
1671 | face-spec) | |
1672 | (when foreground | |
1673 | (setq face-spec (cons ':foreground (cons foreground face-spec)))) | |
1674 | (when background | |
1675 | (setq face-spec (cons ':background (cons background face-spec)))) | |
1676 | (when bold-p | |
0cccb49d | 1677 | (setq face-spec (append '(:weight bold) face-spec))) |
2273c36b | 1678 | (when italic-p |
0cccb49d | 1679 | (setq face-spec (append '(:slant italic) face-spec))) |
2273c36b SM |
1680 | (when underline-p |
1681 | (setq face-spec (append '(:underline t) face-spec))) | |
1682 | (custom-declare-face face (list (list t face-spec)) nil))))))) | |
1683 | ||
1684 | ;; But now we do it the custom way. Note that `defface' will not overwrite any | |
1685 | ;; faces declared above via `custom-declare-face'. | |
9177dd93 RS |
1686 | (defface font-lock-comment-face |
1687 | '((((class grayscale) (background light)) | |
1688 | (:foreground "DimGray" :weight bold :slant italic)) | |
1689 | (((class grayscale) (background dark)) | |
1690 | (:foreground "LightGray" :weight bold :slant italic)) | |
1691 | (((class color) (min-colors 88) (background light)) | |
1692 | (:foreground "Firebrick")) | |
1693 | (((class color) (min-colors 88) (background dark)) | |
1694 | (:foreground "chocolate1")) | |
1695 | (((class color) (min-colors 16) (background light)) | |
1696 | (:foreground "red")) | |
1697 | (((class color) (min-colors 16) (background dark)) | |
1698 | (:foreground "red1")) | |
1699 | (((class color) (min-colors 8) (background light)) | |
1700 | ) | |
1701 | (((class color) (min-colors 8) (background dark)) | |
1702 | ) | |
1703 | (t (:weight bold :slant italic))) | |
1704 | "Font Lock mode face used to highlight comments." | |
1705 | :group 'font-lock-highlighting-faces) | |
bf2cea1d SM |
1706 | |
1707 | (defface font-lock-comment-delimiter-face | |
3187cffc | 1708 | '((default :inherit font-lock-comment-face) |
3989c3e7 SM |
1709 | (((class grayscale))) |
1710 | (((class color) (min-colors 16))) | |
3187cffc SM |
1711 | (((class color) (min-colors 8) (background light)) |
1712 | :foreground "red") | |
1713 | (((class color) (min-colors 8) (background dark)) | |
1714 | :foreground "red1")) | |
bf2cea1d SM |
1715 | "Font Lock mode face used to highlight comment delimiters." |
1716 | :group 'font-lock-highlighting-faces) | |
9177dd93 | 1717 | |
55015061 | 1718 | (defface font-lock-string-face |
a12d182a | 1719 | '((((class grayscale) (background light)) (:foreground "DimGray" :slant italic)) |
0cccb49d | 1720 | (((class grayscale) (background dark)) (:foreground "LightGray" :slant italic)) |
a12d182a EZ |
1721 | (((class color) (min-colors 88) (background light)) (:foreground "RosyBrown")) |
1722 | (((class color) (min-colors 88) (background dark)) (:foreground "LightSalmon")) | |
1723 | (((class color) (min-colors 16) (background light)) (:foreground "RosyBrown")) | |
1724 | (((class color) (min-colors 16) (background dark)) (:foreground "LightSalmon")) | |
1725 | (((class color) (min-colors 8)) (:foreground "green")) | |
0cccb49d | 1726 | (t (:slant italic))) |
55015061 | 1727 | "Font Lock mode face used to highlight strings." |
2273c36b | 1728 | :group 'font-lock-highlighting-faces) |
55015061 | 1729 | |
1c172af4 SM |
1730 | (defface font-lock-doc-face |
1731 | '((t :inherit font-lock-string-face)) | |
1732 | "Font Lock mode face used to highlight documentation." | |
1733 | :group 'font-lock-highlighting-faces) | |
1734 | ||
55015061 | 1735 | (defface font-lock-keyword-face |
a12d182a | 1736 | '((((class grayscale) (background light)) (:foreground "LightGray" :weight bold)) |
0cccb49d | 1737 | (((class grayscale) (background dark)) (:foreground "DimGray" :weight bold)) |
a12d182a | 1738 | (((class color) (min-colors 88) (background light)) (:foreground "Purple")) |
ea81d57e | 1739 | (((class color) (min-colors 88) (background dark)) (:foreground "Cyan1")) |
a12d182a EZ |
1740 | (((class color) (min-colors 16) (background light)) (:foreground "Purple")) |
1741 | (((class color) (min-colors 16) (background dark)) (:foreground "Cyan")) | |
1742 | (((class color) (min-colors 8)) (:foreground "cyan" :weight bold)) | |
0cccb49d | 1743 | (t (:weight bold))) |
55015061 | 1744 | "Font Lock mode face used to highlight keywords." |
2273c36b | 1745 | :group 'font-lock-highlighting-faces) |
55015061 SM |
1746 | |
1747 | (defface font-lock-builtin-face | |
a12d182a | 1748 | '((((class grayscale) (background light)) (:foreground "LightGray" :weight bold)) |
0cccb49d | 1749 | (((class grayscale) (background dark)) (:foreground "DimGray" :weight bold)) |
a12d182a EZ |
1750 | (((class color) (min-colors 88) (background light)) (:foreground "Orchid")) |
1751 | (((class color) (min-colors 88) (background dark)) (:foreground "LightSteelBlue")) | |
1752 | (((class color) (min-colors 16) (background light)) (:foreground "Orchid")) | |
1753 | (((class color) (min-colors 16) (background dark)) (:foreground "LightSteelBlue")) | |
1754 | (((class color) (min-colors 8)) (:foreground "blue" :weight bold)) | |
0cccb49d | 1755 | (t (:weight bold))) |
55015061 | 1756 | "Font Lock mode face used to highlight builtins." |
2273c36b | 1757 | :group 'font-lock-highlighting-faces) |
55015061 SM |
1758 | |
1759 | (defface font-lock-function-name-face | |
ea81d57e | 1760 | '((((class color) (min-colors 88) (background light)) (:foreground "Blue1")) |
a12d182a EZ |
1761 | (((class color) (min-colors 88) (background dark)) (:foreground "LightSkyBlue")) |
1762 | (((class color) (min-colors 16) (background light)) (:foreground "Blue")) | |
1763 | (((class color) (min-colors 16) (background dark)) (:foreground "LightSkyBlue")) | |
1764 | (((class color) (min-colors 8)) (:foreground "blue" :weight bold)) | |
0cccb49d | 1765 | (t (:inverse-video t :weight bold))) |
55015061 | 1766 | "Font Lock mode face used to highlight function names." |
2273c36b | 1767 | :group 'font-lock-highlighting-faces) |
55015061 SM |
1768 | |
1769 | (defface font-lock-variable-name-face | |
a12d182a | 1770 | '((((class grayscale) (background light)) |
0cccb49d | 1771 | (:foreground "Gray90" :weight bold :slant italic)) |
55015061 | 1772 | (((class grayscale) (background dark)) |
0cccb49d | 1773 | (:foreground "DimGray" :weight bold :slant italic)) |
a12d182a EZ |
1774 | (((class color) (min-colors 88) (background light)) (:foreground "DarkGoldenrod")) |
1775 | (((class color) (min-colors 88) (background dark)) (:foreground "LightGoldenrod")) | |
1776 | (((class color) (min-colors 16) (background light)) (:foreground "DarkGoldenrod")) | |
1777 | (((class color) (min-colors 16) (background dark)) (:foreground "LightGoldenrod")) | |
1778 | (((class color) (min-colors 8)) (:foreground "yellow" :weight light)) | |
0cccb49d | 1779 | (t (:weight bold :slant italic))) |
55015061 | 1780 | "Font Lock mode face used to highlight variable names." |
2273c36b | 1781 | :group 'font-lock-highlighting-faces) |
55015061 SM |
1782 | |
1783 | (defface font-lock-type-face | |
a12d182a | 1784 | '((((class grayscale) (background light)) (:foreground "Gray90" :weight bold)) |
0cccb49d | 1785 | (((class grayscale) (background dark)) (:foreground "DimGray" :weight bold)) |
a12d182a EZ |
1786 | (((class color) (min-colors 88) (background light)) (:foreground "ForestGreen")) |
1787 | (((class color) (min-colors 88) (background dark)) (:foreground "PaleGreen")) | |
1788 | (((class color) (min-colors 16) (background light)) (:foreground "ForestGreen")) | |
1789 | (((class color) (min-colors 16) (background dark)) (:foreground "PaleGreen")) | |
1790 | (((class color) (min-colors 8)) (:foreground "green")) | |
0cccb49d | 1791 | (t (:weight bold :underline t))) |
8acf2292 | 1792 | "Font Lock mode face used to highlight type and classes." |
2273c36b | 1793 | :group 'font-lock-highlighting-faces) |
55015061 | 1794 | |
8acf2292 | 1795 | (defface font-lock-constant-face |
a12d182a | 1796 | '((((class grayscale) (background light)) |
0cccb49d | 1797 | (:foreground "LightGray" :weight bold :underline t)) |
55015061 | 1798 | (((class grayscale) (background dark)) |
0cccb49d | 1799 | (:foreground "Gray50" :weight bold :underline t)) |
a12d182a EZ |
1800 | (((class color) (min-colors 88) (background light)) (:foreground "CadetBlue")) |
1801 | (((class color) (min-colors 88) (background dark)) (:foreground "Aquamarine")) | |
1802 | (((class color) (min-colors 16) (background light)) (:foreground "CadetBlue")) | |
1803 | (((class color) (min-colors 16) (background dark)) (:foreground "Aquamarine")) | |
1804 | (((class color) (min-colors 8)) (:foreground "magenta")) | |
0cccb49d | 1805 | (t (:weight bold :underline t))) |
8acf2292 | 1806 | "Font Lock mode face used to highlight constants and labels." |
2273c36b | 1807 | :group 'font-lock-highlighting-faces) |
55015061 SM |
1808 | |
1809 | (defface font-lock-warning-face | |
ea81d57e | 1810 | '((((class color) (min-colors 88) (background light)) (:foreground "Red1" :weight bold)) |
a12d182a EZ |
1811 | (((class color) (min-colors 88) (background dark)) (:foreground "Pink" :weight bold)) |
1812 | (((class color) (min-colors 16) (background light)) (:foreground "Red" :weight bold)) | |
c9341aa0 JB |
1813 | (((class color) (min-colors 16) (background dark)) (:foreground "Pink" :weight bold)) |
1814 | (((class color) (min-colors 8)) (:foreground "red")) | |
0cccb49d | 1815 | (t (:inverse-video t :weight bold))) |
55015061 | 1816 | "Font Lock mode face used to highlight warnings." |
2273c36b | 1817 | :group 'font-lock-highlighting-faces) |
2d63aa67 | 1818 | |
5d27cf9f | 1819 | (defface font-lock-negation-char-face |
39eae073 | 1820 | '((t nil)) |
5d27cf9f DP |
1821 | "Font Lock mode face used to highlight easy to overlook negation." |
1822 | :group 'font-lock-highlighting-faces) | |
1823 | ||
d654cab8 | 1824 | (defface font-lock-preprocessor-face |
c9341aa0 | 1825 | '((t :inherit font-lock-builtin-face)) |
d654cab8 SM |
1826 | "Font Lock mode face used to highlight preprocessor directives." |
1827 | :group 'font-lock-highlighting-faces) | |
1828 | ||
c711faac JL |
1829 | (defface font-lock-regexp-backslash |
1830 | '((((class color) (min-colors 16)) :inherit escape-glyph) | |
1831 | (t :inherit bold)) | |
1832 | "Font Lock mode face used to highlight a backslash in Lisp regexps." | |
1833 | :group 'font-lock-highlighting-faces) | |
1834 | ||
1835 | (defface font-lock-regexp-backslash-construct | |
1836 | '((t :inherit bold)) | |
1837 | "Font Lock mode face used to highlight `\' constructs in Lisp regexps." | |
1838 | :group 'font-lock-highlighting-faces) | |
1839 | ||
2d63aa67 | 1840 | ;;; End of Colour etc. support. |
9bfbb130 | 1841 | \f |
56fcbd7e SM |
1842 | ;;; Menu support. |
1843 | ||
1844 | ;; This section of code is commented out because Emacs does not have real menu | |
1845 | ;; buttons. (We can mimic them by putting "( ) " or "(X) " at the beginning of | |
1846 | ;; the menu entry text, but with Xt it looks both ugly and embarrassingly | |
1847 | ;; amateur.) If/When Emacs gets real menus buttons, put in menu-bar.el after | |
1848 | ;; the entry for "Text Properties" something like: | |
1849 | ;; | |
1850 | ;; (define-key menu-bar-edit-menu [font-lock] | |
9c8de95c | 1851 | ;; (cons "Syntax Highlighting" font-lock-menu)) |
56fcbd7e SM |
1852 | ;; |
1853 | ;; and remove a single ";" from the beginning of each line in the rest of this | |
1854 | ;; section. Probably the mechanism for telling the menu code what are menu | |
1855 | ;; buttons and when they are on or off needs tweaking. I have assumed that the | |
1856 | ;; mechanism is via `menu-toggle' and `menu-selected' symbol properties. sm. | |
1857 | ||
1858 | ;;;;###autoload | |
1859 | ;(progn | |
1860 | ; ;; Make the Font Lock menu. | |
1861 | ; (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting")) | |
1862 | ; ;; Add the menu items in reverse order. | |
1863 | ; (define-key font-lock-menu [fontify-less] | |
1864 | ; '("Less In Current Buffer" . font-lock-fontify-less)) | |
1865 | ; (define-key font-lock-menu [fontify-more] | |
1866 | ; '("More In Current Buffer" . font-lock-fontify-more)) | |
1867 | ; (define-key font-lock-menu [font-lock-sep] | |
1868 | ; '("--")) | |
1869 | ; (define-key font-lock-menu [font-lock-mode] | |
1870 | ; '("In Current Buffer" . font-lock-mode)) | |
1871 | ; (define-key font-lock-menu [global-font-lock-mode] | |
1872 | ; '("In All Buffers" . global-font-lock-mode))) | |
1873 | ; | |
1874 | ;;;;###autoload | |
1875 | ;(progn | |
1876 | ; ;; We put the appropriate `menu-enable' etc. symbol property values on when | |
1877 | ; ;; font-lock.el is loaded, so we don't need to autoload the three variables. | |
1878 | ; (put 'global-font-lock-mode 'menu-toggle t) | |
1879 | ; (put 'font-lock-mode 'menu-toggle t) | |
1880 | ; (put 'font-lock-fontify-more 'menu-enable '(identity)) | |
1881 | ; (put 'font-lock-fontify-less 'menu-enable '(identity))) | |
1882 | ; | |
90cbc9cd | 1883 | ; ;; Put the appropriate symbol property values on now. See above. |
9c8de95c | 1884 | ;(put 'global-font-lock-mode 'menu-selected 'global-font-lock-mode) |
56fcbd7e SM |
1885 | ;(put 'font-lock-mode 'menu-selected 'font-lock-mode) |
1886 | ;(put 'font-lock-fontify-more 'menu-enable '(nth 2 font-lock-fontify-level)) | |
1887 | ;(put 'font-lock-fontify-less 'menu-enable '(nth 1 font-lock-fontify-level)) | |
1888 | ; | |
1889 | ;(defvar font-lock-fontify-level nil) ; For less/more fontification. | |
1890 | ; | |
1891 | ;(defun font-lock-fontify-level (level) | |
1892 | ; (let ((font-lock-maximum-decoration level)) | |
1893 | ; (when font-lock-mode | |
1894 | ; (font-lock-mode)) | |
1895 | ; (font-lock-mode) | |
1896 | ; (when font-lock-verbose | |
1897 | ; (message "Fontifying %s... level %d" (buffer-name) level)))) | |
1898 | ; | |
1899 | ;(defun font-lock-fontify-less () | |
1900 | ; "Fontify the current buffer with less decoration. | |
1901 | ;See `font-lock-maximum-decoration'." | |
1902 | ; (interactive) | |
1903 | ; ;; Check in case we get called interactively. | |
1904 | ; (if (nth 1 font-lock-fontify-level) | |
1905 | ; (font-lock-fontify-level (1- (car font-lock-fontify-level))) | |
1906 | ; (error "No less decoration"))) | |
1907 | ; | |
1908 | ;(defun font-lock-fontify-more () | |
1909 | ; "Fontify the current buffer with more decoration. | |
1910 | ;See `font-lock-maximum-decoration'." | |
1911 | ; (interactive) | |
1912 | ; ;; Check in case we get called interactively. | |
1913 | ; (if (nth 2 font-lock-fontify-level) | |
1914 | ; (font-lock-fontify-level (1+ (car font-lock-fontify-level))) | |
1915 | ; (error "No more decoration"))) | |
1916 | ; | |
90cbc9cd | 1917 | ; ;; This should be called by `font-lock-set-defaults'. |
56fcbd7e SM |
1918 | ;(defun font-lock-set-menu () |
1919 | ; ;; Activate less/more fontification entries if there are multiple levels for | |
1920 | ; ;; the current buffer. Sets `font-lock-fontify-level' to be of the form | |
1921 | ; ;; (CURRENT-LEVEL IS-LOWER-LEVEL-P IS-HIGHER-LEVEL-P) for menu activation. | |
1922 | ; (let ((keywords (or (nth 0 font-lock-defaults) | |
1923 | ; (nth 1 (assq major-mode font-lock-defaults-alist)))) | |
1924 | ; (level (font-lock-value-in-major-mode font-lock-maximum-decoration))) | |
1925 | ; (make-local-variable 'font-lock-fontify-level) | |
1926 | ; (if (or (symbolp keywords) (= (length keywords) 1)) | |
1927 | ; (font-lock-unset-menu) | |
1928 | ; (cond ((eq level t) | |
1929 | ; (setq level (1- (length keywords)))) | |
1930 | ; ((or (null level) (zerop level)) | |
1931 | ; ;; The default level is usually, but not necessarily, level 1. | |
1932 | ; (setq level (- (length keywords) | |
1933 | ; (length (member (eval (car keywords)) | |
1934 | ; (mapcar 'eval (cdr keywords)))))))) | |
1935 | ; (setq font-lock-fontify-level (list level (> level 1) | |
1936 | ; (< level (1- (length keywords)))))))) | |
1937 | ; | |
90cbc9cd | 1938 | ; ;; This should be called by `font-lock-unset-defaults'. |
56fcbd7e SM |
1939 | ;(defun font-lock-unset-menu () |
1940 | ; ;; Deactivate less/more fontification entries. | |
1941 | ; (setq font-lock-fontify-level nil)) | |
2d63aa67 SM |
1942 | |
1943 | ;;; End of Menu support. | |
56fcbd7e | 1944 | \f |
9bfbb130 | 1945 | ;;; Various regexp information shared by several modes. |
90cbc9cd | 1946 | ; ;; Information specific to a single mode should go in its load library. |
030f4a35 | 1947 | |
1fed50c4 SM |
1948 | ;; Font Lock support for C, C++, Objective-C and Java modes is now in |
1949 | ;; cc-fonts.el (and required by cc-mode.el). However, the below function | |
56fcbd7e | 1950 | ;; should stay in font-lock.el, since it is used by other libraries. sm. |
2e6a15fc | 1951 | |
c1f2ffc8 | 1952 | (defun font-lock-match-c-style-declaration-item-and-skip-to-next (limit) |
2e6a15fc | 1953 | "Match, and move over, any declaration/definition item after point. |
c1f2ffc8 SM |
1954 | Matches after point, but ignores leading whitespace and `*' characters. |
1955 | Does not move further than LIMIT. | |
1956 | ||
ac6e572c SM |
1957 | The expected syntax of a declaration/definition item is `word' (preceded by |
1958 | optional whitespace and `*' characters and proceeded by optional whitespace) | |
1959 | optionally followed by a `('. Everything following the item (but belonging to | |
4cac2fc3 | 1960 | it) is expected to be skip-able by `scan-sexps', and items are expected to be |
ac6e572c | 1961 | separated with a `,' and to be terminated with a `;'. |
c1f2ffc8 SM |
1962 | |
1963 | Thus the regexp matches after point: word ( | |
1964 | ^^^^ ^ | |
1965 | Where the match subexpressions are: 1 2 | |
1966 | ||
1967 | The item is delimited by (match-beginning 1) and (match-end 1). | |
1968 | If (match-beginning 2) is non-nil, the item is followed by a `('. | |
1969 | ||
1970 | This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item." | |
c1966bb4 | 1971 | (when (looking-at "[ \n\t*]*\\(\\sw+\\)[ \t\n]*\\(((?\\)?") |
8259bf10 SM |
1972 | (when (and (match-end 2) (> (- (match-end 2) (match-beginning 2)) 1)) |
1973 | ;; If `word' is followed by a double open-paren, it's probably | |
1974 | ;; a macro used for "int myfun P_ ((int arg1))". Let's go back one | |
1975 | ;; word to try and match `myfun' rather than `P_'. | |
1976 | (let ((pos (point))) | |
c1966bb4 | 1977 | (skip-chars-backward " \t\n") |
8259bf10 | 1978 | (skip-syntax-backward "w") |
4cac2fc3 | 1979 | (unless (looking-at "\\(\\sw+\\)[ \t\n]*\\sw+[ \t\n]*\\(((?\\)?") |
8259bf10 SM |
1980 | ;; Looks like it was something else, so go back to where we |
1981 | ;; were and reset the match data by rematching. | |
1982 | (goto-char pos) | |
c1966bb4 | 1983 | (looking-at "[ \n\t*]*\\(\\sw+\\)[ \t\n]*\\(((?\\)?")))) |
2e6a15fc SM |
1984 | (save-match-data |
1985 | (condition-case nil | |
1986 | (save-restriction | |
c1966bb4 | 1987 | ;; Restrict to the LIMIT. |
2e6a15fc SM |
1988 | (narrow-to-region (point-min) limit) |
1989 | (goto-char (match-end 1)) | |
1990 | ;; Move over any item value, etc., to the next item. | |
c1966bb4 | 1991 | (while (not (looking-at "[ \t\n]*\\(\\(,\\)\\|;\\|\\'\\)")) |
2e6a15fc SM |
1992 | (goto-char (or (scan-sexps (point) 1) (point-max)))) |
1993 | (goto-char (match-end 2))) | |
1994 | (error t))))) | |
46f26fcf SM |
1995 | \f |
1996 | ;; Lisp. | |
2e6a15fc | 1997 | |
030f4a35 | 1998 | (defconst lisp-font-lock-keywords-1 |
2e6a15fc | 1999 | (eval-when-compile |
71994ae7 DP |
2000 | `(;; Definitions. |
2001 | (,(concat "(\\(def\\(" | |
2002 | ;; Function declarations. | |
2003 | "\\(advice\\|varalias\\|alias\\|generic\\|macro\\*?\\|method\\|" | |
2004 | "setf\\|subst\\*?\\|un\\*?\\|" | |
2005 | "ine-\\(condition\\|\\(?:derived\\|minor\\|generic\\)-mode\\|" | |
2006 | "method-combination\\|setf-expander\\|skeleton\\|widget\\|" | |
2007 | "function\\|\\(compiler\\|modify\\|symbol\\)-macro\\)\\)\\|" | |
2008 | ;; Variable declarations. | |
2009 | "\\(const\\(ant\\)?\\|custom\\|face\\|parameter\\|var\\)\\|" | |
2010 | ;; Structure declarations. | |
2011 | "\\(class\\|group\\|theme\\|package\\|struct\\|type\\)" | |
2012 | "\\)\\)\\>" | |
2013 | ;; Any whitespace and defined object. | |
2014 | "[ \t'\(]*" | |
2015 | "\\(setf[ \t]+\\sw+)\\|\\sw+\\)?") | |
2016 | (1 font-lock-keyword-face) | |
2017 | (9 (cond ((match-beginning 3) font-lock-function-name-face) | |
2018 | ((match-beginning 6) font-lock-variable-name-face) | |
2019 | (t font-lock-type-face)) | |
2020 | nil t)) | |
2021 | ;; Emacs Lisp autoload cookies. | |
2022 | ("^;;;###\\(autoload\\)" 1 font-lock-warning-face prepend) | |
2023 | ;; Regexp negated char group. | |
2024 | ("\\[\\(\\^\\)" 1 font-lock-negation-char-face prepend))) | |
56fcbd7e | 2025 | "Subdued level highlighting for Lisp modes.") |
030f4a35 RS |
2026 | |
2027 | (defconst lisp-font-lock-keywords-2 | |
799761f0 | 2028 | (append lisp-font-lock-keywords-1 |
2e6a15fc | 2029 | (eval-when-compile |
71994ae7 DP |
2030 | `(;; Control structures. Emacs Lisp forms. |
2031 | (,(concat | |
2032 | "(" (regexp-opt | |
c711faac | 2033 | '("cond" "if" "while" "while-no-input" "let" "let*" |
71994ae7 DP |
2034 | "prog" "progn" "progv" "prog1" "prog2" "prog*" |
2035 | "inline" "lambda" "save-restriction" "save-excursion" | |
2036 | "save-window-excursion" "save-selected-window" | |
2037 | "save-match-data" "save-current-buffer" "unwind-protect" | |
2038 | "condition-case" "track-mouse" | |
2039 | "eval-after-load" "eval-and-compile" "eval-when-compile" | |
2040 | "eval-when" | |
2041 | "with-category-table" | |
2042 | "with-current-buffer" "with-electric-help" | |
2043 | "with-local-quit" "with-no-warnings" | |
2044 | "with-output-to-string" "with-output-to-temp-buffer" | |
2045 | "with-selected-window" "with-syntax-table" | |
2046 | "with-temp-buffer" "with-temp-file" "with-temp-message" | |
2047 | "with-timeout" "with-timeout-handler") t) | |
2048 | "\\>") | |
2049 | . 1) | |
2050 | ;; Control structures. Common Lisp forms. | |
2051 | (,(concat | |
2052 | "(" (regexp-opt | |
2053 | '("when" "unless" "case" "ecase" "typecase" "etypecase" | |
2054 | "ccase" "ctypecase" "handler-case" "handler-bind" | |
2055 | "restart-bind" "restart-case" "in-package" | |
2056 | "break" "ignore-errors" | |
2057 | "loop" "do" "do*" "dotimes" "dolist" "the" "locally" | |
2058 | "proclaim" "declaim" "declare" "symbol-macrolet" | |
2059 | "lexical-let" "lexical-let*" "flet" "labels" "compiler-let" | |
2060 | "destructuring-bind" "macrolet" "tagbody" "block" "go" | |
2061 | "multiple-value-bind" "multiple-value-prog1" | |
2062 | "return" "return-from" | |
2063 | "with-accessors" "with-compilation-unit" | |
2064 | "with-condition-restarts" "with-hash-table-iterator" | |
2065 | "with-input-from-string" "with-open-file" | |
2066 | "with-open-stream" "with-output-to-string" | |
2067 | "with-package-iterator" "with-simple-restart" | |
2068 | "with-slots" "with-standard-io-syntax") t) | |
2069 | "\\>") | |
2070 | . 1) | |
2071 | ;; Exit/Feature symbols as constants. | |
2072 | (,(concat "(\\(catch\\|throw\\|featurep\\|provide\\|require\\)\\>" | |
2073 | "[ \t']*\\(\\sw+\\)?") | |
2074 | (1 font-lock-keyword-face) | |
2075 | (2 font-lock-constant-face nil t)) | |
2076 | ;; Erroneous structures. | |
2077 | ("(\\(abort\\|assert\\|warn\\|check-type\\|cerror\\|error\\|signal\\)\\>" 1 font-lock-warning-face) | |
2078 | ;; Words inside \\[] tend to be for `substitute-command-keys'. | |
2079 | ("\\\\\\\\\\[\\(\\sw+\\)]" 1 font-lock-constant-face prepend) | |
2080 | ;; Words inside `' tend to be symbol names. | |
2081 | ("`\\(\\sw\\sw+\\)'" 1 font-lock-constant-face prepend) | |
2082 | ;; Constant values. | |
2083 | ("\\<:\\sw+\\>" 0 font-lock-builtin-face) | |
2084 | ;; ELisp and CLisp `&' keywords as types. | |
2085 | ("\\&\\sw+\\>" . font-lock-type-face) | |
9605a00f SM |
2086 | ;; Make regexp grouping constructs bold, so they stand out, but only |
2087 | ;; in strings. | |
ae0c6927 | 2088 | ((lambda (bound) |
c711faac | 2089 | (if (re-search-forward "\\(\\\\\\\\\\)\\((\\(?:?:\\)?\\|[|)]\\)" bound t) |
ae0c6927 DP |
2090 | (let ((face (get-text-property (1- (point)) 'face))) |
2091 | (if (listp face) | |
2092 | (memq 'font-lock-string-face face) | |
2093 | (eq 'font-lock-string-face face))))) | |
c711faac JL |
2094 | (1 'font-lock-regexp-backslash prepend) |
2095 | (2 'font-lock-regexp-backslash-construct prepend)) | |
2096 | ||
9605a00f SM |
2097 | ;; Underline innermost grouping, so that you can more easily see what |
2098 | ;; belongs together. 2005-05-12: Font-lock can go into an | |
2099 | ;; unbreakable endless loop on this -- something's broken. | |
71994ae7 DP |
2100 | ;;("[\\][\\][(]\\(?:\\?:\\)?\\(\\(?:[^\\\"]+\\|[\\]\\(?:[^\\]\\|[\\][^(]\\)\\)+?\\)[\\][\\][)]" |
2101 | ;;1 'underline prepend) | |
90cbc9cd SM |
2102 | ;;; This is too general -- rms. |
2103 | ;;; A user complained that he has functions whose names start with `do' | |
2104 | ;;; and that they get the wrong color. | |
e6bdd6ab | 2105 | ;;; ;; CL `with-' and `do-' constructs |
71994ae7 | 2106 | ;;; ("(\\(\\(do-\\|with-\\)\\(\\s_\\|\\w\\)*\\)" 1 font-lock-keyword-face) |
2e6a15fc | 2107 | ))) |
fb512de9 | 2108 | "Gaudy level highlighting for Lisp modes.") |
030f4a35 | 2109 | |
fb512de9 SM |
2110 | (defvar lisp-font-lock-keywords lisp-font-lock-keywords-1 |
2111 | "Default expressions to highlight in Lisp modes.") | |
46f26fcf | 2112 | \f |
030f4a35 | 2113 | (provide 'font-lock) |
54f73af3 | 2114 | |
7ae3cc71 | 2115 | ;; arch-tag: 682327e4-64d8-4057-b20b-1fbb9f1fc54c |
030f4a35 | 2116 | ;;; font-lock.el ends here |