Mercurial > emacs
annotate lisp/emacs-lisp/syntax.el @ 78076:dc2000c17cdd
*** empty log message ***
author | Dan Nicolaescu <dann@ics.uci.edu> |
---|---|
date | Sat, 07 Jul 2007 03:01:31 +0000 |
parents | 7a3f13e2dd57 |
children | 935157c0b596 95d0cdf160ea |
rev | line source |
---|---|
45078 | 1 ;;; syntax.el --- helper functions to find syntactic context |
39756 | 2 |
64751
5b1a238fcbb4
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64085
diff
changeset
|
3 ;; Copyright (C) 2000, 2001, 2002, 2003, 2004, |
75346 | 4 ;; 2005, 2006, 2007 Free Software Foundation, Inc. |
39756 | 5 |
45078 | 6 ;; Maintainer: FSF |
7 ;; Keywords: internal | |
8 | |
39756 | 9 ;; This file is part of GNU Emacs. |
10 | |
11 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 ;; it under the terms of the GNU General Public License as published by | |
13 ;; the Free Software Foundation; either version 2, or (at your option) | |
14 ;; any later version. | |
15 | |
16 ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 ;; GNU General Public License for more details. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
64085 | 23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
24 ;; Boston, MA 02110-1301, USA. | |
39756 | 25 |
26 ;;; Commentary: | |
27 | |
28 ;; The main exported function is `syntax-ppss'. You might also need | |
51941
9bf93e387b5e
(syntax-ppss-flush-cache): Rename from syntax-ppss-after-change-function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49598
diff
changeset
|
29 ;; to call `syntax-ppss-flush-cache' or to add it to |
70505
53adfd470fe4
(syntax-ppss): Flush the cache before rather than after a buffer modification.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68648
diff
changeset
|
30 ;; before-change-functions'(although this is automatically done by |
39756 | 31 ;; syntax-ppss when needed, but that might fail if syntax-ppss is |
70505
53adfd470fe4
(syntax-ppss): Flush the cache before rather than after a buffer modification.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68648
diff
changeset
|
32 ;; called in a context where before-change-functions is temporarily |
39756 | 33 ;; let-bound to nil). |
34 | |
35 ;;; Todo: | |
36 | |
37 ;; - do something about the case where the syntax-table is changed. | |
38 ;; This typically happens with tex-mode and its `$' operator. | |
39 ;; - move font-lock-syntactic-keywords in here. Then again, maybe not. | |
40 ;; - new functions `syntax-state', ... to replace uses of parse-partial-state | |
41 ;; with something higher-level (similar to syntax-ppss-context). | |
42 ;; - interaction with mmm-mode. | |
43 | |
44 ;;; Code: | |
45 | |
46 ;; Note: PPSS stands for `parse-partial-sexp state' | |
47 | |
48 (eval-when-compile (require 'cl)) | |
49 | |
65194
364fe66bab84
(font-lock-beginning-of-syntax-function): Add defvar.
Juanma Barranquero <lekktu@gmail.com>
parents:
64751
diff
changeset
|
50 (defvar font-lock-beginning-of-syntax-function) |
364fe66bab84
(font-lock-beginning-of-syntax-function): Add defvar.
Juanma Barranquero <lekktu@gmail.com>
parents:
64751
diff
changeset
|
51 |
39756 | 52 (defsubst syntax-ppss-depth (ppss) |
53 (nth 0 ppss)) | |
54 | |
74600
ab428131b528
(syntax-ppss-toplevel-pos): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70505
diff
changeset
|
55 (defun syntax-ppss-toplevel-pos (ppss) |
74724
80f7458bbb20
(syntax-ppss-toplevel-pos): Improve docstring.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74600
diff
changeset
|
56 "Get the latest syntactically outermost position found in a syntactic scan. |
80f7458bbb20
(syntax-ppss-toplevel-pos): Improve docstring.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74600
diff
changeset
|
57 PPSS is a scan state, as returned by `partial-parse-sexp' or `syntax-ppss'. |
80f7458bbb20
(syntax-ppss-toplevel-pos): Improve docstring.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74600
diff
changeset
|
58 An \"outermost position\" means one that it is outside of any syntactic entity: |
80f7458bbb20
(syntax-ppss-toplevel-pos): Improve docstring.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74600
diff
changeset
|
59 outside of any parentheses, comments, or strings encountered in the scan. |
80f7458bbb20
(syntax-ppss-toplevel-pos): Improve docstring.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74600
diff
changeset
|
60 If no such position is recorded in PPSS (because the end of the scan was |
80f7458bbb20
(syntax-ppss-toplevel-pos): Improve docstring.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74600
diff
changeset
|
61 itself at the outermost level), return nil." |
74725
7bf99b0f8330
(syntax-ppss-flush-cache, syntax-ppss): Use syntax-ppss-toplevel-pos.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74724
diff
changeset
|
62 ;; BEWARE! We rely on the undocumented 9th field. The 9th field currently |
7bf99b0f8330
(syntax-ppss-flush-cache, syntax-ppss): Use syntax-ppss-toplevel-pos.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74724
diff
changeset
|
63 ;; contains the list of positions of the enclosing open-parens. |
7bf99b0f8330
(syntax-ppss-flush-cache, syntax-ppss): Use syntax-ppss-toplevel-pos.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74724
diff
changeset
|
64 ;; I.e. those positions are outside of any string/comment and the first of |
7bf99b0f8330
(syntax-ppss-flush-cache, syntax-ppss): Use syntax-ppss-toplevel-pos.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74724
diff
changeset
|
65 ;; those is outside of any paren (i.e. corresponds to a nil ppss). |
7bf99b0f8330
(syntax-ppss-flush-cache, syntax-ppss): Use syntax-ppss-toplevel-pos.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74724
diff
changeset
|
66 ;; If this list is empty but we are in a string or comment, then the 8th |
7bf99b0f8330
(syntax-ppss-flush-cache, syntax-ppss): Use syntax-ppss-toplevel-pos.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74724
diff
changeset
|
67 ;; field contains a similar "toplevel" position. |
74600
ab428131b528
(syntax-ppss-toplevel-pos): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70505
diff
changeset
|
68 (or (car (nth 9 ppss)) |
74725
7bf99b0f8330
(syntax-ppss-flush-cache, syntax-ppss): Use syntax-ppss-toplevel-pos.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74724
diff
changeset
|
69 (nth 8 ppss))) |
74600
ab428131b528
(syntax-ppss-toplevel-pos): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70505
diff
changeset
|
70 |
39756 | 71 (defsubst syntax-ppss-context (ppss) |
72 (cond | |
73 ((nth 3 ppss) 'string) | |
74 ((nth 4 ppss) 'comment) | |
75 (t nil))) | |
76 | |
77 (defvar syntax-ppss-max-span 20000 | |
78 "Threshold below which cache info is deemed unnecessary. | |
79 We try to make sure that cache entries are at least this far apart | |
80 from each other, to avoid keeping too much useless info.") | |
81 | |
82 (defvar syntax-begin-function nil | |
83 "Function to move back outside of any comment/string/paren. | |
84 This function should move the cursor back to some syntactically safe | |
85 point (where the PPSS is equivalent to nil).") | |
86 | |
87 (defvar syntax-ppss-cache nil | |
88 "List of (POS . PPSS) pairs, in decreasing POS order.") | |
89 (make-variable-buffer-local 'syntax-ppss-cache) | |
90 (defvar syntax-ppss-last nil | |
91 "Cache of (LAST-POS . LAST-PPSS).") | |
92 (make-variable-buffer-local 'syntax-ppss-last) | |
93 | |
51941
9bf93e387b5e
(syntax-ppss-flush-cache): Rename from syntax-ppss-after-change-function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49598
diff
changeset
|
94 (defalias 'syntax-ppss-after-change-function 'syntax-ppss-flush-cache) |
9bf93e387b5e
(syntax-ppss-flush-cache): Rename from syntax-ppss-after-change-function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49598
diff
changeset
|
95 (defun syntax-ppss-flush-cache (beg &rest ignored) |
9bf93e387b5e
(syntax-ppss-flush-cache): Rename from syntax-ppss-after-change-function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49598
diff
changeset
|
96 "Flush the cache of `syntax-ppss' starting at position BEG." |
39756 | 97 ;; Flush invalid cache entries. |
98 (while (and syntax-ppss-cache (> (caar syntax-ppss-cache) beg)) | |
99 (setq syntax-ppss-cache (cdr syntax-ppss-cache))) | |
100 ;; Throw away `last' value if made invalid. | |
101 (when (< beg (or (car syntax-ppss-last) 0)) | |
66266
f15e775dfb97
(syntax-ppss-flush-cache): Fix corner boundary case.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65194
diff
changeset
|
102 ;; If syntax-begin-function jumped to BEG, then the old state at BEG can |
f15e775dfb97
(syntax-ppss-flush-cache): Fix corner boundary case.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65194
diff
changeset
|
103 ;; depend on the text after BEG (which is presumably changed). So if |
f15e775dfb97
(syntax-ppss-flush-cache): Fix corner boundary case.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65194
diff
changeset
|
104 ;; BEG=(car (nth 10 syntax-ppss-last)) don't reuse that data because the |
f15e775dfb97
(syntax-ppss-flush-cache): Fix corner boundary case.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65194
diff
changeset
|
105 ;; assumed nil state at BEG may not be valid any more. |
74725
7bf99b0f8330
(syntax-ppss-flush-cache, syntax-ppss): Use syntax-ppss-toplevel-pos.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74724
diff
changeset
|
106 (if (<= beg (or (syntax-ppss-toplevel-pos (cdr syntax-ppss-last)) |
66267
2b7c12a97893
(syntax-ppss-flush-cache): Fix typo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66266
diff
changeset
|
107 (nth 3 syntax-ppss-last) |
66266
f15e775dfb97
(syntax-ppss-flush-cache): Fix corner boundary case.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65194
diff
changeset
|
108 0)) |
39756 | 109 (setq syntax-ppss-last nil) |
110 (setcar syntax-ppss-last nil))) | |
111 ;; Unregister if there's no cache left. Sadly this doesn't work | |
70505
53adfd470fe4
(syntax-ppss): Flush the cache before rather than after a buffer modification.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68648
diff
changeset
|
112 ;; because `before-change-functions' is temporarily bound to nil here. |
39756 | 113 ;; (unless syntax-ppss-cache |
70505
53adfd470fe4
(syntax-ppss): Flush the cache before rather than after a buffer modification.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68648
diff
changeset
|
114 ;; (remove-hook 'before-change-functions 'syntax-ppss-flush-cache t)) |
39756 | 115 ) |
116 | |
117 (defvar syntax-ppss-stats | |
118 [(0 . 0.0) (0 . 0.0) (0 . 0.0) (0 . 0.0) (0 . 0.0) (1 . 2500.0)]) | |
119 (defun syntax-ppss-stats () | |
40396
894b9bc4ca7a
(syntax-ppss-stats): Be more robust when dividing by 0.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39889
diff
changeset
|
120 (mapcar (lambda (x) |
894b9bc4ca7a
(syntax-ppss-stats): Be more robust when dividing by 0.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39889
diff
changeset
|
121 (condition-case nil |
894b9bc4ca7a
(syntax-ppss-stats): Be more robust when dividing by 0.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39889
diff
changeset
|
122 (cons (car x) (truncate (/ (cdr x) (car x)))) |
894b9bc4ca7a
(syntax-ppss-stats): Be more robust when dividing by 0.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
39889
diff
changeset
|
123 (error nil))) |
39756 | 124 syntax-ppss-stats)) |
125 | |
126 (defun syntax-ppss (&optional pos) | |
127 "Parse-Partial-Sexp State at POS. | |
128 The returned value is the same as `parse-partial-sexp' except that | |
129 the 2nd and 6th values of the returned state cannot be relied upon. | |
130 Point is at POS when this function returns." | |
131 ;; Default values. | |
132 (unless pos (setq pos (point))) | |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
47356
diff
changeset
|
133 ;; |
39756 | 134 (let ((old-ppss (cdr syntax-ppss-last)) |
135 (old-pos (car syntax-ppss-last)) | |
136 (ppss nil) | |
137 (pt-min (point-min))) | |
138 (if (and old-pos (> old-pos pos)) (setq old-pos nil)) | |
139 ;; Use the OLD-POS if usable and close. Don't update the `last' cache. | |
51942
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
140 (condition-case nil |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
141 (if (and old-pos (< (- pos old-pos) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
142 ;; The time to use syntax-begin-function and |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
143 ;; find PPSS is assumed to be about 2 * distance. |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
144 (* 2 (/ (cdr (aref syntax-ppss-stats 5)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
145 (1+ (car (aref syntax-ppss-stats 5))))))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
146 (progn |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
147 (incf (car (aref syntax-ppss-stats 0))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
148 (incf (cdr (aref syntax-ppss-stats 0)) (- pos old-pos)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
149 (parse-partial-sexp old-pos pos nil nil old-ppss)) |
39756 | 150 |
151 (cond | |
51942
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
152 ;; Use OLD-PPSS if possible and close enough. |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
153 ((and (not old-pos) old-ppss |
74725
7bf99b0f8330
(syntax-ppss-flush-cache, syntax-ppss): Use syntax-ppss-toplevel-pos.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74724
diff
changeset
|
154 ;; If `pt-min' is too far from `pos', we could try to use |
7bf99b0f8330
(syntax-ppss-flush-cache, syntax-ppss): Use syntax-ppss-toplevel-pos.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74724
diff
changeset
|
155 ;; other positions in (nth 9 old-ppss), but that doesn't |
7bf99b0f8330
(syntax-ppss-flush-cache, syntax-ppss): Use syntax-ppss-toplevel-pos.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74724
diff
changeset
|
156 ;; seem to happen in practice and it would complicate this |
7bf99b0f8330
(syntax-ppss-flush-cache, syntax-ppss): Use syntax-ppss-toplevel-pos.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74724
diff
changeset
|
157 ;; code (and the before-change-function code even more). |
7bf99b0f8330
(syntax-ppss-flush-cache, syntax-ppss): Use syntax-ppss-toplevel-pos.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74724
diff
changeset
|
158 ;; But maybe it would be useful in "degenerate" cases such |
7bf99b0f8330
(syntax-ppss-flush-cache, syntax-ppss): Use syntax-ppss-toplevel-pos.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74724
diff
changeset
|
159 ;; as when the whole file is wrapped in a set |
7bf99b0f8330
(syntax-ppss-flush-cache, syntax-ppss): Use syntax-ppss-toplevel-pos.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74724
diff
changeset
|
160 ;; of parentheses. |
7bf99b0f8330
(syntax-ppss-flush-cache, syntax-ppss): Use syntax-ppss-toplevel-pos.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
74724
diff
changeset
|
161 (setq pt-min (or (syntax-ppss-toplevel-pos old-ppss) |
51942
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
162 (nth 2 old-ppss))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
163 (<= pt-min pos) (< (- pos pt-min) syntax-ppss-max-span)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
164 (incf (car (aref syntax-ppss-stats 1))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
165 (incf (cdr (aref syntax-ppss-stats 1)) (- pos pt-min)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
166 (setq ppss (parse-partial-sexp pt-min pos))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
167 ;; The OLD-* data can't be used. Consult the cache. |
39756 | 168 (t |
51942
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
169 (let ((cache-pred nil) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
170 (cache syntax-ppss-cache) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
171 (pt-min (point-min)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
172 ;; I differentiate between PT-MIN and PT-BEST because |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
173 ;; I feel like it might be important to ensure that the |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
174 ;; cache is only filled with 100% sure data (whereas |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
175 ;; syntax-begin-function might return incorrect data). |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
176 ;; Maybe that's just stupid. |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
177 (pt-best (point-min)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
178 (ppss-best nil)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
179 ;; look for a usable cache entry. |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
180 (while (and cache (< pos (caar cache))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
181 (setq cache-pred cache) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
182 (setq cache (cdr cache))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
183 (if cache (setq pt-min (caar cache) ppss (cdar cache))) |
39756 | 184 |
70505
53adfd470fe4
(syntax-ppss): Flush the cache before rather than after a buffer modification.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68648
diff
changeset
|
185 ;; Setup the before-change function if necessary. |
51942
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
186 (unless (or syntax-ppss-cache syntax-ppss-last) |
70505
53adfd470fe4
(syntax-ppss): Flush the cache before rather than after a buffer modification.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68648
diff
changeset
|
187 (add-hook 'before-change-functions |
53adfd470fe4
(syntax-ppss): Flush the cache before rather than after a buffer modification.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68648
diff
changeset
|
188 'syntax-ppss-flush-cache t t)) |
39756 | 189 |
51942
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
190 ;; Use the best of OLD-POS and CACHE. |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
191 (if (or (not old-pos) (< old-pos pt-min)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
192 (setq pt-best pt-min ppss-best ppss) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
193 (incf (car (aref syntax-ppss-stats 4))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
194 (incf (cdr (aref syntax-ppss-stats 4)) (- pos old-pos)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
195 (setq pt-best old-pos ppss-best old-ppss)) |
39756 | 196 |
51942
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
197 ;; Use the `syntax-begin-function' if available. |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
198 ;; We could try using that function earlier, but: |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
199 ;; - The result might not be 100% reliable, so it's better to use |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
200 ;; the cache if available. |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
201 ;; - The function might be slow. |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
202 ;; - If this function almost always finds a safe nearby spot, |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
203 ;; the cache won't be populated, so consulting it is cheap. |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
204 (when (and (not syntax-begin-function) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
205 (boundp 'font-lock-beginning-of-syntax-function) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
206 font-lock-beginning-of-syntax-function) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
207 (set (make-local-variable 'syntax-begin-function) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
208 font-lock-beginning-of-syntax-function)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
209 (when (and syntax-begin-function |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
210 (progn (goto-char pos) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
211 (funcall syntax-begin-function) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
212 ;; Make sure it's better. |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
213 (> (point) pt-best)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
214 ;; Simple sanity check. |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
215 (not (memq (get-text-property (point) 'face) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
216 '(font-lock-string-face font-lock-doc-face |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
217 font-lock-comment-face)))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
218 (incf (car (aref syntax-ppss-stats 5))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
219 (incf (cdr (aref syntax-ppss-stats 5)) (- pos (point))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
220 (setq pt-best (point) ppss-best nil)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
221 |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
222 (cond |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
223 ;; Quick case when we found a nearby pos. |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
224 ((< (- pos pt-best) syntax-ppss-max-span) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
225 (incf (car (aref syntax-ppss-stats 2))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
226 (incf (cdr (aref syntax-ppss-stats 2)) (- pos pt-best)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
227 (setq ppss (parse-partial-sexp pt-best pos nil nil ppss-best))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
228 ;; Slow case: compute the state from some known position and |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
229 ;; populate the cache so we won't need to do it again soon. |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
230 (t |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
231 (incf (car (aref syntax-ppss-stats 3))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
232 (incf (cdr (aref syntax-ppss-stats 3)) (- pos pt-min)) |
39756 | 233 |
51942
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
234 ;; If `pt-min' is too far, add a few intermediate entries. |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
235 (while (> (- pos pt-min) (* 2 syntax-ppss-max-span)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
236 (setq ppss (parse-partial-sexp |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
237 pt-min (setq pt-min (/ (+ pt-min pos) 2)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
238 nil nil ppss)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
239 (let ((pair (cons pt-min ppss))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
240 (if cache-pred |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
241 (push pair (cdr cache-pred)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
242 (push pair syntax-ppss-cache)))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
243 |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
244 ;; Compute the actual return value. |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
245 (setq ppss (parse-partial-sexp pt-min pos nil nil ppss)) |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
47356
diff
changeset
|
246 |
51942
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
247 ;; Debugging check. |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
248 ;; (let ((real-ppss (parse-partial-sexp (point-min) pos))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
249 ;; (setcar (last ppss 4) 0) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
250 ;; (setcar (last real-ppss 4) 0) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
251 ;; (setcar (last ppss 8) nil) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
252 ;; (setcar (last real-ppss 8) nil) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
253 ;; (unless (equal ppss real-ppss) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
254 ;; (message "!!Syntax: %s != %s" ppss real-ppss) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
255 ;; (setq ppss real-ppss))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
256 |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
257 ;; Store it in the cache. |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
258 (let ((pair (cons pos ppss))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
259 (if cache-pred |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
260 (if (> (- (caar cache-pred) pos) syntax-ppss-max-span) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
261 (push pair (cdr cache-pred)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
262 (setcar cache-pred pair)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
263 (if (or (null syntax-ppss-cache) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
264 (> (- (caar syntax-ppss-cache) pos) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
265 syntax-ppss-max-span)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
266 (push pair syntax-ppss-cache) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
267 (setcar syntax-ppss-cache pair))))))))) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
268 |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
269 (setq syntax-ppss-last (cons pos ppss)) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
270 ppss) |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
271 (args-out-of-range |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
272 ;; If the buffer is more narrowed than when we built the cache, |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
273 ;; we may end up calling parse-partial-sexp with a position before |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
274 ;; point-min. In that case, just parse from point-min assuming |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
275 ;; a nil state. |
5fdfe35f3ac4
(syntax-ppss): Catch the case where the buffer is narrowed.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
51941
diff
changeset
|
276 (parse-partial-sexp (point-min) pos))))) |
39756 | 277 |
278 ;; Debugging functions | |
279 | |
280 (defun syntax-ppss-debug () | |
281 (let ((pt nil) | |
282 (min-diffs nil)) | |
283 (dolist (x (append syntax-ppss-cache (list (cons (point-min) nil)))) | |
284 (when pt (push (- pt (car x)) min-diffs)) | |
285 (setq pt (car x))) | |
286 min-diffs)) | |
287 | |
288 ;; XEmacs compatibility functions | |
289 | |
290 ;; (defun buffer-syntactic-context (&optional buffer) | |
291 ;; "Syntactic context at point in BUFFER. | |
292 ;; Either of `string', `comment' or `nil'. | |
293 ;; This is an XEmacs compatibility function." | |
294 ;; (with-current-buffer (or buffer (current-buffer)) | |
295 ;; (syntax-ppss-context (syntax-ppss)))) | |
296 | |
297 ;; (defun buffer-syntactic-context-depth (&optional buffer) | |
298 ;; "Syntactic parenthesis depth at point in BUFFER. | |
299 ;; This is an XEmacs compatibility function." | |
300 ;; (with-current-buffer (or buffer (current-buffer)) | |
301 ;; (syntax-ppss-depth (syntax-ppss)))) | |
302 | |
303 (provide 'syntax) | |
52401 | 304 |
66266
f15e775dfb97
(syntax-ppss-flush-cache): Fix corner boundary case.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65194
diff
changeset
|
305 ;; arch-tag: 302f1eeb-e77c-4680-a8c5-c543e01161a5 |
39756 | 306 ;;; syntax.el ends here |