Commit | Line | Data |
---|---|---|
e8af40ee | 1 | ;;; jit-lock.el --- just-in-time fontification |
7840ced1 | 2 | |
ab422c4d | 3 | ;; Copyright (C) 1998, 2000-2013 Free Software Foundation, Inc. |
7840ced1 GM |
4 | |
5 | ;; Author: Gerd Moellmann <gerd@gnu.org> | |
6 | ;; Keywords: faces files | |
bd78fa1d | 7 | ;; Package: emacs |
7840ced1 GM |
8 | |
9 | ;; This file is part of GNU Emacs. | |
10 | ||
eb3fa2cf | 11 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
7840ced1 | 12 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
13 | ;; the Free Software Foundation, either version 3 of the License, or |
14 | ;; (at your option) any later version. | |
7840ced1 GM |
15 | |
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
eb3fa2cf | 22 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
7840ced1 GM |
23 | |
24 | ;;; Commentary: | |
25 | ||
26 | ;; Just-in-time fontification, triggered by C redisplay code. | |
27 | ||
28 | ;;; Code: | |
29 | ||
30 | ||
7840ced1 | 31 | (eval-when-compile |
bcacade9 | 32 | (defmacro with-buffer-prepared-for-jit-lock (&rest body) |
7840ced1 GM |
33 | "Execute BODY in current buffer, overriding several variables. |
34 | Preserves the `buffer-modified-p' state of the current buffer." | |
7b4d9d3b | 35 | (declare (debug t)) |
d36b74ca SM |
36 | `(let ((inhibit-point-motion-hooks t)) |
37 | (with-silent-modifications | |
38 | ,@body)))) | |
7840ced1 GM |
39 | \f |
40 | ;;; Customization. | |
41 | ||
623a1226 SM |
42 | (defgroup jit-lock nil |
43 | "Font Lock support mode to fontify just-in-time." | |
623a1226 SM |
44 | :version "21.1" |
45 | :group 'font-lock) | |
46 | ||
7840ced1 | 47 | (defcustom jit-lock-chunk-size 500 |
9201cc28 | 48 | "Jit-lock fontifies chunks of at most this many characters at a time. |
45cb4c96 EZ |
49 | |
50 | This variable controls both display-time and stealth fontification." | |
7840ced1 GM |
51 | :type 'integer |
52 | :group 'jit-lock) | |
53 | ||
54 | ||
d0483d25 | 55 | (defcustom jit-lock-stealth-time nil |
9201cc28 | 56 | "Time in seconds to wait before beginning stealth fontification. |
7840ced1 | 57 | Stealth fontification occurs if there is no input within this time. |
f86292a9 | 58 | If nil, stealth fontification is never performed. |
7840ced1 GM |
59 | |
60 | The value of this variable is used when JIT Lock mode is turned on." | |
61 | :type '(choice (const :tag "never" nil) | |
d0483d25 | 62 | (number :tag "seconds" :value 16)) |
7840ced1 GM |
63 | :group 'jit-lock) |
64 | ||
65 | ||
4739237d | 66 | (defcustom jit-lock-stealth-nice 0.5 |
9201cc28 | 67 | "Time in seconds to pause between chunks of stealth fontification. |
7840ced1 GM |
68 | Each iteration of stealth fontification is separated by this amount of time, |
69 | thus reducing the demand that stealth fontification makes on the system. | |
70 | If nil, means stealth fontification is never paused. | |
71 | To reduce machine load during stealth fontification, at the cost of stealth | |
72 | taking longer to fontify, you could increase the value of this variable. | |
73 | See also `jit-lock-stealth-load'." | |
74 | :type '(choice (const :tag "never" nil) | |
f1180544 | 75 | (number :tag "seconds")) |
7840ced1 | 76 | :group 'jit-lock) |
f1180544 | 77 | |
7840ced1 GM |
78 | |
79 | (defcustom jit-lock-stealth-load | |
80 | (if (condition-case nil (load-average) (error)) 200) | |
9201cc28 | 81 | "Load in percentage above which stealth fontification is suspended. |
7840ced1 GM |
82 | Stealth fontification pauses when the system short-term load average (as |
83 | returned by the function `load-average' if supported) goes above this level, | |
84 | thus reducing the demand that stealth fontification makes on the system. | |
85 | If nil, means stealth fontification is never suspended. | |
86 | To reduce machine load during stealth fontification, at the cost of stealth | |
87 | taking longer to fontify, you could reduce the value of this variable. | |
88 | See also `jit-lock-stealth-nice'." | |
89 | :type (if (condition-case nil (load-average) (error)) | |
90 | '(choice (const :tag "never" nil) | |
91 | (integer :tag "load")) | |
92 | '(const :format "%t: unsupported\n" nil)) | |
93 | :group 'jit-lock) | |
94 | ||
95 | ||
96 | (defcustom jit-lock-stealth-verbose nil | |
9201cc28 | 97 | "If non-nil, means stealth fontification should show status messages." |
7840ced1 GM |
98 | :type 'boolean |
99 | :group 'jit-lock) | |
100 | ||
101 | ||
f415f2d7 SM |
102 | (defvaralias 'jit-lock-defer-contextually 'jit-lock-contextually) |
103 | (defcustom jit-lock-contextually 'syntax-driven | |
9201cc28 | 104 | "If non-nil, means fontification should be syntactically true. |
f415f2d7 | 105 | If nil, means fontification occurs only on those lines modified. This |
7840ced1 GM |
106 | means where modification on a line causes syntactic change on subsequent lines, |
107 | those subsequent lines are not refontified to reflect their new context. | |
f415f2d7 | 108 | If t, means fontification occurs on those lines modified and all |
7840ced1 | 109 | subsequent lines. This means those subsequent lines are refontified to reflect |
7b4d9d3b | 110 | their new syntactic context, after `jit-lock-context-time' seconds. |
f415f2d7 | 111 | If any other value, e.g., `syntax-driven', means syntactically true |
7840ced1 GM |
112 | fontification occurs only if syntactic fontification is performed using the |
113 | buffer mode's syntax table, i.e., only if `font-lock-keywords-only' is nil. | |
114 | ||
115 | The value of this variable is used when JIT Lock mode is turned on." | |
116 | :type '(choice (const :tag "never" nil) | |
117 | (const :tag "always" t) | |
118 | (other :tag "syntax-driven" syntax-driven)) | |
119 | :group 'jit-lock) | |
120 | ||
7b4d9d3b SM |
121 | (defcustom jit-lock-context-time 0.5 |
122 | "Idle time after which text is contextually refontified, if applicable." | |
f5307782 JB |
123 | :type '(number :tag "seconds") |
124 | :group 'jit-lock) | |
125 | ||
8e069ce2 | 126 | (defcustom jit-lock-defer-time nil ;; 0.25 |
b743187d SM |
127 | "Idle time after which deferred fontification should take place. |
128 | If nil, fontification is not deferred." | |
129 | :group 'jit-lock | |
130 | :type '(choice (const :tag "never" nil) | |
131 | (number :tag "seconds"))) | |
7840ced1 GM |
132 | \f |
133 | ;;; Variables that are not customizable. | |
134 | ||
135 | (defvar jit-lock-mode nil | |
136 | "Non-nil means Just-in-time Lock mode is active.") | |
137 | (make-variable-buffer-local 'jit-lock-mode) | |
138 | ||
be390cb3 SM |
139 | (defvar jit-lock-functions nil |
140 | "Functions to do the actual fontification. | |
141 | They are called with two arguments: the START and END of the region to fontify.") | |
a62e3c6f | 142 | (make-variable-buffer-local 'jit-lock-functions) |
7840ced1 | 143 | |
623a1226 | 144 | (defvar jit-lock-context-unfontify-pos nil |
a62e3c6f | 145 | "Consider text after this position as contextually unfontified. |
bcacade9 | 146 | If nil, contextual fontification is disabled.") |
623a1226 | 147 | (make-variable-buffer-local 'jit-lock-context-unfontify-pos) |
7840ced1 GM |
148 | |
149 | ||
150 | (defvar jit-lock-stealth-timer nil | |
151 | "Timer for stealth fontification in Just-in-time Lock mode.") | |
1063efe8 CY |
152 | (defvar jit-lock-stealth-repeat-timer nil |
153 | "Timer for repeated stealth fontification in Just-in-time Lock mode.") | |
7b4d9d3b SM |
154 | (defvar jit-lock-context-timer nil |
155 | "Timer for context fontification in Just-in-time Lock mode.") | |
b743187d SM |
156 | (defvar jit-lock-defer-timer nil |
157 | "Timer for deferred fontification in Just-in-time Lock mode.") | |
158 | ||
623a1226 | 159 | (defvar jit-lock-defer-buffers nil |
b743187d | 160 | "List of buffers with pending deferred fontification.") |
1063efe8 CY |
161 | (defvar jit-lock-stealth-buffers nil |
162 | "List of buffers that are being fontified stealthily.") | |
7840ced1 GM |
163 | \f |
164 | ;;; JIT lock mode | |
165 | ||
7840ced1 GM |
166 | (defun jit-lock-mode (arg) |
167 | "Toggle Just-in-time Lock mode. | |
bcacade9 | 168 | Turn Just-in-time Lock mode on if and only if ARG is non-nil. |
7840ced1 GM |
169 | Enable it automatically by customizing group `font-lock'. |
170 | ||
171 | When Just-in-time Lock mode is enabled, fontification is different in the | |
172 | following ways: | |
173 | ||
174 | - Demand-driven buffer fontification triggered by Emacs C code. | |
175 | This means initial fontification of the whole buffer does not occur. | |
176 | Instead, fontification occurs when necessary, such as when scrolling | |
177 | through the buffer would otherwise reveal unfontified areas. This is | |
178 | useful if buffer fontification is too slow for large buffers. | |
179 | ||
180 | - Stealthy buffer fontification if `jit-lock-stealth-time' is non-nil. | |
181 | This means remaining unfontified areas of buffers are fontified if Emacs has | |
182 | been idle for `jit-lock-stealth-time' seconds, while Emacs remains idle. | |
183 | This is useful if any buffer has any deferred fontification. | |
184 | ||
f415f2d7 | 185 | - Deferred context fontification if `jit-lock-contextually' is |
7840ced1 | 186 | non-nil. This means fontification updates the buffer corresponding to |
7b4d9d3b | 187 | true syntactic context, after `jit-lock-context-time' seconds of Emacs |
7840ced1 GM |
188 | idle time, while Emacs remains idle. Otherwise, fontification occurs |
189 | on modified lines only, and subsequent lines can remain fontified | |
190 | corresponding to previous syntactic contexts. This is useful where | |
191 | strings or comments span lines. | |
192 | ||
193 | Stealth fontification only occurs while the system remains unloaded. | |
194 | If the system load rises above `jit-lock-stealth-load' percent, stealth | |
195 | fontification is suspended. Stealth fontification intensity is controlled via | |
02b420eb | 196 | the variable `jit-lock-stealth-nice'." |
bcacade9 SM |
197 | (setq jit-lock-mode arg) |
198 | (cond (;; Turn Just-in-time Lock mode on. | |
199 | jit-lock-mode | |
200 | ||
b743187d | 201 | ;; Mark the buffer for refontification. |
a62e3c6f | 202 | (jit-lock-refontify) |
02b420eb | 203 | |
7840ced1 | 204 | ;; Install an idle timer for stealth fontification. |
c94d5f40 | 205 | (when (and jit-lock-stealth-time (null jit-lock-stealth-timer)) |
02b420eb | 206 | (setq jit-lock-stealth-timer |
b743187d | 207 | (run-with-idle-timer jit-lock-stealth-time t |
7840ced1 GM |
208 | 'jit-lock-stealth-fontify))) |
209 | ||
1063efe8 CY |
210 | ;; Create, but do not activate, the idle timer for repeated |
211 | ;; stealth fontification. | |
212 | (when (and jit-lock-stealth-time (null jit-lock-stealth-repeat-timer)) | |
213 | (setq jit-lock-stealth-repeat-timer (timer-create)) | |
214 | (timer-set-function jit-lock-stealth-repeat-timer | |
215 | 'jit-lock-stealth-fontify '(t))) | |
216 | ||
b743187d SM |
217 | ;; Init deferred fontification timer. |
218 | (when (and jit-lock-defer-time (null jit-lock-defer-timer)) | |
219 | (setq jit-lock-defer-timer | |
220 | (run-with-idle-timer jit-lock-defer-time t | |
221 | 'jit-lock-deferred-fontify))) | |
222 | ||
623a1226 | 223 | ;; Initialize contextual fontification if requested. |
f415f2d7 | 224 | (when (eq jit-lock-contextually t) |
7b4d9d3b SM |
225 | (unless jit-lock-context-timer |
226 | (setq jit-lock-context-timer | |
227 | (run-with-idle-timer jit-lock-context-time t | |
228 | 'jit-lock-context-fontify))) | |
623a1226 SM |
229 | (setq jit-lock-context-unfontify-pos |
230 | (or jit-lock-context-unfontify-pos (point-max)))) | |
bcacade9 | 231 | |
a62e3c6f | 232 | ;; Setup our hooks. |
bcacade9 | 233 | (add-hook 'after-change-functions 'jit-lock-after-change nil t) |
7840ced1 GM |
234 | (add-hook 'fontification-functions 'jit-lock-function)) |
235 | ||
236 | ;; Turn Just-in-time Lock mode off. | |
237 | (t | |
b743187d | 238 | ;; Cancel our idle timers. |
7b4d9d3b SM |
239 | (when (and (or jit-lock-stealth-timer jit-lock-defer-timer |
240 | jit-lock-context-timer) | |
b743187d SM |
241 | ;; Only if there's no other buffer using them. |
242 | (not (catch 'found | |
243 | (dolist (buf (buffer-list)) | |
244 | (with-current-buffer buf | |
245 | (when jit-lock-mode (throw 'found t))))))) | |
246 | (when jit-lock-stealth-timer | |
247 | (cancel-timer jit-lock-stealth-timer) | |
248 | (setq jit-lock-stealth-timer nil)) | |
7b4d9d3b SM |
249 | (when jit-lock-context-timer |
250 | (cancel-timer jit-lock-context-timer) | |
251 | (setq jit-lock-context-timer nil)) | |
b743187d SM |
252 | (when jit-lock-defer-timer |
253 | (cancel-timer jit-lock-defer-timer) | |
254 | (setq jit-lock-defer-timer nil))) | |
7840ced1 | 255 | |
a62e3c6f | 256 | ;; Remove hooks. |
02b420eb | 257 | (remove-hook 'after-change-functions 'jit-lock-after-change t) |
7840ced1 GM |
258 | (remove-hook 'fontification-functions 'jit-lock-function)))) |
259 | ||
e5b5a34d SM |
260 | (define-minor-mode jit-lock-debug-mode |
261 | "Minor mode to help debug code run from jit-lock. | |
262 | When this minor mode is enabled, jit-lock runs as little code as possible | |
263 | during redisplay and moves the rest to a timer, where things | |
264 | like `debug-on-error' and Edebug can be used." | |
265 | :global t | |
266 | (when jit-lock-defer-timer | |
267 | (cancel-timer jit-lock-defer-timer) | |
268 | (setq jit-lock-defer-timer nil)) | |
269 | (when jit-lock-debug-mode | |
270 | (setq jit-lock-defer-timer | |
271 | (run-with-idle-timer 0 t #'jit-lock--debug-fontify)))) | |
272 | ||
273 | (defvar jit-lock--debug-fontifying nil) | |
274 | ||
275 | (defun jit-lock--debug-fontify () | |
276 | "Fontify what was deferred for debugging." | |
277 | (when (and (not jit-lock--debug-fontifying) | |
278 | jit-lock-defer-buffers (not memory-full)) | |
279 | (let ((jit-lock--debug-fontifying t) | |
280 | (inhibit-debugger nil)) ;FIXME: Not sufficient! | |
281 | ;; Mark the deferred regions back to `fontified = nil' | |
282 | (dolist (buffer jit-lock-defer-buffers) | |
283 | (when (buffer-live-p buffer) | |
284 | (with-current-buffer buffer | |
285 | ;; (message "Jit-Debug %s" (buffer-name)) | |
286 | (with-buffer-prepared-for-jit-lock | |
287 | (let ((pos (point-min))) | |
288 | (while | |
289 | (progn | |
290 | (when (eq (get-text-property pos 'fontified) 'defer) | |
291 | (let ((beg pos) | |
292 | (end (setq pos (next-single-property-change | |
293 | pos 'fontified | |
294 | nil (point-max))))) | |
295 | (put-text-property beg end 'fontified nil) | |
296 | (jit-lock-fontify-now beg end))) | |
297 | (setq pos (next-single-property-change | |
298 | pos 'fontified))))))))) | |
299 | (setq jit-lock-defer-buffers nil)))) | |
300 | ||
c94d5f40 | 301 | (defun jit-lock-register (fun &optional contextual) |
8a677d4f SM |
302 | "Register FUN as a fontification function to be called in this buffer. |
303 | FUN will be called with two arguments START and END indicating the region | |
c94d5f40 SM |
304 | that needs to be (re)fontified. |
305 | If non-nil, CONTEXTUAL means that a contextual fontification would be useful." | |
f8bacc70 | 306 | (add-hook 'jit-lock-functions fun nil t) |
f415f2d7 SM |
307 | (when (and contextual jit-lock-contextually) |
308 | (set (make-local-variable 'jit-lock-contextually) t)) | |
f8bacc70 SM |
309 | (jit-lock-mode t)) |
310 | ||
311 | (defun jit-lock-unregister (fun) | |
8a677d4f | 312 | "Unregister FUN as a fontification function. |
f8bacc70 SM |
313 | Only applies to the current buffer." |
314 | (remove-hook 'jit-lock-functions fun t) | |
a62e3c6f | 315 | (unless jit-lock-functions (jit-lock-mode nil))) |
7840ced1 | 316 | |
02b420eb SM |
317 | ;; This function is used to prevent font-lock-fontify-buffer from |
318 | ;; fontifying eagerly the whole buffer. This is important for | |
319 | ;; things like CWarn mode which adds/removes a few keywords and | |
320 | ;; does a refontify (which takes ages on large files). | |
a62e3c6f SM |
321 | (defun jit-lock-refontify (&optional beg end) |
322 | "Force refontification of the region BEG..END (default whole buffer)." | |
bcacade9 | 323 | (with-buffer-prepared-for-jit-lock |
5a5987eb SM |
324 | (save-restriction |
325 | (widen) | |
b743187d SM |
326 | (put-text-property (or beg (point-min)) (or end (point-max)) |
327 | 'fontified nil)))) | |
7840ced1 GM |
328 | \f |
329 | ;;; On demand fontification. | |
330 | ||
331 | (defun jit-lock-function (start) | |
332 | "Fontify current buffer starting at position START. | |
333 | This function is added to `fontification-functions' when `jit-lock-mode' | |
334 | is active." | |
74614ac6 | 335 | (when (and jit-lock-mode (not memory-full)) |
0902822d | 336 | (if (null jit-lock-defer-timer) |
b743187d SM |
337 | ;; No deferral. |
338 | (jit-lock-fontify-now start (+ start jit-lock-chunk-size)) | |
339 | ;; Record the buffer for later fontification. | |
623a1226 SM |
340 | (unless (memq (current-buffer) jit-lock-defer-buffers) |
341 | (push (current-buffer) jit-lock-defer-buffers)) | |
b743187d SM |
342 | ;; Mark the area as defer-fontified so that the redisplay engine |
343 | ;; is happy and so that the idle timer can find the places to fontify. | |
344 | (with-buffer-prepared-for-jit-lock | |
345 | (put-text-property start | |
346 | (next-single-property-change | |
347 | start 'fontified nil | |
348 | (min (point-max) (+ start jit-lock-chunk-size))) | |
349 | 'fontified 'defer))))) | |
a62e3c6f SM |
350 | |
351 | (defun jit-lock-fontify-now (&optional start end) | |
352 | "Fontify current buffer from START to END. | |
353 | Defaults to the whole buffer. END can be out of bounds." | |
bcacade9 | 354 | (with-buffer-prepared-for-jit-lock |
60bffb78 | 355 | (save-excursion |
c9cf2e67 SM |
356 | (unless start (setq start (point-min))) |
357 | (setq end (if end (min end (point-max)) (point-max))) | |
358 | ;; This did bind `font-lock-beginning-of-syntax-function' to | |
359 | ;; nil at some point, for an unknown reason. Don't do this; it | |
360 | ;; can make highlighting slow due to expensive calls to | |
361 | ;; `parse-partial-sexp' in function | |
362 | ;; `font-lock-fontify-syntactically-region'. Example: paging | |
363 | ;; from the end of a buffer to its start, can do repeated | |
364 | ;; `parse-partial-sexp' starting from `point-min', which can | |
365 | ;; take a long time in a large buffer. | |
663e1660 | 366 | (let ((orig-start start) next) |
c9cf2e67 SM |
367 | (save-match-data |
368 | ;; Fontify chunks beginning at START. The end of a | |
369 | ;; chunk is either `end', or the start of a region | |
370 | ;; before `end' that has already been fontified. | |
c1860747 | 371 | (while (and start (< start end)) |
c9cf2e67 SM |
372 | ;; Determine the end of this chunk. |
373 | (setq next (or (text-property-any start end 'fontified t) | |
374 | end)) | |
375 | ||
376 | ;; Decide which range of text should be fontified. | |
377 | ;; The problem is that START and NEXT may be in the | |
378 | ;; middle of something matched by a font-lock regexp. | |
379 | ;; Until someone has a better idea, let's start | |
380 | ;; at the start of the line containing START and | |
381 | ;; stop at the start of the line following NEXT. | |
382 | (goto-char next) (setq next (line-beginning-position 2)) | |
383 | (goto-char start) (setq start (line-beginning-position)) | |
f1180544 | 384 | |
c4ac63d0 SM |
385 | ;; Make sure the contextual refontification doesn't re-refontify |
386 | ;; what's already been refontified. | |
c4ac63d0 SM |
387 | (when (and jit-lock-context-unfontify-pos |
388 | (< jit-lock-context-unfontify-pos next) | |
7aaf6f17 SM |
389 | (>= jit-lock-context-unfontify-pos start) |
390 | ;; Don't move boundary forward if we have to | |
391 | ;; refontify previous text. Otherwise, we risk moving | |
392 | ;; it past the end of the multiline property and thus | |
393 | ;; forget about this multiline region altogether. | |
394 | (not (get-text-property start 'jit-lock-defer-multiline))) | |
c4ac63d0 SM |
395 | (setq jit-lock-context-unfontify-pos next)) |
396 | ||
c9cf2e67 SM |
397 | ;; Fontify the chunk, and mark it as fontified. |
398 | ;; We mark it first, to make sure that we don't indefinitely | |
399 | ;; re-execute this fontification if an error occurs. | |
400 | (put-text-property start next 'fontified t) | |
f415f2d7 SM |
401 | (condition-case err |
402 | (run-hook-with-args 'jit-lock-functions start next) | |
403 | ;; If the user quits (which shouldn't happen in normal on-the-fly | |
404 | ;; jit-locking), make sure the fontification will be performed | |
405 | ;; before displaying the block again. | |
406 | (quit (put-text-property start next 'fontified nil) | |
407 | (funcall 'signal (car err) (cdr err)))) | |
c9cf2e67 | 408 | |
663e1660 SM |
409 | ;; The redisplay engine has already rendered the buffer up-to |
410 | ;; `orig-start' and won't notice if the above jit-lock-functions | |
411 | ;; changed the appearance of any part of the buffer prior | |
412 | ;; to that. So if `start' is before `orig-start', we need to | |
413 | ;; cause a new redisplay cycle after this one so that any changes | |
414 | ;; are properly reflected on screen. | |
415 | ;; To make such repeated redisplay happen less often, we can | |
416 | ;; eagerly extend the refontified region with | |
417 | ;; jit-lock-after-change-extend-region-functions. | |
418 | (when (< start orig-start) | |
be956324 | 419 | (run-with-timer 0 nil 'jit-lock-force-redisplay |
2a8edf31 | 420 | (current-buffer) start orig-start)) |
663e1660 | 421 | |
c9cf2e67 SM |
422 | ;; Find the start of the next chunk, if any. |
423 | (setq start (text-property-any next end 'fontified nil)))))))) | |
7840ced1 | 424 | |
be956324 SM |
425 | (defun jit-lock-force-redisplay (buf start end) |
426 | "Force the display engine to re-render buffer BUF from START to END." | |
427 | (with-current-buffer buf | |
428 | (with-buffer-prepared-for-jit-lock | |
429 | ;; Don't cause refontification (it's already been done), but just do | |
430 | ;; some random buffer change, so as to force redisplay. | |
32937629 | 431 | (put-text-property start end 'fontified t)))) |
2a8edf31 KS |
432 | |
433 | ||
7840ced1 GM |
434 | \f |
435 | ;;; Stealth fontification. | |
436 | ||
437 | (defsubst jit-lock-stealth-chunk-start (around) | |
6dea7173 | 438 | "Return the start of the next chunk to fontify around position AROUND. |
7840ced1 | 439 | Value is nil if there is nothing more to fontify." |
8c887c51 GM |
440 | (if (zerop (buffer-size)) |
441 | nil | |
442 | (save-restriction | |
443 | (widen) | |
b743187d | 444 | (let* ((next (text-property-not-all around (point-max) 'fontified t)) |
8c887c51 GM |
445 | (prev (previous-single-property-change around 'fontified)) |
446 | (prop (get-text-property (max (point-min) (1- around)) | |
447 | 'fontified)) | |
448 | (start (cond | |
449 | ((null prev) | |
450 | ;; There is no property change between AROUND | |
451 | ;; and the start of the buffer. If PROP is | |
452 | ;; non-nil, everything in front of AROUND is | |
453 | ;; fontified, otherwise nothing is fontified. | |
b743187d | 454 | (if (eq prop t) |
8c887c51 GM |
455 | nil |
456 | (max (point-min) | |
457 | (- around (/ jit-lock-chunk-size 2))))) | |
b743187d | 458 | ((eq prop t) |
8c887c51 | 459 | ;; PREV is the start of a region of fontified |
bcacade9 | 460 | ;; text containing AROUND. Start fontifying a |
8c887c51 GM |
461 | ;; chunk size before the end of the unfontified |
462 | ;; region in front of that. | |
463 | (max (or (previous-single-property-change prev 'fontified) | |
464 | (point-min)) | |
465 | (- prev jit-lock-chunk-size))) | |
466 | (t | |
467 | ;; PREV is the start of a region of unfontified | |
468 | ;; text containing AROUND. Start at PREV or | |
469 | ;; chunk size in front of AROUND, whichever is | |
470 | ;; nearer. | |
471 | (max prev (- around jit-lock-chunk-size))))) | |
472 | (result (cond ((null start) next) | |
473 | ((null next) start) | |
474 | ((< (- around start) (- next around)) start) | |
475 | (t next)))) | |
476 | result)))) | |
f1180544 | 477 | |
1063efe8 | 478 | (defun jit-lock-stealth-fontify (&optional repeat) |
7840ced1 | 479 | "Fontify buffers stealthily. |
1063efe8 CY |
480 | This function is called repeatedly after Emacs has become idle for |
481 | `jit-lock-stealth-time' seconds. Optional argument REPEAT is expected | |
482 | non-nil in a repeated invocation of this function." | |
483 | ;; Cancel timer for repeated invocations. | |
484 | (unless repeat | |
485 | (cancel-timer jit-lock-stealth-repeat-timer)) | |
7840ced1 | 486 | (unless (or executing-kbd-macro |
74614ac6 | 487 | memory-full |
1063efe8 CY |
488 | (window-minibuffer-p (selected-window)) |
489 | ;; For first invocation set up `jit-lock-stealth-buffers'. | |
490 | ;; In repeated invocations it's already been set up. | |
491 | (null (if repeat | |
492 | jit-lock-stealth-buffers | |
493 | (setq jit-lock-stealth-buffers (buffer-list))))) | |
494 | (let ((buffer (car jit-lock-stealth-buffers)) | |
495 | (delay 0) | |
7840ced1 | 496 | minibuffer-auto-raise |
1063efe8 CY |
497 | message-log-max |
498 | start) | |
499 | (if (and jit-lock-stealth-load | |
500 | (> (car (load-average)) jit-lock-stealth-load)) | |
501 | ;; Wait a little if load is too high. | |
502 | (setq delay jit-lock-stealth-time) | |
503 | (if (buffer-live-p buffer) | |
504 | (with-current-buffer buffer | |
505 | (if (and jit-lock-mode | |
506 | (setq start (jit-lock-stealth-chunk-start (point)))) | |
507 | ;; Fontify one block of at most `jit-lock-chunk-size' | |
508 | ;; characters. | |
509 | (with-temp-message (if jit-lock-stealth-verbose | |
510 | (concat "JIT stealth lock " | |
511 | (buffer-name))) | |
512 | (jit-lock-fontify-now start | |
513 | (+ start jit-lock-chunk-size)) | |
514 | ;; Run again after `jit-lock-stealth-nice' seconds. | |
515 | (setq delay (or jit-lock-stealth-nice 0))) | |
516 | ;; Nothing to fontify here. Remove this buffer from | |
517 | ;; `jit-lock-stealth-buffers' and run again immediately. | |
518 | (setq jit-lock-stealth-buffers (cdr jit-lock-stealth-buffers)))) | |
519 | ;; Buffer is no longer live. Remove it from | |
520 | ;; `jit-lock-stealth-buffers' and run again immediately. | |
521 | (setq jit-lock-stealth-buffers (cdr jit-lock-stealth-buffers)))) | |
522 | ;; Call us again. | |
523 | (when jit-lock-stealth-buffers | |
524 | (timer-set-idle-time jit-lock-stealth-repeat-timer (current-idle-time)) | |
525 | (timer-inc-time jit-lock-stealth-repeat-timer delay) | |
526 | (timer-activate-when-idle jit-lock-stealth-repeat-timer t))))) | |
7840ced1 GM |
527 | |
528 | \f | |
529 | ;;; Deferred fontification. | |
530 | ||
b743187d SM |
531 | (defun jit-lock-deferred-fontify () |
532 | "Fontify what was deferred." | |
74614ac6 | 533 | (when (and jit-lock-defer-buffers (not memory-full)) |
b743187d | 534 | ;; Mark the deferred regions back to `fontified = nil' |
623a1226 | 535 | (dolist (buffer jit-lock-defer-buffers) |
b743187d SM |
536 | (when (buffer-live-p buffer) |
537 | (with-current-buffer buffer | |
538 | ;; (message "Jit-Defer %s" (buffer-name)) | |
539 | (with-buffer-prepared-for-jit-lock | |
540 | (let ((pos (point-min))) | |
541 | (while | |
542 | (progn | |
543 | (when (eq (get-text-property pos 'fontified) 'defer) | |
544 | (put-text-property | |
545 | pos (setq pos (next-single-property-change | |
546 | pos 'fontified nil (point-max))) | |
547 | 'fontified nil)) | |
e5b5a34d SM |
548 | (setq pos (next-single-property-change |
549 | pos 'fontified))))))))) | |
623a1226 | 550 | (setq jit-lock-defer-buffers nil) |
b743187d | 551 | ;; Force fontification of the visible parts. |
0902822d | 552 | (let ((jit-lock-defer-timer nil)) |
b743187d SM |
553 | ;; (message "Jit-Defer Now") |
554 | (sit-for 0) | |
555 | ;; (message "Jit-Defer Done") | |
556 | ))) | |
f1180544 | 557 | |
b743187d | 558 | |
7b4d9d3b SM |
559 | (defun jit-lock-context-fontify () |
560 | "Refresh fontification to take new context into account." | |
74614ac6 RS |
561 | (unless memory-full |
562 | (dolist (buffer (buffer-list)) | |
563 | (with-current-buffer buffer | |
564 | (when jit-lock-context-unfontify-pos | |
565 | ;; (message "Jit-Context %s" (buffer-name)) | |
566 | (save-restriction | |
567 | (widen) | |
568 | (when (and (>= jit-lock-context-unfontify-pos (point-min)) | |
569 | (< jit-lock-context-unfontify-pos (point-max))) | |
570 | ;; If we're in text that matches a complex multi-line | |
571 | ;; font-lock pattern, make sure the whole text will be | |
572 | ;; redisplayed eventually. | |
573 | ;; Despite its name, we treat jit-lock-defer-multiline here | |
574 | ;; rather than in jit-lock-defer since it has to do with multiple | |
575 | ;; lines, i.e. with context. | |
576 | (when (get-text-property jit-lock-context-unfontify-pos | |
577 | 'jit-lock-defer-multiline) | |
578 | (setq jit-lock-context-unfontify-pos | |
579 | (or (previous-single-property-change | |
580 | jit-lock-context-unfontify-pos | |
581 | 'jit-lock-defer-multiline) | |
582 | (point-min)))) | |
583 | (with-buffer-prepared-for-jit-lock | |
584 | ;; Force contextual refontification. | |
585 | (remove-text-properties | |
586 | jit-lock-context-unfontify-pos (point-max) | |
587 | '(fontified nil jit-lock-defer-multiline nil))) | |
588 | (setq jit-lock-context-unfontify-pos (point-max))))))))) | |
7b4d9d3b | 589 | |
663e1660 SM |
590 | (defvar jit-lock-start) (defvar jit-lock-end) ; Dynamically scoped variables. |
591 | (defvar jit-lock-after-change-extend-region-functions nil | |
592 | "Hook that can extend the text to refontify after a change. | |
593 | This is run after every buffer change. The functions are called with | |
594 | the three arguments of `after-change-functions': START END OLD-LEN. | |
595 | The extended region to refontify is returned indirectly by modifying | |
596 | the variables `jit-lock-start' and `jit-lock-end'. | |
597 | ||
9fd762b0 SM |
598 | Note that extending the region this way is not strictly necessary, except |
599 | that the nature of the redisplay code tends to otherwise leave some of | |
600 | the rehighlighted text displayed with the old highlight until the next | |
601 | redisplay (see comment about repeated redisplay in `jit-lock-fontify-now').") | |
663e1660 | 602 | |
7840ced1 GM |
603 | (defun jit-lock-after-change (start end old-len) |
604 | "Mark the rest of the buffer as not fontified after a change. | |
605 | Installed on `after-change-functions'. | |
606 | START and END are the start and end of the changed text. OLD-LEN | |
607 | is the pre-change length. | |
608 | This function ensures that lines following the change will be refontified | |
609 | in case the syntax of those lines has changed. Refontification | |
610 | will take place when text is fontified stealthily." | |
74614ac6 | 611 | (when (and jit-lock-mode (not memory-full)) |
663e1660 SM |
612 | (let ((jit-lock-start start) |
613 | (jit-lock-end end)) | |
614 | (with-buffer-prepared-for-jit-lock | |
615 | (run-hook-with-args 'jit-lock-after-change-extend-region-functions | |
616 | start end old-len) | |
617 | ;; Make sure we change at least one char (in case of deletions). | |
618 | (setq jit-lock-end (min (max jit-lock-end (1+ start)) (point-max))) | |
619 | ;; Request refontification. | |
620 | (put-text-property jit-lock-start jit-lock-end 'fontified nil)) | |
621 | ;; Mark the change for deferred contextual refontification. | |
622 | (when jit-lock-context-unfontify-pos | |
623 | (setq jit-lock-context-unfontify-pos | |
624 | ;; Here we use `start' because nothing guarantees that the | |
625 | ;; text between start and end will be otherwise refontified: | |
626 | ;; usually it will be refontified by virtue of being | |
627 | ;; displayed, but if it's outside of any displayed area in the | |
628 | ;; buffer, only jit-lock-context-* will re-fontify it. | |
629 | (min jit-lock-context-unfontify-pos jit-lock-start)))))) | |
f1180544 | 630 | |
7840ced1 GM |
631 | (provide 'jit-lock) |
632 | ||
e8af40ee | 633 | ;;; jit-lock.el ends here |