What lookup-key returns for an undefined key

What lookup-key returns for an undefined key

[Eli Zaretskii]

In Emacs 21.3, lookup-key returns `undefined' for an undefined key; in
the current CVS it returns nil.

If this change is intentional, I think we should reflect that in NEWS.

Two bundled Lisp packages are affected by this: woman.el and
gnus-util.el.  I've fixed the former, but not the latter.

Re: What lookup-key returns for an undefined key

[Luc Teirlinck]

Eli Zaretskii wrote:

   In Emacs 21.3, lookup-key returns `undefined' for an undefined key; in
   the current CVS it returns nil.

In what concrete way has the behavior of `lookup-key' changed since
21.3?  I could not find any indications of such a change in the
changelogs, nor in actual behavior.  The following produced identical
*ielm* runs in 21.3 and this morning's CVS:

ELISP> (setq kmp (make-sparse-keymap))
(keymap)

ELISP> (define-key kmp "\C-a" 'undefined)
undefined
ELISP> (lookup-key kmp "\C-a")
undefined
ELISP> (lookup-key kmp "\C-b")
nil
ELISP> (lookup-key kmp "\C-a" t)
undefined
ELISP> (lookup-key kmp "\C-b" t)
nil
ELISP> 

Re: What lookup-key returns for an undefined key

[Luc Teirlinck]

Eli Zaretskii wrote"
   
   In Emacs 21.3, lookup-key returns `undefined' for an undefined key; in
   the current CVS it returns nil.

   If this change is intentional, I think we should reflect that in NEWS.

   Two bundled Lisp packages are affected by this: woman.el and
   gnus-util.el.  I've fixed the former, but not the latter.

There are three types of key that are commonly referred to as
"undefined":  keys that are not bound, keys bound to the symbol nil and
keys bound to the command `undefined'.  If nothing else tries to
define the key, the end result is the same, in as far as the user is
concerned.  If something else tries to define the key, there are
subtle differences.  `lookup-key' returns nil for the first two types
and `undefined' for the latter.

`dired-mode-map' used by woman.el has been changed from 21.3 to unbind
several keys that were formerly bound to the command `undefined'.  I
believe that your change to woman.el is correct.  However that code
was _already_ broken in 21.3.  Probably, gnus-util.el needs a similar
change.

Sincerely,

Luc.

Re: What lookup-key returns for an undefined key

[Eli Zaretskii]

> Date: Sat, 15 Jan 2005 11:18:28 -0600 (CST)
> From: Luc Teirlinck <teirllm@dms.auburn.edu>
> Cc: emacs-devel@gnu.org
> 
> `dired-mode-map' used by woman.el has been changed from 21.3 to unbind
> several keys that were formerly bound to the command `undefined'.

It's possible that I only checked with dired-mode-map, so it looked to
me like lookup-key have changed.

In any case, I think that the change to dired-mode-map should be in
NEWS.  There's no way to know what unbundled packages used the
`undefined' thing to bind keys in Dired that were free.

Re: What lookup-key returns for an undefined key

[Luc Teirlinck]

Eli Zaretskii wrote:

   It's possible that I only checked with dired-mode-map, so it looked to
   me like lookup-key have changed.

   In any case, I think that the change to dired-mode-map should be in
   NEWS.  There's no way to know what unbundled packages used the
   `undefined' thing to bind keys in Dired that were free.

Actually, after taking a closer look, I noticed that the change in
dired-mode-map is a consequence of a change in suppress-keymap (as I
already pointed out in a previous message):

   2002-08-26  Kim F. Storm  <storm@cua.dk>

	       * subr.el (suppress-keymap): Use command remapping instead of
	       substitute-key-definition to undefine self-inserting keys.

Sincerely,

Luc.

Re: What lookup-key returns for an undefined key

[Richard Stallman]

    In any case, I think that the change to dired-mode-map should be in
    NEWS.

This is an implementation detail.  In general, programs that depend on
the internal behavior of various parts of Emacs may break when we
change those internals.  I don't want NEWS to describe internal
changes merely because of this; it would distract people from more
important changes by burying them in lots of minor ones.

However, the change in suppress-keymap ought to be in NEWS.

Re: What lookup-key returns for an undefined key

[Luc Teirlinck]

Richard Stallman wrote:

   However, the change in suppress-keymap ought to be in NEWS.

Is the following OK?  Should this count as an "incompatible" change?

+++
** `suppress-keymap' now works by remapping `self-insert-command' to
the command `undefined'.  (In earlier Emacs versions, it used
`substitute-key-definition' to rebind self inserting characters to
`undefined'.)

Sincerely,

Luc.

Re: What lookup-key returns for an undefined key

[Richard Stallman]

    Is the following OK?  Should this count as an "incompatible" change?

It is ok.  I think it should count as incompatible, since the only
reason to mention it in NEWS is that it might break some things.

Re: What lookup-key returns for an undefined key

[Luc Teirlinck]

>From my previous message:

   I believe that your change to woman.el is correct.  However that
   code was _already_ broken in 21.3.

Actually, I do not use woman.el and so I can not be really sure of
those two statements.  The reason why self-inserting characters not
bound by Dired are no longer bound to the command `undefined' in Dired
is that dired-mode-map now remaps `self-insert-command' to
`undefined'.  _If_ the woman.el code was correct for 21.3, that is if
it really _only_ was meant to apply to commands that were explicitly
bound to `undefined' in Dired, then your latest patch might not be
completely accurate.  (In that case it should only apply to non-bound
self-inserting characters.)

The reason for the changed behavior you refer to seems to have nothing
to do with `lookup-key' but with the following:

2002-08-26  Kim F. Storm  <storm@cua.dk>

	    * subr.el (suppress-keymap): Use command remapping instead of
	    substitute-key-definition to undefine self-inserting keys.

Sincerely,

Luc.