GNU bug report logs - #15909
24.3.50; please fix `read-face-name' brain-dead PROMPT handling

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 15909 in the body.
You can then email your comments to 15909 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: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.3.50; please fix `read-face-name' brain-dead PROMPT handling
Date: Fri, 15 Nov 2013 14:12:31 -0800 (PST)

In Emacs 20, the PROMPT arg was just passed to `completing-read'.  So
you used ": " at the end.  As usual in Emacs.  Simple.  Sure.  No
nonsense.

In Emacs 22, `read-face-name' decided to become "smart": It required
callers NOT to end the PROMPT with a space.  Dumb.

In Emacs 24, `read-face-name' decided to become even "smarter": It
requires callers NOT to end the PROMPT with EITHER a space or a colon.
It systematically adds ": " to PROMPT.  Dumber.

This is silly.  It means that any 3rd-party code that passes a prompt to
`read-face-name' has to fiddle with it to get the desired result for
different Emacs versions.  To what end?  What good is accomplished by
this silliness?

Please add some code similar to the following to `read-face-name', so it
DTRT.

 (when (save-match-data (string-match ": $" prompt))
   (setq prompt  (substring prompt 0 -2)))

Feel free to make this code even smarter - make it accommodate prompts
of all sorts, adding ": " or ":" or " " ONLY AS NEEDED, not
systematically.  After a decade or so of silliness, we should be able to
get this right finally.

If there were no silly history, the right approach would of course be to
have callers include ": " in the PROMPT arg, as usual in Emacs.
`read-face-name' (or some utility function it calls) could massage the
prompt to fiddle with default values or whatever.

It's not too late to make that the new interface.  But we still need to
fix the problem of callers that must work across Emacs versions.

So please update the behavior (and the doc string) to expect PROMPT to
have its own ": ", but still accommodate PROMPTs that do not have it by
adding ": ", ":", or " " as needed.  Yes, this is a mess.  And a
gratuitous one, to boot.


In GNU Emacs 24.3.50.1 (i686-pc-mingw32)
 of 2013-11-12 on LEG570
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --enable-checking 'CFLAGS=-O0 -g3' CPPFLAGS=-DGLYPH_DEBUG=1'

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

From: Drew Adams <drew.adams <at> oracle.com>
To: 15909 <at> debbugs.gnu.org
Subject: RE: bug#15909: 24.3.50; please fix `read-face-name' brain-dead PROMPT
 handling
Date: Fri, 15 Nov 2013 14:49:10 -0800 (PST)

> Please add some code similar to the following to `read-face-name',
> so it DTRT.
>  (when (save-match-data (string-match ": $" prompt))
>    (setq prompt  (substring prompt 0 -2)))

To be clearer about that part.  Below is code I use to counteract
the current `read-face-name' behavior.  Incorporating a reasonable
fix into `read-face-name' would do something akin to the opposite.

(defun my-read-face-name (prompt)
  "Read a face name using completion.  Return its face symbol.
Accommodate vanilla Emacs PROMPT arg across Emacs versions."
  (save-match-data
    (when (and (> emacs-major-version 21)
               (string-match "\\(:\\s *$\\|:?\\s +$\\)" prompt))
      (setq prompt
            (substring prompt 0
                       (- (length (match-string 0 prompt)))))))
  (read-face-name prompt))

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 15909 <at> debbugs.gnu.org
Subject: Re: bug#15909: 24.3.50;
 please fix `read-face-name' brain-dead PROMPT handling
Date: Fri, 07 Feb 2014 19:14:42 -0800

Drew Adams <drew.adams <at> oracle.com> writes:

> In Emacs 20, the PROMPT arg was just passed to `completing-read'.  So
> you used ": " at the end.  As usual in Emacs.  Simple.  Sure.  No
> nonsense.
>
> In Emacs 22, `read-face-name' decided to become "smart": It required
> callers NOT to end the PROMPT with a space.  Dumb.
>
> In Emacs 24, `read-face-name' decided to become even "smarter": It
> requires callers NOT to end the PROMPT with EITHER a space or a colon.
> It systematically adds ": " to PROMPT.  Dumber.
>
> This is silly.  It means that any 3rd-party code that passes a prompt to
> `read-face-name' has to fiddle with it to get the desired result for
> different Emacs versions.  To what end?  What good is accomplished by
> this silliness?

Is there any third-party code that calls that function?

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

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

From: Drew Adams <drew.adams <at> oracle.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 15909 <at> debbugs.gnu.org
Subject: RE: bug#15909: 24.3.50; please fix `read-face-name' brain-dead PROMPT
 handling
Date: Sat, 8 Feb 2014 15:08:58 -0800 (PST)

> Is there any third-party code that calls that function?

Of course.  Why wouldn't there be?  Take a look:

http://lmgtfy.com/?q=%22read-face-name%22+-debbugs+-bug-gnu-emacs

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 15909 <at> debbugs.gnu.org
Subject: Re: bug#15909: 24.3.50;
 please fix `read-face-name' brain-dead PROMPT handling
Date: Fri, 29 Apr 2016 16:42:14 +0200

Drew Adams <drew.adams <at> oracle.com> writes:

> In Emacs 20, the PROMPT arg was just passed to `completing-read'.  So
> you used ": " at the end.  As usual in Emacs.  Simple.  Sure.  No
> nonsense.
>
> In Emacs 22, `read-face-name' decided to become "smart": It required
> callers NOT to end the PROMPT with a space.  Dumb.
>
> In Emacs 24, `read-face-name' decided to become even "smarter": It
> requires callers NOT to end the PROMPT with EITHER a space or a colon.
> It systematically adds ": " to PROMPT.  Dumber.
>
> This is silly.  It means that any 3rd-party code that passes a prompt to
> `read-face-name' has to fiddle with it to get the desired result for
> different Emacs versions.  To what end?  What good is accomplished by
> this silliness?

I've now pushed a fix for this to the trunk.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

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