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