Commit | Line | Data |
---|---|---|
876f2438 SM |
1 | ;;; font-lock.el --- Electric font lock mode |
2 | ||
1c626aaf | 3 | ;; Copyright (C) 1992, 93, 94, 95, 96, 1997 Free Software Foundation, Inc. |
030f4a35 | 4 | |
9bfbb130 | 5 | ;; Author: jwz, then rms, then sm <simon@gnu.ai.mit.edu> |
030f4a35 RS |
6 | ;; Maintainer: FSF |
7 | ;; Keywords: languages, faces | |
8 | ||
9 | ;; This file is part of GNU Emacs. | |
10 | ||
11 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 | ;; it under the terms of the GNU General Public License as published by | |
13 | ;; the Free Software Foundation; either version 2, or (at your option) | |
14 | ;; any later version. | |
15 | ||
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
23 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 | ;; Boston, MA 02111-1307, USA. | |
030f4a35 | 25 | |
030f4a35 RS |
26 | ;;; Commentary: |
27 | ||
b89e1134 SM |
28 | ;; Font Lock mode is a minor mode that causes your comments to be displayed in |
29 | ;; one face, strings in another, reserved words in another, and so on. | |
030f4a35 RS |
30 | ;; |
31 | ;; Comments will be displayed in `font-lock-comment-face'. | |
32 | ;; Strings will be displayed in `font-lock-string-face'. | |
a1eb1cf1 | 33 | ;; Regexps are used to display selected patterns in other faces. |
030f4a35 | 34 | ;; |
9bfbb130 SM |
35 | ;; To make the text you type be fontified, use M-x font-lock-mode RET. |
36 | ;; When this minor mode is on, the faces of the current line are updated with | |
37 | ;; every insertion or deletion. | |
030f4a35 | 38 | ;; |
a2b8e66b | 39 | ;; To turn Font Lock mode on automatically, add this to your ~/.emacs file: |
030f4a35 | 40 | ;; |
b89e1134 | 41 | ;; (add-hook 'emacs-lisp-mode-hook 'turn-on-font-lock) |
030f4a35 | 42 | ;; |
a2b8e66b SM |
43 | ;; Or if you want to turn Font Lock mode on in many modes: |
44 | ;; | |
45 | ;; (global-font-lock-mode t) | |
46 | ;; | |
9bfbb130 SM |
47 | ;; Fontification for a particular mode may be available in a number of levels |
48 | ;; of decoration. The higher the level, the more decoration, but the more time | |
49 | ;; it takes to fontify. See the variable `font-lock-maximum-decoration', and | |
5aa29679 RS |
50 | ;; also the variable `font-lock-maximum-size'. Support modes for Font Lock |
51 | ;; mode can be used to speed up Font Lock mode. See `font-lock-support-mode'. | |
98f84f52 | 52 | \f |
56fcbd7e SM |
53 | ;;; How Font Lock mode fontifies: |
54 | ||
55 | ;; When Font Lock mode is turned on in a buffer, it (a) fontifies the entire | |
56 | ;; buffer and (b) installs one of its fontification functions on one of the | |
57 | ;; hook variables that are run by Emacs after every buffer change (i.e., an | |
58 | ;; insertion or deletion). Fontification means the replacement of `face' text | |
59 | ;; properties in a given region; Emacs displays text with these `face' text | |
60 | ;; properties appropriately. | |
61 | ;; | |
62 | ;; Fontification normally involves syntactic (i.e., strings and comments) and | |
ac6e572c SM |
63 | ;; regexp (i.e., keywords and everything else) passes. There are actually |
64 | ;; three passes; (a) the syntactic keyword pass, (b) the syntactic pass and (c) | |
65 | ;; the keyword pass. Confused? | |
66 | ;; | |
67 | ;; The syntactic keyword pass places `syntax-table' text properties in the | |
68 | ;; buffer according to the variable `font-lock-syntactic-keywords'. It is | |
69 | ;; necessary because Emacs' syntax table is not powerful enough to describe all | |
70 | ;; the different syntactic constructs required by the sort of people who decide | |
71 | ;; that a single quote can be syntactic or not depending on the time of day. | |
72 | ;; (What sort of person could decide to overload the meaning of a quote?) | |
73 | ;; Obviously the syntactic keyword pass must occur before the syntactic pass. | |
74 | ;; | |
75 | ;; The syntactic pass places `face' text properties in the buffer according to | |
76 | ;; syntactic context, i.e., according to the buffer's syntax table and buffer | |
77 | ;; text's `syntax-table' text properties. It involves using a syntax parsing | |
78 | ;; function to determine the context of different parts of a region of text. A | |
79 | ;; syntax parsing function is necessary because generally strings and/or | |
80 | ;; comments can span lines, and so the context of a given region is not | |
81 | ;; necessarily apparent from the content of that region. Because the keyword | |
82 | ;; pass only works within a given region, it is not generally appropriate for | |
83 | ;; syntactic fontification. This is the first fontification pass that makes | |
84 | ;; changes visible to the user; it fontifies strings and comments. | |
85 | ;; | |
86 | ;; The keyword pass places `face' text properties in the buffer according to | |
87 | ;; the variable `font-lock-keywords'. It involves searching for given regexps | |
88 | ;; (or calling given search functions) within the given region. This is the | |
89 | ;; second fontification pass that makes changes visible to the user; it | |
90 | ;; fontifies language reserved words, etc. | |
91 | ;; | |
92 | ;; Oh, and the answer is, "Yes, obviously just about everything should be done | |
93 | ;; in a single syntactic pass, but the only syntactic parser available | |
94 | ;; understands only strings and comments." Perhaps one day someone will write | |
95 | ;; some syntactic parsers for common languages and a son-of-font-lock.el could | |
96 | ;; use them rather then relying so heavily on the keyword (regexp) pass. | |
56fcbd7e | 97 | |
c1f2ffc8 SM |
98 | ;;; How Font Lock mode supports modes or is supported by modes: |
99 | ||
100 | ;; Modes that support Font Lock mode do so by defining one or more variables | |
101 | ;; whose values specify the fontification. Font Lock mode knows of these | |
102 | ;; variable names from (a) the buffer local variable `font-lock-defaults', if | |
103 | ;; non-nil, or (b) the global variable `font-lock-defaults-alist', if the major | |
104 | ;; mode has an entry. (Font Lock mode is set up via (a) where a mode's | |
105 | ;; patterns are distributed with the mode's package library, and (b) where a | |
106 | ;; mode's patterns are distributed with font-lock.el itself. An example of (a) | |
107 | ;; is Pascal mode, an example of (b) is Lisp mode. Normally, the mechanism is | |
108 | ;; (a); (b) is used where it is not clear which package library should contain | |
109 | ;; the pattern definitions.) Font Lock mode chooses which variable to use for | |
110 | ;; fontification based on `font-lock-maximum-decoration'. | |
56fcbd7e SM |
111 | ;; |
112 | ;; Font Lock mode fontification behaviour can be modified in a number of ways. | |
113 | ;; See the below comments and the comments distributed throughout this file. | |
c1f2ffc8 SM |
114 | |
115 | ;;; Constructing patterns: | |
116 | ||
98f84f52 SM |
117 | ;; See the documentation for the variable `font-lock-keywords'. |
118 | ;; | |
ac6e572c SM |
119 | ;; Efficient regexps for use as MATCHERs for `font-lock-keywords' and |
120 | ;; `font-lock-syntactic-keywords' can be generated via the function | |
121 | ;; `regexp-opt', and their depth counted via the function `regexp-opt-depth'. | |
98f84f52 | 122 | |
c1f2ffc8 SM |
123 | ;;; Adding patterns for modes that already support Font Lock: |
124 | ||
125 | ;; Though Font Lock highlighting patterns already exist for many modes, it's | |
126 | ;; likely there's something that you want fontified that currently isn't, even | |
127 | ;; at the maximum fontification level. You can add highlighting patterns via | |
128 | ;; `font-lock-add-keywords'. For example, say in some C | |
129 | ;; header file you #define the token `and' to expand to `&&', etc., to make | |
130 | ;; your C code almost readable. In your ~/.emacs there could be: | |
98f84f52 | 131 | ;; |
c1f2ffc8 | 132 | ;; (font-lock-add-keywords 'c-mode '("\\<\\(and\\|or\\|not\\)\\>")) |
98f84f52 | 133 | ;; |
c1f2ffc8 SM |
134 | ;; Some modes provide specific ways to modify patterns based on the values of |
135 | ;; other variables. For example, additional C types can be specified via the | |
136 | ;; variable `c-font-lock-extra-types'. | |
137 | ||
138 | ;;; Adding patterns for modes that do not support Font Lock: | |
139 | ||
140 | ;; Not all modes support Font Lock mode. If you (as a user of the mode) add | |
141 | ;; patterns for a new mode, you must define in your ~/.emacs a variable or | |
142 | ;; variables that specify regexp fontification. Then, you should indicate to | |
143 | ;; Font Lock mode, via the mode hook setting `font-lock-defaults', exactly what | |
144 | ;; support is required. For example, say Foo mode should have the following | |
145 | ;; regexps fontified case-sensitively, and comments and strings should not be | |
146 | ;; fontified automagically. In your ~/.emacs there could be: | |
98f84f52 | 147 | ;; |
c1f2ffc8 SM |
148 | ;; (defvar foo-font-lock-keywords |
149 | ;; '(("\\<\\(one\\|two\\|three\\)\\>" . font-lock-keyword-face) | |
150 | ;; ("\\<\\(four\\|five\\|six\\)\\>" . font-lock-type-face)) | |
151 | ;; "Default expressions to highlight in Foo mode.") | |
98f84f52 | 152 | ;; |
c1f2ffc8 SM |
153 | ;; (add-hook 'foo-mode-hook |
154 | ;; (function (lambda () | |
155 | ;; (make-local-variable 'font-lock-defaults) | |
156 | ;; (setq font-lock-defaults '(foo-font-lock-keywords t))))) | |
157 | ||
158 | ;;; Adding Font Lock support for modes: | |
159 | ||
160 | ;; Of course, it would be better that the mode already supports Font Lock mode. | |
161 | ;; The package author would do something similar to above. The mode must | |
162 | ;; define at the top-level a variable or variables that specify regexp | |
163 | ;; fontification. Then, the mode command should indicate to Font Lock mode, | |
164 | ;; via `font-lock-defaults', exactly what support is required. For example, | |
165 | ;; say Bar mode should have the following regexps fontified case-insensitively, | |
166 | ;; and comments and strings should be fontified automagically. In bar.el there | |
167 | ;; could be: | |
98f84f52 | 168 | ;; |
c1f2ffc8 SM |
169 | ;; (defvar bar-font-lock-keywords |
170 | ;; '(("\\<\\(uno\\|due\\|tre\\)\\>" . font-lock-keyword-face) | |
171 | ;; ("\\<\\(quattro\\|cinque\\|sei\\)\\>" . font-lock-type-face)) | |
172 | ;; "Default expressions to highlight in Bar mode.") | |
98f84f52 | 173 | ;; |
c1f2ffc8 | 174 | ;; and within `bar-mode' there could be: |
98f84f52 | 175 | ;; |
c1f2ffc8 SM |
176 | ;; (make-local-variable 'font-lock-defaults) |
177 | ;; (setq font-lock-defaults '(bar-font-lock-keywords nil t)) | |
98f84f52 | 178 | \f |
9bfbb130 SM |
179 | ;; What is fontification for? You might say, "It's to make my code look nice." |
180 | ;; I think it should be for adding information in the form of cues. These cues | |
181 | ;; should provide you with enough information to both (a) distinguish between | |
182 | ;; different items, and (b) identify the item meanings, without having to read | |
183 | ;; the items and think about it. Therefore, fontification allows you to think | |
184 | ;; less about, say, the structure of code, and more about, say, why the code | |
185 | ;; doesn't work. Or maybe it allows you to think less and drift off to sleep. | |
186 | ;; | |
187 | ;; So, here are my opinions/advice/guidelines: | |
188 | ;; | |
7d7d915a SM |
189 | ;; - Highlight conceptual objects, such as function and variable names, and |
190 | ;; different objects types differently, i.e., (a) and (b) above, highlight | |
191 | ;; function names differently to variable names. | |
192 | ;; - Keep the faces distinct from each other as far as possible. | |
193 | ;; i.e., (a) above. | |
9bfbb130 SM |
194 | ;; - Use the same face for the same conceptual object, across all modes. |
195 | ;; i.e., (b) above, all modes that have items that can be thought of as, say, | |
196 | ;; keywords, should be highlighted with the same face, etc. | |
9bfbb130 SM |
197 | ;; - Make the face attributes fit the concept as far as possible. |
198 | ;; i.e., function names might be a bold colour such as blue, comments might | |
199 | ;; be a bright colour such as red, character strings might be brown, because, | |
200 | ;; err, strings are brown (that was not the reason, please believe me). | |
201 | ;; - Don't use a non-nil OVERRIDE unless you have a good reason. | |
202 | ;; Only use OVERRIDE for special things that are easy to define, such as the | |
203 | ;; way `...' quotes are treated in strings and comments in Emacs Lisp mode. | |
204 | ;; Don't use it to, say, highlight keywords in commented out code or strings. | |
205 | ;; - Err, that's it. | |
a1eb1cf1 | 206 | \f |
2e6a15fc SM |
207 | ;;; Code: |
208 | ||
2273c36b | 209 | ;; Define core `font-lock' group. |
55015061 SM |
210 | (defgroup font-lock nil |
211 | "Font Lock mode text highlighting package." | |
212 | :link '(custom-manual "(emacs)Font Lock") | |
213 | :group 'faces) | |
214 | ||
2273c36b SM |
215 | (defgroup font-lock-highlighting-faces nil |
216 | "Faces for highlighting text." | |
55015061 | 217 | :prefix "font-lock-" |
2273c36b SM |
218 | :group 'font-lock) |
219 | ||
220 | (defgroup font-lock-extra-types nil | |
221 | "Extra mode-specific type names for highlighting declarations." | |
222 | :group 'font-lock) | |
223 | ||
ac6e572c | 224 | ;; Define support mode groups here to impose `font-lock' group order. |
2273c36b SM |
225 | (defgroup fast-lock nil |
226 | "Font Lock support mode to cache fontification." | |
227 | :link '(custom-manual "(emacs)Support Modes") | |
228 | :load 'fast-lock | |
229 | :group 'font-lock) | |
230 | ||
231 | (defgroup lazy-lock nil | |
232 | "Font Lock support mode to fontify lazily." | |
233 | :link '(custom-manual "(emacs)Support Modes") | |
234 | :load 'lazy-lock | |
55015061 SM |
235 | :group 'font-lock) |
236 | \f | |
9bfbb130 SM |
237 | ;; User variables. |
238 | ||
55015061 | 239 | (defcustom font-lock-verbose (* 0 1024) |
5aa29679 | 240 | "*If non-nil, means show status messages for buffer fontification. |
55015061 | 241 | If a number, only buffers greater than this size have fontification messages." |
b34aa0a3 SM |
242 | :type '(choice (const :tag "never" nil) |
243 | (const :tag "always" t) | |
244 | (integer :tag "size")) | |
55015061 | 245 | :group 'font-lock) |
9bfbb130 | 246 | |
55015061 | 247 | (defcustom font-lock-maximum-decoration t |
2d9cdda8 | 248 | "*Maximum decoration level for fontification. |
9bfbb130 SM |
249 | If nil, use the default decoration (typically the minimum available). |
250 | If t, use the maximum decoration available. | |
251 | If a number, use that level of decoration (or if not available the maximum). | |
252 | If a list, each element should be a cons pair of the form (MAJOR-MODE . LEVEL), | |
253 | where MAJOR-MODE is a symbol or t (meaning the default). For example: | |
5aa29679 RS |
254 | ((c-mode . t) (c++-mode . 2) (t . 1)) |
255 | means use the maximum decoration available for buffers in C mode, level 2 | |
55015061 | 256 | decoration for buffers in C++ mode, and level 1 decoration otherwise." |
b34aa0a3 SM |
257 | :type '(choice (const :tag "default" nil) |
258 | (const :tag "maximum" t) | |
259 | (integer :tag "level" 1) | |
260 | (repeat :menu-tag "mode specific" :tag "mode specific" | |
261 | :value ((t . t)) | |
262 | (cons :tag "Instance" | |
263 | (radio :tag "Mode" | |
264 | (const :tag "all" t) | |
265 | (symbol :tag "name")) | |
266 | (radio :tag "Decoration" | |
267 | (const :tag "default" nil) | |
268 | (const :tag "maximum" t) | |
269 | (integer :tag "level" 1))))) | |
55015061 SM |
270 | :group 'font-lock) |
271 | ||
272 | (defcustom font-lock-maximum-size (* 250 1024) | |
2d9cdda8 | 273 | "*Maximum size of a buffer for buffer fontification. |
9bfbb130 SM |
274 | Only buffers less than this can be fontified when Font Lock mode is turned on. |
275 | If nil, means size is irrelevant. | |
276 | If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE), | |
277 | where MAJOR-MODE is a symbol or t (meaning the default). For example: | |
5aa29679 RS |
278 | ((c-mode . 256000) (c++-mode . 256000) (rmail-mode . 1048576)) |
279 | means that the maximum size is 250K for buffers in C or C++ modes, one megabyte | |
55015061 | 280 | for buffers in Rmail mode, and size is irrelevant otherwise." |
b34aa0a3 SM |
281 | :type '(choice (const :tag "none" nil) |
282 | (integer :tag "size") | |
283 | (repeat :menu-tag "mode specific" :tag "mode specific" | |
284 | :value ((t . nil)) | |
285 | (cons :tag "Instance" | |
286 | (radio :tag "Mode" | |
287 | (const :tag "all" t) | |
288 | (symbol :tag "name")) | |
289 | (radio :tag "Size" | |
290 | (const :tag "none" nil) | |
291 | (integer :tag "size"))))) | |
55015061 | 292 | :group 'font-lock) |
9bfbb130 SM |
293 | \f |
294 | ;; Fontification variables: | |
295 | ||
030f4a35 | 296 | (defvar font-lock-keywords nil |
ac6e572c | 297 | "A list of the keywords to highlight. |
d46c21ec | 298 | Each element should be of the form: |
a1eb1cf1 | 299 | |
826b2925 SM |
300 | MATCHER |
301 | (MATCHER . MATCH) | |
302 | (MATCHER . FACENAME) | |
303 | (MATCHER . HIGHLIGHT) | |
304 | (MATCHER HIGHLIGHT ...) | |
a078558d | 305 | (eval . FORM) |
a1eb1cf1 | 306 | |
9bfbb130 SM |
307 | where HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED. |
308 | ||
a078558d SM |
309 | FORM is an expression, whose value should be a keyword element, evaluated when |
310 | the keyword is (first) used in a buffer. This feature can be used to provide a | |
311 | keyword that can only be generated when Font Lock mode is actually turned on. | |
312 | ||
9bfbb130 | 313 | For highlighting single items, typically only MATCH-HIGHLIGHT is required. |
d9f7b2d3 | 314 | However, if an item or (typically) items are to be highlighted following the |
9bfbb130 SM |
315 | instance of another item (the anchor) then MATCH-ANCHORED may be required. |
316 | ||
317 | MATCH-HIGHLIGHT should be of the form: | |
318 | ||
319 | (MATCH FACENAME OVERRIDE LAXMATCH) | |
320 | ||
321 | Where MATCHER can be either the regexp to search for, or the function name to | |
322 | call to make the search (called with one argument, the limit of the search). | |
ac6e572c SM |
323 | MATCHER regexps can be generated via the function `regexp-opt'. MATCH is the |
324 | subexpression of MATCHER to be highlighted. MATCH can be calculated via the | |
325 | function `regexp-opt-depth'. FACENAME is an expression whose value is the face | |
326 | name to use. Face default attributes can be modified via \\[customize]. | |
a1eb1cf1 | 327 | |
2d63aa67 | 328 | OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification can |
9bfbb130 SM |
329 | be overwritten. If `keep', only parts not already fontified are highlighted. |
330 | If `prepend' or `append', existing fontification is merged with the new, in | |
331 | which the new or existing fontification, respectively, takes precedence. | |
d9f7b2d3 | 332 | If LAXMATCH is non-nil, no error is signaled if there is no MATCH in MATCHER. |
a1eb1cf1 | 333 | |
9bfbb130 SM |
334 | For example, an element of the form highlights (if not already highlighted): |
335 | ||
876f2438 SM |
336 | \"\\\\\\=<foo\\\\\\=>\" Discrete occurrences of \"foo\" in the value of the |
337 | variable `font-lock-keyword-face'. | |
9bfbb130 SM |
338 | (\"fu\\\\(bar\\\\)\" . 1) Substring \"bar\" within all occurrences of \"fubar\" in |
339 | the value of `font-lock-keyword-face'. | |
340 | (\"fubar\" . fubar-face) Occurrences of \"fubar\" in the value of `fubar-face'. | |
341 | (\"foo\\\\|bar\" 0 foo-bar-face t) | |
342 | Occurrences of either \"foo\" or \"bar\" in the value | |
343 | of `foo-bar-face', even if already highlighted. | |
344 | ||
345 | MATCH-ANCHORED should be of the form: | |
346 | ||
347 | (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...) | |
348 | ||
56fcbd7e | 349 | Where MATCHER is as for MATCH-HIGHLIGHT with one exception; see below. |
876f2438 SM |
350 | PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after |
351 | the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be | |
352 | used to initialise before, and cleanup after, MATCHER is used. Typically, | |
353 | PRE-MATCH-FORM is used to move to some position relative to the original | |
354 | MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might | |
355 | be used to move, before resuming with MATCH-ANCHORED's parent's MATCHER. | |
9bfbb130 SM |
356 | |
357 | For example, an element of the form highlights (if not already highlighted): | |
358 | ||
876f2438 | 359 | (\"\\\\\\=<anchor\\\\\\=>\" (0 anchor-face) (\"\\\\\\=<item\\\\\\=>\" nil nil (0 item-face))) |
9bfbb130 | 360 | |
876f2438 SM |
361 | Discrete occurrences of \"anchor\" in the value of `anchor-face', and subsequent |
362 | discrete occurrences of \"item\" (on the same line) in the value of `item-face'. | |
363 | (Here PRE-MATCH-FORM and POST-MATCH-FORM are nil. Therefore \"item\" is | |
364 | initially searched for starting from the end of the match of \"anchor\", and | |
365 | searching for subsequent instance of \"anchor\" resumes from where searching | |
366 | for \"item\" concluded.) | |
9bfbb130 | 367 | |
56fcbd7e SM |
368 | The above-mentioned exception is as follows. The limit of the MATCHER search |
369 | defaults to the end of the line after PRE-MATCH-FORM is evaluated. | |
370 | However, if PRE-MATCH-FORM returns a position greater than the position after | |
371 | PRE-MATCH-FORM is evaluated, that position is used as the limit of the search. | |
372 | It is generally a bad idea to return a position greater than the end of the | |
373 | line, i.e., cause the MATCHER search to span lines. | |
374 | ||
9bfbb130 SM |
375 | Note that the MATCH-ANCHORED feature is experimental; in the future, we may |
376 | replace it with other ways of providing this functionality. | |
377 | ||
a1eb1cf1 RS |
378 | These regular expressions should not match text which spans lines. While |
379 | \\[font-lock-fontify-buffer] handles multi-line patterns correctly, updating | |
380 | when you edit the buffer does not, since it considers text one line at a time. | |
381 | ||
2d63aa67 SM |
382 | This variable is set by major modes via the variable `font-lock-defaults'. |
383 | Be careful when composing regexps for this list; a poorly written pattern can | |
384 | dramatically slow things down!") | |
030f4a35 | 385 | |
2e6a15fc SM |
386 | ;; This variable is used by mode packages that support Font Lock mode by |
387 | ;; defining their own keywords to use for `font-lock-keywords'. (The mode | |
388 | ;; command should make it buffer-local and set it to provide the set up.) | |
b89e1134 | 389 | (defvar font-lock-defaults nil |
2d63aa67 SM |
390 | "Defaults for Font Lock mode specified by the major mode. |
391 | Defaults should be of the form: | |
392 | ||
393 | (KEYWORDS KEYWORDS-ONLY CASE-FOLD SYNTAX-ALIST SYNTAX-BEGIN ...) | |
394 | ||
395 | KEYWORDS may be a symbol (a variable or function whose value is the keywords to | |
396 | use for fontification) or a list of symbols. If KEYWORDS-ONLY is non-nil, | |
397 | syntactic fontification (strings and comments) is not performed. | |
398 | If CASE-FOLD is non-nil, the case of the keywords is ignored when fontifying. | |
399 | If SYNTAX-ALIST is non-nil, it should be a list of cons pairs of the form | |
400 | \(CHAR-OR-STRING . STRING) used to set the local Font Lock syntax table, for | |
401 | keyword and syntactic fontification (see `modify-syntax-entry'). | |
402 | ||
403 | If SYNTAX-BEGIN is non-nil, it should be a function with no args used to move | |
404 | backwards outside any enclosing syntactic block, for syntactic fontification. | |
405 | Typical values are `beginning-of-line' (i.e., the start of the line is known to | |
406 | be outside a syntactic block), or `beginning-of-defun' for programming modes or | |
407 | `backward-paragraph' for textual modes (i.e., the mode-dependent function is | |
408 | known to move outside a syntactic block). If nil, the beginning of the buffer | |
409 | is used as a position outside of a syntactic block, in the worst case. | |
410 | ||
411 | These item elements are used by Font Lock mode to set the variables | |
412 | `font-lock-keywords', `font-lock-keywords-only', | |
413 | `font-lock-keywords-case-fold-search', `font-lock-syntax-table' and | |
414 | `font-lock-beginning-of-syntax-function', respectively. | |
415 | ||
416 | Further item elements are alists of the form (VARIABLE . VALUE) and are in no | |
417 | particular order. Each VARIABLE is made buffer-local before set to VALUE. | |
418 | ||
419 | Currently, appropriate variables include `font-lock-mark-block-function'. | |
420 | If this is non-nil, it should be a function with no args used to mark any | |
421 | enclosing block of text, for fontification via \\[font-lock-fontify-block]. | |
422 | Typical values are `mark-defun' for programming modes or `mark-paragraph' for | |
423 | textual modes (i.e., the mode-dependent function is known to put point and mark | |
424 | around a text block relevant to that mode). | |
425 | ||
426 | Other variables include those for buffer-specialised fontification functions, | |
427 | `font-lock-fontify-buffer-function', `font-lock-unfontify-buffer-function', | |
428 | `font-lock-fontify-region-function', `font-lock-unfontify-region-function', | |
55015061 | 429 | `font-lock-inhibit-thing-lock' and `font-lock-maximum-size'.") |
b89e1134 | 430 | |
2e6a15fc | 431 | ;; This variable is used where font-lock.el itself supplies the keywords. |
b89e1134 | 432 | (defvar font-lock-defaults-alist |
2e6a15fc SM |
433 | (let (;; We use `beginning-of-defun', rather than nil, for SYNTAX-BEGIN. |
434 | ;; Thus the calculation of the cache is usually faster but not | |
435 | ;; infallible, so we risk mis-fontification. sm. | |
fb512de9 | 436 | (c-mode-defaults |
9bfbb130 SM |
437 | '((c-font-lock-keywords c-font-lock-keywords-1 |
438 | c-font-lock-keywords-2 c-font-lock-keywords-3) | |
a078558d | 439 | nil nil ((?_ . "w")) beginning-of-defun |
55015061 SM |
440 | ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP. |
441 | ;(font-lock-comment-start-regexp . "/[*/]") | |
a078558d | 442 | (font-lock-mark-block-function . mark-defun))) |
fb512de9 SM |
443 | (c++-mode-defaults |
444 | '((c++-font-lock-keywords c++-font-lock-keywords-1 | |
9bfbb130 | 445 | c++-font-lock-keywords-2 c++-font-lock-keywords-3) |
55015061 SM |
446 | nil nil ((?_ . "w")) beginning-of-defun |
447 | ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP. | |
448 | ;(font-lock-comment-start-regexp . "/[*/]") | |
a078558d | 449 | (font-lock-mark-block-function . mark-defun))) |
2e6a15fc SM |
450 | (objc-mode-defaults |
451 | '((objc-font-lock-keywords objc-font-lock-keywords-1 | |
452 | objc-font-lock-keywords-2 objc-font-lock-keywords-3) | |
453 | nil nil ((?_ . "w") (?$ . "w")) nil | |
55015061 SM |
454 | ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP. |
455 | ;(font-lock-comment-start-regexp . "/[*/]") | |
2e6a15fc SM |
456 | (font-lock-mark-block-function . mark-defun))) |
457 | (java-mode-defaults | |
458 | '((java-font-lock-keywords java-font-lock-keywords-1 | |
459 | java-font-lock-keywords-2 java-font-lock-keywords-3) | |
460 | nil nil ((?_ . "w") (?$ . "w") (?. . "w")) nil | |
55015061 SM |
461 | ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP. |
462 | ;(font-lock-comment-start-regexp . "/[*/]") | |
2e6a15fc | 463 | (font-lock-mark-block-function . mark-defun))) |
fb512de9 | 464 | (lisp-mode-defaults |
9bfbb130 SM |
465 | '((lisp-font-lock-keywords |
466 | lisp-font-lock-keywords-1 lisp-font-lock-keywords-2) | |
5aa29679 | 467 | nil nil (("+-*/.<>=!?$%_&~^:" . "w")) beginning-of-defun |
55015061 SM |
468 | ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP. |
469 | ;(font-lock-comment-start-regexp . ";") | |
5aa29679 | 470 | (font-lock-mark-block-function . mark-defun))) |
d46c21ec | 471 | (scheme-mode-defaults |
5aa29679 RS |
472 | '(scheme-font-lock-keywords |
473 | nil t (("+-*/.<>=!?$%_&~^:" . "w")) beginning-of-defun | |
55015061 SM |
474 | ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP. |
475 | ;(font-lock-comment-start-regexp . ";") | |
5aa29679 | 476 | (font-lock-mark-block-function . mark-defun))) |
d46c21ec | 477 | ;; For TeX modes we could use `backward-paragraph' for the same reason. |
a078558d SM |
478 | ;; But we don't, because paragraph breaks are arguably likely enough to |
479 | ;; occur within a genuine syntactic block to make it too risky. | |
480 | ;; However, we do specify a MARK-BLOCK function as that cannot result | |
481 | ;; in a mis-fontification even if it might not fontify enough. --sm. | |
98f84f52 SM |
482 | (tex-mode-defaults |
483 | '(tex-font-lock-keywords nil nil ((?$ . "\"")) nil | |
55015061 SM |
484 | ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP. |
485 | ;(font-lock-comment-start-regexp . "%") | |
98f84f52 | 486 | (font-lock-mark-block-function . mark-paragraph))) |
d46c21ec | 487 | ) |
826b2925 | 488 | (list |
d46c21ec | 489 | (cons 'c-mode c-mode-defaults) |
2e6a15fc SM |
490 | (cons 'c++-mode c++-mode-defaults) |
491 | (cons 'objc-mode objc-mode-defaults) | |
492 | (cons 'java-mode java-mode-defaults) | |
d46c21ec SM |
493 | (cons 'emacs-lisp-mode lisp-mode-defaults) |
494 | (cons 'inferior-scheme-mode scheme-mode-defaults) | |
495 | (cons 'latex-mode tex-mode-defaults) | |
496 | (cons 'lisp-mode lisp-mode-defaults) | |
497 | (cons 'lisp-interaction-mode lisp-mode-defaults) | |
498 | (cons 'plain-tex-mode tex-mode-defaults) | |
499 | (cons 'scheme-mode scheme-mode-defaults) | |
500 | (cons 'scheme-interaction-mode scheme-mode-defaults) | |
501 | (cons 'slitex-mode tex-mode-defaults) | |
502 | (cons 'tex-mode tex-mode-defaults))) | |
2d63aa67 | 503 | "Alist of fall-back Font Lock defaults for major modes. |
b89e1134 | 504 | Each item should be a list of the form: |
d46c21ec | 505 | |
2d63aa67 | 506 | (MAJOR-MODE . FONT-LOCK-DEFAULTS) |
a2b8e66b | 507 | |
2d63aa67 SM |
508 | where MAJOR-MODE is a symbol and FONT-LOCK-DEFAULTS is a list of default |
509 | settings. See the variable `font-lock-defaults', which takes precedence.") | |
d46c21ec | 510 | |
c1f2ffc8 SM |
511 | (defvar font-lock-keywords-alist nil |
512 | "*Alist of `font-lock-keywords' local to a `major-mode'. | |
513 | This is normally set via `font-lock-add-keywords'.") | |
514 | ||
9bfbb130 | 515 | (defvar font-lock-keywords-only nil |
d46c21ec SM |
516 | "*Non-nil means Font Lock should not fontify comments or strings. |
517 | This is normally set via `font-lock-defaults'.") | |
b89e1134 | 518 | |
030f4a35 | 519 | (defvar font-lock-keywords-case-fold-search nil |
d46c21ec SM |
520 | "*Non-nil means the patterns in `font-lock-keywords' are case-insensitive. |
521 | This is normally set via `font-lock-defaults'.") | |
030f4a35 | 522 | |
ac6e572c SM |
523 | (defvar font-lock-syntactic-keywords nil |
524 | "A list of the syntactic keywords to highlight. | |
525 | Can be the list or the name of a function or variable whose value is the list. | |
526 | See `font-lock-keywords' for a description of the form of this list; | |
527 | the differences are listed below. MATCH-HIGHLIGHT should be of the form: | |
528 | ||
529 | (MATCH SYNTAX OVERRIDE LAXMATCH) | |
530 | ||
531 | where SYNTAX can be of the form (SYNTAX-CODE . MATCHING-CHAR), the name of a | |
532 | syntax table, or an expression whose value is such a form or a syntax table. | |
533 | OVERRIDE cannot be `prepend' or `append'. | |
534 | ||
535 | This is normally set via `font-lock-defaults'.") | |
536 | ||
b056da51 | 537 | (defvar font-lock-syntax-table nil |
799761f0 | 538 | "Non-nil means use this syntax table for fontifying. |
d46c21ec SM |
539 | If this is nil, the major mode's syntax table is used. |
540 | This is normally set via `font-lock-defaults'.") | |
541 | ||
9bfbb130 SM |
542 | ;; If this is nil, we only use the beginning of the buffer if we can't use |
543 | ;; `font-lock-cache-position' and `font-lock-cache-state'. | |
d46c21ec | 544 | (defvar font-lock-beginning-of-syntax-function nil |
9bfbb130 | 545 | "*Non-nil means use this function to move back outside of a syntactic block. |
a078558d SM |
546 | When called with no args it should leave point at the beginning of any |
547 | enclosing syntactic block. | |
9bfbb130 | 548 | If this is nil, the beginning of the buffer is used (in the worst case). |
d46c21ec | 549 | This is normally set via `font-lock-defaults'.") |
b056da51 | 550 | |
a078558d SM |
551 | (defvar font-lock-mark-block-function nil |
552 | "*Non-nil means use this function to mark a block of text. | |
553 | When called with no args it should leave point at the beginning of any | |
554 | enclosing textual block and mark at the end. | |
555 | This is normally set via `font-lock-defaults'.") | |
556 | ||
55015061 SM |
557 | ;; Obsoleted by Emacs 19.35 parse-partial-sexp's COMMENTSTOP. |
558 | ;(defvar font-lock-comment-start-regexp nil | |
559 | ; "*Regexp to match the start of a comment. | |
560 | ;This need not discriminate between genuine comments and quoted comment | |
561 | ;characters or comment characters within strings. | |
562 | ;If nil, `comment-start-skip' is used instead; see that variable for more info. | |
563 | ;This is normally set via `font-lock-defaults'.") | |
98f84f52 | 564 | |
a2b8e66b SM |
565 | (defvar font-lock-fontify-buffer-function 'font-lock-default-fontify-buffer |
566 | "Function to use for fontifying the buffer. | |
567 | This is normally set via `font-lock-defaults'.") | |
568 | ||
569 | (defvar font-lock-unfontify-buffer-function 'font-lock-default-unfontify-buffer | |
570 | "Function to use for unfontifying the buffer. | |
571 | This is used when turning off Font Lock mode. | |
572 | This is normally set via `font-lock-defaults'.") | |
573 | ||
574 | (defvar font-lock-fontify-region-function 'font-lock-default-fontify-region | |
575 | "Function to use for fontifying a region. | |
576 | It should take two args, the beginning and end of the region, and an optional | |
577 | third arg VERBOSE. If non-nil, the function should print status messages. | |
578 | This is normally set via `font-lock-defaults'.") | |
579 | ||
580 | (defvar font-lock-unfontify-region-function 'font-lock-default-unfontify-region | |
581 | "Function to use for unfontifying a region. | |
582 | It should take two args, the beginning and end of the region. | |
583 | This is normally set via `font-lock-defaults'.") | |
584 | ||
585 | (defvar font-lock-inhibit-thing-lock nil | |
586 | "List of Font Lock mode related modes that should not be turned on. | |
587 | Currently, valid mode names as `fast-lock-mode' and `lazy-lock-mode'. | |
588 | This is normally set via `font-lock-defaults'.") | |
589 | ||
1c626aaf | 590 | (defvar font-lock-mode nil) ; Whether we are turned on/modeline. |
9bfbb130 | 591 | (defvar font-lock-fontified nil) ; Whether we have fontified the buffer. |
826b2925 | 592 | |
9bfbb130 SM |
593 | ;;;###autoload |
594 | (defvar font-lock-mode-hook nil | |
595 | "Function or functions to run on entry to Font Lock mode.") | |
030f4a35 | 596 | \f |
5aa29679 RS |
597 | ;; Font Lock mode. |
598 | ||
599 | (eval-when-compile | |
2e6a15fc | 600 | ;; |
5aa29679 | 601 | ;; We don't do this at the top-level as we only use non-autoloaded macros. |
2e6a15fc SM |
602 | (require 'cl) |
603 | ;; | |
604 | ;; Borrowed from lazy-lock.el. | |
605 | ;; We use this to preserve or protect things when modifying text properties. | |
606 | (defmacro save-buffer-state (varlist &rest body) | |
607 | "Bind variables according to VARLIST and eval BODY restoring buffer state." | |
608 | (` (let* ((,@ (append varlist | |
55015061 SM |
609 | '((modified (buffer-modified-p)) (buffer-undo-list t) |
610 | (inhibit-read-only t) (inhibit-point-motion-hooks t) | |
2e6a15fc SM |
611 | before-change-functions after-change-functions |
612 | deactivate-mark buffer-file-name buffer-file-truename)))) | |
613 | (,@ body) | |
614 | (when (and (not modified) (buffer-modified-p)) | |
615 | (set-buffer-modified-p nil))))) | |
616 | (put 'save-buffer-state 'lisp-indent-function 1)) | |
030f4a35 RS |
617 | |
618 | ;;;###autoload | |
619 | (defun font-lock-mode (&optional arg) | |
e595fa35 | 620 | "Toggle Font Lock mode. |
030f4a35 RS |
621 | With arg, turn Font Lock mode on if and only if arg is positive. |
622 | ||
623 | When Font Lock mode is enabled, text is fontified as you type it: | |
624 | ||
a1eb1cf1 RS |
625 | - Comments are displayed in `font-lock-comment-face'; |
626 | - Strings are displayed in `font-lock-string-face'; | |
627 | - Certain other expressions are displayed in other faces according to the | |
628 | value of the variable `font-lock-keywords'. | |
629 | ||
630 | You can enable Font Lock mode in any major mode automatically by turning on in | |
631 | the major mode's hook. For example, put in your ~/.emacs: | |
632 | ||
633 | (add-hook 'c-mode-hook 'turn-on-font-lock) | |
634 | ||
a2b8e66b | 635 | Alternatively, you can use Global Font Lock mode to automagically turn on Font |
fd23afbe SM |
636 | Lock mode in buffers whose major mode supports it and whose major mode is one |
637 | of `font-lock-global-modes'. For example, put in your ~/.emacs: | |
a2b8e66b SM |
638 | |
639 | (global-font-lock-mode t) | |
640 | ||
fd23afbe SM |
641 | There are a number of support modes that may be used to speed up Font Lock mode |
642 | in various ways, specified via the variable `font-lock-support-mode'. Where | |
643 | major modes support different levels of fontification, you can use the variable | |
fb512de9 | 644 | `font-lock-maximum-decoration' to specify which level you generally prefer. |
b89e1134 SM |
645 | When you turn Font Lock mode on/off the buffer is fontified/defontified, though |
646 | fontification occurs only if the buffer is less than `font-lock-maximum-size'. | |
7d7d915a | 647 | |
fd23afbe SM |
648 | For example, to specify that Font Lock mode use use Lazy Lock mode as a support |
649 | mode and use maximum levels of fontification, put in your ~/.emacs: | |
650 | ||
651 | (setq font-lock-support-mode 'lazy-lock-mode) | |
652 | (setq font-lock-maximum-decoration t) | |
653 | ||
56fcbd7e SM |
654 | To add your own highlighting for some major mode, and modify the highlighting |
655 | selected automatically via the variable `font-lock-maximum-decoration', you can | |
656 | use `font-lock-add-keywords'. | |
657 | ||
7d7d915a SM |
658 | To fontify a buffer, without turning on Font Lock mode and regardless of buffer |
659 | size, you can use \\[font-lock-fontify-buffer]. | |
a078558d SM |
660 | |
661 | To fontify a block (the function or paragraph containing point, or a number of | |
662 | lines around point), perhaps because modification on the current line caused | |
fd23afbe SM |
663 | syntactic change on other lines, you can use \\[font-lock-fontify-block]. |
664 | ||
2273c36b SM |
665 | See the variable `font-lock-defaults-alist' for the Font Lock mode default |
666 | settings. You can set your own default settings for some mode, by setting a | |
667 | buffer local value for `font-lock-defaults', via its mode hook." | |
030f4a35 | 668 | (interactive "P") |
a2b8e66b SM |
669 | ;; Don't turn on Font Lock mode if we don't have a display (we're running a |
670 | ;; batch job) or if the buffer is invisible (the name starts with a space). | |
5aa29679 | 671 | (let ((on-p (and (not noninteractive) |
a2b8e66b SM |
672 | (not (eq (aref (buffer-name) 0) ?\ )) |
673 | (if arg | |
674 | (> (prefix-numeric-value arg) 0) | |
343204bd | 675 | (not font-lock-mode))))) |
030f4a35 | 676 | (set (make-local-variable 'font-lock-mode) on-p) |
5aa29679 RS |
677 | ;; Turn on Font Lock mode. |
678 | (when on-p | |
2e6a15fc SM |
679 | (make-local-hook 'after-change-functions) |
680 | (add-hook 'after-change-functions 'font-lock-after-change-function nil t) | |
5aa29679 RS |
681 | (font-lock-set-defaults) |
682 | (font-lock-turn-on-thing-lock) | |
683 | (run-hooks 'font-lock-mode-hook) | |
684 | ;; Fontify the buffer if we have to. | |
685 | (let ((max-size (font-lock-value-in-major-mode font-lock-maximum-size))) | |
686 | (cond (font-lock-fontified | |
687 | nil) | |
688 | ((or (null max-size) (> max-size (buffer-size))) | |
689 | (font-lock-fontify-buffer)) | |
690 | (font-lock-verbose | |
691 | (message "Fontifying %s...buffer too big" (buffer-name)))))) | |
692 | ;; Turn off Font Lock mode. | |
2e6a15fc | 693 | (unless on-p |
5aa29679 RS |
694 | (remove-hook 'after-change-functions 'font-lock-after-change-function t) |
695 | (font-lock-unfontify-buffer) | |
696 | (font-lock-turn-off-thing-lock) | |
697 | (font-lock-unset-defaults)) | |
030f4a35 RS |
698 | (force-mode-line-update))) |
699 | ||
a1eb1cf1 RS |
700 | ;;;###autoload |
701 | (defun turn-on-font-lock () | |
a465832f | 702 | "Turn on Font Lock mode conditionally. |
fd23afbe | 703 | Turn on only if the terminal can display it." |
56fcbd7e SM |
704 | (when (and (not font-lock-mode) window-system) |
705 | (font-lock-mode))) | |
c1f2ffc8 SM |
706 | |
707 | ;;;###autoload | |
708 | (defun font-lock-add-keywords (major-mode keywords &optional append) | |
709 | "Add highlighting KEYWORDS for MAJOR-MODE. | |
1c626aaf SM |
710 | MAJOR-MODE should be a symbol, the major mode command name, such as `c-mode' |
711 | or nil. If nil, highlighting keywords are added for the current buffer. | |
c1f2ffc8 SM |
712 | KEYWORDS should be a list; see the variable `font-lock-keywords'. |
713 | By default they are added at the beginning of the current highlighting list. | |
714 | If optional argument APPEND is `set', they are used to replace the current | |
2d63aa67 SM |
715 | highlighting list. If APPEND is any other non-nil value, they are added at the |
716 | end of the current highlighting list. | |
c1f2ffc8 SM |
717 | |
718 | For example: | |
719 | ||
720 | (font-lock-add-keywords 'c-mode | |
721 | '((\"\\\\\\=<\\\\(FIXME\\\\):\" 1 font-lock-warning-face prepend) | |
722 | (\"\\\\\\=<\\\\(and\\\\|or\\\\|not\\\\)\\\\\\=>\" . font-lock-keyword-face))) | |
723 | ||
724 | adds two fontification patterns for C mode, to fontify `FIXME:' words, even in | |
2d63aa67 SM |
725 | comments, and to fontify `and', `or' and `not' words as keywords. |
726 | ||
727 | Note that some modes have specialised support for additional patterns, e.g., | |
728 | see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types', | |
729 | `objc-font-lock-extra-types' and `java-font-lock-extra-types'." | |
c1f2ffc8 SM |
730 | (cond (major-mode |
731 | ;; If MAJOR-MODE is non-nil, add the KEYWORDS and APPEND spec to | |
732 | ;; `font-lock-keywords-alist' so `font-lock-set-defaults' uses them. | |
733 | (let ((spec (cons keywords append)) cell) | |
734 | (if (setq cell (assq major-mode font-lock-keywords-alist)) | |
735 | (setcdr cell (append (cdr cell) (list spec))) | |
736 | (push (list major-mode spec) font-lock-keywords-alist)))) | |
737 | (font-lock-mode | |
738 | ;; Otherwise if Font Lock mode is on, set or add the keywords now. | |
739 | (if (eq append 'set) | |
740 | (setq font-lock-keywords keywords) | |
741 | (let ((old (if (eq (car-safe font-lock-keywords) t) | |
742 | (cdr font-lock-keywords) | |
743 | font-lock-keywords))) | |
744 | (setq font-lock-keywords (if append | |
745 | (append old keywords) | |
746 | (append keywords old)))))))) | |
a2b8e66b | 747 | \f |
2d63aa67 SM |
748 | ;;; Global Font Lock mode. |
749 | ||
a2b8e66b | 750 | ;; A few people have hassled in the past for a way to make it easier to turn on |
5aa29679 RS |
751 | ;; Font Lock mode, without the user needing to know for which modes s/he has to |
752 | ;; turn it on, perhaps the same way hilit19.el/hl319.el does. I've always | |
a2b8e66b SM |
753 | ;; balked at that way, as I see it as just re-moulding the same problem in |
754 | ;; another form. That is; some person would still have to keep track of which | |
755 | ;; modes (which may not even be distributed with Emacs) support Font Lock mode. | |
756 | ;; The list would always be out of date. And that person might have to be me. | |
757 | ||
5aa29679 RS |
758 | ;; Implementation. |
759 | ;; | |
760 | ;; In a previous discussion the following hack came to mind. It is a gross | |
761 | ;; hack, but it generally works. We use the convention that major modes start | |
762 | ;; by calling the function `kill-all-local-variables', which in turn runs | |
a2b8e66b SM |
763 | ;; functions on the hook variable `change-major-mode-hook'. We attach our |
764 | ;; function `font-lock-change-major-mode' to that hook. Of course, when this | |
765 | ;; hook is run, the major mode is in the process of being changed and we do not | |
766 | ;; know what the final major mode will be. So, `font-lock-change-major-mode' | |
767 | ;; only (a) notes the name of the current buffer, and (b) adds our function | |
5aa29679 RS |
768 | ;; `turn-on-font-lock-if-enabled' to the hook variables `find-file-hooks' and |
769 | ;; `post-command-hook' (for buffers that are not visiting files). By the time | |
770 | ;; the functions on the first of these hooks to be run are run, the new major | |
771 | ;; mode is assumed to be in place. This way we get a Font Lock function run | |
772 | ;; when a major mode is turned on, without knowing major modes or their hooks. | |
773 | ;; | |
a2b8e66b SM |
774 | ;; Naturally this requires that (a) major modes run `kill-all-local-variables', |
775 | ;; as they are supposed to do, and (b) the major mode is in place after the | |
5aa29679 RS |
776 | ;; file is visited or the command that ran `kill-all-local-variables' has |
777 | ;; finished, whichever the sooner. Arguably, any major mode that does not | |
778 | ;; follow the convension (a) is broken, and I can't think of any reason why (b) | |
779 | ;; would not be met (except `gnudoit' on non-files). However, it is not clean. | |
780 | ;; | |
a2b8e66b SM |
781 | ;; Probably the cleanest solution is to have each major mode function run some |
782 | ;; hook, e.g., `major-mode-hook', but maybe implementing that change is | |
5aa29679 RS |
783 | ;; impractical. I am personally against making `setq' a macro or be advised, |
784 | ;; or have a special function such as `set-major-mode', but maybe someone can | |
785 | ;; come up with another solution? | |
786 | ||
787 | ;; User interface. | |
788 | ;; | |
789 | ;; Although Global Font Lock mode is a pseudo-mode, I think that the user | |
790 | ;; interface should conform to the usual Emacs convention for modes, i.e., a | |
791 | ;; command to toggle the feature (`global-font-lock-mode') with a variable for | |
792 | ;; finer control of the mode's behaviour (`font-lock-global-modes'). | |
793 | ;; | |
2e6a15fc SM |
794 | ;; The feature should not be enabled by loading font-lock.el, since other |
795 | ;; mechanisms for turning on Font Lock mode, such as M-x font-lock-mode RET or | |
796 | ;; (add-hook 'c-mode-hook 'turn-on-font-lock), would cause Font Lock mode to be | |
797 | ;; turned on everywhere. That would not be intuitive or informative because | |
798 | ;; loading a file tells you nothing about the feature or how to control it. It | |
1c626aaf | 799 | ;; would also be contrary to the Principle of Least Surprise. sm. |
a2b8e66b | 800 | |
2d9cdda8 | 801 | (defvar font-lock-buffers nil) ; For remembering buffers. |
5aa29679 | 802 | (defvar global-font-lock-mode nil) |
a078558d | 803 | |
55015061 | 804 | (defcustom font-lock-global-modes t |
5aa29679 | 805 | "*Modes for which Font Lock mode is automagically turned on. |
a2b8e66b SM |
806 | Global Font Lock mode is controlled by the `global-font-lock-mode' command. |
807 | If nil, means no modes have Font Lock mode automatically turned on. | |
808 | If t, all modes that support Font Lock mode have it automatically turned on. | |
5aa29679 RS |
809 | If a list, it should be a list of `major-mode' symbol names for which Font Lock |
810 | mode should be automatically turned on. The sense of the list is negated if it | |
811 | begins with `not'. For example: | |
812 | (c-mode c++-mode) | |
55015061 | 813 | means that Font Lock mode is turned on for buffers in C and C++ modes only." |
b34aa0a3 SM |
814 | :type '(choice (const :tag "none" nil) |
815 | (const :tag "all" t) | |
816 | (set :menu-tag "mode specific" :tag "modes" | |
817 | :value (not) | |
818 | (const :tag "Except" not) | |
819 | (repeat :inline t (symbol :tag "mode")))) | |
55015061 | 820 | :group 'font-lock) |
a2b8e66b SM |
821 | |
822 | ;;;###autoload | |
343204bd | 823 | (defun global-font-lock-mode (&optional arg message) |
a2b8e66b | 824 | "Toggle Global Font Lock mode. |
343204bd SM |
825 | With prefix ARG, turn Global Font Lock mode on if and only if ARG is positive. |
826 | Displays a message saying whether the mode is on or off if MESSAGE is non-nil. | |
827 | Returns the new status of Global Font Lock mode (non-nil means on). | |
a2b8e66b SM |
828 | |
829 | When Global Font Lock mode is enabled, Font Lock mode is automagically | |
830 | turned on in a buffer if its major mode is one of `font-lock-global-modes'." | |
343204bd SM |
831 | (interactive "P\np") |
832 | (let ((off-p (if arg | |
833 | (<= (prefix-numeric-value arg) 0) | |
5aa29679 | 834 | global-font-lock-mode))) |
343204bd | 835 | (if off-p |
5aa29679 | 836 | (remove-hook 'find-file-hooks 'turn-on-font-lock-if-enabled) |
6c0fc428 | 837 | (add-hook 'find-file-hooks 'turn-on-font-lock-if-enabled) |
5aa29679 | 838 | (add-hook 'post-command-hook 'turn-on-font-lock-if-enabled) |
2d9cdda8 | 839 | (setq font-lock-buffers (buffer-list))) |
5aa29679 RS |
840 | (when message |
841 | (message "Global Font Lock mode is now %s." (if off-p "OFF" "ON"))) | |
842 | (setq global-font-lock-mode (not off-p)))) | |
a2b8e66b | 843 | |
a2b8e66b | 844 | (defun font-lock-change-major-mode () |
5aa29679 RS |
845 | ;; Turn off Font Lock mode if it's on. |
846 | (when font-lock-mode | |
56fcbd7e | 847 | (font-lock-mode)) |
a2b8e66b | 848 | ;; Gross hack warning: Delicate readers should avert eyes now. |
343204bd SM |
849 | ;; Something is running `kill-all-local-variables', which generally means the |
850 | ;; major mode is being changed. Run `turn-on-font-lock-if-enabled' after the | |
5aa29679 RS |
851 | ;; file is visited or the current command has finished. |
852 | (when global-font-lock-mode | |
853 | (add-hook 'post-command-hook 'turn-on-font-lock-if-enabled) | |
854 | (add-to-list 'font-lock-buffers (current-buffer)))) | |
a2b8e66b | 855 | |
a465832f | 856 | (defun turn-on-font-lock-if-enabled () |
a2b8e66b | 857 | ;; Gross hack warning: Delicate readers should avert eyes now. |
fd23afbe SM |
858 | ;; Turn on Font Lock mode if it's supported by the major mode and enabled by |
859 | ;; the user. | |
a465832f | 860 | (remove-hook 'post-command-hook 'turn-on-font-lock-if-enabled) |
2d9cdda8 | 861 | (while font-lock-buffers |
1c626aaf SM |
862 | (when (buffer-live-p (car font-lock-buffers)) |
863 | (save-excursion | |
864 | (set-buffer (car font-lock-buffers)) | |
865 | (when (and (or font-lock-defaults | |
fd23afbe SM |
866 | (assq major-mode font-lock-defaults-alist)) |
867 | (or (eq font-lock-global-modes t) | |
868 | (if (eq (car-safe font-lock-global-modes) 'not) | |
869 | (not (memq major-mode (cdr font-lock-global-modes))) | |
870 | (memq major-mode font-lock-global-modes)))) | |
1c626aaf SM |
871 | (let (inhibit-quit) |
872 | (turn-on-font-lock))))) | |
2d9cdda8 | 873 | (setq font-lock-buffers (cdr font-lock-buffers)))) |
a2b8e66b | 874 | |
5aa29679 RS |
875 | (add-hook 'change-major-mode-hook 'font-lock-change-major-mode) |
876 | ||
2d63aa67 | 877 | ;;; End of Global Font Lock mode. |
a2b8e66b | 878 | \f |
2d63aa67 SM |
879 | ;;; Font Lock Support mode. |
880 | ||
5aa29679 RS |
881 | ;; This is the code used to interface font-lock.el with any of its add-on |
882 | ;; packages, and provide the user interface. Packages that have their own | |
883 | ;; local buffer fontification functions (see below) may have to call | |
884 | ;; `font-lock-after-fontify-buffer' and/or `font-lock-after-unfontify-buffer' | |
885 | ;; themselves. | |
886 | ||
55015061 | 887 | (defcustom font-lock-support-mode nil |
5aa29679 RS |
888 | "*Support mode for Font Lock mode. |
889 | Support modes speed up Font Lock mode by being choosy about when fontification | |
890 | occurs. Known support modes are Fast Lock mode (symbol `fast-lock-mode') and | |
891 | Lazy Lock mode (symbol `lazy-lock-mode'). See those modes for more info. | |
892 | If nil, means support for Font Lock mode is never performed. | |
893 | If a symbol, use that support mode. | |
894 | If a list, each element should be of the form (MAJOR-MODE . SUPPORT-MODE), | |
895 | where MAJOR-MODE is a symbol or t (meaning the default). For example: | |
896 | ((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode) (t . lazy-lock-mode)) | |
897 | means that Fast Lock mode is used to support Font Lock mode for buffers in C or | |
898 | C++ modes, and Lazy Lock mode is used to support Font Lock mode otherwise. | |
899 | ||
55015061 | 900 | The value of this variable is used when Font Lock mode is turned on." |
b34aa0a3 SM |
901 | :type '(choice (const :tag "none" nil) |
902 | (const :tag "fast lock" fast-lock-mode) | |
903 | (const :tag "lazy lock" lazy-lock-mode) | |
904 | (repeat :menu-tag "mode specific" :tag "mode specific" | |
905 | :value ((t . lazy-lock-mode)) | |
906 | (cons :tag "Instance" | |
907 | (radio :tag "Mode" | |
908 | (const :tag "all" t) | |
909 | (symbol :tag "name")) | |
910 | (radio :tag "Decoration" | |
911 | (const :tag "fast lock" fast-lock-mode) | |
912 | (const :tag "lazy lock" lazy-lock-mode))) | |
913 | )) | |
55015061 | 914 | :group 'font-lock) |
5aa29679 | 915 | |
2e6a15fc SM |
916 | (defvar fast-lock-mode nil) |
917 | (defvar lazy-lock-mode nil) | |
918 | ||
5aa29679 RS |
919 | (defun font-lock-turn-on-thing-lock () |
920 | (let ((thing-mode (font-lock-value-in-major-mode font-lock-support-mode))) | |
921 | (cond ((eq thing-mode 'fast-lock-mode) | |
922 | (fast-lock-mode t)) | |
923 | ((eq thing-mode 'lazy-lock-mode) | |
924 | (lazy-lock-mode t))))) | |
925 | ||
5aa29679 RS |
926 | (defun font-lock-turn-off-thing-lock () |
927 | (cond (fast-lock-mode | |
928 | (fast-lock-mode nil)) | |
929 | (lazy-lock-mode | |
930 | (lazy-lock-mode nil)))) | |
931 | ||
932 | (defun font-lock-after-fontify-buffer () | |
933 | (cond (fast-lock-mode | |
934 | (fast-lock-after-fontify-buffer)) | |
935 | (lazy-lock-mode | |
936 | (lazy-lock-after-fontify-buffer)))) | |
937 | ||
938 | (defun font-lock-after-unfontify-buffer () | |
939 | (cond (fast-lock-mode | |
940 | (fast-lock-after-unfontify-buffer)) | |
941 | (lazy-lock-mode | |
942 | (lazy-lock-after-unfontify-buffer)))) | |
943 | ||
2d63aa67 | 944 | ;;; End of Font Lock Support mode. |
5aa29679 | 945 | \f |
2d63aa67 | 946 | ;;; Fontification functions. |
a1eb1cf1 | 947 | |
56fcbd7e SM |
948 | ;; Rather than the function, e.g., `font-lock-fontify-region' containing the |
949 | ;; code to fontify a region, the function runs the function whose name is the | |
950 | ;; value of the variable, e.g., `font-lock-fontify-region-function'. Normally, | |
951 | ;; the value of this variable is, e.g., `font-lock-default-fontify-region' | |
952 | ;; which does contain the code to fontify a region. However, the value of the | |
953 | ;; variable could be anything and thus, e.g., `font-lock-fontify-region' could | |
954 | ;; do anything. The indirection of the fontification functions gives major | |
955 | ;; modes the capability of modifying the way font-lock.el fontifies. Major | |
956 | ;; modes can modify the values of, e.g., `font-lock-fontify-region-function', | |
957 | ;; via the variable `font-lock-defaults'. | |
958 | ;; | |
959 | ;; For example, Rmail mode sets the variable `font-lock-defaults' so that | |
960 | ;; font-lock.el uses its own function for buffer fontification. This function | |
961 | ;; makes fontification be on a message-by-message basis and so visiting an | |
962 | ;; RMAIL file is much faster. A clever implementation of the function might | |
963 | ;; fontify the headers differently than the message body. (It should, and | |
964 | ;; correspondingly for Mail mode, but I can't be bothered to do the work. Can | |
965 | ;; you?) This hints at a more interesting use... | |
966 | ;; | |
967 | ;; Languages that contain text normally contained in different major modes | |
968 | ;; could define their own fontification functions that treat text differently | |
969 | ;; depending on its context. For example, Perl mode could arrange that here | |
970 | ;; docs are fontified differently than Perl code. Or Yacc mode could fontify | |
971 | ;; rules one way and C code another. Neat! | |
972 | ;; | |
973 | ;; A further reason to use the fontification indirection feature is when the | |
974 | ;; default syntactual fontification, or the default fontification in general, | |
975 | ;; is not flexible enough for a particular major mode. For example, perhaps | |
55015061 SM |
976 | ;; comments are just too hairy for `font-lock-fontify-syntactically-region' to |
977 | ;; cope with. You need to write your own version of that function, e.g., | |
978 | ;; `hairy-fontify-syntactically-region', and make your own version of | |
979 | ;; `hairy-fontify-region' call that function before calling | |
56fcbd7e SM |
980 | ;; `font-lock-fontify-keywords-region' for the normal regexp fontification |
981 | ;; pass. And Hairy mode would set `font-lock-defaults' so that font-lock.el | |
982 | ;; would call your region fontification function instead of its own. For | |
55015061 | 983 | ;; example, TeX modes could fontify {\foo ...} and \bar{...} etc. multi-line |
56fcbd7e SM |
984 | ;; directives correctly and cleanly. (It is the same problem as fontifying |
985 | ;; multi-line strings and comments; regexps are not appropriate for the job.) | |
986 | ||
a1eb1cf1 | 987 | ;;;###autoload |
030f4a35 | 988 | (defun font-lock-fontify-buffer () |
a1eb1cf1 | 989 | "Fontify the current buffer the way `font-lock-mode' would." |
030f4a35 | 990 | (interactive) |
a2b8e66b SM |
991 | (let ((font-lock-verbose (or font-lock-verbose (interactive-p)))) |
992 | (funcall font-lock-fontify-buffer-function))) | |
993 | ||
994 | (defun font-lock-unfontify-buffer () | |
995 | (funcall font-lock-unfontify-buffer-function)) | |
996 | ||
997 | (defun font-lock-fontify-region (beg end &optional loudly) | |
998 | (funcall font-lock-fontify-region-function beg end loudly)) | |
999 | ||
1000 | (defun font-lock-unfontify-region (beg end) | |
1001 | (funcall font-lock-unfontify-region-function beg end)) | |
1002 | ||
1003 | (defun font-lock-default-fontify-buffer () | |
5aa29679 RS |
1004 | (let ((verbose (if (numberp font-lock-verbose) |
1005 | (> (buffer-size) font-lock-verbose) | |
1006 | font-lock-verbose))) | |
56fcbd7e SM |
1007 | (when verbose |
1008 | (message "Fontifying %s..." (buffer-name))) | |
7d7d915a | 1009 | ;; Make sure we have the right `font-lock-keywords' etc. |
56fcbd7e SM |
1010 | (unless font-lock-mode |
1011 | (font-lock-set-defaults)) | |
7d7d915a SM |
1012 | ;; Make sure we fontify etc. in the whole buffer. |
1013 | (save-restriction | |
1014 | (widen) | |
1015 | (condition-case nil | |
1016 | (save-excursion | |
1017 | (save-match-data | |
1018 | (font-lock-fontify-region (point-min) (point-max) verbose) | |
271c888a | 1019 | (font-lock-after-fontify-buffer) |
7d7d915a SM |
1020 | (setq font-lock-fontified t))) |
1021 | ;; We don't restore the old fontification, so it's best to unfontify. | |
a078558d | 1022 | (quit (font-lock-unfontify-buffer)))) |
56fcbd7e SM |
1023 | ;; Make sure we undo `font-lock-keywords' etc. |
1024 | (unless font-lock-mode | |
1025 | (font-lock-unset-defaults)) | |
6c0fc428 | 1026 | (if verbose (message "Fontifying %s...%s" (buffer-name) |
2e6a15fc | 1027 | (if font-lock-fontified "done" "quit"))))) |
7d7d915a | 1028 | |
a2b8e66b | 1029 | (defun font-lock-default-unfontify-buffer () |
56fcbd7e | 1030 | ;; Make sure we unfontify etc. in the whole buffer. |
a2b8e66b SM |
1031 | (save-restriction |
1032 | (widen) | |
1033 | (font-lock-unfontify-region (point-min) (point-max)) | |
271c888a | 1034 | (font-lock-after-unfontify-buffer) |
a2b8e66b | 1035 | (setq font-lock-fontified nil))) |
9bfbb130 | 1036 | |
a2b8e66b | 1037 | (defun font-lock-default-fontify-region (beg end loudly) |
ac6e572c SM |
1038 | (save-buffer-state |
1039 | ((parse-sexp-lookup-properties font-lock-syntactic-keywords) | |
1040 | (old-syntax-table (syntax-table))) | |
876f2438 | 1041 | (unwind-protect |
a078558d SM |
1042 | (save-restriction |
1043 | (widen) | |
876f2438 | 1044 | ;; Use the fontification syntax table, if any. |
2e6a15fc SM |
1045 | (when font-lock-syntax-table |
1046 | (set-syntax-table font-lock-syntax-table)) | |
876f2438 | 1047 | ;; Now do the fontification. |
2e6a15fc | 1048 | (font-lock-unfontify-region beg end) |
ac6e572c SM |
1049 | (when font-lock-syntactic-keywords |
1050 | (font-lock-fontify-syntactic-keywords-region beg end)) | |
2e6a15fc | 1051 | (unless font-lock-keywords-only |
876f2438 SM |
1052 | (font-lock-fontify-syntactically-region beg end loudly)) |
1053 | (font-lock-fontify-keywords-region beg end loudly)) | |
1054 | ;; Clean up. | |
2e6a15fc | 1055 | (set-syntax-table old-syntax-table)))) |
9bfbb130 SM |
1056 | |
1057 | ;; The following must be rethought, since keywords can override fontification. | |
1058 | ; ;; Now scan for keywords, but not if we are inside a comment now. | |
1059 | ; (or (and (not font-lock-keywords-only) | |
1060 | ; (let ((state (parse-partial-sexp beg end nil nil | |
1061 | ; font-lock-cache-state))) | |
1062 | ; (or (nth 4 state) (nth 7 state)))) | |
1063 | ; (font-lock-fontify-keywords-region beg end)) | |
1064 | ||
a2b8e66b | 1065 | (defun font-lock-default-unfontify-region (beg end) |
2e6a15fc | 1066 | (save-buffer-state nil |
ac6e572c | 1067 | (remove-text-properties beg end '(face nil syntax-table nil)))) |
9bfbb130 SM |
1068 | |
1069 | ;; Called when any modification is made to buffer text. | |
1070 | (defun font-lock-after-change-function (beg end old-len) | |
1071 | (save-excursion | |
1072 | (save-match-data | |
2e6a15fc | 1073 | ;; Rescan between start of lines enclosing the region. |
9bfbb130 SM |
1074 | (font-lock-fontify-region |
1075 | (progn (goto-char beg) (beginning-of-line) (point)) | |
1c626aaf | 1076 | (progn (goto-char end) (forward-line 1) (point)))))) |
a2b8e66b | 1077 | |
a078558d SM |
1078 | (defun font-lock-fontify-block (&optional arg) |
1079 | "Fontify some lines the way `font-lock-fontify-buffer' would. | |
1080 | The lines could be a function or paragraph, or a specified number of lines. | |
a078558d | 1081 | If ARG is given, fontify that many lines before and after point, or 16 lines if |
a465832f SM |
1082 | no ARG is given and `font-lock-mark-block-function' is nil. |
1083 | If `font-lock-mark-block-function' non-nil and no ARG is given, it is used to | |
1084 | delimit the region to fontify." | |
a078558d | 1085 | (interactive "P") |
a465832f | 1086 | (let (font-lock-beginning-of-syntax-function deactivate-mark) |
a078558d SM |
1087 | ;; Make sure we have the right `font-lock-keywords' etc. |
1088 | (if (not font-lock-mode) (font-lock-set-defaults)) | |
a2b8e66b SM |
1089 | (save-excursion |
1090 | (save-match-data | |
1091 | (condition-case error-data | |
a078558d SM |
1092 | (if (or arg (not font-lock-mark-block-function)) |
1093 | (let ((lines (if arg (prefix-numeric-value arg) 16))) | |
1094 | (font-lock-fontify-region | |
1095 | (save-excursion (forward-line (- lines)) (point)) | |
1096 | (save-excursion (forward-line lines) (point)))) | |
1097 | (funcall font-lock-mark-block-function) | |
1098 | (font-lock-fontify-region (point) (mark))) | |
6c0fc428 | 1099 | ((error quit) (message "Fontifying block...%s" error-data))))))) |
a078558d | 1100 | |
94de9afe | 1101 | (define-key facemenu-keymap "\M-g" 'font-lock-fontify-block) |
2d63aa67 SM |
1102 | |
1103 | ;;; End of Fontification functions. | |
9bfbb130 | 1104 | \f |
9bfbb130 SM |
1105 | ;;; Additional text property functions. |
1106 | ||
1c626aaf SM |
1107 | ;; The following text property functions should be builtins. This means they |
1108 | ;; should be written in C and put with all the other text property functions. | |
1109 | ;; In the meantime, those that are used by font-lock.el are defined in Lisp | |
1110 | ;; below and given a `font-lock-' prefix. Those that are not used are defined | |
1111 | ;; in Lisp below and commented out. sm. | |
9bfbb130 | 1112 | |
1c626aaf | 1113 | (defun font-lock-prepend-text-property (start end prop value &optional object) |
9bfbb130 SM |
1114 | "Prepend to one property of the text from START to END. |
1115 | Arguments PROP and VALUE specify the property and value to prepend to the value | |
1c626aaf | 1116 | already in place. The resulting property values are always lists. |
9bfbb130 SM |
1117 | Optional argument OBJECT is the string or buffer containing the text." |
1118 | (let ((val (if (listp value) value (list value))) next prev) | |
1119 | (while (/= start end) | |
1120 | (setq next (next-single-property-change start prop object end) | |
1121 | prev (get-text-property start prop object)) | |
1c626aaf SM |
1122 | (put-text-property start next prop |
1123 | (append val (if (listp prev) prev (list prev))) | |
1124 | object) | |
9bfbb130 SM |
1125 | (setq start next)))) |
1126 | ||
1c626aaf | 1127 | (defun font-lock-append-text-property (start end prop value &optional object) |
9bfbb130 SM |
1128 | "Append to one property of the text from START to END. |
1129 | Arguments PROP and VALUE specify the property and value to append to the value | |
1c626aaf | 1130 | already in place. The resulting property values are always lists. |
9bfbb130 SM |
1131 | Optional argument OBJECT is the string or buffer containing the text." |
1132 | (let ((val (if (listp value) value (list value))) next prev) | |
1133 | (while (/= start end) | |
1134 | (setq next (next-single-property-change start prop object end) | |
1135 | prev (get-text-property start prop object)) | |
1c626aaf SM |
1136 | (put-text-property start next prop |
1137 | (append (if (listp prev) prev (list prev)) val) | |
1138 | object) | |
9bfbb130 | 1139 | (setq start next)))) |
1c626aaf SM |
1140 | |
1141 | (defun font-lock-fillin-text-property (start end prop value &optional object) | |
1142 | "Fill in one property of the text from START to END. | |
1143 | Arguments PROP and VALUE specify the property and value to put where none are | |
1144 | already in place. Therefore existing property values are not overwritten. | |
1145 | Optional argument OBJECT is the string or buffer containing the text." | |
1146 | (let ((start (text-property-any start end prop nil object)) next) | |
1147 | (while start | |
1148 | (setq next (next-single-property-change start prop object end)) | |
1149 | (put-text-property start next prop value object) | |
1150 | (setq start (text-property-any next end prop nil object))))) | |
1151 | ||
1152 | ;; For completeness: this is to `remove-text-properties' as `put-text-property' | |
1153 | ;; is to `add-text-properties', etc. | |
1154 | ;(defun remove-text-property (start end property &optional object) | |
1155 | ; "Remove a property from text from START to END. | |
1156 | ;Argument PROPERTY is the property to remove. | |
1157 | ;Optional argument OBJECT is the string or buffer containing the text. | |
1158 | ;Return t if the property was actually removed, nil otherwise." | |
1159 | ; (remove-text-properties start end (list property) object)) | |
1160 | ||
1161 | ;; For consistency: maybe this should be called `remove-single-property' like | |
1162 | ;; `next-single-property-change' (not `next-single-text-property-change'), etc. | |
1163 | ;(defun remove-single-text-property (start end prop value &optional object) | |
1164 | ; "Remove a specific property value from text from START to END. | |
1165 | ;Arguments PROP and VALUE specify the property and value to remove. The | |
1166 | ;resulting property values are not equal to VALUE nor lists containing VALUE. | |
1167 | ;Optional argument OBJECT is the string or buffer containing the text." | |
1168 | ; (let ((start (text-property-not-all start end prop nil object)) next prev) | |
1169 | ; (while start | |
1170 | ; (setq next (next-single-property-change start prop object end) | |
1171 | ; prev (get-text-property start prop object)) | |
1172 | ; (cond ((and (symbolp prev) (eq value prev)) | |
1173 | ; (remove-text-property start next prop object)) | |
1174 | ; ((and (listp prev) (memq value prev)) | |
1175 | ; (let ((new (delq value prev))) | |
1176 | ; (cond ((null new) | |
1177 | ; (remove-text-property start next prop object)) | |
1178 | ; ((= (length new) 1) | |
1179 | ; (put-text-property start next prop (car new) object)) | |
1180 | ; (t | |
1181 | ; (put-text-property start next prop new object)))))) | |
1182 | ; (setq start (text-property-not-all next end prop nil object))))) | |
2d63aa67 SM |
1183 | |
1184 | ;;; End of Additional text property functions. | |
9bfbb130 | 1185 | \f |
ac6e572c SM |
1186 | ;;; Syntactic regexp fontification functions. |
1187 | ||
1188 | ;; These syntactic keyword pass functions are identical to those keyword pass | |
1189 | ;; functions below, with the following exceptions; (a) they operate on | |
1190 | ;; `font-lock-syntactic-keywords' of course, (b) they are all `defun' as speed | |
1191 | ;; is less of an issue, (c) eval of property value does not occur JIT as speed | |
1192 | ;; is less of an issue, (d) OVERRIDE cannot be `prepend' or `append' as it | |
1193 | ;; makes no sense for `syntax-table' property values, (e) they do not do it | |
1194 | ;; LOUDLY as it is not likely to be intensive. | |
1195 | ||
1196 | (defun font-lock-apply-syntactic-highlight (highlight) | |
1197 | "Apply HIGHLIGHT following a match. | |
1198 | HIGHLIGHT should be of the form MATCH-HIGHLIGHT, | |
1199 | see `font-lock-syntactic-keywords'." | |
1200 | (let* ((match (nth 0 highlight)) | |
1201 | (start (match-beginning match)) (end (match-end match)) | |
1202 | (value (nth 1 highlight)) | |
1203 | (override (nth 2 highlight))) | |
1204 | (unless (numberp (car value)) | |
1205 | (setq value (eval value))) | |
1206 | (cond ((not start) | |
1207 | ;; No match but we might not signal an error. | |
1208 | (or (nth 3 highlight) | |
1209 | (error "No match %d in highlight %S" match highlight))) | |
1210 | ((not override) | |
1211 | ;; Cannot override existing fontification. | |
1212 | (or (text-property-not-all start end 'syntax-table nil) | |
1213 | (put-text-property start end 'syntax-table value))) | |
1214 | ((eq override t) | |
1215 | ;; Override existing fontification. | |
1216 | (put-text-property start end 'syntax-table value)) | |
1217 | ((eq override 'keep) | |
1218 | ;; Keep existing fontification. | |
1219 | (font-lock-fillin-text-property start end 'syntax-table value))))) | |
1220 | ||
1221 | (defun font-lock-fontify-syntactic-anchored-keywords (keywords limit) | |
1222 | "Fontify according to KEYWORDS until LIMIT. | |
1223 | KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords', | |
1224 | LIMIT can be modified by the value of its PRE-MATCH-FORM." | |
1225 | (let ((matcher (nth 0 keywords)) (lowdarks (nthcdr 3 keywords)) highlights | |
1226 | ;; Evaluate PRE-MATCH-FORM. | |
1227 | (pre-match-value (eval (nth 1 keywords)))) | |
1228 | ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line. | |
1229 | (if (and (numberp pre-match-value) (> pre-match-value (point))) | |
1230 | (setq limit pre-match-value) | |
1231 | (save-excursion (end-of-line) (setq limit (point)))) | |
1232 | (save-match-data | |
1233 | ;; Find an occurrence of `matcher' before `limit'. | |
1234 | (while (if (stringp matcher) | |
1235 | (re-search-forward matcher limit t) | |
1236 | (funcall matcher limit)) | |
1237 | ;; Apply each highlight to this instance of `matcher'. | |
1238 | (setq highlights lowdarks) | |
1239 | (while highlights | |
1240 | (font-lock-apply-syntactic-highlight (car highlights)) | |
1241 | (setq highlights (cdr highlights))))) | |
1242 | ;; Evaluate POST-MATCH-FORM. | |
1243 | (eval (nth 2 keywords)))) | |
1244 | ||
1245 | (defun font-lock-fontify-syntactic-keywords-region (start end) | |
1246 | "Fontify according to `font-lock-syntactic-keywords' between START and END. | |
1247 | START should be at the beginning of a line." | |
1248 | ;; If `font-lock-syntactic-keywords' is a symbol, get the real keywords. | |
1249 | (when (symbolp font-lock-syntactic-keywords) | |
1250 | (setq font-lock-syntactic-keywords (font-lock-eval-keywords | |
1251 | font-lock-syntactic-keywords))) | |
1252 | ;; If `font-lock-syntactic-keywords' is not compiled, compile it. | |
1253 | (unless (eq (car font-lock-syntactic-keywords) t) | |
1254 | (setq font-lock-syntactic-keywords (font-lock-compile-keywords | |
1255 | font-lock-syntactic-keywords))) | |
1256 | ;; Get down to business. | |
1257 | (let ((case-fold-search font-lock-keywords-case-fold-search) | |
1258 | (keywords (cdr font-lock-syntactic-keywords)) | |
1259 | keyword matcher highlights) | |
1260 | (while keywords | |
1261 | ;; Find an occurrence of `matcher' from `start' to `end'. | |
1262 | (setq keyword (car keywords) matcher (car keyword)) | |
1263 | (goto-char start) | |
1264 | (while (if (stringp matcher) | |
1265 | (re-search-forward matcher end t) | |
1266 | (funcall matcher end)) | |
1267 | ;; Apply each highlight to this instance of `matcher', which may be | |
1268 | ;; specific highlights or more keywords anchored to `matcher'. | |
1269 | (setq highlights (cdr keyword)) | |
1270 | (while highlights | |
1271 | (if (numberp (car (car highlights))) | |
1272 | (font-lock-apply-syntactic-highlight (car highlights)) | |
1273 | (font-lock-fontify-syntactic-anchored-keywords (car highlights) | |
1274 | end)) | |
1275 | (setq highlights (cdr highlights)))) | |
1276 | (setq keywords (cdr keywords))))) | |
1277 | ||
1278 | ;;; End of Syntactic regexp fontification functions. | |
1279 | \f | |
1280 | ;;; Syntactic fontification functions. | |
1281 | ||
1282 | ;; These record the parse state at a particular position, always the start of a | |
1283 | ;; line. Used to make `font-lock-fontify-syntactically-region' faster. | |
1284 | ;; Previously, `font-lock-cache-position' was just a buffer position. However, | |
1285 | ;; under certain situations, this occasionally resulted in mis-fontification. | |
1286 | ;; I think the "situations" were deletion with Lazy Lock mode's deferral. sm. | |
1287 | (defvar font-lock-cache-state nil) | |
1288 | (defvar font-lock-cache-position nil) | |
1289 | ||
1290 | (defun font-lock-fontify-syntactically-region (start end &optional loudly) | |
1291 | "Put proper face on each string and comment between START and END. | |
1292 | START should be at the beginning of a line." | |
1293 | (let ((cache (marker-position font-lock-cache-position)) | |
1294 | state string beg) | |
1295 | (if loudly (message "Fontifying %s... (syntactically...)" (buffer-name))) | |
1296 | (goto-char start) | |
1297 | ;; | |
1298 | ;; Find the state at the `beginning-of-line' before `start'. | |
1299 | (if (eq start cache) | |
1300 | ;; Use the cache for the state of `start'. | |
1301 | (setq state font-lock-cache-state) | |
1302 | ;; Find the state of `start'. | |
1303 | (if (null font-lock-beginning-of-syntax-function) | |
1304 | ;; Use the state at the previous cache position, if any, or | |
1305 | ;; otherwise calculate from `point-min'. | |
1306 | (if (or (null cache) (< start cache)) | |
1307 | (setq state (parse-partial-sexp (point-min) start)) | |
1308 | (setq state (parse-partial-sexp cache start nil nil | |
1309 | font-lock-cache-state))) | |
1310 | ;; Call the function to move outside any syntactic block. | |
1311 | (funcall font-lock-beginning-of-syntax-function) | |
1312 | (setq state (parse-partial-sexp (point) start))) | |
1313 | ;; Cache the state and position of `start'. | |
1314 | (setq font-lock-cache-state state) | |
1315 | (set-marker font-lock-cache-position start)) | |
1316 | ;; | |
1317 | ;; If the region starts inside a string or comment, show the extent of it. | |
1318 | (when (or (nth 3 state) (nth 4 state)) | |
1319 | (setq string (nth 3 state) beg (point)) | |
1320 | (setq state (parse-partial-sexp (point) end nil nil state 'syntax-table)) | |
1321 | (put-text-property beg (point) 'face | |
1322 | (if string | |
1323 | font-lock-string-face | |
1324 | font-lock-comment-face))) | |
1325 | ;; | |
1326 | ;; Find each interesting place between here and `end'. | |
1327 | (while (and (< (point) end) | |
1328 | (progn | |
1329 | (setq state (parse-partial-sexp (point) end nil nil state | |
1330 | 'syntax-table)) | |
1331 | (or (nth 3 state) (nth 4 state)))) | |
1332 | (setq string (nth 3 state) beg (nth 8 state)) | |
1333 | (setq state (parse-partial-sexp (point) end nil nil state 'syntax-table)) | |
1334 | (put-text-property beg (point) 'face | |
1335 | (if string | |
1336 | font-lock-string-face | |
1337 | font-lock-comment-face))))) | |
1338 | ||
1339 | ;;; End of Syntactic fontification functions. | |
1340 | \f | |
1341 | ;;; Keyword regexp fontification functions. | |
9bfbb130 SM |
1342 | |
1343 | (defsubst font-lock-apply-highlight (highlight) | |
1344 | "Apply HIGHLIGHT following a match. | |
1345 | HIGHLIGHT should be of the form MATCH-HIGHLIGHT, see `font-lock-keywords'." | |
1346 | (let* ((match (nth 0 highlight)) | |
1347 | (start (match-beginning match)) (end (match-end match)) | |
1348 | (override (nth 2 highlight))) | |
1349 | (cond ((not start) | |
1350 | ;; No match but we might not signal an error. | |
1351 | (or (nth 3 highlight) | |
1352 | (error "No match %d in highlight %S" match highlight))) | |
1353 | ((not override) | |
1354 | ;; Cannot override existing fontification. | |
1355 | (or (text-property-not-all start end 'face nil) | |
1356 | (put-text-property start end 'face (eval (nth 1 highlight))))) | |
1357 | ((eq override t) | |
1358 | ;; Override existing fontification. | |
1359 | (put-text-property start end 'face (eval (nth 1 highlight)))) | |
9bfbb130 SM |
1360 | ((eq override 'prepend) |
1361 | ;; Prepend to existing fontification. | |
1c626aaf | 1362 | (font-lock-prepend-text-property start end 'face (eval (nth 1 highlight)))) |
9bfbb130 SM |
1363 | ((eq override 'append) |
1364 | ;; Append to existing fontification. | |
1c626aaf | 1365 | (font-lock-append-text-property start end 'face (eval (nth 1 highlight)))) |
c1f2ffc8 SM |
1366 | ((eq override 'keep) |
1367 | ;; Keep existing fontification. | |
1c626aaf | 1368 | (font-lock-fillin-text-property start end 'face (eval (nth 1 highlight))))))) |
9bfbb130 SM |
1369 | |
1370 | (defsubst font-lock-fontify-anchored-keywords (keywords limit) | |
1371 | "Fontify according to KEYWORDS until LIMIT. | |
56fcbd7e SM |
1372 | KEYWORDS should be of the form MATCH-ANCHORED, see `font-lock-keywords', |
1373 | LIMIT can be modified by the value of its PRE-MATCH-FORM." | |
1374 | (let ((matcher (nth 0 keywords)) (lowdarks (nthcdr 3 keywords)) highlights | |
1375 | ;; Evaluate PRE-MATCH-FORM. | |
1376 | (pre-match-value (eval (nth 1 keywords)))) | |
1377 | ;; Set LIMIT to value of PRE-MATCH-FORM or the end of line. | |
1378 | (if (and (numberp pre-match-value) (> pre-match-value (point))) | |
1379 | (setq limit pre-match-value) | |
1380 | (save-excursion (end-of-line) (setq limit (point)))) | |
9bfbb130 | 1381 | (save-match-data |
876f2438 | 1382 | ;; Find an occurrence of `matcher' before `limit'. |
9bfbb130 SM |
1383 | (while (if (stringp matcher) |
1384 | (re-search-forward matcher limit t) | |
1385 | (funcall matcher limit)) | |
876f2438 | 1386 | ;; Apply each highlight to this instance of `matcher'. |
9bfbb130 SM |
1387 | (setq highlights lowdarks) |
1388 | (while highlights | |
1389 | (font-lock-apply-highlight (car highlights)) | |
1390 | (setq highlights (cdr highlights))))) | |
876f2438 | 1391 | ;; Evaluate POST-MATCH-FORM. |
9bfbb130 SM |
1392 | (eval (nth 2 keywords)))) |
1393 | ||
1394 | (defun font-lock-fontify-keywords-region (start end &optional loudly) | |
1395 | "Fontify according to `font-lock-keywords' between START and END. | |
1396 | START should be at the beginning of a line." | |
ac6e572c | 1397 | (unless (eq (car font-lock-keywords) t) |
55015061 | 1398 | (setq font-lock-keywords (font-lock-compile-keywords font-lock-keywords))) |
9bfbb130 | 1399 | (let ((case-fold-search font-lock-keywords-case-fold-search) |
55015061 | 1400 | (keywords (cdr font-lock-keywords)) |
9bfbb130 | 1401 | (bufname (buffer-name)) (count 0) |
876f2438 SM |
1402 | keyword matcher highlights) |
1403 | ;; | |
1404 | ;; Fontify each item in `font-lock-keywords' from `start' to `end'. | |
1405 | (while keywords | |
1406 | (if loudly (message "Fontifying %s... (regexps..%s)" bufname | |
2e6a15fc | 1407 | (make-string (incf count) ?.))) |
9bfbb130 | 1408 | ;; |
876f2438 SM |
1409 | ;; Find an occurrence of `matcher' from `start' to `end'. |
1410 | (setq keyword (car keywords) matcher (car keyword)) | |
1411 | (goto-char start) | |
1412 | (while (if (stringp matcher) | |
1413 | (re-search-forward matcher end t) | |
1414 | (funcall matcher end)) | |
1415 | ;; Apply each highlight to this instance of `matcher', which may be | |
1416 | ;; specific highlights or more keywords anchored to `matcher'. | |
1417 | (setq highlights (cdr keyword)) | |
1418 | (while highlights | |
1419 | (if (numberp (car (car highlights))) | |
1420 | (font-lock-apply-highlight (car highlights)) | |
1421 | (font-lock-fontify-anchored-keywords (car highlights) end)) | |
1422 | (setq highlights (cdr highlights)))) | |
1423 | (setq keywords (cdr keywords))))) | |
2d63aa67 | 1424 | |
ac6e572c | 1425 | ;;; End of Keyword regexp fontification functions. |
9bfbb130 SM |
1426 | \f |
1427 | ;; Various functions. | |
1428 | ||
55015061 SM |
1429 | (defun font-lock-compile-keywords (keywords) |
1430 | ;; Compile KEYWORDS into the form (t KEYWORD ...) where KEYWORD is of the | |
1431 | ;; form (MATCHER HIGHLIGHT ...) as shown in `font-lock-keywords' doc string. | |
1432 | (if (eq (car-safe keywords) t) | |
1433 | keywords | |
1434 | (cons t (mapcar 'font-lock-compile-keyword keywords)))) | |
a2b8e66b SM |
1435 | |
1436 | (defun font-lock-compile-keyword (keyword) | |
c1f2ffc8 | 1437 | (cond ((nlistp keyword) ; MATCHER |
a2b8e66b | 1438 | (list keyword '(0 font-lock-keyword-face))) |
c1f2ffc8 | 1439 | ((eq (car keyword) 'eval) ; (eval . FORM) |
a2b8e66b | 1440 | (font-lock-compile-keyword (eval (cdr keyword)))) |
c1f2ffc8 SM |
1441 | ((eq (car-safe (cdr keyword)) 'quote) ; (MATCHER . 'FORM) |
1442 | ;; If FORM is a FACENAME then quote it. Otherwise ignore the quote. | |
1443 | (if (symbolp (nth 2 keyword)) | |
1444 | (list (car keyword) (list 0 (cdr keyword))) | |
1445 | (font-lock-compile-keyword (cons (car keyword) (nth 2 keyword))))) | |
1446 | ((numberp (cdr keyword)) ; (MATCHER . MATCH) | |
a2b8e66b | 1447 | (list (car keyword) (list (cdr keyword) 'font-lock-keyword-face))) |
c1f2ffc8 | 1448 | ((symbolp (cdr keyword)) ; (MATCHER . FACENAME) |
a2b8e66b | 1449 | (list (car keyword) (list 0 (cdr keyword)))) |
c1f2ffc8 | 1450 | ((nlistp (nth 1 keyword)) ; (MATCHER . HIGHLIGHT) |
a2b8e66b | 1451 | (list (car keyword) (cdr keyword))) |
c1f2ffc8 | 1452 | (t ; (MATCHER HIGHLIGHT ...) |
a2b8e66b | 1453 | keyword))) |
d46c21ec | 1454 | |
ac6e572c SM |
1455 | (defun font-lock-eval-keywords (keywords) |
1456 | ;; Evalulate KEYWORDS if a function (funcall) or variable (eval) name. | |
1457 | (if (symbolp keywords) | |
1458 | (font-lock-eval-keywords (if (fboundp keywords) | |
1459 | (funcall keywords) | |
1460 | (eval keywords))) | |
1461 | keywords)) | |
1462 | ||
343204bd SM |
1463 | (defun font-lock-value-in-major-mode (alist) |
1464 | ;; Return value in ALIST for `major-mode', or ALIST if it is not an alist. | |
2e6a15fc | 1465 | ;; Structure is ((MAJOR-MODE . VALUE) ...) where MAJOR-MODE may be t. |
343204bd SM |
1466 | (if (consp alist) |
1467 | (cdr (or (assq major-mode alist) (assq t alist))) | |
1468 | alist)) | |
1469 | ||
d46c21ec SM |
1470 | (defun font-lock-choose-keywords (keywords level) |
1471 | ;; Return LEVELth element of KEYWORDS. A LEVEL of nil is equal to a | |
1472 | ;; LEVEL of 0, a LEVEL of t is equal to (1- (length KEYWORDS)). | |
343204bd SM |
1473 | (cond ((symbolp keywords) |
1474 | keywords) | |
1475 | ((numberp level) | |
1476 | (or (nth level keywords) (car (reverse keywords)))) | |
1477 | ((eq level t) | |
1478 | (car (reverse keywords))) | |
1479 | (t | |
1480 | (car keywords)))) | |
d46c21ec | 1481 | |
2e6a15fc SM |
1482 | (defvar font-lock-set-defaults nil) ; Whether we have set up defaults. |
1483 | ||
d46c21ec SM |
1484 | (defun font-lock-set-defaults () |
1485 | "Set fontification defaults appropriately for this mode. | |
a2b8e66b SM |
1486 | Sets various variables using `font-lock-defaults' (or, if nil, using |
1487 | `font-lock-defaults-alist') and `font-lock-maximum-decoration'." | |
d46c21ec | 1488 | ;; Set fontification defaults. |
a2b8e66b | 1489 | (make-local-variable 'font-lock-fontified) |
2e6a15fc SM |
1490 | ;; Set iff not previously set. |
1491 | (unless font-lock-set-defaults | |
1492 | (set (make-local-variable 'font-lock-set-defaults) t) | |
1493 | (set (make-local-variable 'font-lock-cache-state) nil) | |
1494 | (set (make-local-variable 'font-lock-cache-position) (make-marker)) | |
1495 | (let* ((defaults (or font-lock-defaults | |
1496 | (cdr (assq major-mode font-lock-defaults-alist)))) | |
1497 | (keywords | |
1498 | (font-lock-choose-keywords (nth 0 defaults) | |
c1f2ffc8 SM |
1499 | (font-lock-value-in-major-mode font-lock-maximum-decoration))) |
1500 | (local (cdr (assq major-mode font-lock-keywords-alist)))) | |
2e6a15fc | 1501 | ;; Regexp fontification? |
2d63aa67 | 1502 | (set (make-local-variable 'font-lock-keywords) |
ac6e572c | 1503 | (font-lock-compile-keywords (font-lock-eval-keywords keywords))) |
c1f2ffc8 SM |
1504 | ;; Local fontification? |
1505 | (while local | |
1506 | (font-lock-add-keywords nil (car (car local)) (cdr (car local))) | |
1507 | (setq local (cdr local))) | |
2e6a15fc SM |
1508 | ;; Syntactic fontification? |
1509 | (when (nth 1 defaults) | |
1510 | (set (make-local-variable 'font-lock-keywords-only) t)) | |
1511 | ;; Case fold during regexp fontification? | |
1512 | (when (nth 2 defaults) | |
1513 | (set (make-local-variable 'font-lock-keywords-case-fold-search) t)) | |
1514 | ;; Syntax table for regexp and syntactic fontification? | |
1515 | (when (nth 3 defaults) | |
1516 | (let ((slist (nth 3 defaults))) | |
1517 | (set (make-local-variable 'font-lock-syntax-table) | |
1518 | (copy-syntax-table (syntax-table))) | |
1519 | (while slist | |
1520 | ;; The character to modify may be a single CHAR or a STRING. | |
1521 | (let ((chars (if (numberp (car (car slist))) | |
1522 | (list (car (car slist))) | |
1523 | (mapcar 'identity (car (car slist))))) | |
1524 | (syntax (cdr (car slist)))) | |
1525 | (while chars | |
1526 | (modify-syntax-entry (car chars) syntax | |
1527 | font-lock-syntax-table) | |
1528 | (setq chars (cdr chars))) | |
1529 | (setq slist (cdr slist)))))) | |
1530 | ;; Syntax function for syntactic fontification? | |
1531 | (when (nth 4 defaults) | |
1532 | (set (make-local-variable 'font-lock-beginning-of-syntax-function) | |
1533 | (nth 4 defaults))) | |
1534 | ;; Variable alist? | |
1535 | (let ((alist (nthcdr 5 defaults))) | |
1536 | (while alist | |
55015061 SM |
1537 | (let ((variable (car (car alist))) (value (cdr (car alist)))) |
1538 | (unless (boundp variable) | |
ac6e572c | 1539 | (set variable nil)) |
55015061 SM |
1540 | (set (make-local-variable variable) value) |
1541 | (setq alist (cdr alist)))))))) | |
a2b8e66b SM |
1542 | |
1543 | (defun font-lock-unset-defaults () | |
1544 | "Unset fontification defaults. See `font-lock-set-defaults'." | |
2e6a15fc SM |
1545 | (setq font-lock-set-defaults nil |
1546 | font-lock-keywords nil | |
a2b8e66b SM |
1547 | font-lock-keywords-only nil |
1548 | font-lock-keywords-case-fold-search nil | |
1549 | font-lock-syntax-table nil | |
a078558d SM |
1550 | font-lock-beginning-of-syntax-function nil) |
1551 | (let* ((defaults (or font-lock-defaults | |
1552 | (cdr (assq major-mode font-lock-defaults-alist)))) | |
1553 | (alist (nthcdr 5 defaults))) | |
1554 | (while alist | |
1555 | (set (car (car alist)) (default-value (car (car alist)))) | |
1556 | (setq alist (cdr alist))))) | |
030f4a35 | 1557 | \f |
2d63aa67 | 1558 | ;;; Colour etc. support. |
9bfbb130 | 1559 | |
55015061 SM |
1560 | ;; Originally these variable values were face names such as `bold' etc. |
1561 | ;; Now we create our own faces, but we keep these variables for compatibility | |
1562 | ;; and they give users another mechanism for changing face appearance. | |
1563 | ;; We now allow a FACENAME in `font-lock-keywords' to be any expression that | |
1564 | ;; returns a face. So the easiest thing is to continue using these variables, | |
1565 | ;; rather than sometimes evaling FACENAME and sometimes not. sm. | |
1566 | (defvar font-lock-comment-face 'font-lock-comment-face | |
1567 | "Face name to use for comments.") | |
1568 | ||
1569 | (defvar font-lock-string-face 'font-lock-string-face | |
1570 | "Face name to use for strings.") | |
1571 | ||
1572 | (defvar font-lock-keyword-face 'font-lock-keyword-face | |
1573 | "Face name to use for keywords.") | |
1574 | ||
1575 | (defvar font-lock-builtin-face 'font-lock-builtin-face | |
1576 | "Face name to use for builtins.") | |
1577 | ||
1578 | (defvar font-lock-function-name-face 'font-lock-function-name-face | |
1579 | "Face name to use for function names.") | |
1580 | ||
1581 | (defvar font-lock-variable-name-face 'font-lock-variable-name-face | |
1582 | "Face name to use for variable names.") | |
1583 | ||
1584 | (defvar font-lock-type-face 'font-lock-type-face | |
1585 | "Face name to use for type names.") | |
1586 | ||
1587 | (defvar font-lock-reference-face 'font-lock-reference-face | |
1588 | "Face name to use for reference names.") | |
1589 | ||
1590 | (defvar font-lock-warning-face 'font-lock-warning-face | |
1591 | "Face name to use for things that should stand out.") | |
1592 | ||
2273c36b SM |
1593 | ;; Originally face attributes were specified via `font-lock-face-attributes'. |
1594 | ;; Users then changed the default face attributes by setting this variable. | |
1595 | ;; However, we try and be back-compatible and respect its value if set except | |
1596 | ;; for faces where M-x customize has been used to save changes for the face. | |
1597 | (when (boundp 'font-lock-face-attributes) | |
1598 | (let ((face-attributes font-lock-face-attributes)) | |
1599 | (while face-attributes | |
1600 | (let* ((face-attribute (pop face-attributes)) | |
1601 | (face (car face-attribute))) | |
1602 | ;; Rustle up a `defface' SPEC from a `font-lock-face-attributes' entry. | |
1603 | (unless (get face 'saved-face) | |
1604 | (let ((foreground (nth 1 face-attribute)) | |
1605 | (background (nth 2 face-attribute)) | |
1606 | (bold-p (nth 3 face-attribute)) | |
1607 | (italic-p (nth 4 face-attribute)) | |
1608 | (underline-p (nth 5 face-attribute)) | |
1609 | face-spec) | |
1610 | (when foreground | |
1611 | (setq face-spec (cons ':foreground (cons foreground face-spec)))) | |
1612 | (when background | |
1613 | (setq face-spec (cons ':background (cons background face-spec)))) | |
1614 | (when bold-p | |
1615 | (setq face-spec (append '(:bold t) face-spec))) | |
1616 | (when italic-p | |
1617 | (setq face-spec (append '(:italic t) face-spec))) | |
1618 | (when underline-p | |
1619 | (setq face-spec (append '(:underline t) face-spec))) | |
1620 | (custom-declare-face face (list (list t face-spec)) nil))))))) | |
1621 | ||
1622 | ;; But now we do it the custom way. Note that `defface' will not overwrite any | |
1623 | ;; faces declared above via `custom-declare-face'. | |
55015061 SM |
1624 | (defface font-lock-comment-face |
1625 | '((((class grayscale) (background light)) | |
1626 | (:foreground "DimGray" :bold t :italic t)) | |
1627 | (((class grayscale) (background dark)) | |
1628 | (:foreground "LightGray" :bold t :italic t)) | |
1629 | (((class color) (background light)) (:foreground "Firebrick")) | |
1630 | (((class color) (background dark)) (:foreground "OrangeRed")) | |
1631 | (t (:bold t :italic t))) | |
1632 | "Font Lock mode face used to highlight comments." | |
2273c36b | 1633 | :group 'font-lock-highlighting-faces) |
55015061 SM |
1634 | |
1635 | (defface font-lock-string-face | |
1636 | '((((class grayscale) (background light)) (:foreground "DimGray" :italic t)) | |
1637 | (((class grayscale) (background dark)) (:foreground "LightGray" :italic t)) | |
1638 | (((class color) (background light)) (:foreground "RosyBrown")) | |
1639 | (((class color) (background dark)) (:foreground "LightSalmon")) | |
1640 | (t (:italic t))) | |
1641 | "Font Lock mode face used to highlight strings." | |
2273c36b | 1642 | :group 'font-lock-highlighting-faces) |
55015061 SM |
1643 | |
1644 | (defface font-lock-keyword-face | |
1645 | '((((class grayscale) (background light)) (:foreground "LightGray" :bold t)) | |
1646 | (((class grayscale) (background dark)) (:foreground "DimGray" :bold t)) | |
1647 | (((class color) (background light)) (:foreground "Purple")) | |
1648 | (((class color) (background dark)) (:foreground "Cyan")) | |
1649 | (t (:bold t))) | |
1650 | "Font Lock mode face used to highlight keywords." | |
2273c36b | 1651 | :group 'font-lock-highlighting-faces) |
55015061 SM |
1652 | |
1653 | (defface font-lock-builtin-face | |
1654 | '((((class grayscale) (background light)) (:foreground "LightGray" :bold t)) | |
1655 | (((class grayscale) (background dark)) (:foreground "DimGray" :bold t)) | |
1656 | (((class color) (background light)) (:foreground "Orchid")) | |
1657 | (((class color) (background dark)) (:foreground "LightSteelBlue")) | |
1658 | (t (:bold t))) | |
1659 | "Font Lock mode face used to highlight builtins." | |
2273c36b | 1660 | :group 'font-lock-highlighting-faces) |
55015061 SM |
1661 | |
1662 | (defface font-lock-function-name-face | |
55015061 SM |
1663 | '((((class color) (background light)) (:foreground "Blue")) |
1664 | (((class color) (background dark)) (:foreground "LightSkyBlue")) | |
ac6e572c | 1665 | (t (:inverse-video t :bold t))) |
55015061 | 1666 | "Font Lock mode face used to highlight function names." |
2273c36b | 1667 | :group 'font-lock-highlighting-faces) |
55015061 SM |
1668 | |
1669 | (defface font-lock-variable-name-face | |
1670 | '((((class grayscale) (background light)) | |
1671 | (:foreground "Gray90" :bold t :italic t)) | |
1672 | (((class grayscale) (background dark)) | |
1673 | (:foreground "DimGray" :bold t :italic t)) | |
1674 | (((class color) (background light)) (:foreground "DarkGoldenrod")) | |
1675 | (((class color) (background dark)) (:foreground "LightGoldenrod")) | |
1676 | (t (:bold t :italic t))) | |
1677 | "Font Lock mode face used to highlight variable names." | |
2273c36b | 1678 | :group 'font-lock-highlighting-faces) |
55015061 SM |
1679 | |
1680 | (defface font-lock-type-face | |
1681 | '((((class grayscale) (background light)) (:foreground "Gray90" :bold t)) | |
1682 | (((class grayscale) (background dark)) (:foreground "DimGray" :bold t)) | |
1683 | (((class color) (background light)) (:foreground "DarkOliveGreen")) | |
1684 | (((class color) (background dark)) (:foreground "PaleGreen")) | |
1685 | (t (:bold t :underline t))) | |
1686 | "Font Lock mode face used to highlight types." | |
2273c36b | 1687 | :group 'font-lock-highlighting-faces) |
55015061 SM |
1688 | |
1689 | (defface font-lock-reference-face | |
1690 | '((((class grayscale) (background light)) | |
1691 | (:foreground "LightGray" :bold t :underline t)) | |
1692 | (((class grayscale) (background dark)) | |
1693 | (:foreground "Gray50" :bold t :underline t)) | |
1694 | (((class color) (background light)) (:foreground "CadetBlue")) | |
1695 | (((class color) (background dark)) (:foreground "Aquamarine")) | |
1696 | (t (:bold t :underline t))) | |
1697 | "Font Lock mode face used to highlight references." | |
2273c36b | 1698 | :group 'font-lock-highlighting-faces) |
55015061 SM |
1699 | |
1700 | (defface font-lock-warning-face | |
55015061 SM |
1701 | '((((class color) (background light)) (:foreground "Red" :bold t)) |
1702 | (((class color) (background dark)) (:foreground "Pink" :bold t)) | |
ac6e572c | 1703 | (t (:inverse-video t :bold t))) |
55015061 | 1704 | "Font Lock mode face used to highlight warnings." |
2273c36b | 1705 | :group 'font-lock-highlighting-faces) |
2d63aa67 SM |
1706 | |
1707 | ;;; End of Colour etc. support. | |
9bfbb130 | 1708 | \f |
56fcbd7e SM |
1709 | ;;; Menu support. |
1710 | ||
1711 | ;; This section of code is commented out because Emacs does not have real menu | |
1712 | ;; buttons. (We can mimic them by putting "( ) " or "(X) " at the beginning of | |
1713 | ;; the menu entry text, but with Xt it looks both ugly and embarrassingly | |
1714 | ;; amateur.) If/When Emacs gets real menus buttons, put in menu-bar.el after | |
1715 | ;; the entry for "Text Properties" something like: | |
1716 | ;; | |
1717 | ;; (define-key menu-bar-edit-menu [font-lock] | |
1718 | ;; '("Syntax Highlighting" . font-lock-menu)) | |
1719 | ;; | |
1720 | ;; and remove a single ";" from the beginning of each line in the rest of this | |
1721 | ;; section. Probably the mechanism for telling the menu code what are menu | |
1722 | ;; buttons and when they are on or off needs tweaking. I have assumed that the | |
1723 | ;; mechanism is via `menu-toggle' and `menu-selected' symbol properties. sm. | |
1724 | ||
1725 | ;;;;###autoload | |
1726 | ;(progn | |
1727 | ; ;; Make the Font Lock menu. | |
1728 | ; (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting")) | |
1729 | ; ;; Add the menu items in reverse order. | |
1730 | ; (define-key font-lock-menu [fontify-less] | |
1731 | ; '("Less In Current Buffer" . font-lock-fontify-less)) | |
1732 | ; (define-key font-lock-menu [fontify-more] | |
1733 | ; '("More In Current Buffer" . font-lock-fontify-more)) | |
1734 | ; (define-key font-lock-menu [font-lock-sep] | |
1735 | ; '("--")) | |
1736 | ; (define-key font-lock-menu [font-lock-mode] | |
1737 | ; '("In Current Buffer" . font-lock-mode)) | |
1738 | ; (define-key font-lock-menu [global-font-lock-mode] | |
1739 | ; '("In All Buffers" . global-font-lock-mode))) | |
1740 | ; | |
1741 | ;;;;###autoload | |
1742 | ;(progn | |
1743 | ; ;; We put the appropriate `menu-enable' etc. symbol property values on when | |
1744 | ; ;; font-lock.el is loaded, so we don't need to autoload the three variables. | |
1745 | ; (put 'global-font-lock-mode 'menu-toggle t) | |
1746 | ; (put 'font-lock-mode 'menu-toggle t) | |
1747 | ; (put 'font-lock-fontify-more 'menu-enable '(identity)) | |
1748 | ; (put 'font-lock-fontify-less 'menu-enable '(identity))) | |
1749 | ; | |
1750 | ;;; Put the appropriate symbol property values on now. See above. | |
1751 | ;(put 'global-font-lock-mode 'menu-selected 'global-font-lock-mode)) | |
1752 | ;(put 'font-lock-mode 'menu-selected 'font-lock-mode) | |
1753 | ;(put 'font-lock-fontify-more 'menu-enable '(nth 2 font-lock-fontify-level)) | |
1754 | ;(put 'font-lock-fontify-less 'menu-enable '(nth 1 font-lock-fontify-level)) | |
1755 | ; | |
1756 | ;(defvar font-lock-fontify-level nil) ; For less/more fontification. | |
1757 | ; | |
1758 | ;(defun font-lock-fontify-level (level) | |
1759 | ; (let ((font-lock-maximum-decoration level)) | |
1760 | ; (when font-lock-mode | |
1761 | ; (font-lock-mode)) | |
1762 | ; (font-lock-mode) | |
1763 | ; (when font-lock-verbose | |
1764 | ; (message "Fontifying %s... level %d" (buffer-name) level)))) | |
1765 | ; | |
1766 | ;(defun font-lock-fontify-less () | |
1767 | ; "Fontify the current buffer with less decoration. | |
1768 | ;See `font-lock-maximum-decoration'." | |
1769 | ; (interactive) | |
1770 | ; ;; Check in case we get called interactively. | |
1771 | ; (if (nth 1 font-lock-fontify-level) | |
1772 | ; (font-lock-fontify-level (1- (car font-lock-fontify-level))) | |
1773 | ; (error "No less decoration"))) | |
1774 | ; | |
1775 | ;(defun font-lock-fontify-more () | |
1776 | ; "Fontify the current buffer with more decoration. | |
1777 | ;See `font-lock-maximum-decoration'." | |
1778 | ; (interactive) | |
1779 | ; ;; Check in case we get called interactively. | |
1780 | ; (if (nth 2 font-lock-fontify-level) | |
1781 | ; (font-lock-fontify-level (1+ (car font-lock-fontify-level))) | |
1782 | ; (error "No more decoration"))) | |
1783 | ; | |
1784 | ;;; This should be called by `font-lock-set-defaults'. | |
1785 | ;(defun font-lock-set-menu () | |
1786 | ; ;; Activate less/more fontification entries if there are multiple levels for | |
1787 | ; ;; the current buffer. Sets `font-lock-fontify-level' to be of the form | |
1788 | ; ;; (CURRENT-LEVEL IS-LOWER-LEVEL-P IS-HIGHER-LEVEL-P) for menu activation. | |
1789 | ; (let ((keywords (or (nth 0 font-lock-defaults) | |
1790 | ; (nth 1 (assq major-mode font-lock-defaults-alist)))) | |
1791 | ; (level (font-lock-value-in-major-mode font-lock-maximum-decoration))) | |
1792 | ; (make-local-variable 'font-lock-fontify-level) | |
1793 | ; (if (or (symbolp keywords) (= (length keywords) 1)) | |
1794 | ; (font-lock-unset-menu) | |
1795 | ; (cond ((eq level t) | |
1796 | ; (setq level (1- (length keywords)))) | |
1797 | ; ((or (null level) (zerop level)) | |
1798 | ; ;; The default level is usually, but not necessarily, level 1. | |
1799 | ; (setq level (- (length keywords) | |
1800 | ; (length (member (eval (car keywords)) | |
1801 | ; (mapcar 'eval (cdr keywords)))))))) | |
1802 | ; (setq font-lock-fontify-level (list level (> level 1) | |
1803 | ; (< level (1- (length keywords)))))))) | |
1804 | ; | |
1805 | ;;; This should be called by `font-lock-unset-defaults'. | |
1806 | ;(defun font-lock-unset-menu () | |
1807 | ; ;; Deactivate less/more fontification entries. | |
1808 | ; (setq font-lock-fontify-level nil)) | |
2d63aa67 SM |
1809 | |
1810 | ;;; End of Menu support. | |
56fcbd7e | 1811 | \f |
9bfbb130 | 1812 | ;;; Various regexp information shared by several modes. |
a1eb1cf1 | 1813 | ;;; Information specific to a single mode should go in its load library. |
030f4a35 | 1814 | |
1c626aaf | 1815 | ;; Font Lock support for C, C++, Objective-C and Java modes will one day be in |
56fcbd7e SM |
1816 | ;; some cc-font.el (and required by cc-mode.el). However, the below function |
1817 | ;; should stay in font-lock.el, since it is used by other libraries. sm. | |
2e6a15fc | 1818 | |
c1f2ffc8 | 1819 | (defun font-lock-match-c-style-declaration-item-and-skip-to-next (limit) |
2e6a15fc | 1820 | "Match, and move over, any declaration/definition item after point. |
c1f2ffc8 SM |
1821 | Matches after point, but ignores leading whitespace and `*' characters. |
1822 | Does not move further than LIMIT. | |
1823 | ||
ac6e572c SM |
1824 | The expected syntax of a declaration/definition item is `word' (preceded by |
1825 | optional whitespace and `*' characters and proceeded by optional whitespace) | |
1826 | optionally followed by a `('. Everything following the item (but belonging to | |
1827 | it) is expected to by skip-able by `scan-sexps', and items are expected to be | |
1828 | separated with a `,' and to be terminated with a `;'. | |
c1f2ffc8 SM |
1829 | |
1830 | Thus the regexp matches after point: word ( | |
1831 | ^^^^ ^ | |
1832 | Where the match subexpressions are: 1 2 | |
1833 | ||
1834 | The item is delimited by (match-beginning 1) and (match-end 1). | |
1835 | If (match-beginning 2) is non-nil, the item is followed by a `('. | |
1836 | ||
1837 | This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item." | |
1838 | (when (looking-at "[ \t*]*\\(\\sw+\\)[ \t]*\\((\\)?") | |
2e6a15fc SM |
1839 | (save-match-data |
1840 | (condition-case nil | |
1841 | (save-restriction | |
1842 | ;; Restrict to the end of line, currently guaranteed to be LIMIT. | |
1843 | (narrow-to-region (point-min) limit) | |
1844 | (goto-char (match-end 1)) | |
1845 | ;; Move over any item value, etc., to the next item. | |
1846 | (while (not (looking-at "[ \t]*\\(\\(,\\)\\|;\\|$\\)")) | |
1847 | (goto-char (or (scan-sexps (point) 1) (point-max)))) | |
1848 | (goto-char (match-end 2))) | |
1849 | (error t))))) | |
1850 | ||
1851 | ||
030f4a35 | 1852 | (defconst lisp-font-lock-keywords-1 |
2e6a15fc SM |
1853 | (eval-when-compile |
1854 | (list | |
2d63aa67 | 1855 | ;; |
55015061 SM |
1856 | ;; Definitions. |
1857 | (list (concat "(\\(def\\(" | |
1858 | ;; Function declarations. | |
1859 | "\\(advice\\|alias\\|" | |
2273c36b | 1860 | "ine-\\(derived-mode\\|function\\|skeleton\\|widget\\)\\|" |
55015061 | 1861 | "macro\\|subst\\|un\\)\\|" |
2e6a15fc | 1862 | ;; Variable declarations. |
56fcbd7e | 1863 | "\\(const\\|custom\\|face\\|var\\)\\|" |
2e6a15fc | 1864 | ;; Structure declarations. |
55015061 | 1865 | "\\(class\\|group\\|struct\\|type\\)" |
2e6a15fc | 1866 | "\\)\\)\\>" |
55015061 | 1867 | ;; Any whitespace and defined object. |
2e6a15fc SM |
1868 | "[ \t'\(]*" |
1869 | "\\(\\sw+\\)?") | |
1870 | '(1 font-lock-keyword-face) | |
55015061 SM |
1871 | '(7 (cond ((match-beginning 3) font-lock-function-name-face) |
1872 | ((match-beginning 5) font-lock-variable-name-face) | |
1873 | (t font-lock-type-face)) | |
2e6a15fc | 1874 | nil t)) |
2d63aa67 SM |
1875 | ;; |
1876 | ;; Emacs Lisp autoload cookies. | |
1877 | '("^;;;\\(###\\)\\(autoload\\)\\>" | |
1878 | (1 font-lock-reference-face prepend) | |
1879 | (2 font-lock-warning-face prepend)) | |
2e6a15fc | 1880 | )) |
56fcbd7e | 1881 | "Subdued level highlighting for Lisp modes.") |
030f4a35 RS |
1882 | |
1883 | (defconst lisp-font-lock-keywords-2 | |
799761f0 | 1884 | (append lisp-font-lock-keywords-1 |
2e6a15fc SM |
1885 | (eval-when-compile |
1886 | (list | |
1887 | ;; | |
2d63aa67 | 1888 | ;; Control structures. Emacs Lisp forms. |
ac6e572c SM |
1889 | (cons (concat |
1890 | "(" (regexp-opt | |
1891 | '("cond" "if" "while" "catch" "throw" "let" "let*" | |
1892 | "prog" "progn" "progv" "prog1" "prog2" "prog*" | |
1893 | "inline" "save-restriction" "save-excursion" | |
1894 | "save-window-excursion" "save-selected-window" | |
1895 | "save-match-data" "save-current-buffer" "unwind-protect" | |
1896 | "condition-case" "track-mouse" "dont-compile" | |
1897 | "eval-after-load" "eval-and-compile" "eval-when-compile" | |
1898 | "eval-when" "with-output-to-temp-buffer" "with-timeout" | |
1899 | "with-current-buffer" "with-temp-buffer" | |
1900 | "with-temp-file") t) | |
1901 | "\\>") | |
2e6a15fc SM |
1902 | 1) |
1903 | ;; | |
2d63aa67 | 1904 | ;; Control structures. Common Lisp forms. |
ac6e572c SM |
1905 | (cons (concat |
1906 | "(" (regexp-opt | |
1907 | '("when" "unless" "case" "ecase" "typecase" "etypecase" | |
1908 | "loop" "do" "do*" "dotimes" "dolist" | |
1909 | "proclaim" "declaim" "declare" | |
1910 | "lexical-let" "lexical-let*" "flet" "labels" | |
1911 | "return" "return-from") t) | |
1912 | "\\>") | |
2d63aa67 SM |
1913 | 1) |
1914 | ;; | |
2e6a15fc SM |
1915 | ;; Feature symbols as references. |
1916 | '("(\\(featurep\\|provide\\|require\\)\\>[ \t']*\\(\\sw+\\)?" | |
1917 | (1 font-lock-keyword-face) (2 font-lock-reference-face nil t)) | |
1918 | ;; | |
1919 | ;; Words inside \\[] tend to be for `substitute-command-keys'. | |
1920 | '("\\\\\\\\\\[\\(\\sw+\\)]" 1 font-lock-reference-face prepend) | |
1921 | ;; | |
1922 | ;; Words inside `' tend to be symbol names. | |
1923 | '("`\\(\\sw\\sw+\\)'" 1 font-lock-reference-face prepend) | |
1924 | ;; | |
c1f2ffc8 SM |
1925 | ;; CLisp `:' keywords as builtins. |
1926 | '("\\<:\\sw\\sw+\\>" 0 font-lock-builtin-face) | |
2e6a15fc SM |
1927 | ;; |
1928 | ;; ELisp and CLisp `&' keywords as types. | |
1929 | '("\\<\\&\\sw+\\>" . font-lock-type-face) | |
1930 | ))) | |
fb512de9 | 1931 | "Gaudy level highlighting for Lisp modes.") |
030f4a35 | 1932 | |
2e6a15fc | 1933 | |
fb512de9 SM |
1934 | (defvar lisp-font-lock-keywords lisp-font-lock-keywords-1 |
1935 | "Default expressions to highlight in Lisp modes.") | |
030f4a35 RS |
1936 | |
1937 | ||
d46c21ec | 1938 | (defvar scheme-font-lock-keywords |
9bfbb130 SM |
1939 | (eval-when-compile |
1940 | (list | |
1941 | ;; | |
1942 | ;; Declarations. Hannes Haug <hannes.haug@student.uni-tuebingen.de> says | |
1943 | ;; this works for SOS, STklos, SCOOPS, Meroon and Tiny CLOS. | |
1944 | (list (concat "(\\(define\\(" | |
1945 | ;; Function names. | |
1946 | "\\(\\|-\\(generic\\(\\|-procedure\\)\\|method\\)\\)\\|" | |
1947 | ;; Macro names, as variable names. A bit dubious, this. | |
1948 | "\\(-syntax\\)\\|" | |
1949 | ;; Class names. | |
2e6a15fc | 1950 | "-class" |
9bfbb130 SM |
1951 | "\\)\\)\\>" |
1952 | ;; Any whitespace and declared object. | |
1953 | "[ \t]*(?" | |
1954 | "\\(\\sw+\\)?") | |
1955 | '(1 font-lock-keyword-face) | |
2e6a15fc | 1956 | '(7 (cond ((match-beginning 3) font-lock-function-name-face) |
9bfbb130 SM |
1957 | ((match-beginning 6) font-lock-variable-name-face) |
1958 | (t font-lock-type-face)) | |
1959 | nil t)) | |
1960 | ;; | |
1961 | ;; Control structures. | |
9bfbb130 | 1962 | (cons |
ac6e572c SM |
1963 | (concat |
1964 | "(" (regexp-opt | |
1965 | '("begin" "call-with-current-continuation" "call/cc" | |
1966 | "call-with-input-file" "call-with-output-file" "case" "cond" | |
1967 | "do" "else" "for-each" "if" "lambda" | |
1968 | "let" "let*" "let-syntax" "letrec" "letrec-syntax" | |
1969 | ;; Hannes Haug <hannes.haug@student.uni-tuebingen.de> wants: | |
1970 | "and" "or" "delay" | |
1971 | ;; Stefan Monnier <stefan.monnier@epfl.ch> says don't bother: | |
1972 | ;;"quasiquote" "quote" "unquote" "unquote-splicing" | |
1973 | "map" "syntax" "syntax-rules") t) | |
1974 | "\\>") 1) | |
9bfbb130 SM |
1975 | ;; |
1976 | ;; David Fox <fox@graphics.cs.nyu.edu> for SOS/STklos class specifiers. | |
1977 | '("\\<<\\sw+>\\>" . font-lock-type-face) | |
1978 | ;; | |
1979 | ;; Scheme `:' keywords as references. | |
1980 | '("\\<:\\sw+\\>" . font-lock-reference-face) | |
1981 | )) | |
2e6a15fc | 1982 | "Default expressions to highlight in Scheme modes.") |
d46c21ec SM |
1983 | |
1984 | ||
2e6a15fc SM |
1985 | (defvar tex-font-lock-keywords |
1986 | ; ;; Regexps updated with help from Ulrik Dickow <dickow@nbi.dk>. | |
1987 | ; '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}" | |
1988 | ; 2 font-lock-function-name-face) | |
1989 | ; ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}" | |
1990 | ; 2 font-lock-reference-face) | |
1991 | ; ;; It seems a bit dubious to use `bold' and `italic' faces since we might | |
1992 | ; ;; not be able to display those fonts. | |
1993 | ; ("{\\\\bf\\([^}]+\\)}" 1 'bold keep) | |
1994 | ; ("{\\\\\\(em\\|it\\|sl\\)\\([^}]+\\)}" 2 'italic keep) | |
1995 | ; ("\\\\\\([a-zA-Z@]+\\|.\\)" . font-lock-keyword-face) | |
1996 | ; ("^[ \t\n]*\\\\def[\\\\@]\\(\\w+\\)" 1 font-lock-function-name-face keep)) | |
1997 | ;; Rewritten and extended for LaTeX2e by Ulrik Dickow <dickow@nbi.dk>. | |
1998 | '(("\\\\\\(begin\\|end\\|newcommand\\){\\([a-zA-Z0-9\\*]+\\)}" | |
1999 | 2 font-lock-function-name-face) | |
2000 | ("\\\\\\(cite\\|label\\|pageref\\|ref\\){\\([^} \t\n]+\\)}" | |
2001 | 2 font-lock-reference-face) | |
2002 | ("^[ \t]*\\\\def\\\\\\(\\(\\w\\|@\\)+\\)" 1 font-lock-function-name-face) | |
2003 | "\\\\\\([a-zA-Z@]+\\|.\\)" | |
2004 | ;; It seems a bit dubious to use `bold' and `italic' faces since we might | |
2005 | ;; not be able to display those fonts. | |
2006 | ;; LaTeX2e: \emph{This is emphasized}. | |
2007 | ("\\\\emph{\\([^}]+\\)}" 1 'italic keep) | |
2008 | ;; LaTeX2e: \textbf{This is bold}, \textit{...}, \textsl{...} | |
2009 | ("\\\\text\\(\\(bf\\)\\|it\\|sl\\){\\([^}]+\\)}" | |
2010 | 3 (if (match-beginning 2) 'bold 'italic) keep) | |
2011 | ;; Old-style bf/em/it/sl. Stop at `\\' and un-escaped `&', for good tables. | |
2012 | ("\\\\\\(\\(bf\\)\\|em\\|it\\|sl\\)\\>\\(\\([^}&\\]\\|\\\\[^\\]\\)+\\)" | |
2013 | 3 (if (match-beginning 2) 'bold 'italic) keep)) | |
2014 | "Default expressions to highlight in TeX modes.") | |
2015 | \f | |
2016 | ;;; User choices. | |
030f4a35 | 2017 | |
c1f2ffc8 SM |
2018 | ;; These provide a means to fontify types not defined by the language. Those |
2019 | ;; types might be the user's own or they might be generally accepted and used. | |
55015061 | 2020 | ;; Generally accepted types are used to provide default variable values. |
c1f2ffc8 | 2021 | |
2273c36b SM |
2022 | (define-widget 'font-lock-extra-types-widget 'radio |
2023 | "Widget `:type' for members of the custom group `font-lock-extra-types'. | |
2024 | Members should `:load' the package `font-lock' to use this widget." | |
2025 | :args '((const :tag "none" nil) | |
2026 | (repeat :tag "types" | |
2027 | (string :tag "regexp")))) | |
2028 | ||
2029 | (defcustom c-font-lock-extra-types '("FILE" "\\sw+_t") | |
2e6a15fc | 2030 | "*List of extra types to fontify in C mode. |
55015061 | 2031 | Each list item should be a regexp not containing word-delimiters. |
c1f2ffc8 | 2032 | For example, a value of (\"FILE\" \"\\\\sw+_t\") means the word FILE and words |
55015061 SM |
2033 | ending in _t are treated as type names. |
2034 | ||
2273c36b SM |
2035 | The value of this variable is used when Font Lock mode is turned on." |
2036 | :type 'font-lock-extra-types-widget | |
2037 | :group 'font-lock-extra-types) | |
9bfbb130 | 2038 | |
2273c36b | 2039 | (defcustom c++-font-lock-extra-types '("string") |
2e6a15fc | 2040 | "*List of extra types to fontify in C++ mode. |
55015061 SM |
2041 | Each list item should be a regexp not containing word-delimiters. |
2042 | For example, a value of (\"string\") means the word string is treated as a type | |
2043 | name. | |
2044 | ||
2273c36b SM |
2045 | The value of this variable is used when Font Lock mode is turned on." |
2046 | :type 'font-lock-extra-types-widget | |
2047 | :group 'font-lock-extra-types) | |
030f4a35 | 2048 | |
2273c36b | 2049 | (defcustom objc-font-lock-extra-types '("Class" "BOOL" "IMP" "SEL") |
2e6a15fc | 2050 | "*List of extra types to fontify in Objective-C mode. |
55015061 | 2051 | Each list item should be a regexp not containing word-delimiters. |
c1f2ffc8 | 2052 | For example, a value of (\"Class\" \"BOOL\" \"IMP\" \"SEL\") means the words |
55015061 SM |
2053 | Class, BOOL, IMP and SEL are treated as type names. |
2054 | ||
2273c36b SM |
2055 | The value of this variable is used when Font Lock mode is turned on." |
2056 | :type 'font-lock-extra-types-widget | |
2057 | :group 'font-lock-extra-types) | |
1bd50840 | 2058 | |
2273c36b | 2059 | (defcustom java-font-lock-extra-types '("[A-Z\300-\326\330-\337]\\sw+") |
2e6a15fc | 2060 | "*List of extra types to fontify in Java mode. |
55015061 | 2061 | Each list item should be a regexp not containing word-delimiters. |
c1f2ffc8 | 2062 | For example, a value of (\"[A-Z\300-\326\330-\337]\\\\sw+\") means capitalised |
55015061 SM |
2063 | words (and words conforming to the Java id spec) are treated as type names. |
2064 | ||
2273c36b SM |
2065 | The value of this variable is used when Font Lock mode is turned on." |
2066 | :type 'font-lock-extra-types-widget | |
2067 | :group 'font-lock-extra-types) | |
2e6a15fc SM |
2068 | \f |
2069 | ;;; C. | |
c1f2ffc8 SM |
2070 | |
2071 | ;; [Murmur murmur murmur] Maestro, drum-roll please... [Murmur murmur murmur.] | |
2072 | ;; Ahem. [Murmur murmur murmur] Lay-dees an Gennel-men. [Murmur murmur shhh!] | |
2073 | ;; I am most proud and humbly honoured today [murmur murmur cough] to present | |
2074 | ;; to you good people, the winner of the Second Millennium Award for The Most | |
2075 | ;; Hairy Language Syntax. [Ahhh!] All rise please. [Shuffle shuffle | |
2076 | ;; shuffle.] And a round of applause please. For... The C Language! [Roar.] | |
2077 | ;; | |
2078 | ;; Thank you... You are too kind... It is with a feeling of great privilege | |
2079 | ;; and indeed emotion [sob] that I accept this award. It has been a long hard | |
2080 | ;; road. But we know our destiny. And our future. For we must not rest. | |
2081 | ;; There are more tokens to overload, more shoehorn, more methodologies. But | |
2082 | ;; more is a plus! [Ha ha ha.] And more means plus! [Ho ho ho.] The future | |
1c626aaf | 2083 | ;; is C++! [Ohhh!] The Third Millennium Award... Will be ours! [Roar.] |
c1f2ffc8 | 2084 | |
2e6a15fc SM |
2085 | (defconst c-font-lock-keywords-1 nil |
2086 | "Subdued level highlighting for C mode.") | |
9bfbb130 | 2087 | |
2e6a15fc SM |
2088 | (defconst c-font-lock-keywords-2 nil |
2089 | "Medium level highlighting for C mode. | |
2090 | See also `c-font-lock-extra-types'.") | |
1bd50840 | 2091 | |
2e6a15fc SM |
2092 | (defconst c-font-lock-keywords-3 nil |
2093 | "Gaudy level highlighting for C mode. | |
2094 | See also `c-font-lock-extra-types'.") | |
9bfbb130 | 2095 | |
2d63aa67 | 2096 | (let* ((c-keywords |
ac6e572c SM |
2097 | (eval-when-compile |
2098 | (regexp-opt '("break" "continue" "do" "else" "for" "if" "return" | |
2099 | "switch" "while") t))) | |
2d63aa67 | 2100 | (c-type-types |
2d63aa67 SM |
2101 | `(mapconcat 'identity |
2102 | (cons | |
ac6e572c SM |
2103 | (,@ (eval-when-compile |
2104 | (regexp-opt | |
2105 | '("auto" "extern" "register" "static" "typedef" "struct" | |
2106 | "union" "enum" "signed" "unsigned" "short" "long" | |
2107 | "int" "char" "float" "double" "void" "volatile" "const")))) | |
2d63aa67 SM |
2108 | c-font-lock-extra-types) |
2109 | "\\|")) | |
ac6e572c | 2110 | (c-type-depth `(regexp-opt-depth (,@ c-type-types))) |
2d63aa67 | 2111 | ) |
f60f18ae KH |
2112 | (setq c-font-lock-keywords-1 |
2113 | (list | |
f60f18ae | 2114 | ;; |
9bfbb130 | 2115 | ;; These are all anchored at the beginning of line for speed. |
2e6a15fc | 2116 | ;; Note that `c++-font-lock-keywords-1' depends on `c-font-lock-keywords-1'. |
9bfbb130 SM |
2117 | ;; |
2118 | ;; Fontify function name definitions (GNU style; without type on line). | |
c1f2ffc8 SM |
2119 | '("^\\(\\sw+\\)[ \t]*(" 1 font-lock-function-name-face) |
2120 | ;; | |
2121 | ;; Fontify error directives. | |
2122 | '("^#[ \t]*error[ \t]+\\(.+\\)" 1 font-lock-warning-face prepend) | |
9bfbb130 SM |
2123 | ;; |
2124 | ;; Fontify filenames in #include <...> preprocessor directives as strings. | |
c1f2ffc8 | 2125 | '("^#[ \t]*\\(import\\|include\\)[ \t]+\\(<[^>\"\n]*>?\\)" |
2e6a15fc | 2126 | 2 font-lock-string-face) |
f60f18ae | 2127 | ;; |
a1eb1cf1 | 2128 | ;; Fontify function macro names. |
7d7d915a | 2129 | '("^#[ \t]*define[ \t]+\\(\\sw+\\)(" 1 font-lock-function-name-face) |
f60f18ae | 2130 | ;; |
5aa29679 RS |
2131 | ;; Fontify symbol names in #elif or #if ... defined preprocessor directives. |
2132 | '("^#[ \t]*\\(elif\\|if\\)\\>" | |
9bfbb130 SM |
2133 | ("\\<\\(defined\\)\\>[ \t]*(?\\(\\sw+\\)?" nil nil |
2134 | (1 font-lock-reference-face) (2 font-lock-variable-name-face nil t))) | |
2135 | ;; | |
a1eb1cf1 | 2136 | ;; Fontify otherwise as symbol names, and the preprocessor directive names. |
7d7d915a | 2137 | '("^#[ \t]*\\(\\sw+\\)\\>[ \t]*\\(\\sw+\\)?" |
a1eb1cf1 | 2138 | (1 font-lock-reference-face) (2 font-lock-variable-name-face nil t)) |
f60f18ae KH |
2139 | )) |
2140 | ||
2141 | (setq c-font-lock-keywords-2 | |
2142 | (append c-font-lock-keywords-1 | |
030f4a35 | 2143 | (list |
030f4a35 | 2144 | ;; |
9bfbb130 | 2145 | ;; Simple regexps for speed. |
b89e1134 | 2146 | ;; |
9bfbb130 | 2147 | ;; Fontify all type specifiers. |
c1f2ffc8 SM |
2148 | `(eval . |
2149 | (cons (concat "\\<\\(" (,@ c-type-types) "\\)\\>") 'font-lock-type-face)) | |
030f4a35 | 2150 | ;; |
b89e1134 | 2151 | ;; Fontify all builtin keywords (except case, default and goto; see below). |
ac6e572c | 2152 | (concat "\\<" c-keywords "\\>") |
030f4a35 | 2153 | ;; |
9bfbb130 | 2154 | ;; Fontify case/goto keywords and targets, and case default/goto tags. |
56fcbd7e | 2155 | '("\\<\\(case\\|goto\\)\\>[ \t]*\\(-?\\sw+\\)?" |
a1eb1cf1 | 2156 | (1 font-lock-keyword-face) (2 font-lock-reference-face nil t)) |
2e6a15fc SM |
2157 | ;; Anders Lindgren <andersl@csd.uu.se> points out that it is quicker to use |
2158 | ;; MATCH-ANCHORED to effectively anchor the regexp on the left. | |
2159 | '(":" ("^[ \t]*\\(\\sw+\\)[ \t]*:" | |
2160 | (beginning-of-line) (end-of-line) | |
2161 | (1 font-lock-reference-face))) | |
f60f18ae | 2162 | ))) |
1bd50840 | 2163 | |
9bfbb130 SM |
2164 | (setq c-font-lock-keywords-3 |
2165 | (append c-font-lock-keywords-2 | |
2166 | ;; | |
2167 | ;; More complicated regexps for more complete highlighting for types. | |
2168 | ;; We still have to fontify type specifiers individually, as C is so hairy. | |
2169 | (list | |
2170 | ;; | |
2171 | ;; Fontify all storage classes and type specifiers, plus their items. | |
c1f2ffc8 SM |
2172 | `(eval . |
2173 | (list (concat "\\<\\(" (,@ c-type-types) "\\)\\>" | |
2174 | "\\([ \t*&]+\\sw+\\>\\)*") | |
2175 | ;; Fontify each declaration item. | |
2d63aa67 SM |
2176 | (list 'font-lock-match-c-style-declaration-item-and-skip-to-next |
2177 | ;; Start with point after all type specifiers. | |
2178 | (list 'goto-char (list 'or (list 'match-beginning | |
2179 | (+ (,@ c-type-depth) 2)) | |
2180 | '(match-end 1))) | |
2181 | ;; Finish with point after first type specifier. | |
2182 | '(goto-char (match-end 1)) | |
2183 | ;; Fontify as a variable or function name. | |
2184 | '(1 (if (match-beginning 2) | |
2185 | font-lock-function-name-face | |
2186 | font-lock-variable-name-face))))) | |
9bfbb130 SM |
2187 | ;; |
2188 | ;; Fontify structures, or typedef names, plus their items. | |
2189 | '("\\(}\\)[ \t*]*\\sw" | |
c1f2ffc8 | 2190 | (font-lock-match-c-style-declaration-item-and-skip-to-next |
9bfbb130 | 2191 | (goto-char (match-end 1)) nil |
c1f2ffc8 | 2192 | (1 (if (match-beginning 2) |
9bfbb130 SM |
2193 | font-lock-function-name-face |
2194 | font-lock-variable-name-face)))) | |
2195 | ;; | |
2196 | ;; Fontify anything at beginning of line as a declaration or definition. | |
2197 | '("^\\(\\sw+\\)\\>\\([ \t*]+\\sw+\\>\\)*" | |
2198 | (1 font-lock-type-face) | |
c1f2ffc8 | 2199 | (font-lock-match-c-style-declaration-item-and-skip-to-next |
9bfbb130 | 2200 | (goto-char (or (match-beginning 2) (match-end 1))) nil |
c1f2ffc8 | 2201 | (1 (if (match-beginning 2) |
9bfbb130 SM |
2202 | font-lock-function-name-face |
2203 | font-lock-variable-name-face)))) | |
2204 | ))) | |
2e6a15fc SM |
2205 | ) |
2206 | ||
2207 | (defvar c-font-lock-keywords c-font-lock-keywords-1 | |
2208 | "Default expressions to highlight in C mode. | |
2209 | See also `c-font-lock-extra-types'.") | |
2210 | \f | |
2211 | ;;; C++. | |
2212 | ||
2213 | (defconst c++-font-lock-keywords-1 nil | |
2214 | "Subdued level highlighting for C++ mode.") | |
2215 | ||
2216 | (defconst c++-font-lock-keywords-2 nil | |
2217 | "Medium level highlighting for C++ mode. | |
2218 | See also `c++-font-lock-extra-types'.") | |
2219 | ||
2220 | (defconst c++-font-lock-keywords-3 nil | |
2221 | "Gaudy level highlighting for C++ mode. | |
2222 | See also `c++-font-lock-extra-types'.") | |
9bfbb130 | 2223 | |
c1f2ffc8 SM |
2224 | (defun font-lock-match-c++-style-declaration-item-and-skip-to-next (limit) |
2225 | ;; Regexp matches after point: word<word>::word ( | |
2226 | ;; ^^^^ ^^^^ ^^^^ ^ | |
2227 | ;; Where the match subexpressions are: 1 3 5 6 | |
2228 | ;; | |
2229 | ;; Item is delimited by (match-beginning 1) and (match-end 1). | |
2230 | ;; If (match-beginning 3) is non-nil, that part of the item incloses a `<>'. | |
2231 | ;; If (match-beginning 5) is non-nil, that part of the item follows a `::'. | |
2232 | ;; If (match-beginning 6) is non-nil, the item is followed by a `('. | |
2233 | (when (looking-at (eval-when-compile | |
55015061 SM |
2234 | (concat |
2235 | ;; Skip any leading whitespace. | |
2236 | "[ \t*&]*" | |
2237 | ;; This is `c++-type-spec' from below. (Hint hint!) | |
2238 | "\\(\\sw+\\)" ; The instance? | |
ac6e572c | 2239 | "\\([ \t]*<\\([^>\n]+\\)[ \t*&]*>\\)?" ; Or template? |
55015061 SM |
2240 | "\\([ \t]*::[ \t*~]*\\(\\sw+\\)\\)?" ; Or member? |
2241 | ;; Match any trailing parenthesis. | |
2242 | "[ \t]*\\((\\)?"))) | |
c1f2ffc8 SM |
2243 | (save-match-data |
2244 | (condition-case nil | |
2245 | (save-restriction | |
2246 | ;; Restrict to the end of line, currently guaranteed to be LIMIT. | |
2247 | (narrow-to-region (point-min) limit) | |
2248 | (goto-char (match-end 1)) | |
2249 | ;; Move over any item value, etc., to the next item. | |
2250 | (while (not (looking-at "[ \t]*\\(\\(,\\)\\|;\\|$\\)")) | |
2251 | (goto-char (or (scan-sexps (point) 1) (point-max)))) | |
2252 | (goto-char (match-end 2))) | |
2253 | (error t))))) | |
2254 | ||
2255 | (let* ((c++-keywords | |
ac6e572c SM |
2256 | (eval-when-compile |
2257 | (regexp-opt | |
2258 | '("break" "continue" "do" "else" "for" "if" "return" "switch" | |
2259 | "while" "asm" "catch" "delete" "new" "operator" "sizeof" "this" | |
2260 | "throw" "try" | |
2261 | ;; Eric Hopper <hopper@omnifarious.mn.org> says these are new. | |
2262 | "static_cast" "dynamic_cast" "const_cast" "reinterpret_cast") t))) | |
c1f2ffc8 SM |
2263 | (c++-operators |
2264 | (mapconcat 'identity | |
2265 | (mapcar 'regexp-quote | |
2266 | ;; Taken from Stroustrup, minus keywords otherwise fontified. | |
2267 | (sort '("+" "-" "*" "/" "%" "^" "&" "|" "~" "!" "=" "<" ">" | |
2268 | "+=" "-=" "*=" "/=" "%=" "^=" "&=" "|=" "<<" ">>" | |
2269 | ">>=" "<<=" "==" "!=" "<=" ">=" "&&" "||" "++" "--" | |
2270 | "->*" "," "->" "[]" "()") | |
1c626aaf | 2271 | #'(lambda (a b) (> (length a) (length b))))) |
c1f2ffc8 SM |
2272 | "\\|")) |
2273 | (c++-type-types | |
c1f2ffc8 SM |
2274 | `(mapconcat 'identity |
2275 | (cons | |
ac6e572c SM |
2276 | (,@ (eval-when-compile |
2277 | (regexp-opt | |
2278 | '("auto" "extern" "register" "static" "typedef" "struct" | |
2279 | "union" "enum" "signed" "unsigned" "short" "long" | |
2280 | "int" "char" "float" "double" "void" "volatile" "const" | |
2281 | "inline" "friend" "bool" "virtual" "complex" "template" | |
2282 | "namespace" "using")))) | |
c1f2ffc8 SM |
2283 | c++-font-lock-extra-types) |
2284 | "\\|")) | |
55015061 SM |
2285 | ;; |
2286 | ;; A brave attempt to match templates following a type and/or match | |
2287 | ;; class membership. See and sync the above function | |
2288 | ;; `font-lock-match-c++-style-declaration-item-and-skip-to-next'. | |
ac6e572c | 2289 | (c++-type-suffix (concat "\\([ \t]*<\\([^>\n]+\\)[ \t*&]*>\\)?" |
55015061 SM |
2290 | "\\([ \t]*::[ \t*~]*\\(\\sw+\\)\\)?")) |
2291 | ;; If the string is a type, it may be followed by the cruft above. | |
2292 | (c++-type-spec (concat "\\(\\sw+\\)\\>" c++-type-suffix)) | |
2293 | ;; | |
2294 | ;; Parenthesis depth of user-defined types not forgetting their cruft. | |
ac6e572c | 2295 | (c++-type-depth `(regexp-opt-depth |
2d63aa67 | 2296 | (concat (,@ c++-type-types) (,@ c++-type-suffix)))) |
2d63aa67 | 2297 | ) |
9bfbb130 SM |
2298 | (setq c++-font-lock-keywords-1 |
2299 | (append | |
2300 | ;; | |
2301 | ;; The list `c-font-lock-keywords-1' less that for function names. | |
2302 | (cdr c-font-lock-keywords-1) | |
9bfbb130 | 2303 | (list |
2e6a15fc | 2304 | ;; |
c1f2ffc8 SM |
2305 | ;; Class names etc. |
2306 | (list (concat "\\<\\(class\\|public\\|private\\|protected\\)\\>[ \t]*" | |
2307 | "\\(" c++-type-spec "\\)?") | |
2308 | '(1 font-lock-type-face) | |
2309 | '(3 (if (match-beginning 6) | |
2310 | font-lock-type-face | |
2311 | font-lock-function-name-face) nil t) | |
2312 | '(5 font-lock-function-name-face nil t) | |
2313 | '(7 font-lock-function-name-face nil t)) | |
2314 | ;; | |
2315 | ;; Fontify function name definitions, possibly incorporating class names. | |
2316 | (list (concat "^" c++-type-spec "[ \t]*(") | |
2317 | '(1 (if (or (match-beginning 2) (match-beginning 4)) | |
2318 | font-lock-type-face | |
2319 | font-lock-function-name-face)) | |
2320 | '(3 font-lock-function-name-face nil t) | |
2321 | '(5 font-lock-function-name-face nil t)) | |
9bfbb130 SM |
2322 | ))) |
2323 | ||
1bd50840 | 2324 | (setq c++-font-lock-keywords-2 |
b89e1134 | 2325 | (append c++-font-lock-keywords-1 |
a1eb1cf1 | 2326 | (list |
9bfbb130 SM |
2327 | ;; |
2328 | ;; The list `c-font-lock-keywords-2' for C++ plus operator overloading. | |
c1f2ffc8 SM |
2329 | `(eval . |
2330 | (cons (concat "\\<\\(" (,@ c++-type-types) "\\)\\>") | |
2331 | 'font-lock-type-face)) | |
9bfbb130 | 2332 | ;; |
c1f2ffc8 SM |
2333 | ;; Fontify operator overloading. |
2334 | (list (concat "\\<\\(operator\\)\\>[ \t]*\\(" c++-operators "\\)?") | |
2335 | '(1 font-lock-keyword-face) | |
2336 | '(2 font-lock-builtin-face nil t)) | |
9bfbb130 SM |
2337 | ;; |
2338 | ;; Fontify case/goto keywords and targets, and case default/goto tags. | |
56fcbd7e | 2339 | '("\\<\\(case\\|goto\\)\\>[ \t]*\\(-?\\sw+\\)?" |
b89e1134 | 2340 | (1 font-lock-keyword-face) (2 font-lock-reference-face nil t)) |
2e6a15fc SM |
2341 | '(":" ("^[ \t]*\\(\\sw+\\)[ \t]*:\\($\\|[^:]\\)" |
2342 | (beginning-of-line) (end-of-line) | |
2343 | (1 font-lock-reference-face))) | |
9bfbb130 SM |
2344 | ;; |
2345 | ;; Fontify other builtin keywords. | |
ac6e572c | 2346 | (concat "\\<" c++-keywords "\\>") |
2e6a15fc SM |
2347 | ;; |
2348 | ;; Eric Hopper <hopper@omnifarious.mn.org> says `true' and `false' are new. | |
2349 | '("\\<\\(false\\|true\\)\\>" . font-lock-reference-face) | |
9bfbb130 SM |
2350 | ))) |
2351 | ||
2352 | (setq c++-font-lock-keywords-3 | |
2353 | (append c++-font-lock-keywords-2 | |
2354 | ;; | |
2355 | ;; More complicated regexps for more complete highlighting for types. | |
2356 | (list | |
2357 | ;; | |
2358 | ;; Fontify all storage classes and type specifiers, plus their items. | |
c1f2ffc8 SM |
2359 | `(eval . |
2360 | (list (concat "\\<\\(" (,@ c++-type-types) "\\)\\>" (,@ c++-type-suffix) | |
2361 | "\\([ \t*&]+" (,@ c++-type-spec) "\\)*") | |
2362 | ;; Fontify each declaration item. | |
2d63aa67 SM |
2363 | (list 'font-lock-match-c++-style-declaration-item-and-skip-to-next |
2364 | ;; Start with point after all type specifiers. | |
2365 | (list 'goto-char (list 'or (list 'match-beginning | |
2366 | (+ (,@ c++-type-depth) 2)) | |
2367 | '(match-end 1))) | |
2368 | ;; Finish with point after first type specifier. | |
2369 | '(goto-char (match-end 1)) | |
2370 | ;; Fontify as a variable or function name. | |
2371 | '(1 (cond ((or (match-beginning 2) (match-beginning 4)) | |
2372 | font-lock-type-face) | |
2373 | ((match-beginning 6) font-lock-function-name-face) | |
2374 | (t font-lock-variable-name-face))) | |
2375 | '(3 font-lock-function-name-face nil t) | |
2376 | '(5 (if (match-beginning 6) | |
2377 | font-lock-function-name-face | |
2378 | font-lock-variable-name-face) nil t)))) | |
9bfbb130 SM |
2379 | ;; |
2380 | ;; Fontify structures, or typedef names, plus their items. | |
2381 | '("\\(}\\)[ \t*]*\\sw" | |
2382 | (font-lock-match-c++-style-declaration-item-and-skip-to-next | |
2383 | (goto-char (match-end 1)) nil | |
c1f2ffc8 | 2384 | (1 (if (match-beginning 6) |
9bfbb130 SM |
2385 | font-lock-function-name-face |
2386 | font-lock-variable-name-face)))) | |
2387 | ;; | |
2388 | ;; Fontify anything at beginning of line as a declaration or definition. | |
c1f2ffc8 SM |
2389 | (list (concat "^\\(" c++-type-spec "[ \t*&]*\\)+") |
2390 | '(font-lock-match-c++-style-declaration-item-and-skip-to-next | |
2391 | (goto-char (match-beginning 1)) | |
2392 | (goto-char (match-end 1)) | |
2393 | (1 (cond ((or (match-beginning 2) (match-beginning 4)) | |
2394 | font-lock-type-face) | |
2395 | ((match-beginning 6) font-lock-function-name-face) | |
2396 | (t font-lock-variable-name-face))) | |
2397 | (3 font-lock-function-name-face nil t) | |
2398 | (5 (if (match-beginning 6) | |
2399 | font-lock-function-name-face | |
2400 | font-lock-variable-name-face) nil t))) | |
9bfbb130 | 2401 | ))) |
f60f18ae | 2402 | ) |
030f4a35 | 2403 | |
fb512de9 | 2404 | (defvar c++-font-lock-keywords c++-font-lock-keywords-1 |
2e6a15fc SM |
2405 | "Default expressions to highlight in C++ mode. |
2406 | See also `c++-font-lock-extra-types'.") | |
2407 | \f | |
2408 | ;;; Objective-C. | |
2409 | ||
2410 | (defconst objc-font-lock-keywords-1 nil | |
2411 | "Subdued level highlighting for Objective-C mode.") | |
2412 | ||
2413 | (defconst objc-font-lock-keywords-2 nil | |
2414 | "Medium level highlighting for Objective-C mode. | |
2415 | See also `objc-font-lock-extra-types'.") | |
2416 | ||
2417 | (defconst objc-font-lock-keywords-3 nil | |
2418 | "Gaudy level highlighting for Objective-C mode. | |
2419 | See also `objc-font-lock-extra-types'.") | |
2420 | ||
2421 | ;; Regexps written with help from Stephen Peters <speters@us.oracle.com> and | |
2422 | ;; Jacques Duthen Prestataire <duthen@cegelec-red.fr>. | |
2d63aa67 | 2423 | (let* ((objc-keywords |
ac6e572c SM |
2424 | (eval-when-compile |
2425 | (regexp-opt '("break" "continue" "do" "else" "for" "if" "return" | |
2426 | "switch" "while" "sizeof" "self" "super") t))) | |
2d63aa67 SM |
2427 | (objc-type-types |
2428 | `(mapconcat 'identity | |
2429 | (cons | |
ac6e572c SM |
2430 | (,@ (eval-when-compile |
2431 | (regexp-opt | |
2432 | '("auto" "extern" "register" "static" "typedef" "struct" | |
2433 | "union" "enum" "signed" "unsigned" "short" "long" | |
2434 | "int" "char" "float" "double" "void" "volatile" "const" | |
2435 | "id" "oneway" "in" "out" "inout" "bycopy" "byref")))) | |
2d63aa67 SM |
2436 | objc-font-lock-extra-types) |
2437 | "\\|")) | |
ac6e572c | 2438 | (objc-type-depth `(regexp-opt-depth (,@ objc-type-types))) |
2d63aa67 | 2439 | ) |
2e6a15fc SM |
2440 | (setq objc-font-lock-keywords-1 |
2441 | (append | |
2442 | ;; | |
2443 | ;; The list `c-font-lock-keywords-1' less that for function names. | |
2444 | (cdr c-font-lock-keywords-1) | |
2445 | (list | |
2446 | ;; | |
2447 | ;; Fontify compiler directives. | |
c1f2ffc8 SM |
2448 | '("@\\(\\sw+\\)\\>" |
2449 | (1 font-lock-keyword-face) | |
2450 | ("\\=[ \t:<(,]*\\(\\sw+\\)" nil nil | |
2e6a15fc SM |
2451 | (1 font-lock-function-name-face))) |
2452 | ;; | |
2453 | ;; Fontify method names and arguments. Oh Lordy! | |
2454 | ;; First, on the same line as the function declaration. | |
2455 | '("^[+-][ \t]*\\(PRIVATE\\)?[ \t]*\\((\\([^)\n]+\\))\\)?[ \t]*\\(\\sw+\\)" | |
2456 | (1 font-lock-type-face nil t) | |
2457 | (3 font-lock-type-face nil t) | |
2458 | (4 font-lock-function-name-face) | |
2459 | ("\\=[ \t]*\\(\\sw+\\)?:[ \t]*\\((\\([^)\n]+\\))\\)?[ \t]*\\(\\sw+\\)" | |
2460 | nil nil | |
2461 | (1 font-lock-function-name-face nil t) | |
2462 | (3 font-lock-type-face nil t) | |
2463 | (4 font-lock-variable-name-face))) | |
2464 | ;; Second, on lines following the function declaration. | |
2465 | '(":" ("^[ \t]*\\(\\sw+\\)?:[ \t]*\\((\\([^)\n]+\\))\\)?[ \t]*\\(\\sw+\\)" | |
2466 | (beginning-of-line) (end-of-line) | |
2467 | (1 font-lock-function-name-face nil t) | |
2468 | (3 font-lock-type-face nil t) | |
2469 | (4 font-lock-variable-name-face))) | |
2470 | ))) | |
030f4a35 | 2471 | |
2e6a15fc SM |
2472 | (setq objc-font-lock-keywords-2 |
2473 | (append objc-font-lock-keywords-1 | |
2474 | (list | |
2475 | ;; | |
2476 | ;; Simple regexps for speed. | |
2477 | ;; | |
2478 | ;; Fontify all type specifiers. | |
c1f2ffc8 SM |
2479 | `(eval . |
2480 | (cons (concat "\\<\\(" (,@ objc-type-types) "\\)\\>") | |
2481 | 'font-lock-type-face)) | |
2e6a15fc SM |
2482 | ;; |
2483 | ;; Fontify all builtin keywords (except case, default and goto; see below). | |
ac6e572c | 2484 | (concat "\\<" objc-keywords "\\>") |
2e6a15fc SM |
2485 | ;; |
2486 | ;; Fontify case/goto keywords and targets, and case default/goto tags. | |
56fcbd7e | 2487 | '("\\<\\(case\\|goto\\)\\>[ \t]*\\(-?\\sw+\\)?" |
2e6a15fc SM |
2488 | (1 font-lock-keyword-face) (2 font-lock-reference-face nil t)) |
2489 | ;; Fontify tags iff sole statement on line, otherwise we detect selectors. | |
2490 | '(":" ("^[ \t]*\\(\\sw+\\)[ \t]*:[ \t]*$" | |
2491 | (beginning-of-line) (end-of-line) | |
2492 | (1 font-lock-reference-face))) | |
2493 | ;; | |
2494 | ;; Fontify null object pointers. | |
2495 | '("\\<\\(Nil\\|nil\\)\\>" 1 font-lock-reference-face) | |
2496 | ))) | |
d46c21ec | 2497 | |
2e6a15fc SM |
2498 | (setq objc-font-lock-keywords-3 |
2499 | (append objc-font-lock-keywords-2 | |
2500 | ;; | |
2501 | ;; More complicated regexps for more complete highlighting for types. | |
2502 | ;; We still have to fontify type specifiers individually, as C is so hairy. | |
2503 | (list | |
2504 | ;; | |
2505 | ;; Fontify all storage classes and type specifiers, plus their items. | |
c1f2ffc8 SM |
2506 | `(eval . |
2507 | (list (concat "\\<\\(" (,@ objc-type-types) "\\)\\>" | |
2508 | "\\([ \t*&]+\\sw+\\>\\)*") | |
2509 | ;; Fontify each declaration item. | |
2d63aa67 SM |
2510 | (list 'font-lock-match-c-style-declaration-item-and-skip-to-next |
2511 | ;; Start with point after all type specifiers. | |
2512 | (list 'goto-char (list 'or (list 'match-beginning | |
2513 | (+ (,@ objc-type-depth) 2)) | |
2514 | '(match-end 1))) | |
2515 | ;; Finish with point after first type specifier. | |
2516 | '(goto-char (match-end 1)) | |
2517 | ;; Fontify as a variable or function name. | |
2518 | '(1 (if (match-beginning 2) | |
2519 | font-lock-function-name-face | |
2520 | font-lock-variable-name-face))))) | |
2e6a15fc SM |
2521 | ;; |
2522 | ;; Fontify structures, or typedef names, plus their items. | |
2523 | '("\\(}\\)[ \t*]*\\sw" | |
c1f2ffc8 | 2524 | (font-lock-match-c-style-declaration-item-and-skip-to-next |
2e6a15fc | 2525 | (goto-char (match-end 1)) nil |
c1f2ffc8 | 2526 | (1 (if (match-beginning 2) |
2e6a15fc SM |
2527 | font-lock-function-name-face |
2528 | font-lock-variable-name-face)))) | |
2529 | ;; | |
2530 | ;; Fontify anything at beginning of line as a declaration or definition. | |
2531 | '("^\\(\\sw+\\)\\>\\([ \t*]+\\sw+\\>\\)*" | |
2532 | (1 font-lock-type-face) | |
c1f2ffc8 | 2533 | (font-lock-match-c-style-declaration-item-and-skip-to-next |
2e6a15fc | 2534 | (goto-char (or (match-beginning 2) (match-end 1))) nil |
c1f2ffc8 | 2535 | (1 (if (match-beginning 2) |
2e6a15fc SM |
2536 | font-lock-function-name-face |
2537 | font-lock-variable-name-face)))) | |
2538 | ))) | |
2539 | ) | |
2540 | ||
2541 | (defvar objc-font-lock-keywords objc-font-lock-keywords-1 | |
2542 | "Default expressions to highlight in Objective-C mode. | |
2543 | See also `objc-font-lock-extra-types'.") | |
2544 | \f | |
2545 | ;;; Java. | |
2546 | ||
2547 | (defconst java-font-lock-keywords-1 nil | |
2548 | "Subdued level highlighting for Java mode.") | |
2549 | ||
2550 | (defconst java-font-lock-keywords-2 nil | |
2551 | "Medium level highlighting for Java mode. | |
2552 | See also `java-font-lock-extra-types'.") | |
2553 | ||
2554 | (defconst java-font-lock-keywords-3 nil | |
2555 | "Gaudy level highlighting for Java mode. | |
2556 | See also `java-font-lock-extra-types'.") | |
2557 | ||
2558 | ;; Regexps written with help from Fred White <fwhite@bbn.com> and | |
2559 | ;; Anders Lindgren <andersl@csd.uu.se>. | |
2d63aa67 | 2560 | (let* ((java-keywords |
ac6e572c SM |
2561 | (eval-when-compile |
2562 | (regexp-opt | |
2563 | '("catch" "do" "else" "super" "this" "finally" "for" "if" | |
2564 | ;; Anders Lindgren <andersl@csd.uu.se> says these have gone. | |
2565 | ;; "cast" "byvalue" "future" "generic" "operator" "var" | |
2566 | ;; "inner" "outer" "rest" | |
2567 | "interface" "return" "switch" "throw" "try" "while") t))) | |
2d63aa67 SM |
2568 | ;; |
2569 | ;; These are immediately followed by an object name. | |
2570 | (java-minor-types | |
ac6e572c SM |
2571 | (eval-when-compile |
2572 | (regexp-opt '("boolean" "char" "byte" "short" "int" "long" | |
2573 | "float" "double" "void")))) | |
2d63aa67 SM |
2574 | ;; |
2575 | ;; These are eventually followed by an object name. | |
2576 | (java-major-types | |
ac6e572c SM |
2577 | (eval-when-compile |
2578 | (regexp-opt | |
2579 | '("abstract" "const" "final" "synchronized" "transient" "static" | |
2580 | ;; Anders Lindgren <andersl@csd.uu.se> says this has gone. | |
2581 | ;; "threadsafe" | |
2582 | "volatile" "public" "private" "protected" "native")))) | |
2d63aa67 SM |
2583 | ;; |
2584 | ;; Random types immediately followed by an object name. | |
2585 | (java-other-types | |
2586 | '(mapconcat 'identity (cons "\\sw+\\.\\sw+" java-font-lock-extra-types) | |
2587 | "\\|")) | |
ac6e572c SM |
2588 | (java-other-depth `(regexp-opt-depth (,@ java-other-types))) |
2589 | ) | |
2e6a15fc SM |
2590 | (setq java-font-lock-keywords-1 |
2591 | (list | |
2592 | ;; | |
2593 | ;; Fontify class names. | |
2594 | '("\\<\\(class\\)\\>[ \t]*\\(\\sw+\\)?" | |
2595 | (1 font-lock-type-face) (2 font-lock-function-name-face nil t)) | |
2596 | ;; | |
2597 | ;; Fontify package names in import directives. | |
2598 | '("\\<\\(import\\|package\\)\\>[ \t]*\\(\\sw+\\)?" | |
2599 | (1 font-lock-keyword-face) (2 font-lock-reference-face nil t)) | |
2600 | )) | |
2601 | ||
2602 | (setq java-font-lock-keywords-2 | |
2603 | (append java-font-lock-keywords-1 | |
2604 | (list | |
2605 | ;; | |
2606 | ;; Fontify all builtin type specifiers. | |
2607 | (cons (concat "\\<\\(" java-minor-types "\\|" java-major-types "\\)\\>") | |
2608 | 'font-lock-type-face) | |
2609 | ;; | |
2610 | ;; Fontify all builtin keywords (except below). | |
ac6e572c | 2611 | (concat "\\<" java-keywords "\\>") |
2e6a15fc SM |
2612 | ;; |
2613 | ;; Fontify keywords and targets, and case default/goto tags. | |
56fcbd7e | 2614 | (list "\\<\\(break\\|case\\|continue\\|goto\\)\\>[ \t]*\\(-?\\sw+\\)?" |
2e6a15fc SM |
2615 | '(1 font-lock-keyword-face) '(2 font-lock-reference-face nil t)) |
2616 | '(":" ("^[ \t]*\\(\\sw+\\)[ \t]*:" | |
2617 | (beginning-of-line) (end-of-line) | |
2618 | (1 font-lock-reference-face))) | |
2619 | ;; | |
2620 | ;; Fontify keywords and types; the first can be followed by a type list. | |
2621 | (list (concat "\\<\\(" | |
2622 | "implements\\|throws\\|" | |
2623 | "\\(extends\\|instanceof\\|new\\)" | |
2624 | "\\)\\>[ \t]*\\(\\sw+\\)?") | |
2625 | '(1 font-lock-keyword-face) '(3 font-lock-type-face nil t) | |
2626 | '("\\=[ \t]*,[ \t]*\\(\\sw+\\)" | |
2627 | (if (match-beginning 2) (goto-char (match-end 2))) nil | |
2628 | (1 font-lock-type-face))) | |
2629 | ;; | |
2630 | ;; Fontify all constants. | |
2631 | '("\\<\\(false\\|null\\|true\\)\\>" . font-lock-reference-face) | |
2632 | ;; | |
2633 | ;; Javadoc tags within comments. | |
2634 | '("@\\(author\\|exception\\|return\\|see\\|version\\)\\>" | |
2635 | (1 font-lock-reference-face prepend)) | |
2636 | '("@\\(param\\)\\>[ \t]*\\(\\sw+\\)?" | |
2637 | (1 font-lock-reference-face prepend) | |
2638 | (2 font-lock-variable-name-face prepend t)) | |
2639 | ))) | |
2640 | ||
2641 | (setq java-font-lock-keywords-3 | |
2642 | (append java-font-lock-keywords-2 | |
2643 | ;; | |
2644 | ;; More complicated regexps for more complete highlighting for types. | |
2645 | ;; We still have to fontify type specifiers individually, as Java is hairy. | |
2646 | (list | |
2647 | ;; | |
2648 | ;; Fontify random types in casts. | |
c1f2ffc8 SM |
2649 | `(eval . |
2650 | (list (concat "(\\(" (,@ java-other-types) "\\))" | |
2651 | "[ \t]*\\(\\sw\\|[\"\(]\\)") | |
2652 | ;; Fontify the type name. | |
2653 | '(1 font-lock-type-face))) | |
2e6a15fc SM |
2654 | ;; |
2655 | ;; Fontify random types immediately followed by an item or items. | |
c1f2ffc8 SM |
2656 | `(eval . |
2657 | (list (concat "\\<\\(" (,@ java-other-types) "\\)\\>" | |
2658 | "\\([ \t]*\\[[ \t]*\\]\\)*" | |
2659 | "[ \t]*\\sw") | |
2660 | ;; Fontify the type name. | |
2661 | '(1 font-lock-type-face))) | |
2662 | `(eval . | |
2663 | (list (concat "\\<\\(" (,@ java-other-types) "\\)\\>" | |
2664 | "\\([ \t]*\\[[ \t]*\\]\\)*" | |
2665 | "\\([ \t]*\\sw\\)") | |
2666 | ;; Fontify each declaration item. | |
2d63aa67 SM |
2667 | (list 'font-lock-match-c-style-declaration-item-and-skip-to-next |
2668 | ;; Start and finish with point after the type specifier. | |
2669 | (list 'goto-char (list 'match-beginning | |
2670 | (+ (,@ java-other-depth) 3))) | |
2671 | (list 'goto-char (list 'match-beginning | |
2672 | (+ (,@ java-other-depth) 3))) | |
2673 | ;; Fontify as a variable or function name. | |
2674 | '(1 (if (match-beginning 2) | |
2675 | font-lock-function-name-face | |
2676 | font-lock-variable-name-face))))) | |
2e6a15fc SM |
2677 | ;; |
2678 | ;; Fontify those that are immediately followed by an item or items. | |
2679 | (list (concat "\\<\\(" java-minor-types "\\)\\>" | |
2680 | "\\([ \t]*\\[[ \t]*\\]\\)*") | |
2681 | ;; Fontify each declaration item. | |
c1f2ffc8 | 2682 | '(font-lock-match-c-style-declaration-item-and-skip-to-next |
2e6a15fc SM |
2683 | ;; Start and finish with point after the type specifier. |
2684 | nil (goto-char (match-end 0)) | |
2685 | ;; Fontify as a variable or function name. | |
c1f2ffc8 | 2686 | (1 (if (match-beginning 2) |
2e6a15fc SM |
2687 | font-lock-function-name-face |
2688 | font-lock-variable-name-face)))) | |
2689 | ;; | |
2690 | ;; Fontify those that are eventually followed by an item or items. | |
2691 | (list (concat "\\<\\(" java-major-types "\\)\\>" | |
2692 | "\\([ \t]+\\sw+\\>" | |
2693 | "\\([ \t]*\\[[ \t]*\\]\\)*" | |
2694 | "\\)*") | |
2695 | ;; Fontify each declaration item. | |
c1f2ffc8 | 2696 | '(font-lock-match-c-style-declaration-item-and-skip-to-next |
2e6a15fc | 2697 | ;; Start with point after all type specifiers. |
2d63aa67 | 2698 | (goto-char (or (match-beginning 5) (match-end 1))) |
2e6a15fc SM |
2699 | ;; Finish with point after first type specifier. |
2700 | (goto-char (match-end 1)) | |
2701 | ;; Fontify as a variable or function name. | |
c1f2ffc8 | 2702 | (1 (if (match-beginning 2) |
2e6a15fc SM |
2703 | font-lock-function-name-face |
2704 | font-lock-variable-name-face)))) | |
2705 | ))) | |
2706 | ) | |
2707 | ||
2708 | (defvar java-font-lock-keywords java-font-lock-keywords-1 | |
2709 | "Default expressions to highlight in Java mode. | |
2710 | See also `java-font-lock-extra-types'.") | |
d46c21ec | 2711 | \f |
a1eb1cf1 RS |
2712 | ;; Install ourselves: |
2713 | ||
5aa29679 | 2714 | (unless (assq 'font-lock-mode minor-mode-alist) |
2e6a15fc | 2715 | (push '(font-lock-mode " Font") minor-mode-alist)) |
a1eb1cf1 RS |
2716 | |
2717 | ;; Provide ourselves: | |
8f261d40 | 2718 | |
030f4a35 RS |
2719 | (provide 'font-lock) |
2720 | ||
2721 | ;;; font-lock.el ends here |