* bug#58665: Indentation in lisp/emacs-lisp/syntax.el is wrong
@ 2022-10-20 17:23 Jim Blandy
2022-10-20 17:57 ` Eli Zaretskii
0 siblings, 1 reply; 6+ messages in thread
From: Jim Blandy @ 2022-10-20 17:23 UTC (permalink / raw)
To: 58665
[-- Attachment #1.1: Type: text/plain, Size: 116 bytes --]
2022-10-20 Jim Blandy <jimb@red-bean.com>
* lisp/emacs-lisp/syntax.el: Fix indentation in `syntax-ppss'.
[-- Attachment #1.2: Type: text/html, Size: 257 bytes --]
[-- Attachment #2: indent-syntax.el.patch --]
[-- Type: text/x-patch, Size: 12688 bytes --]
2022-10-20 Jim Blandy <jimb@red-bean.com>
* lisp/emacs-lisp/syntax.el: Fix indentation in `syntax-ppss'.
diff --git a/lisp/emacs-lisp/syntax.el b/lisp/emacs-lisp/syntax.el
index e1be301583..e550047bcb 100644
--- a/lisp/emacs-lisp/syntax.el
+++ b/lisp/emacs-lisp/syntax.el
@@ -615,150 +615,150 @@ syntax-ppss
(syntax-propertize pos)
;;
(with-syntax-table (or syntax-ppss-table (syntax-table))
- (let* ((cell (syntax-ppss--data))
- (ppss-last (car cell))
- (ppss-cache (cdr cell))
- (old-ppss (cdr ppss-last))
- (old-pos (car ppss-last))
- (ppss nil)
- (pt-min (point-min)))
- (if (and old-pos (> old-pos pos)) (setq old-pos nil))
- ;; Use the OLD-POS if usable and close. Don't update the `last' cache.
- (condition-case nil
- (if (and old-pos (< (- pos old-pos)
- ;; The time to use syntax-begin-function and
- ;; find PPSS is assumed to be about 2 * distance.
- (let ((pair (aref syntax-ppss-stats 5)))
- (/ (* 2 (cdr pair)) (car pair)))))
- (progn
- (syntax-ppss--update-stats 0 old-pos pos)
- (parse-partial-sexp old-pos pos nil nil old-ppss))
-
- (cond
- ;; Use OLD-PPSS if possible and close enough.
- ((and (not old-pos) old-ppss
- ;; If `pt-min' is too far from `pos', we could try to use
- ;; other positions in (nth 9 old-ppss), but that doesn't
- ;; seem to happen in practice and it would complicate this
- ;; code (and the before-change-function code even more).
- ;; But maybe it would be useful in "degenerate" cases such
- ;; as when the whole file is wrapped in a set
- ;; of parentheses.
- (setq pt-min (or (syntax-ppss-toplevel-pos old-ppss)
- (nth 2 old-ppss)))
- (<= pt-min pos) (< (- pos pt-min) syntax-ppss-max-span))
- (syntax-ppss--update-stats 1 pt-min pos)
- (setq ppss (parse-partial-sexp pt-min pos)))
- ;; The OLD-* data can't be used. Consult the cache.
- (t
- (let ((cache-pred nil)
- (cache ppss-cache)
- (pt-min (point-min))
- ;; I differentiate between PT-MIN and PT-BEST because
- ;; I feel like it might be important to ensure that the
- ;; cache is only filled with 100% sure data (whereas
- ;; syntax-begin-function might return incorrect data).
- ;; Maybe that's just stupid.
- (pt-best (point-min))
- (ppss-best nil))
- ;; look for a usable cache entry.
- (while (and cache (< pos (caar cache)))
- (setq cache-pred cache)
- (setq cache (cdr cache)))
- (if cache (setq pt-min (caar cache) ppss (cdar cache)))
-
- ;; Setup the before-change function if necessary.
- (unless (or ppss-cache ppss-last)
- ;; Note: combine-change-calls-1 needs to be kept in sync
- ;; with this!
- (add-hook 'before-change-functions
- #'syntax-ppss-flush-cache
- ;; We should be either the very last function on
- ;; before-change-functions or the very first on
- ;; after-change-functions.
- 99 t))
-
- ;; Use the best of OLD-POS and CACHE.
- (if (or (not old-pos) (< old-pos pt-min))
- (setq pt-best pt-min ppss-best ppss)
- (syntax-ppss--update-stats 4 old-pos pos)
- (setq pt-best old-pos ppss-best old-ppss))
-
- ;; Use the `syntax-begin-function' if available.
- ;; We could try using that function earlier, but:
- ;; - The result might not be 100% reliable, so it's better to use
- ;; the cache if available.
- ;; - The function might be slow.
- ;; - If this function almost always finds a safe nearby spot,
- ;; the cache won't be populated, so consulting it is cheap.
- (when (and syntax-begin-function
- (progn (goto-char pos)
- (funcall syntax-begin-function)
- ;; Make sure it's better.
- (> (point) pt-best))
- ;; Simple sanity checks.
- (< (point) pos) ; backward-paragraph can fail here.
- (not (memq (get-text-property (point) 'face)
- '(font-lock-string-face font-lock-doc-face
- font-lock-comment-face))))
- (syntax-ppss--update-stats 5 (point) pos)
- (setq pt-best (point) ppss-best nil))
-
- (cond
- ;; Quick case when we found a nearby pos.
- ((< (- pos pt-best) syntax-ppss-max-span)
- (syntax-ppss--update-stats 2 pt-best pos)
- (setq ppss (parse-partial-sexp pt-best pos nil nil ppss-best)))
- ;; Slow case: compute the state from some known position and
- ;; populate the cache so we won't need to do it again soon.
- (t
- (syntax-ppss--update-stats 3 pt-min pos)
- (setq syntax-ppss--updated-cache t)
-
- ;; If `pt-min' is too far, add a few intermediate entries.
- (while (> (- pos pt-min) (* 2 syntax-ppss-max-span))
- (setq ppss (parse-partial-sexp
- pt-min (setq pt-min (/ (+ pt-min pos) 2))
- nil nil ppss))
- (push (cons pt-min ppss)
- (if cache-pred (cdr cache-pred) ppss-cache)))
-
- ;; Compute the actual return value.
- (setq ppss (parse-partial-sexp pt-min pos nil nil ppss))
-
- ;; Debugging check.
- ;; (let ((real-ppss (parse-partial-sexp (point-min) pos)))
- ;; (setcar (last ppss 4) 0)
- ;; (setcar (last real-ppss 4) 0)
- ;; (setcar (last ppss 8) nil)
- ;; (setcar (last real-ppss 8) nil)
- ;; (unless (equal ppss real-ppss)
- ;; (message "!!Syntax: %s != %s" ppss real-ppss)
- ;; (setq ppss real-ppss)))
-
- ;; Store it in the cache.
- (let ((pair (cons pos ppss)))
- (if cache-pred
- (if (> (- (caar cache-pred) pos) syntax-ppss-max-span)
- (push pair (cdr cache-pred))
- (setcar cache-pred pair))
- (if (or (null ppss-cache)
- (> (- (caar ppss-cache) pos)
- syntax-ppss-max-span))
- (push pair ppss-cache)
- (setcar ppss-cache pair)))))))))
-
- (setq syntax-ppss--updated-cache t)
- (setq ppss-last (cons pos ppss))
- (setcar cell ppss-last)
- (setcdr cell ppss-cache)
- ppss)
- (args-out-of-range
- ;; If the buffer is more narrowed than when we built the cache,
- ;; we may end up calling parse-partial-sexp with a position before
- ;; point-min. In that case, just parse from point-min assuming
- ;; a nil state.
- (parse-partial-sexp (point-min) pos))))))
+ (let* ((cell (syntax-ppss--data))
+ (ppss-last (car cell))
+ (ppss-cache (cdr cell))
+ (old-ppss (cdr ppss-last))
+ (old-pos (car ppss-last))
+ (ppss nil)
+ (pt-min (point-min)))
+ (if (and old-pos (> old-pos pos)) (setq old-pos nil))
+ ;; Use the OLD-POS if usable and close. Don't update the `last' cache.
+ (condition-case nil
+ (if (and old-pos (< (- pos old-pos)
+ ;; The time to use syntax-begin-function and
+ ;; find PPSS is assumed to be about 2 * distance.
+ (let ((pair (aref syntax-ppss-stats 5)))
+ (/ (* 2 (cdr pair)) (car pair)))))
+ (progn
+ (syntax-ppss--update-stats 0 old-pos pos)
+ (parse-partial-sexp old-pos pos nil nil old-ppss))
+
+ (cond
+ ;; Use OLD-PPSS if possible and close enough.
+ ((and (not old-pos) old-ppss
+ ;; If `pt-min' is too far from `pos', we could try to use
+ ;; other positions in (nth 9 old-ppss), but that doesn't
+ ;; seem to happen in practice and it would complicate this
+ ;; code (and the before-change-function code even more).
+ ;; But maybe it would be useful in "degenerate" cases such
+ ;; as when the whole file is wrapped in a set
+ ;; of parentheses.
+ (setq pt-min (or (syntax-ppss-toplevel-pos old-ppss)
+ (nth 2 old-ppss)))
+ (<= pt-min pos) (< (- pos pt-min) syntax-ppss-max-span))
+ (syntax-ppss--update-stats 1 pt-min pos)
+ (setq ppss (parse-partial-sexp pt-min pos)))
+ ;; The OLD-* data can't be used. Consult the cache.
+ (t
+ (let ((cache-pred nil)
+ (cache ppss-cache)
+ (pt-min (point-min))
+ ;; I differentiate between PT-MIN and PT-BEST because
+ ;; I feel like it might be important to ensure that the
+ ;; cache is only filled with 100% sure data (whereas
+ ;; syntax-begin-function might return incorrect data).
+ ;; Maybe that's just stupid.
+ (pt-best (point-min))
+ (ppss-best nil))
+ ;; look for a usable cache entry.
+ (while (and cache (< pos (caar cache)))
+ (setq cache-pred cache)
+ (setq cache (cdr cache)))
+ (if cache (setq pt-min (caar cache) ppss (cdar cache)))
+
+ ;; Setup the before-change function if necessary.
+ (unless (or ppss-cache ppss-last)
+ ;; Note: combine-change-calls-1 needs to be kept in sync
+ ;; with this!
+ (add-hook 'before-change-functions
+ #'syntax-ppss-flush-cache
+ ;; We should be either the very last function on
+ ;; before-change-functions or the very first on
+ ;; after-change-functions.
+ 99 t))
+
+ ;; Use the best of OLD-POS and CACHE.
+ (if (or (not old-pos) (< old-pos pt-min))
+ (setq pt-best pt-min ppss-best ppss)
+ (syntax-ppss--update-stats 4 old-pos pos)
+ (setq pt-best old-pos ppss-best old-ppss))
+
+ ;; Use the `syntax-begin-function' if available.
+ ;; We could try using that function earlier, but:
+ ;; - The result might not be 100% reliable, so it's better to use
+ ;; the cache if available.
+ ;; - The function might be slow.
+ ;; - If this function almost always finds a safe nearby spot,
+ ;; the cache won't be populated, so consulting it is cheap.
+ (when (and syntax-begin-function
+ (progn (goto-char pos)
+ (funcall syntax-begin-function)
+ ;; Make sure it's better.
+ (> (point) pt-best))
+ ;; Simple sanity checks.
+ (< (point) pos) ; backward-paragraph can fail here.
+ (not (memq (get-text-property (point) 'face)
+ '(font-lock-string-face font-lock-doc-face
+ font-lock-comment-face))))
+ (syntax-ppss--update-stats 5 (point) pos)
+ (setq pt-best (point) ppss-best nil))
+
+ (cond
+ ;; Quick case when we found a nearby pos.
+ ((< (- pos pt-best) syntax-ppss-max-span)
+ (syntax-ppss--update-stats 2 pt-best pos)
+ (setq ppss (parse-partial-sexp pt-best pos nil nil ppss-best)))
+ ;; Slow case: compute the state from some known position and
+ ;; populate the cache so we won't need to do it again soon.
+ (t
+ (syntax-ppss--update-stats 3 pt-min pos)
+ (setq syntax-ppss--updated-cache t)
+
+ ;; If `pt-min' is too far, add a few intermediate entries.
+ (while (> (- pos pt-min) (* 2 syntax-ppss-max-span))
+ (setq ppss (parse-partial-sexp
+ pt-min (setq pt-min (/ (+ pt-min pos) 2))
+ nil nil ppss))
+ (push (cons pt-min ppss)
+ (if cache-pred (cdr cache-pred) ppss-cache)))
+
+ ;; Compute the actual return value.
+ (setq ppss (parse-partial-sexp pt-min pos nil nil ppss))
+
+ ;; Debugging check.
+ ;; (let ((real-ppss (parse-partial-sexp (point-min) pos)))
+ ;; (setcar (last ppss 4) 0)
+ ;; (setcar (last real-ppss 4) 0)
+ ;; (setcar (last ppss 8) nil)
+ ;; (setcar (last real-ppss 8) nil)
+ ;; (unless (equal ppss real-ppss)
+ ;; (message "!!Syntax: %s != %s" ppss real-ppss)
+ ;; (setq ppss real-ppss)))
+
+ ;; Store it in the cache.
+ (let ((pair (cons pos ppss)))
+ (if cache-pred
+ (if (> (- (caar cache-pred) pos) syntax-ppss-max-span)
+ (push pair (cdr cache-pred))
+ (setcar cache-pred pair))
+ (if (or (null ppss-cache)
+ (> (- (caar ppss-cache) pos)
+ syntax-ppss-max-span))
+ (push pair ppss-cache)
+ (setcar ppss-cache pair)))))))))
+
+ (setq syntax-ppss--updated-cache t)
+ (setq ppss-last (cons pos ppss))
+ (setcar cell ppss-last)
+ (setcdr cell ppss-cache)
+ ppss)
+ (args-out-of-range
+ ;; If the buffer is more narrowed than when we built the cache,
+ ;; we may end up calling parse-partial-sexp with a position before
+ ;; point-min. In that case, just parse from point-min assuming
+ ;; a nil state.
+ (parse-partial-sexp (point-min) pos))))))
;; Debugging functions
^ permalink raw reply related [flat|nested] 6+ messages in thread
* bug#58665: Indentation in lisp/emacs-lisp/syntax.el is wrong
2022-10-20 17:23 bug#58665: Indentation in lisp/emacs-lisp/syntax.el is wrong Jim Blandy
@ 2022-10-20 17:57 ` Eli Zaretskii
2022-10-20 21:18 ` Jim Blandy
0 siblings, 1 reply; 6+ messages in thread
From: Eli Zaretskii @ 2022-10-20 17:57 UTC (permalink / raw)
To: Jim Blandy; +Cc: 58665
> From: Jim Blandy <jblandy@mozilla.com>
> Date: Thu, 20 Oct 2022 10:23:30 -0700
>
> 2022-10-20 Jim Blandy <jimb@red-bean.com>
>
> * lisp/emacs-lisp/syntax.el: Fix indentation in `syntax-ppss'.
Thanks, but we don't like pure-whitespace changes. We fix these
issues when we change code around the places with wrong indentation.
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#58665: Indentation in lisp/emacs-lisp/syntax.el is wrong
2022-10-20 17:57 ` Eli Zaretskii
@ 2022-10-20 21:18 ` Jim Blandy
2023-09-03 10:21 ` Stefan Kangas
0 siblings, 1 reply; 6+ messages in thread
From: Jim Blandy @ 2022-10-20 21:18 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: 58665
[-- Attachment #1: Type: text/plain, Size: 592 bytes --]
This code changes almost never. It's been like that since 2016. It doesn't
make sense to let it sit there with formatting that obscures the structure
of the code.
On Thu, Oct 20, 2022 at 10:57 AM Eli Zaretskii <eliz@gnu.org> wrote:
> > From: Jim Blandy <jblandy@mozilla.com>
> > Date: Thu, 20 Oct 2022 10:23:30 -0700
> >
> > 2022-10-20 Jim Blandy <jimb@red-bean.com>
> >
> > * lisp/emacs-lisp/syntax.el: Fix indentation in `syntax-ppss'.
>
> Thanks, but we don't like pure-whitespace changes. We fix these
> issues when we change code around the places with wrong indentation.
>
[-- Attachment #2: Type: text/html, Size: 1062 bytes --]
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#58665: Indentation in lisp/emacs-lisp/syntax.el is wrong
2022-10-20 21:18 ` Jim Blandy
@ 2023-09-03 10:21 ` Stefan Kangas
2023-09-03 10:39 ` Eli Zaretskii
0 siblings, 1 reply; 6+ messages in thread
From: Stefan Kangas @ 2023-09-03 10:21 UTC (permalink / raw)
To: Jim Blandy; +Cc: Eli Zaretskii, 58665
Jim Blandy <jblandy@mozilla.com> writes:
> This code changes almost never. It's been like that since 2016. It
> doesn't make sense to let it sit there with formatting that obscures
> the structure of the code.
>
> On Thu, Oct 20, 2022 at 10:57 AM Eli Zaretskii <eliz@gnu.org> wrote:
>
> > From: Jim Blandy <jblandy@mozilla.com>
> > Date: Thu, 20 Oct 2022 10:23:30 -0700
> >
> > 2022-10-20 Jim Blandy <jimb@red-bean.com>
> >
> > * lisp/emacs-lisp/syntax.el: Fix indentation in `syntax-ppss'.
>
> Thanks, but we don't like pure-whitespace changes. We fix these
> issues when we change code around the places with wrong indentation.
I agree that we should avoid making whitespace-only changes in general.
Jim makes the point that readability counts. He also points out that
this code changes so infrequently that we do not need to be overly
worried about any annoying merge conflicts. I think these are valid
points.
So on balance, I'd be willing to make an exception and take this patch.
If Eli is still not convinced, I think it would be better to close this
bug and move on. I think we can all agree it's not worth spending
energy discussing it further.
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#58665: Indentation in lisp/emacs-lisp/syntax.el is wrong
2023-09-03 10:21 ` Stefan Kangas
@ 2023-09-03 10:39 ` Eli Zaretskii
2023-09-03 10:45 ` Stefan Kangas
0 siblings, 1 reply; 6+ messages in thread
From: Eli Zaretskii @ 2023-09-03 10:39 UTC (permalink / raw)
To: Stefan Kangas; +Cc: jblandy, 58665
> From: Stefan Kangas <stefankangas@gmail.com>
> Date: Sun, 3 Sep 2023 03:21:33 -0700
> Cc: Eli Zaretskii <eliz@gnu.org>, 58665@debbugs.gnu.org
>
> Jim Blandy <jblandy@mozilla.com> writes:
>
> > This code changes almost never. It's been like that since 2016. It
> > doesn't make sense to let it sit there with formatting that obscures
> > the structure of the code.
> >
> > On Thu, Oct 20, 2022 at 10:57 AM Eli Zaretskii <eliz@gnu.org> wrote:
> >
> > > From: Jim Blandy <jblandy@mozilla.com>
> > > Date: Thu, 20 Oct 2022 10:23:30 -0700
> > >
> > > 2022-10-20 Jim Blandy <jimb@red-bean.com>
> > >
> > > * lisp/emacs-lisp/syntax.el: Fix indentation in `syntax-ppss'.
> >
> > Thanks, but we don't like pure-whitespace changes. We fix these
> > issues when we change code around the places with wrong indentation.
>
> I agree that we should avoid making whitespace-only changes in general.
> Jim makes the point that readability counts. He also points out that
> this code changes so infrequently that we do not need to be overly
> worried about any annoying merge conflicts. I think these are valid
> points.
>
> So on balance, I'd be willing to make an exception and take this patch.
> If Eli is still not convinced, I think it would be better to close this
> bug and move on. I think we can all agree it's not worth spending
> energy discussing it further.
If you think this change could be useful, I won't object applying it.
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#58665: Indentation in lisp/emacs-lisp/syntax.el is wrong
2023-09-03 10:39 ` Eli Zaretskii
@ 2023-09-03 10:45 ` Stefan Kangas
0 siblings, 0 replies; 6+ messages in thread
From: Stefan Kangas @ 2023-09-03 10:45 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: 58665-done, jblandy
Version: 30.1
Eli Zaretskii <eliz@gnu.org> writes:
> If you think this change could be useful, I won't object applying it.
Thanks, installed on master as commit 2ed99b6aa97.
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2023-09-03 10:45 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-10-20 17:23 bug#58665: Indentation in lisp/emacs-lisp/syntax.el is wrong Jim Blandy
2022-10-20 17:57 ` Eli Zaretskii
2022-10-20 21:18 ` Jim Blandy
2023-09-03 10:21 ` Stefan Kangas
2023-09-03 10:39 ` Eli Zaretskii
2023-09-03 10:45 ` Stefan Kangas
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).