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