GNU bug report logs - #76373
31.0.50; Extend autoconf-mode macro support

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 76373 in the body.
You can then email your comments to 76373 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: "Basil L. Contovounesios" <basil <at> contovou.net>
To: bug-gnu-emacs <at> gnu.org
Subject: 31.0.50; Extend autoconf-mode macro support
Date: Mon, 17 Feb 2025 22:05:48 +0100

[Message part 1 (text/plain, inline)]

The attached patch extends autoconf-mode to:

- also fontify AU_, AX_, and gl_ macro calls as keywords;

- also recognise AH_, AS_, AU_, AX_, LT_, and gl_ macro calls as targets
  for beginning-of-defun, but not an opening square bracket in column 0;

- fontify the first argument of AC_DEFINE, AC_DEFINE_UNQUOTED, AC_SUBST,
  and AH_TEMPLATE with font-lock-variable-name-face instead of
  font-lock-function-name-face;

- also fontify the first argument of AH_VERBATIM, AM_CONDITIONAL, and
  AM_MISSING_PROG as a variable;

- fontify the first argument of AC_DEFUN, AC_DEFUN_ONCE, AU_ALIAS,
  AU_DEFUN, and function-like AC_DEFINE as a function;

- support backslashes, variable substitutions, and command substitutions
  with backticks in the first argument of AC_DEFINE_UNQUOTED; and

- fontify changequote only when it stands freely, not when it is part of
  m4_changequote (where either the whole macro name should be fontified,
  or no part of it).

WDYT?

Also, a question: should defun-prompt-regexp really allow for leading
indentation?  In Autoconf scripts of the form:

if ...

  ...
  AC_MSG_...
  ...
  AC_MSG_...
  ...

fi

it means that beginning-of-defun stops at every indented AC_ or AM_
macro call (and with the attached patch, at any macro call with a known
namespace).

Is this a feature (which allows jumping to the Autoconf parts in a sea
of shell code), or does it break from expected beginning-of-defun
semantics?

Thanks,
-- 
Basil

[0001-Improve-autoconf-mode-macro-detection.patch (text/x-diff, attachment)]

[Message part 3 (text/plain, inline)]

In GNU Emacs 31.0.50 (build 1, x86_64-pc-linux-gnu, X toolkit, cairo
 version 1.18.2, Xaw3d scroll bars) of 2025-02-16 built on tais
Repository revision: fc189cb83cf7284344a737e75b3ee56487b1c386
Repository branch: master
Windowing system distributor 'The X.Org Foundation', version 11.0.12101015
System Description: Debian GNU/Linux trixie/sid

Configured using:
 'configure 'CFLAGS=-Og -ggdb3' -C --prefix=/home/blc/.local
 --enable-checking=structs --without-native-compilation
 --with-file-notification --with-x-toolkit=lucid --with-x'

Configured features:
ACL CAIRO DBUS FREETYPE GIF GLIB GMP GNUTLS GPM GSETTINGS HARFBUZZ JPEG
LCMS2 LIBOTF LIBSELINUX LIBSYSTEMD LIBXML2 M17N_FLT MODULES NOTIFY
INOTIFY PDUMPER PNG RSVG SECCOMP SOUND SQLITE3 THREADS TIFF
TOOLKIT_SCROLL_BARS TREE_SITTER WEBP X11 XAW3D XDBE XIM XINERAMA XINPUT2
XPM XRANDR LUCID ZLIB

Important settings:
  value of $LANG: en_IE.UTF-8
  locale-coding-system: utf-8-unix

Major mode: Lisp Interaction

Minor modes in effect:
  tooltip-mode: t
  global-eldoc-mode: t
  eldoc-mode: t
  show-paren-mode: t
  electric-indent-mode: t
  mouse-wheel-mode: t
  tool-bar-mode: t
  menu-bar-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  blink-cursor-mode: t
  minibuffer-regexp-mode: t
  line-number-mode: t
  indent-tabs-mode: t
  transient-mark-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t

Load-path shadows:
None found.

Features:
(shadow sort mail-extr emacsbug message mailcap yank-media puny dired
dired-loaddefs rfc822 mml mml-sec password-cache epa derived epg rfc6068
epg-config gnus-util text-property-search time-date subr-x mm-decode
mm-bodies mm-encode mail-parse rfc2231 mailabbrev gmm-utils mailheader
cl-loaddefs cl-lib sendmail rfc2047 rfc2045 ietf-drums mm-util
mail-prsvr mail-utils rmc iso-transl tooltip cconv eldoc paren electric
uniquify ediff-hook vc-hooks lisp-float-type elisp-mode mwheel
term/x-win x-win term/common-win x-dnd touch-screen tool-bar dnd fontset
image regexp-opt fringe tabulated-list replace newcomment text-mode
lisp-mode prog-mode register page tab-bar menu-bar rfn-eshadow isearch
easymenu timer select scroll-bar mouse jit-lock font-lock syntax
font-core term/tty-colors frame minibuffer nadvice seq simple cl-generic
indonesian philippine cham georgian utf-8-lang misc-lang vietnamese
tibetan thai tai-viet lao korean japanese eucjp-ms cp51932 hebrew greek
romanian slovak czech european ethiopic indian cyrillic chinese
composite emoji-zwj charscript charprop case-table epa-hook
jka-cmpr-hook help abbrev obarray oclosure cl-preloaded button loaddefs
theme-loaddefs faces cus-face macroexp files window text-properties
overlay sha1 md5 base64 format env code-pages mule custom widget keymap
hashtable-print-readable backquote threads dbusbind inotify lcms2
dynamic-setting system-font-setting font-render-setting cairo x-toolkit
xinput2 x multi-tty move-toolbar make-network-process tty-child-frames
emacs)

Memory information:
((conses 16 39874 9371) (symbols 48 5391 0) (strings 32 13472 1563)
 (string-bytes 1 318133) (vectors 16 9452)
 (vector-slots 8 113642 8578) (floats 8 23 3) (intervals 56 268 0)
 (buffers 992 10))

Message #8 received at 76373 <at> debbugs.gnu.org (full text, mbox):

From: Paul Eggert <eggert <at> cs.ucla.edu>
To: "Basil L. Contovounesios" <basil <at> contovou.net>
Cc: Dave Love <fx <at> gnu.org>, 76373 <at> debbugs.gnu.org
Subject: Re: bug#76373: 31.0.50; Extend autoconf-mode macro support
Date: Mon, 17 Feb 2025 17:32:57 -0800

On 2025-02-17 13:05, Basil L. Contovounesios wrote:
> The attached patch extends autoconf-mode

Thanks, I installed it.


> Also, a question: should defun-prompt-regexp really allow for leading
> indentation?  In Autoconf scripts of the form:
> 
> if ...
> 
>    ...
>    AC_MSG_...
>    ...
>    AC_MSG_...
>    ...
> 
> fi
> 
> it means that beginning-of-defun stops at every indented AC_ or AM_
> macro call (and with the attached patch, at any macro call with a known
> namespace).

Conversely, there may be conditional definitions of functions, e.g., 
Gnulib does this:

  AC_DEFUN([gl_ASSERT_NO_GNULIB_TESTS],
  [
    dnl Override gl_MODULE_INDICATOR_FOR_TESTS.
    AC_DEFUN([gl_MODULE_INDICATOR_FOR_TESTS], [])
  ])

Admittedly this sort of thing is rare.

Could we change the search for defuns to be more selective? It's not 
reasonable to think that every AC_.... call is a defun.

Message #11 received at 76373 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Paul Eggert <eggert <at> cs.ucla.edu>
Cc: fx <at> gnu.org, basil <at> contovou.net, 76373 <at> debbugs.gnu.org
Subject: Re: bug#76373: 31.0.50; Extend autoconf-mode macro support
Date: Tue, 18 Feb 2025 14:56:27 +0200

> Cc: Dave Love <fx <at> gnu.org>, 76373 <at> debbugs.gnu.org
> Date: Mon, 17 Feb 2025 17:32:57 -0800
> From: Paul Eggert <eggert <at> cs.ucla.edu>
> 
> On 2025-02-17 13:05, Basil L. Contovounesios wrote:
> > The attached patch extends autoconf-mode
> 
> Thanks, I installed it.

Without the bug-number reference, sigh...

Please never rely blindly on people who submit "git format-patch"
patches to have the bug number in the log message.  They don't always
have that, especially if the patch is the first message that creates
the debbugs bug, because the number is unknown when the patch is
submitted.

Please always eyeball the change before pushing, and if needed, use
"git commit --amend" to edit the commit log message to add the bug
number and fix any other blunders you find there.

TIA

Message #14 received at 76373 <at> debbugs.gnu.org (full text, mbox):

From: "Basil L. Contovounesios" <basil <at> contovou.net>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: Paul Eggert <eggert <at> cs.ucla.edu>, fx <at> gnu.org, 76373 <at> debbugs.gnu.org
Subject: Re: bug#76373: 31.0.50; Extend autoconf-mode macro support
Date: Tue, 18 Feb 2025 20:05:16 +0100

Eli Zaretskii [2025-02-18 14:56 +0200] wrote:

> Please never rely blindly on people who submit "git format-patch"
> patches to have the bug number in the log message.  They don't always
> have that, especially if the patch is the first message that creates
> the debbugs bug, because the number is unknown when the patch is
> submitted.

Right, I also could have waited for the bug# before submitting the
patch.  Didn't expect it to be applied near the speed of light :).

-- 
Basil

Message #17 received at 76373 <at> debbugs.gnu.org (full text, mbox):

From: "Basil L. Contovounesios" <basil <at> contovou.net>
To: Paul Eggert <eggert <at> cs.ucla.edu>
Cc: Dave Love <fx <at> gnu.org>, 76373 <at> debbugs.gnu.org
Subject: Re: bug#76373: 31.0.50; Extend autoconf-mode macro support
Date: Tue, 18 Feb 2025 20:16:40 +0100

[Message part 1 (text/plain, inline)]

Paul Eggert [2025-02-17 17:32 -0800] wrote:
> On 2025-02-17 13:05, Basil L. Contovounesios wrote:
>> The attached patch extends autoconf-mode
> Thanks, I installed it.

Thanks.

>> Also, a question: should defun-prompt-regexp really allow for leading
>> indentation?  In Autoconf scripts of the form:
>> if ...
>>    ...
>>    AC_MSG_...
>>    ...
>>    AC_MSG_...
>>    ...
>> fi
>> it means that beginning-of-defun stops at every indented AC_ or AM_
>> macro call (and with the attached patch, at any macro call with a known
>> namespace).
>
> Conversely, there may be conditional definitions of functions, e.g., Gnulib does
> this:
>
>   AC_DEFUN([gl_ASSERT_NO_GNULIB_TESTS],
>   [
>     dnl Override gl_MODULE_INDICATOR_FOR_TESTS.
>     AC_DEFUN([gl_MODULE_INDICATOR_FOR_TESTS], [])
>   ])

Right, but there seems to be some tension here between 'defun' as a
toplevel definition/form vs any (nested) definition.

> Could we change the search for defuns to be more selective? It's not reasonable
> to think that every AC_.... call is a defun.

Like so?

[defun.diff (text/x-diff, inline)]

diff --git a/lisp/progmodes/autoconf.el b/lisp/progmodes/autoconf.el
index c5b076bfacc..c313aa8d671 100644
--- a/lisp/progmodes/autoconf.el
+++ b/lisp/progmodes/autoconf.el
@@ -54,6 +54,28 @@ autoconf--macro
         "gl") ;; Gnulib.
      ?_ autoconf--symbol))
 
+;; Autoconf macros that define a variable symbol.
+(rx-define autoconf--defvar
+  (| "AC_SUBST"
+     "AH_TEMPLATE"
+     "AH_VERBATIM"
+     "AM_CONDITIONAL"
+     "AM_MISSING_PROG"))
+
+;; Autoconf macros that define a function symbol.
+(rx-define autoconf--defun
+  (| "AC_DEFUN"
+     "AC_DEFUN_ONCE"
+     "AU_ALIAS"
+     "AU_DEFUN"))
+
+;; Autoconf macros that define something.
+(rx-define autoconf--define
+  (| "AC_DEFINE"
+     "AC_DEFINE_UNQUOTED"
+     autoconf--defvar
+     autoconf--defun))
+
 (defconst autoconf-definition-regexp
   ;; Historically this `defconst' defined only group #1.
   ;; For internal Font Lock use, the presence of an optional group #2
@@ -70,15 +92,8 @@ autoconf-definition-regexp
               ;; knowledge of shell syntax, so don't bother for now.
               (| (: plaindef (? (group-n 2 ?\()))
                  (: "_UNQUOTED" argbeg (group-n 1 (+ (not argend))))))
-           (: (| "AC_SUBST"
-                 "AH_TEMPLATE"
-                 "AH_VERBATIM"
-                 "AM_CONDITIONAL"
-                 "AM_MISSING_PROG"
-                 (group-n 2 (| "AC_DEFUN"
-                               "AC_DEFUN_ONCE"
-                               "AU_ALIAS"
-                               "AU_DEFUN")))
+           (: (| autoconf--defvar
+                 (group-n 2 autoconf--defun))
               plaindef))))
   "Matches Autoconf macro calls that define something.
 The thing being defined is captured in the first subexpression group.")
@@ -122,7 +137,7 @@ autoconf-mode
   "Major mode for editing Autoconf configure.ac files."
   (setq-local parens-require-spaces nil) ; for M4 arg lists
   ;; FIXME: Should indented macro calls really count as defuns?
-  (setq-local defun-prompt-regexp (rx bol (* (in "\t ")) autoconf--macro))
+  (setq-local defun-prompt-regexp (rx bol (* (in "\t ")) autoconf--define))
   (setq-local open-paren-in-column-0-is-defun-start nil)
   (setq-local comment-start "dnl ")
   ;; We want to avoid matching "dnl" in other text.

[Message part 3 (text/plain, inline)]

I'm on the fence about whether it's actually better like this.  I now
find it unpredictable just how far C-M-a will travel in search of a
definition, and Imenu already presents an alternative means of jumping
only to definitions.

But I don't feel too strongly and can see the utility either way, so I
defer to others who write more Autoconf than I do.

-- 
Basil

Message #20 received at 76373 <at> debbugs.gnu.org (full text, mbox):

From: Paul Eggert <eggert <at> cs.ucla.edu>
To: "Basil L. Contovounesios" <basil <at> contovou.net>
Cc: Dave Love <fx <at> gnu.org>, 76373 <at> debbugs.gnu.org
Subject: Re: bug#76373: 31.0.50; Extend autoconf-mode macro support
Date: Tue, 18 Feb 2025 16:29:44 -0800

On 2/18/25 11:16, Basil L. Contovounesios wrote:
> I'm on the fence about whether it's actually better like this.

Let's leave it alone, then.

Message #27 received at 76373-done <at> debbugs.gnu.org (full text, mbox):

From: "Basil L. Contovounesios" <basil <at> contovou.net>
To: Paul Eggert <eggert <at> cs.ucla.edu>
Cc: 76373-done <at> debbugs.gnu.org, Dave Love <fx <at> gnu.org>
Subject: Re: bug#76373: 31.0.50; Extend autoconf-mode macro support
Date: Wed, 19 Feb 2025 20:49:26 +0100

close 76373 31.1
quit

Paul Eggert [2025-02-18 16:29 -0800] wrote:
> On 2/18/25 11:16, Basil L. Contovounesios wrote:
>> I'm on the fence about whether it's actually better like this.
> Let's leave it alone, then.

Okay, closing then.
Thanks,
-- 
Basil

Previous Next

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