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