GNU bug report logs - #65824
Indent after open delimiters in verb constructs

Previous Next

Package: auctex;

Reported by: Arash Esbati <arash <at> gnu.org>

Date: Fri, 8 Sep 2023 15:46:02 UTC

Severity: normal

Done: Arash Esbati <arash <at> gnu.org>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Arash Esbati <arash <at> gnu.org>
Subject: bug#65824: closed (Re: bug#65824: Indent after open delimiters in
 verb constructs)
Date: Fri, 15 Sep 2023 08:19:02 +0000
[Message part 1 (text/plain, inline)]
Your bug report

#65824: Indent after open delimiters in verb constructs

which was filed against the auctex package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to 65824 <at> debbugs.gnu.org.

-- 
65824: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=65824
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
From: Arash Esbati <arash <at> gnu.org>
To: Ikumi Keita <ikumi <at> ikumi.que.jp>
Cc: 65824-done <at> debbugs.gnu.org
Subject: Re: bug#65824: Indent after open delimiters in verb constructs
Date: Fri, 15 Sep 2023 10:17:43 +0200
Hi Keita,

Ikumi Keita <ikumi <at> ikumi.que.jp> writes:

> Hmm, it really matters, I think there are two actions that we can take:
> 1. Remove `save-match-data' from `LaTeX-verbatim-p' and announce the
>    removal in changes.texi. Grepping over the current source briefly,
>    the only usage of (La)TeX-verbatim-p that needs to preserve the match
>    data is `LaTeX-search-forward-comment-start'. So wrapping it with
>    `save-match-data' in that function is easy. (In addition,
>    `LaTeX-search-forward-comment-start' is only used as a value of
>    `TeX-search-forward-comment-start-function', which is only used in
>    `TeX-search-forward-comment-start', which isn't used at all now.)
> 2. Implement LaTeX mode function for `indent-region'. Now AUCTeX has
>    "line-by-line" indent function only, but there are apparent overheads
>    when AUCTeX indents a region. We could implement region-oriented
>    indent function which works with less overheads.

Thanks for your response.  I pushed that change (a228137f66).  I'd say
let's wait and see if users complain about any performance regressions,
we can then implement one of your suggestions above.

For now, I'm closing this report.

Best, Arash

[Message part 3 (message/rfc822, inline)]
From: Arash Esbati <arash <at> gnu.org>
To: auctex-bugs <bug-auctex <at> gnu.org>
Subject: Indent after open delimiters in verb constructs
Date: Fri, 08 Sep 2023 17:44:26 +0200
Hi all,

please consider this small file:

--8<---------------cut here---------------start------------->8---
\documentclass{article}

\begin{document}

\verb|foo{bar|
foo
bar
baz
\end{document}
--8<---------------cut here---------------end--------------->8---

Now do 'M-x mark-whole-buffer RET M-x indent-region RET' and you get:

--8<---------------cut here---------------start------------->8---
\documentclass{article}

\begin{document}

\verb|foo{bar|
  foo
  bar
  baz
\end{document}
--8<---------------cut here---------------end--------------->8---

I think the issue is within `TeX-brace-count-line' which doesn't look
for opening/closing delimiters in verbatim text.  My simple minded
solution looks like this:

--8<---------------cut here---------------start------------->8---
diff --git a/tex.el b/tex.el
index a85b8ef9..30118384 100644
--- a/tex.el
+++ b/tex.el
@@ -5485,21 +5485,22 @@ additional characters."
                                           '(?\{ ?\} ?\\))
                                     (TeX-in-comment))))
                  (forward-char)
-                 (cond ((memq char (append
-                                    TeX-indent-open-delimiters
-                                    '(?\{)))
-                        (setq count (+ count TeX-brace-indent-level)))
-                       ((memq char (append
-                                    TeX-indent-close-delimiters
-                                    '(?\})))
-                        (setq count (- count TeX-brace-indent-level)))
-                       ((eq char ?\\)
-                        (when (< (point) limit)
-                          ;; ?\\ in verbatim constructs doesn't escape
-                          ;; the next char
-                          (unless (TeX-verbatim-p)
-                            (forward-char))
-                          t))))))
+                 ;; If inside a verbatim construct, just return t and
+                 ;; proceed, otherwise start counting:
+                 (if (TeX-verbatim-p)
+                     t
+                   (cond ((memq char (append
+                                      TeX-indent-open-delimiters
+                                      '(?\{)))
+                          (setq count (+ count TeX-brace-indent-level)))
+                         ((memq char (append
+                                      TeX-indent-close-delimiters
+                                      '(?\})))
+                          (setq count (- count TeX-brace-indent-level)))
+                         ((eq char ?\\)
+                          (when (< (point) limit)
+                            (forward-char)
+                            t)))))))
       count)))

 ;;; Navigation
--8<---------------cut here---------------end--------------->8---

Any better ideas how to do this?  My only concern is that
`LaTeX-verbatim-p' (which is used by `TeX-verbatim-p') uses
`save-match-data' which is known to be expensive.  I don't have any
benchmarks, but there might be performance hit when indenting/filling
large portions of text.

Best, Arash



This bug report was last modified 1 year and 246 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.