From unknown Sat Sep 20 11:02:46 2025
X-Loop: help-debbugs@gnu.org
Subject: bug#79476: 30.1; False negative in electric-pair-inhibit-if-helps-balance
Resent-From: Paul Du Bois <dubois@valvesoftware.com>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces@debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@gnu.org
Resent-Date: Sat, 20 Sep 2025 06:21:03 +0000
Resent-Message-ID: <handler.79476.B.175834923516946@debbugs.gnu.org>
Resent-Sender: help-debbugs@gnu.org
X-GNU-PR-Message: report 79476
X-GNU-PR-Package: emacs
X-GNU-PR-Keywords: 
To: 79476@debbugs.gnu.org
X-Debbugs-Original-To: "'bug-gnu-emacs@gnu.org'" <bug-gnu-emacs@gnu.org>
Received: via spool by submit@debbugs.gnu.org id=B.175834923516946
          (code B ref -1); Sat, 20 Sep 2025 06:21:03 +0000
Received: (at submit) by debbugs.gnu.org; 20 Sep 2025 06:20:35 +0000
Received: from localhost ([127.0.0.1]:43559 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces@debbugs.gnu.org>)
	id 1uzqxU-0004PB-JS
	for submit@debbugs.gnu.org; Sat, 20 Sep 2025 02:20:34 -0400
Received: from lists.gnu.org ([2001:470:142::17]:47696)
 by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.84_2) (envelope-from <dubois@valvesoftware.com>)
 id 1uzjZJ-0001Pl-Lv
 for submit@debbugs.gnu.org; Fri, 19 Sep 2025 18:27:10 -0400
Received: from eggs.gnu.org ([2001:470:142:3::10])
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <dubois@valvesoftware.com>)
 id 1uzjZC-0003AO-Tq
 for bug-gnu-emacs@gnu.org; Fri, 19 Sep 2025 18:26:58 -0400
Received: from us-smtp-delivery-172.mimecast.com ([170.10.129.172])
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <dubois@valvesoftware.com>)
 id 1uzjZ9-0007rc-07
 for bug-gnu-emacs@gnu.org; Fri, 19 Sep 2025 18:26:58 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=valvesoftware.com;
 s=mc20150811; t=1758320809;
 h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
 to:to:cc:mime-version:mime-version:content-type:content-type:
 content-transfer-encoding:content-transfer-encoding;
 bh=gm2v4hgTF5slamICEPrVoK7yADsyGAkcSvDDCch3c58=;
 b=cY/fbx/l5PDfG/KZ6Xb9Rv0oarKHcT0eZyxd9GIAkxXQ5G5UfGRwXtG/FaKDQFrIALT+Tu
 xhbdm7yuixrxl29eVre8dKYRgf2yUBwxDRDi1OkM6HTxThqlu8pkAQn3arweBu+TPLtata
 e4KfBEbU2h0iiIPyNwP4+T1U/JtdLXg=
Received: from smtp-01-tuk3.valvesoftware.com
 (smtp-01-tuk3.valvesoftware.com [208.64.203.181]) by relay.mimecast.com
 with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384)
 id us-mta-283-VyAbxKs4OdeDddIMj8ZX-w-1; Fri, 19 Sep 2025 18:26:46 -0400
X-MC-Unique: VyAbxKs4OdeDddIMj8ZX-w-1
X-Mimecast-MFC-AGG-ID: VyAbxKs4OdeDddIMj8ZX-w_1758320805
Received: from antispam.valve.org ([172.16.1.107])
 by smtp-01-tuk3.valvesoftware.com with esmtp (Exim 4.97)
 (envelope-from <dubois@valvesoftware.com>) id 1uzjYz-0000000G07c-23b1
 for bug-gnu-emacs@gnu.org; Fri, 19 Sep 2025 15:26:45 -0700
Received: from antispam.valve.org (127.0.0.1) id hpncaa0171s8 for
 <bug-gnu-emacs@gnu.org>;
 Fri, 19 Sep 2025 15:26:45 -0700 (envelope-from <dubois@valvesoftware.com>)
Received: from mail2.valvemail.org ([172.16.144.23])
 by antispam.valve.org ([172.16.1.107]) (SonicWall 10.0.15.7233)
 with ESMTP id o202509192226450032357-5; Fri, 19 Sep 2025 15:26:45 -0700
Received: from mail2.valvemail.org (172.16.144.23) by mail2.valvemail.org
 (172.16.144.23) with Microsoft SMTP Server (version=TLS1_2,
 cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1748.10; Fri, 19 Sep
 2025 15:26:45 -0700
Received: from mail2.valvemail.org ([::1]) by mail2.valvemail.org ([::1]) with
 mapi id 15.02.1748.010; Fri, 19 Sep 2025 15:26:45 -0700
From: Paul Du Bois <dubois@valvesoftware.com>
Thread-Topic: 30.1; False negative in electric-pair-inhibit-if-helps-balance
Thread-Index: AdwptBBJcJnYbRprSdShOKEll6t4qA==
Date: Fri, 19 Sep 2025 22:26:44 +0000
Message-ID: <7bcb92bd0a904755b8e1ea2e7f1e120d@valvesoftware.com>
Accept-Language: en-US
X-MS-Has-Attach: 
X-MS-TNEF-Correlator: 
x-originating-ip: [172.27.17.14]
MIME-Version: 1.0
X-Mlf-DSE-Version: 6871
X-Mlf-Rules-Version: s20250917042539; ds20230628172248;
 di20250919181858; ri20160318003319; fs20250919180131
X-Mlf-Smartnet-Version: 20210917223710
X-Mlf-Envelope-From: dubois@valvesoftware.com
X-Mlf-Version: 10.0.15.7233
X-Mlf-License: BSV_C_AP_T_R
X-Mlf-UniqueId: o202509192226450032357
X-Mimecast-Spam-Score: 0
X-Mimecast-MFC-PROC-ID: TQ_EZ9jmLzCuPBFOsvm8JCQbQNItuHNE9U9eDudeBfw_1758320805
X-Mimecast-Originator: valvesoftware.com
Content-Language: en-US
Content-Type: text/plain; charset=WINDOWS-1252
Content-Transfer-Encoding: quoted-printable
Received-SPF: pass client-ip=170.10.129.172;
 envelope-from=dubois@valvesoftware.com; helo=us-smtp-delivery-172.mimecast.com
X-Spam_score_int: -20
X-Spam_score: -2.1
X-Spam_bar: --
X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
 DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,
 RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001,
 RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, SPF_HELO_PASS=-0.001,
 SPF_PASS=-0.001 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-Spam-Score: 0.9 (/)
X-Mailman-Approved-At: Sat, 20 Sep 2025 02:20:30 -0400
X-BeenThere: debbugs-submit@debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request@debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit@debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request@debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request@debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces@debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces@debbugs.gnu.org>
X-Spam-Score: -0.1 (/)

Reproduction steps:

$ cat > test.py <<EOF

a =3D "'"
EOF
$ emacs -Q
C-x C-f test.py
M-x electric-pair-mode

In the following, I'll use | to indicate point.
The current line will be empty
Hit ". The current line will look like "|"
Hit ". The current line will look like ""|
This shows that electric-pair-skip-if-helps-balance is working as expected.

Hit RETURN
Hit C-q ". The current line will look like "|
Hit ". The current line will look like ""|"
Expected: the current line looks like ""|

Diagnosis:

The logic for skip-if-helps and inhibit-if-helps is subtly different.
Both remove the character that the user just typed, and then examine the
parse state.  However:

`skip-if-helps` checks the parse state at `(point)` -- is it inside a
string of the same type as the user's quote char?

`inhibit-if-helps` checks the parse-state at `(point-max)` (modulo any
customizations to electric-pair-string-bound-function).  However, at
`(point-max)` the user's un-terminated quote could have caused all kinds
of havoc.  In the example above, the `a =3D "'"` makes EOB look like it's i=
n a
`'`-string, rather than a `"`-string.  This causes the false-negative.

Other examples of situations that confuse `inhibit-if-helps`:

```
"|
# a =3D "'"
```
ppss at EOB still looks like a '-string, because the # is ignored

```
"|
""" " """
```
ppss at EOB looks like it's not in a string


Patch:

A minimal patch is to change inhibit-if-helps to use the same logic as
skip-if-helps:

--- elec-pair.el
+++ elec-pair.el
@@ -467,7 +467,7 @@
                          (t
                           (eq (cdr outermost) pair)))))
                 ((eq syntax ?\")
-                 (electric-pair--inside-string-p char)))))))))
+                 (electric-pair--unbalanced-strings-p char)))))))))
=20
 (defun electric-pair-skip-if-helps-balance (char)
   "Return non-nil if skipping CHAR would benefit parentheses' balance.


This would make electric-pair--unbalanced-strings-p entirely unused, so
it could be deleted along with the variable
electric-pair-string-bound-function (which is un-customized by any major
mode in emacs)


Another way is to change the logic of unbalanced-strings-p to check the
parse state at (point) rather than (point-max), by customizing
electric-pair-string-bound-function.


In GNU Emacs 30.1 (build 2, x86_64-w64-mingw32) of 2025-02-23 built on
 AVALON
Windowing system distributor 'Microsoft Corp.', version 10.0.19045
System Description: Microsoft Windows 10 Pro (v10.0.2009.19045.6332)

Configured using:
 'configure --with-modules --without-dbus --with-native-compilation=3Daot
 --without-compress-install --with-tree-sitter CFLAGS=3D-O2
 prefix=3D/g/rel/install/emacs-30.1'

Configured features:
ACL GIF GMP GNUTLS HARFBUZZ JPEG LCMS2 LIBXML2 MODULES NATIVE_COMP
NOTIFY W32NOTIFY PDUMPER PNG RSVG SOUND SQLITE3 THREADS TIFF
TOOLKIT_SCROLL_BARS TREE_SITTER WEBP XPM ZLIB

(NATIVE_COMP present but libgccjit not available)

Important settings:
  value of $LANG: ENU
  locale-coding-system: cp1252

Major mode: Python

Minor modes in effect:
  electric-pair-mode: t
  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
  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 mm-decode mm-bodies
mm-encode mail-parse rfc2231 mailabbrev gmm-utils mailheader sendmail
rfc2047 rfc2045 ietf-drums mm-util mail-prsvr mail-utils cl-seq python
rx project byte-opt gv bytecomp byte-compile compat pcase treesit comint
subr-x ansi-osc ring cl-loaddefs cl-lib ansi-color cus-start cus-load
elec-pair rmc iso-transl tooltip cconv eldoc paren electric uniquify
ediff-hook vc-hooks lisp-float-type elisp-mode mwheel touch-screen
dos-w32 ls-lisp disp-table term/w32-win w32-win w32-vars term/common-win
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
w32notify w32 lcms2 multi-tty move-toolbar make-network-process
native-compile emacs)

Memory information:
((conses 16 86360 11467) (symbols 48 8548 0) (strings 32 23964 1208)
 (string-bytes 1 729777) (vectors 16 13151)
 (vector-slots 8 176946 7166) (floats 8 34 6) (intervals 56 275 0)
 (buffers 992 11))