bug#67204: 29.1; request: always echo EMOJI name while emoji-list

bug#67204: 29.1; request: always echo EMOJI name while emoji-list

[awrhygty]

#'emoji-list creates '*Emoji*' buffer containing EMOJIs.
Typing 'h' shows a name of a EMOJI under the current point.
If the names are always echoed, selection may be easier.

I tried the form below in the '*Emoji*' buffer:
  (add-hook #'post-command-hook
            (lambda ()
              (when-let ((glyph (get-text-property (point) 'emoji-glyph))
                         (name (emoji--name glyph)))
                (message "%s" name)))
            nil 'local)
But it is not successfull when moving to/from composed character EMOJI.


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

Configured using:
 'configure --with-modules --without-dbus --with-native-compilation=aot
 --without-compress-install --with-tree-sitter CFLAGS=-O2'

Configured features:
ACL GIF GMP GNUTLS HARFBUZZ JPEG JSON 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: JPN
  locale-coding-system: cp932

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
  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:
(help-fns radix-tree cl-print debug backtrace find-func gnutls
network-stream nsm mailalias smtpmail textsec uni-scripts url url-proxy
url-privacy url-expand url-methods url-history url-cookie
generate-lisp-file url-domsuf url-util url-parse auth-source cl-seq
eieio eieio-core cl-macs json map byte-opt gv bytecomp byte-compile
url-vars idna-mapping ucs-normalize uni-confusable textsec-check
jka-compr qp misearch multi-isearch help-mode pp 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
term/bobcat japan-util rmc iso-transl tooltip cconv eldoc paren electric
uniquify ediff-hook vc-hooks lisp-float-type elisp-mode mwheel 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 make-network-process native-compile emacs)

Memory information:
((conses 16 225947 32909)
 (symbols 48 8366 9)
 (strings 32 38253 2543)
 (string-bytes 1 870992)
 (vectors 16 46404)
 (vector-slots 8 1526724 109516)
 (floats 8 54 289)
 (intervals 56 1335 60)
 (buffers 984 16))

bug#67204: 29.1; request: always echo EMOJI name while emoji-list

[Daniel Martín via Bug reports for GNU Emacs, the Swiss army knife of text editors]

awrhygty@outlook.com writes:

> #'emoji-list creates '*Emoji*' buffer containing EMOJIs.
> Typing 'h' shows a name of a EMOJI under the current point.
> If the names are always echoed, selection may be easier.
>
> I tried the form below in the '*Emoji*' buffer:
>   (add-hook #'post-command-hook
>             (lambda ()
>               (when-let ((glyph (get-text-property (point) 'emoji-glyph))
>                          (name (emoji--name glyph)))
>                 (message "%s" name)))
>             nil 'local)
> But it is not successfull when moving to/from composed character EMOJI.
>

This is because Emacs automatically moves the point when it’s in the
middle of text with the ’composition’ property.  See (elisp) Adjusting
Point in the Elisp Info manual for more information about this feature.

It seems that post-command-hook is invoked _before_ the point is moved,
so querying the position of point inside post-command-hook does not
always give correct results.  You could add your code to the
pre-redisplay-function instead.

About what you propose, I think that showing the name of the Emoji under
point may be a good new feature of emoji-list.  What do others think?

bug#67204: 29.1; request: always echo EMOJI name while emoji-list

[Eli Zaretskii]

> Cc: 67204@debbugs.gnu.org
> Date: Mon, 25 Dec 2023 19:59:49 +0100
> From:  Daniel Martín via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> 
> awrhygty@outlook.com writes:
> 
> > #'emoji-list creates '*Emoji*' buffer containing EMOJIs.
> > Typing 'h' shows a name of a EMOJI under the current point.
> > If the names are always echoed, selection may be easier.
> >
> > I tried the form below in the '*Emoji*' buffer:
> >   (add-hook #'post-command-hook
> >             (lambda ()
> >               (when-let ((glyph (get-text-property (point) 'emoji-glyph))
> >                          (name (emoji--name glyph)))
> >                 (message "%s" name)))
> >             nil 'local)
> > But it is not successfull when moving to/from composed character EMOJI.
> >
> 
> This is because Emacs automatically moves the point when it’s in the
> middle of text with the ’composition’ property.  See (elisp) Adjusting
> Point in the Elisp Info manual for more information about this feature.
> 
> It seems that post-command-hook is invoked _before_ the point is moved,
> so querying the position of point inside post-command-hook does not
> always give correct results.  You could add your code to the
> pre-redisplay-function instead.

Would temporarily disabling point adjustment help here?

bug#67204: 29.1; request: always echo EMOJI name while emoji-list

[Daniel Martín via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Eli Zaretskii <eliz@gnu.org> writes:

>> 
>> This is because Emacs automatically moves the point when it’s in the
>> middle of text with the ’composition’ property.  See (elisp) Adjusting
>> Point in the Elisp Info manual for more information about this feature.
>> 
>> It seems that post-command-hook is invoked _before_ the point is moved,
>> so querying the position of point inside post-command-hook does not
>> always give correct results.  You could add your code to the
>> pre-redisplay-function instead.
>
> Would temporarily disabling point adjustment help here?

Not really.  I think point adjustment is really needed in the emoji-list
buffer; otherwise, sometimes you’d need to press C-f multiple times to
go from one emoji to the next one, when compositions are involved.

Here’s a complete recipe to understand the issue better:

emacs -Q

Eval the following code:

(add-hook #'post-command-hook
          (lambda ()
            (message "Column: %d" (current-column)))
          nil)

M-x column-number-mode
M-x emoji-list
C-s people > activity
C-n
C-n
C-f

The mode-line shows point is at line 115 and column 9, but the echo area
shows "Column: 8".

However, if you click on the emoji at column 9, then the echo area
correctly shows "Column: 9".

bug#67204: 29.1; request: always echo EMOJI name while emoji-list

[Eli Zaretskii]

> From: Daniel Martín <mardani29@yahoo.es>
> Cc: awrhygty@outlook.com,  67204@debbugs.gnu.org
> Date: Mon, 25 Dec 2023 21:52:42 +0100
> 
> Eli Zaretskii <eliz@gnu.org> writes:
> 
> >> 
> >> This is because Emacs automatically moves the point when it’s in the
> >> middle of text with the ’composition’ property.  See (elisp) Adjusting
> >> Point in the Elisp Info manual for more information about this feature.
> >> 
> >> It seems that post-command-hook is invoked _before_ the point is moved,
> >> so querying the position of point inside post-command-hook does not
> >> always give correct results.  You could add your code to the
> >> pre-redisplay-function instead.
> >
> > Would temporarily disabling point adjustment help here?
> 
> Not really.  I think point adjustment is really needed in the emoji-list
> buffer; otherwise, sometimes you’d need to press C-f multiple times to
> go from one emoji to the next one, when compositions are involved.
> 
> Here’s a complete recipe to understand the issue better:
> 
> emacs -Q
> 
> Eval the following code:
> 
> (add-hook #'post-command-hook
>           (lambda ()
>             (message "Column: %d" (current-column)))
>           nil)
> 
> M-x column-number-mode
> M-x emoji-list
> C-s people > activity
> C-n
> C-n
> C-f
> 
> The mode-line shows point is at line 115 and column 9, but the echo area
> shows "Column: 8".
> 
> However, if you click on the emoji at column 9, then the echo area
> correctly shows "Column: 9".

Yes, I know how point adjustment works.  What I meant is to set
global-disable-point-adjustment non-nil in the *Emoji* buffer.

However, now that I tried the original recipe in
https://debbugs.gnu.org/cgi/bugreport.cgi?bug=67204#5, I don't think I
see the OP's problem.  With that post-command hook, I see the emoji
name shown in the echo-area for all the emoji I tried.  I probably
didn't try with those which caused problems to the OP, so I'm asking:
what are those "composed character EMOJI" which DON'T show their name
with that post-command hook?  I'd like to reproduce the problem before
I see if we have a ready solution for it.

Btw, each emoji in that buffer has also a help-echo string with the
name, so moving the mouse there is another way of showing the name.

Also, an alternative for post-command-hook is a point-entered text
property.

bug#67204: 29.1; request: always echo EMOJI name while emoji-list

[Daniel Martín via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Eli Zaretskii <eliz@gnu.org> writes:

>
> However, now that I tried the original recipe in
> https://debbugs.gnu.org/cgi/bugreport.cgi?bug=67204#5, I don't think I
> see the OP's problem.  With that post-command hook, I see the emoji
> name shown in the echo-area for all the emoji I tried.  I probably
> didn't try with those which caused problems to the OP, so I'm asking:
> what are those "composed character EMOJI" which DON'T show their name
> with that post-command hook?  I'd like to reproduce the problem before
> I see if we have a ready solution for it.
>

M-<
C-s People > activity

If I move the point over that section of emojis one by one with C-f, I
get:

person getting massage
person getting haircut
person walking
person walking facing right
person walking facing right (this is wrong, it should be "person standing").

bug#67204: 29.1; request: always echo EMOJI name while emoji-list

[Eli Zaretskii]

> From: Daniel Martín <mardani29@yahoo.es>
> Cc: 67204@debbugs.gnu.org,  awrhygty@outlook.com
> Date: Fri, 29 Dec 2023 16:12:24 +0100
> 
> Eli Zaretskii <eliz@gnu.org> writes:
> 
> >
> > However, now that I tried the original recipe in
> > https://debbugs.gnu.org/cgi/bugreport.cgi?bug=67204#5, I don't think I
> > see the OP's problem.  With that post-command hook, I see the emoji
> > name shown in the echo-area for all the emoji I tried.  I probably
> > didn't try with those which caused problems to the OP, so I'm asking:
> > what are those "composed character EMOJI" which DON'T show their name
> > with that post-command hook?  I'd like to reproduce the problem before
> > I see if we have a ready solution for it.
> >
> 
> M-<
> C-s People > activity
> 
> If I move the point over that section of emojis one by one with C-f, I
> get:
> 
> person getting massage
> person getting haircut
> person walking
> person walking facing right
> person walking facing right (this is wrong, it should be "person standing").

I cannot reproduce this.  I get:

  person getting massage
  person getting haircut
  person walking
  person running
  people with bunny ears
  woman dancing

So I guess the emoji I see are different from what you see.  However,
since the OP is on MS-Windows, I'd expect him to see what I see, not
what you see.

bug#67204: 29.1; request: always echo EMOJI name while emoji-list

[Eli Zaretskii]

> Cc: 67204@debbugs.gnu.org, awrhygty@outlook.com
> Date: Fri, 29 Dec 2023 17:38:59 +0200
> From: Eli Zaretskii <eliz@gnu.org>
> 
> I cannot reproduce this.  I get:
> 
>   person getting massage
>   person getting haircut
>   person walking
>   person running
>   people with bunny ears
>   woman dancing

Sorry, this was in Emacs 29.  In Emacs 20 I indeed see what you see.
(But the OP used Emacs 29.1.)  Will investigate.

bug#67204: 29.1; request: always echo EMOJI name while emoji-list

[Daniel Martín via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Eli Zaretskii <eliz@gnu.org> writes:

>> 
>> M-<
>> C-s People > activity
>> 
>> If I move the point over that section of emojis one by one with C-f, I
>> get:
>> 
>> person getting massage
>> person getting haircut
>> person walking
>> person walking facing right
>> person walking facing right (this is wrong, it should be "person standing").
>
> I cannot reproduce this.  I get:
>
>   person getting massage
>   person getting haircut
>   person walking
>   person running
>   people with bunny ears
>   woman dancing
>
> So I guess the emoji I see are different from what you see.  However,
> since the OP is on MS-Windows, I'd expect him to see what I see, not
> what you see.

The list is different, it seems.  I can reproduce the problem if I move
the point to the emoji that is next to this one:

             position: 988 of 4826 (20%), column: 6
            character: 🚶 (displayed as 🚶) (codepoint 128694, #o373266, #x1f6b6)
              charset: unicode (Unicode (ISO10646))
code point in charset: 0x1F6B6
               script: emoji
               syntax: w 	which means: word
             category: .:Base
             to input: type "C-x 8 RET 1f6b6" or "C-x 8 RET PEDESTRIAN"
          buffer code: #xF0 #x9F #x9A #xB6
            file code: #xF0 #x9F #x9A #xB6 (encoded by coding system utf-8-unix)
              display: composed to form "🚶‍➡️" (see below)
     composition name: person walking facing right

Composed with the following character(s) "‍➡️" using this font:
  mac-ct:-*-Apple Color Emoji-regular-normal-normal-*-24-*-*-*-p-0-iso10646-1
by these glyphs:
  [0 3 128694 2323 25 -1 25 22 3 nil]
  [0 3 10145 319 25 -1 25 22 3 nil]
with these character(s):
  ‍ (#x200d) ZERO WIDTH JOINER
  ➡ (#x27a1) BLACK RIGHTWARDS ARROW
  ️ (#xfe0f) VARIATION SELECTOR-16

Character code properties: customize what to show
  name: PEDESTRIAN
  general-category: So (Symbol, Other)
  decomposition: (128694) ('🚶')

There are text properties here:
  emoji-glyph          "🚶‍➡️"
  face                 emoji-with-derivations
  help-echo            "person walking facing right"

You can also try other composed emojis, like those under 'Flags >
country-flag'.  The first flag shows "flag: Ascension Island".  If I
C-b, I see "flag: Ascension Island", which is incorrect.  If I press "h"
(or move the mouse cursor over the second flag), I see "flag: Andorra",
which is the correct result.

bug#67204: 29.1; request: always echo EMOJI name while emoji-list

[Eli Zaretskii]

> Cc: 67204@debbugs.gnu.org, awrhygty@outlook.com
> Date: Fri, 29 Dec 2023 17:44:15 +0200
> From: Eli Zaretskii <eliz@gnu.org>
> 
> > Cc: 67204@debbugs.gnu.org, awrhygty@outlook.com
> > Date: Fri, 29 Dec 2023 17:38:59 +0200
> > From: Eli Zaretskii <eliz@gnu.org>
> > 
> > I cannot reproduce this.  I get:
> > 
> >   person getting massage
> >   person getting haircut
> >   person walking
> >   person running
> >   people with bunny ears
> >   woman dancing
> 
> Sorry, this was in Emacs 29.  In Emacs 20 I indeed see what you see.
> (But the OP used Emacs 29.1.)  Will investigate.

OK, I see the issue now: it's because C-f/C-b still moves by one
character in this buffer, and we basically rely on point-adjustment to
move to the next emoji.  The cases where the echo is incorrect, point
after C-f is still on the same emoji, not on the next one, whereas
after point adjustment it is on the next emoji.

The solution to that is not to show the emoji name from the
post-command-hook, but from an idle timer.  Like this:

  (add-hook #'post-command-hook
	    (lambda ()
	      (run-with-idle-timer 0.02 nil
				   (lambda ()
				     (when-let
					 ((glyph (get-text-property (point)
								    'emoji-glyph))
					  (name (emoji--name glyph)))
				       (message "%s" name)))))
	    nil 'local)

We could have this as an optional feature, or we could leave this
alone and rely on users who want this to customize their Emacs like
above.

bug#67204: 29.1; request: always echo EMOJI name while emoji-list

[Eli Zaretskii]

> Cc: 67204@debbugs.gnu.org, awrhygty@outlook.com
> Date: Sat, 30 Dec 2023 11:20:59 +0200
> From: Eli Zaretskii <eliz@gnu.org>
> 
> OK, I see the issue now: it's because C-f/C-b still moves by one
> character in this buffer, and we basically rely on point-adjustment to
> move to the next emoji.  The cases where the echo is incorrect, point
> after C-f is still on the same emoji, not on the next one, whereas
> after point adjustment it is on the next emoji.
> 
> The solution to that is not to show the emoji name from the
> post-command-hook, but from an idle timer.  Like this:
> 
>   (add-hook #'post-command-hook
> 	    (lambda ()
> 	      (run-with-idle-timer 0.02 nil
> 				   (lambda ()
> 				     (when-let
> 					 ((glyph (get-text-property (point)
> 								    'emoji-glyph))
> 					  (name (emoji--name glyph)))
> 				       (message "%s" name)))))
> 	    nil 'local)
> 
> We could have this as an optional feature, or we could leave this
> alone and rely on users who want this to customize their Emacs like
> above.

No further comments, so I'm now closing this bug.