annotate lisp/jit-lock.el @ 28973:d87cf6d0bd48

*** empty log message ***
author Eli Zaretskii <eliz@gnu.org>
date Thu, 18 May 2000 14:46:49 +0000
parents e564d806233e
children dbb0996702bd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25003
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1 ;;; jit-lock.el --- just-in-time fontification.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
2
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
3 ;; Copyright (C) 1998 Free Software Foundation, Inc.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
4
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
5 ;; Author: Gerd Moellmann <gerd@gnu.org>
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
6 ;; Keywords: faces files
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
7 ;; Version: 1.0
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
8
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
9 ;; This file is part of GNU Emacs.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
10
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
12 ;; it under the terms of the GNU General Public License as published by
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
13 ;; the Free Software Foundation; either version 2, or (at your option)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
14 ;; any later version.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
15
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
16 ;; GNU Emacs is distributed in the hope that it will be useful,
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
19 ;; GNU General Public License for more details.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
20
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
21 ;; You should have received a copy of the GNU General Public License
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
24 ;; Boston, MA 02111-1307, USA.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
25
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
26 ;;; Commentary:
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
27
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
28 ;; Just-in-time fontification, triggered by C redisplay code.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
29
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
30 ;;; Code:
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
31
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
32
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
33 (require 'font-lock)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
34
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
35 (eval-when-compile
28501
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
36 (defmacro with-buffer-unmodified (&rest body)
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
37 "Eval BODY, preserving the current buffer's modified state."
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
38 (let ((modified (make-symbol "modified")))
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
39 `(let ((,modified (buffer-modified-p)))
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
40 ,@body
28533
e564d806233e (with-buffer-unmodified): Fix bug introduced by `)'
Gerd Moellmann <gerd@gnu.org>
parents: 28521
diff changeset
41 (unless ,modified
e564d806233e (with-buffer-unmodified): Fix bug introduced by `)'
Gerd Moellmann <gerd@gnu.org>
parents: 28521
diff changeset
42 (restore-buffer-modified-p nil)))))
28501
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
43
25003
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
44 (defmacro with-buffer-prepared-for-font-lock (&rest body)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
45 "Execute BODY in current buffer, overriding several variables.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
46 Preserves the `buffer-modified-p' state of the current buffer."
28521
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
47 `(with-buffer-unmodified
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
48 (let ((buffer-undo-list t)
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
49 (inhibit-read-only t)
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
50 (inhibit-point-motion-hooks t)
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
51 before-change-functions
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
52 after-change-functions
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
53 deactivate-mark
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
54 buffer-file-name
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
55 buffer-file-truename)
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
56 ,@body))))
28501
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
57
25003
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
58
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
59
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
60 ;;; Customization.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
61
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
62 (defcustom jit-lock-chunk-size 500
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
63 "*Font-lock chunks of this many characters, or smaller."
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
64 :type 'integer
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
65 :group 'jit-lock)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
66
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
67
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
68 (defcustom jit-lock-stealth-time 3
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
69 "*Time in seconds to wait before beginning stealth fontification.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
70 Stealth fontification occurs if there is no input within this time.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
71 If nil, means stealth fontification is never performed.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
72
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
73 The value of this variable is used when JIT Lock mode is turned on."
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
74 :type '(choice (const :tag "never" nil)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
75 (number :tag "seconds"))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
76 :group 'jit-lock)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
77
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
78
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
79 (defcustom jit-lock-stealth-nice 0.125
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
80 "*Time in seconds to pause between chunks of stealth fontification.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
81 Each iteration of stealth fontification is separated by this amount of time,
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
82 thus reducing the demand that stealth fontification makes on the system.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
83 If nil, means stealth fontification is never paused.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
84 To reduce machine load during stealth fontification, at the cost of stealth
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
85 taking longer to fontify, you could increase the value of this variable.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
86 See also `jit-lock-stealth-load'."
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
87 :type '(choice (const :tag "never" nil)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
88 (number :tag "seconds"))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
89 :group 'jit-lock)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
90
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
91
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
92 (defcustom jit-lock-stealth-load
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
93 (if (condition-case nil (load-average) (error)) 200)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
94 "*Load in percentage above which stealth fontification is suspended.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
95 Stealth fontification pauses when the system short-term load average (as
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
96 returned by the function `load-average' if supported) goes above this level,
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
97 thus reducing the demand that stealth fontification makes on the system.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
98 If nil, means stealth fontification is never suspended.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
99 To reduce machine load during stealth fontification, at the cost of stealth
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
100 taking longer to fontify, you could reduce the value of this variable.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
101 See also `jit-lock-stealth-nice'."
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
102 :type (if (condition-case nil (load-average) (error))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
103 '(choice (const :tag "never" nil)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
104 (integer :tag "load"))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
105 '(const :format "%t: unsupported\n" nil))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
106 :group 'jit-lock)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
107
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
108
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
109 (defcustom jit-lock-stealth-verbose nil
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
110 "*If non-nil, means stealth fontification should show status messages."
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
111 :type 'boolean
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
112 :group 'jit-lock)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
113
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
114
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
115 (defcustom jit-lock-defer-contextually 'syntax-driven
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
116 "*If non-nil, means deferred fontification should be syntactically true.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
117 If nil, means deferred fontification occurs only on those lines modified. This
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
118 means where modification on a line causes syntactic change on subsequent lines,
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
119 those subsequent lines are not refontified to reflect their new context.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
120 If t, means deferred fontification occurs on those lines modified and all
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
121 subsequent lines. This means those subsequent lines are refontified to reflect
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
122 their new syntactic context, either immediately or when scrolling into them.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
123 If any other value, e.g., `syntax-driven', means deferred syntactically true
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
124 fontification occurs only if syntactic fontification is performed using the
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
125 buffer mode's syntax table, i.e., only if `font-lock-keywords-only' is nil.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
126
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
127 The value of this variable is used when JIT Lock mode is turned on."
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
128 :type '(choice (const :tag "never" nil)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
129 (const :tag "always" t)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
130 (other :tag "syntax-driven" syntax-driven))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
131 :group 'jit-lock)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
132
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
133
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
134
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
135 ;;; Variables that are not customizable.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
136
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
137 (defvar jit-lock-mode nil
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
138 "Non-nil means Just-in-time Lock mode is active.")
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
139 (make-variable-buffer-local 'jit-lock-mode)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
140
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
141
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
142 (defvar jit-lock-first-unfontify-pos nil
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
143 "Consider text after this position as unfontified.")
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
144 (make-variable-buffer-local 'jit-lock-first-unfontify-pos)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
145
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
146
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
147 (defvar jit-lock-stealth-timer nil
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
148 "Timer for stealth fontification in Just-in-time Lock mode.")
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
149
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
150
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
151
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
152 ;;; JIT lock mode
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
153
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
154 ;;;###autoload
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
155 (defun jit-lock-mode (arg)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
156 "Toggle Just-in-time Lock mode.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
157 With arg, turn Just-in-time Lock mode on if and only if arg is positive.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
158 Enable it automatically by customizing group `font-lock'.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
159
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
160 When Just-in-time Lock mode is enabled, fontification is different in the
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
161 following ways:
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
162
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
163 - Demand-driven buffer fontification triggered by Emacs C code.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
164 This means initial fontification of the whole buffer does not occur.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
165 Instead, fontification occurs when necessary, such as when scrolling
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
166 through the buffer would otherwise reveal unfontified areas. This is
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
167 useful if buffer fontification is too slow for large buffers.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
168
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
169 - Stealthy buffer fontification if `jit-lock-stealth-time' is non-nil.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
170 This means remaining unfontified areas of buffers are fontified if Emacs has
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
171 been idle for `jit-lock-stealth-time' seconds, while Emacs remains idle.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
172 This is useful if any buffer has any deferred fontification.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
173
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
174 - Deferred context fontification if `jit-lock-defer-contextually' is
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
175 non-nil. This means fontification updates the buffer corresponding to
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
176 true syntactic context, after `jit-lock-stealth-time' seconds of Emacs
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
177 idle time, while Emacs remains idle. Otherwise, fontification occurs
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
178 on modified lines only, and subsequent lines can remain fontified
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
179 corresponding to previous syntactic contexts. This is useful where
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
180 strings or comments span lines.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
181
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
182 Stealth fontification only occurs while the system remains unloaded.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
183 If the system load rises above `jit-lock-stealth-load' percent, stealth
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
184 fontification is suspended. Stealth fontification intensity is controlled via
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
185 the variable `jit-lock-stealth-nice' and `jit-lock-stealth-lines'."
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
186 (interactive "P")
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
187 (setq jit-lock-mode (if arg
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
188 (> (prefix-numeric-value arg) 0)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
189 (not jit-lock-mode)))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
190 (cond ((and jit-lock-mode
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
191 (or (not (boundp 'font-lock-mode))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
192 (not font-lock-mode)))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
193 ;; If font-lock is not on, turn it on, with Just-in-time
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
194 ;; Lock mode as support mode; font-lock will call us again.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
195 (let ((font-lock-support-mode 'jit-lock-mode))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
196 (font-lock-mode t)))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
197
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
198 ;; Turn Just-in-time Lock mode on.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
199 (jit-lock-mode
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
200 ;; Setting `font-lock-fontified' makes font-lock believe the
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
201 ;; buffer is already fontified, so that it won't highlight
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
202 ;; the whole buffer.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
203 (make-local-variable 'font-lock-fontified)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
204 (setq font-lock-fontified t)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
205
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
206 (setq jit-lock-first-unfontify-pos nil)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
207
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
208 ;; Install an idle timer for stealth fontification.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
209 (when (and jit-lock-stealth-time
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
210 (null jit-lock-stealth-timer))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
211 (setq jit-lock-stealth-timer
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
212 (run-with-idle-timer jit-lock-stealth-time
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
213 jit-lock-stealth-time
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
214 'jit-lock-stealth-fontify)))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
215
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
216 ;; Add a hook for deferred contectual fontification.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
217 (when (or (eq jit-lock-defer-contextually 'always)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
218 (and (not (eq jit-lock-defer-contextually 'never))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
219 (null font-lock-keywords-only)))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
220 (add-hook 'after-change-functions 'jit-lock-after-change))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
221
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
222 ;; Install the fontification hook.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
223 (add-hook 'fontification-functions 'jit-lock-function))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
224
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
225 ;; Turn Just-in-time Lock mode off.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
226 (t
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
227 ;; Cancel our idle timer.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
228 (when jit-lock-stealth-timer
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
229 (cancel-timer jit-lock-stealth-timer)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
230 (setq jit-lock-stealth-timer nil))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
231
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
232 ;; Remove hooks.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
233 (remove-hook 'after-change-functions 'jit-lock-after-change)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
234 (remove-hook 'fontification-functions 'jit-lock-function))))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
235
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
236
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
237 ;;;###autoload
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
238 (defun turn-on-jit-lock ()
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
239 "Unconditionally turn on Just-in-time Lock mode."
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
240 (jit-lock-mode 1))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
241
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
242
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
243
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
244 ;;; On demand fontification.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
245
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
246 (defun jit-lock-function (start)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
247 "Fontify current buffer starting at position START.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
248 This function is added to `fontification-functions' when `jit-lock-mode'
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
249 is active."
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
250 (when jit-lock-mode
28521
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
251 (jit-lock-function-1 start)))
28501
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
252
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
253
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
254 (defun jit-lock-function-1 (start)
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
255 "Fontify current buffer starting at position START.
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
256 This function is added to `fontification-functions' when `jit-lock-mode'
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
257 is active."
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
258 (with-buffer-prepared-for-font-lock
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
259 (save-excursion
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
260 (save-restriction
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
261 (widen)
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
262 (let ((end (min (point-max) (+ start jit-lock-chunk-size)))
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
263 (parse-sexp-lookup-properties font-lock-syntactic-keywords)
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
264 (font-lock-beginning-of-syntax-function nil)
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
265 (old-syntax-table (syntax-table))
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
266 next font-lock-start font-lock-end)
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
267 (when font-lock-syntax-table
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
268 (set-syntax-table font-lock-syntax-table))
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
269 (save-match-data
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
270 (condition-case error
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
271 ;; Fontify chunks beginning at START. The end of a
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
272 ;; chunk is either `end', or the start of a region
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
273 ;; before `end' that has already been fontified.
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
274 (while start
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
275 ;; Determine the end of this chunk.
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
276 (setq next (or (text-property-any start end 'fontified t)
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
277 end))
25395
9d8fff117316 (jit-lock-function): Extend the fontified range
Gerd Moellmann <gerd@gnu.org>
parents: 25341
diff changeset
278
28501
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
279 ;; Decide which range of text should be fontified.
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
280 ;; The problem is that START and NEXT may be in the
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
281 ;; middle of something matched by a font-lock regexp.
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
282 ;; Until someone has a better idea, let's start
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
283 ;; at the start of the line containing START and
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
284 ;; stop at the start of the line following NEXT.
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
285 (goto-char next)
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
286 (setq font-lock-end (line-beginning-position 2))
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
287 (goto-char start)
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
288 (setq font-lock-start (line-beginning-position))
25003
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
289
28501
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
290 ;; Fontify the chunk, and mark it as fontified.
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
291 (font-lock-fontify-region font-lock-start font-lock-end nil)
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
292 (add-text-properties start next '(fontified t))
25003
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
293
28501
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
294 ;; Find the start of the next chunk, if any.
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
295 (setq start (text-property-any next end 'fontified nil)))
25003
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
296
28501
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
297 ((error quit)
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
298 (message "Fontifying region...%s" error))))
25003
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
299
28501
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
300 ;; Restore previous buffer settings.
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
301 (set-syntax-table old-syntax-table))))))
25003
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
302
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
303
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
304 (defun jit-lock-after-fontify-buffer ()
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
305 "Mark the current buffer as fontified.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
306 Called from `font-lock-after-fontify-buffer."
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
307 (with-buffer-prepared-for-font-lock
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
308 (add-text-properties (point-min) (point-max) '(fontified t))))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
309
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
310
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
311 (defun jit-lock-after-unfontify-buffer ()
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
312 "Mark the current buffer as unfontified.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
313 Called from `font-lock-after-fontify-buffer."
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
314 (with-buffer-prepared-for-font-lock
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
315 (remove-text-properties (point-min) (point-max) '(fontified nil))))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
316
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
317
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
318
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
319 ;;; Stealth fontification.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
320
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
321 (defsubst jit-lock-stealth-chunk-start (around)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
322 "Return the start of the next chunk to fontify around position AROUND..
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
323 Value is nil if there is nothing more to fontify."
27537
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
324 (if (zerop (buffer-size))
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
325 nil
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
326 (save-restriction
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
327 (widen)
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
328 (let* ((next (text-property-any around (point-max) 'fontified nil))
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
329 (prev (previous-single-property-change around 'fontified))
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
330 (prop (get-text-property (max (point-min) (1- around))
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
331 'fontified))
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
332 (start (cond
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
333 ((null prev)
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
334 ;; There is no property change between AROUND
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
335 ;; and the start of the buffer. If PROP is
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
336 ;; non-nil, everything in front of AROUND is
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
337 ;; fontified, otherwise nothing is fontified.
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
338 (if prop
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
339 nil
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
340 (max (point-min)
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
341 (- around (/ jit-lock-chunk-size 2)))))
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
342 (prop
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
343 ;; PREV is the start of a region of fontified
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
344 ;; text containing AROUND. Start fontfifying a
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
345 ;; chunk size before the end of the unfontified
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
346 ;; region in front of that.
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
347 (max (or (previous-single-property-change prev 'fontified)
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
348 (point-min))
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
349 (- prev jit-lock-chunk-size)))
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
350 (t
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
351 ;; PREV is the start of a region of unfontified
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
352 ;; text containing AROUND. Start at PREV or
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
353 ;; chunk size in front of AROUND, whichever is
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
354 ;; nearer.
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
355 (max prev (- around jit-lock-chunk-size)))))
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
356 (result (cond ((null start) next)
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
357 ((null next) start)
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
358 ((< (- around start) (- next around)) start)
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
359 (t next))))
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
360 result))))
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
361
25003
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
362
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
363 (defun jit-lock-stealth-fontify ()
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
364 "Fontify buffers stealthily.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
365 This functions is called after Emacs has been idle for
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
366 `jit-lock-stealth-time' seconds."
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
367 (unless (or executing-kbd-macro
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
368 (window-minibuffer-p (selected-window)))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
369 (let ((buffers (buffer-list))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
370 minibuffer-auto-raise
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
371 message-log-max)
27537
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
372 (while (and buffers (not (input-pending-p)))
25003
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
373 (let ((buffer (car buffers)))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
374 (setq buffers (cdr buffers))
27537
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
375
25003
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
376 (with-current-buffer buffer
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
377 (when jit-lock-mode
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
378 ;; This is funny. Calling sit-for with 3rd arg non-nil
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
379 ;; so that it doesn't redisplay, internally calls
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
380 ;; wait_reading_process_input also with a parameter
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
381 ;; saying "don't redisplay." Since this function here
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
382 ;; is called periodically, this effectively leads to
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
383 ;; process output not being redisplayed at all because
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
384 ;; redisplay_internal is never called. (That didn't
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
385 ;; work in the old redisplay either.) So, we learn that
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
386 ;; we mustn't call sit-for that way here. But then, we
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
387 ;; have to be cautious not to call sit-for in a widened
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
388 ;; buffer, since this could display hidden parts of that
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
389 ;; buffer. This explains the seemingly weird use of
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
390 ;; save-restriction/widen here.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
391
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
392 (with-temp-message (if jit-lock-stealth-verbose
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
393 (concat "JIT stealth lock "
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
394 (buffer-name)))
27537
d04b7ce72b4a (jit-lock-function): Widen before calculating end
Gerd Moellmann <gerd@gnu.org>
parents: 25395
diff changeset
395
28521
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
396 ;; Perform deferred unfontification, if any.
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
397 (when jit-lock-first-unfontify-pos
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
398 (save-restriction
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
399 (widen)
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
400 (when (and (>= jit-lock-first-unfontify-pos (point-min))
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
401 (< jit-lock-first-unfontify-pos (point-max)))
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
402 (with-buffer-prepared-for-font-lock
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
403 (put-text-property jit-lock-first-unfontify-pos
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
404 (point-max) 'fontified nil))
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
405 (setq jit-lock-first-unfontify-pos nil))))
28501
030a9790d290 (with-buffer-unmodified): New macro.
Gerd Moellmann <gerd@gnu.org>
parents: 28208
diff changeset
406
28521
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
407 ;; In the following code, the `sit-for' calls cause a
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
408 ;; redisplay, so it's required that the
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
409 ;; buffer-modified flag of a buffer that is displayed
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
410 ;; has the right value---otherwise the mode line of
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
411 ;; an unmodified buffer would show a `*'.
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
412 (let (start
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
413 (nice (or jit-lock-stealth-nice 0))
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
414 (point (point)))
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
415 (while (and (setq start
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
416 (jit-lock-stealth-chunk-start point))
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
417 (sit-for nice))
25003
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
418
28521
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
419 ;; Wait a little if load is too high.
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
420 (when (and jit-lock-stealth-load
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
421 (> (car (load-average)) jit-lock-stealth-load))
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
422 (sit-for (or jit-lock-stealth-time 30)))
25003
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
423
28521
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
424 ;; Unless there's input pending now, fontify.
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
425 (unless (input-pending-p)
73d4caf44d53 (with-buffer-unmodified): Use
Gerd Moellmann <gerd@gnu.org>
parents: 28501
diff changeset
426 (jit-lock-function-1 start))))))))))))
25003
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
427
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
428
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
429
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
430 ;;; Deferred fontification.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
431
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
432 (defun jit-lock-after-change (start end old-len)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
433 "Mark the rest of the buffer as not fontified after a change.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
434 Installed on `after-change-functions'.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
435 START and END are the start and end of the changed text. OLD-LEN
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
436 is the pre-change length.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
437 This function ensures that lines following the change will be refontified
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
438 in case the syntax of those lines has changed. Refontification
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
439 will take place when text is fontified stealthily."
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
440 ;; Don't do much here---removing text properties is too slow for
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
441 ;; fast typers, giving them the impression of Emacs not being
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
442 ;; very responsive.
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
443 (when jit-lock-mode
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
444 (setq jit-lock-first-unfontify-pos
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
445 (if jit-lock-first-unfontify-pos
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
446 (min jit-lock-first-unfontify-pos start)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
447 start))))
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
448
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
449
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
450 (provide 'jit-lock)
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
451
bb68fe3c72f8 New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
452 ;; jit-lock.el ends here