GNU bug report logs - #33170
27.0.50; interactive spec with cl-defgeneric/method

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 33170 in the body.
You can then email your comments to 33170 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: Alex Branham <alex.branham <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 27.0.50; interactive spec with cl-defgeneric/method
Date: Fri, 26 Oct 2018 17:19:44 -0500

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

I'm struggling to understand how to make functions defined with
cl-defgeneric interactive:

(require 'cl-lib)

(cl-defgeneric my/test ()
  (interactive)
  (message "generic"))

If you evaluate that you can do M-x my/test, as expected. However, as
soon as you evaluate this:

(cl-defgeneric my/test (&context (major-mode emacs-lisp-mode))
  (interactive)
  (message "method"))

M-x my/test no longer works.

Is this a bug or am I misunderstanding how this works?

Thanks,
Alex

[signature.asc (application/pgp-signature, inline)]

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Alex Branham <alex.branham <at> gmail.com>
Cc: 33170 <at> debbugs.gnu.org
Subject: Re: bug#33170: 27.0.50; interactive spec with cl-defgeneric/method
Date: Sat, 27 Oct 2018 09:54:04 +0300

> From: Alex Branham <alex.branham <at> gmail.com>
> Date: Fri, 26 Oct 2018 17:19:44 -0500
> 
> I'm struggling to understand how to make functions defined with
> cl-defgeneric interactive:
> 
> (require 'cl-lib)
> 
> (cl-defgeneric my/test ()
>   (interactive)
>   (message "generic"))
> 
> If you evaluate that you can do M-x my/test, as expected. However, as
> soon as you evaluate this:
> 
> (cl-defgeneric my/test (&context (major-mode emacs-lisp-mode))
>   (interactive)
>   (message "method"))
> 
> M-x my/test no longer works.

'&context' is documented only as part of cl-defmethod, so why are you
trying to use it with cl-defgeneric?

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

From: Alex Branham <alex.branham <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 33170 <at> debbugs.gnu.org
Subject: Re: bug#33170: 27.0.50; interactive spec with cl-defgeneric/method
Date: Sat, 27 Oct 2018 07:40:11 -0500

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

On Sat 27 Oct 2018 at 01:54, Eli Zaretskii <eliz <at> gnu.org> wrote:

>> From: Alex Branham <alex.branham <at> gmail.com>
>> Date: Fri, 26 Oct 2018 17:19:44 -0500
>> 
>> I'm struggling to understand how to make functions defined with
>> cl-defgeneric interactive:
>> 
>> (require 'cl-lib)
>> 
>> (cl-defgeneric my/test ()
>>   (interactive)
>>   (message "generic"))
>> 
>> If you evaluate that you can do M-x my/test, as expected. However, as
>> soon as you evaluate this:
>> 
>> (cl-defgeneric my/test (&context (major-mode emacs-lisp-mode))
>>   (interactive)
>>   (message "method"))
>> 
>> M-x my/test no longer works.
>
> '&context' is documented only as part of cl-defmethod, so why are you
> trying to use it with cl-defgeneric?

Sorry, that was a typo. The same thing happens if you use defmethod:

(require 'cl-lib)

(cl-defgeneric my/test ()
  (interactive)
  (message "generic"))

here, M-x my/test works

(cl-defmethod my/test (&context (major-mode emacs-lisp-mode))
  (interactive)
  (message "method"))

Here, M-x my/test does not work.

[signature.asc (application/pgp-signature, inline)]

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Alex Branham <alex.branham <at> gmail.com>
Cc: 33170 <at> debbugs.gnu.org
Subject: Re: bug#33170: 27.0.50; interactive spec with cl-defgeneric/method
Date: Sat, 27 Oct 2018 17:47:11 +0300

> From: Alex Branham <alex.branham <at> gmail.com>
> Cc: 33170 <at> debbugs.gnu.org
> Date: Sat, 27 Oct 2018 07:40:11 -0500
> 
> (require 'cl-lib)
> 
> (cl-defgeneric my/test ()
>   (interactive)
>   (message "generic"))
> 
> here, M-x my/test works
> 
> (cl-defmethod my/test (&context (major-mode emacs-lisp-mode))
>   (interactive)
>   (message "method"))
> 
> Here, M-x my/test does not work.

But "M-: (my/test) RET" does.

I don't think generic functions can be interactive.  At least it is
not documented anywhere that they can be.

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

From: Alex Branham <alex.branham <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 33170 <at> debbugs.gnu.org
Subject: Re: bug#33170: 27.0.50; interactive spec with cl-defgeneric/method
Date: Sat, 27 Oct 2018 09:50:26 -0500

On Sat 27 Oct 2018 at 09:47, Eli Zaretskii <eliz <at> gnu.org> wrote:

>> (require 'cl-lib)
>>
>> (cl-defgeneric my/test ()
>>   (interactive)
>>   (message "generic"))
>>
>> here, M-x my/test works
>>
>> (cl-defmethod my/test (&context (major-mode emacs-lisp-mode))
>>   (interactive)
>>   (message "method"))
>>
>> Here, M-x my/test does not work.
>
> But "M-: (my/test) RET" does.

Right. I'd like them to be interactive though so I can e.g. use them
from a keymap.

> I don't think generic functions can be interactive.  At least it is
> not documented anywhere that they can be.

Ah, that's unfortunate. Perhaps this limitation should be documented
somewhere?

Thanks,
Alex

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Alex Branham <alex.branham <at> gmail.com>,
 Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 33170 <at> debbugs.gnu.org
Subject: Re: bug#33170: 27.0.50; interactive spec with cl-defgeneric/method
Date: Sat, 27 Oct 2018 19:11:42 +0300

> From: Alex Branham <alex.branham <at> gmail.com>
> Cc: 33170 <at> debbugs.gnu.org
> Date: Sat, 27 Oct 2018 09:50:26 -0500
> 
> >> Here, M-x my/test does not work.
> >
> > But "M-: (my/test) RET" does.
> 
> Right. I'd like them to be interactive though so I can e.g. use them
> from a keymap.

You could have a single command that invoked my/test, I think that
would do what you want.

> > I don't think generic functions can be interactive.  At least it is
> > not documented anywhere that they can be.
> 
> Ah, that's unfortunate. Perhaps this limitation should be documented
> somewhere?

If Stefan (CC'ed) says it's a limitation and not a bug, I will
document it.

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

From: Alex Branham <alex.branham <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 33170 <at> debbugs.gnu.org, Stefan Monnier <monnier <at> iro.umontreal.ca>
Subject: Re: bug#33170: 27.0.50; interactive spec with cl-defgeneric/method
Date: Sat, 27 Oct 2018 11:14:41 -0500

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

On Sat 27 Oct 2018 at 11:11, Eli Zaretskii <eliz <at> gnu.org> wrote:

> You could have a single command that invoked my/test, I think that
> would do what you want.

Ah, good idea. That does work, thanks!

Alex

[signature.asc (application/pgp-signature, inline)]

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

From: Stefan Monnier <monnier <at> IRO.UMontreal.CA>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 33170 <at> debbugs.gnu.org, Alex Branham <alex.branham <at> gmail.com>
Subject: Re: bug#33170: 27.0.50; interactive spec with cl-defgeneric/method
Date: Sat, 27 Oct 2018 17:49:13 -0400

>> > I don't think generic functions can be interactive.  At least it is
>> > not documented anywhere that they can be.
>> Ah, that's unfortunate. Perhaps this limitation should be documented
>> somewhere?
> If Stefan (CC'ed) says it's a limitation and not a bug, I will
> document it.

AFAIC it's a limitation.  We could support interactive specs, but I'm
really not convinced it's worth the trouble.  If using 2 functions (one
generic and one interactive, which calls the generic one) is really
annoying for some reason, I guess you could use

    (put '<GENERIC> 'interactive-form <FORM>)

but I think this property should be deprecated, so don't tell anyone
(especially don't tell me) that I even mentioned it to you,


        Stefan

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

From: Alex Branham <alex.branham <at> gmail.com>
To: Stefan Monnier <monnier <at> IRO.UMontreal.CA>
Cc: 33170 <at> debbugs.gnu.org, Eli Zaretskii <eliz <at> gnu.org>
Subject: Re: bug#33170: 27.0.50; interactive spec with cl-defgeneric/method
Date: Mon, 29 Oct 2018 09:18:53 -0500

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

On Sat 27 Oct 2018 at 16:49, Stefan Monnier <monnier <at> IRO.UMontreal.CA> wrote:

> AFAIC it's a limitation.  We could support interactive specs, but I'm
> really not convinced it's worth the trouble.  If using 2 functions (one
> generic and one interactive, which calls the generic one) is really
> annoying for some reason, I guess you could use
>
>     (put '<GENERIC> 'interactive-form <FORM>)
>
> but I think this property should be deprecated, so don't tell anyone
> (especially don't tell me) that I even mentioned it to you,

Thanks for the response. Seems like the two-function solution is the way
to go I guess. I do think this should be documented as a limitation
somewhere though. Perhaps a note at the end of that section in the
manual along the lines:

Note that a current limitation of generic functions is that they may not
be interactive. The recommended way of working around this is to define
an interactive function that simply calls the generic function.

That's not strictly true of course since (cl-defgeneric foo ()
(interactive) (message "foo")) works just fine. It's adding methods that
seems to mess it up.

Alex

[signature.asc (application/pgp-signature, inline)]

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Alex Branham <alex.branham <at> gmail.com>
Cc: 33170-done <at> debbugs.gnu.org, monnier <at> IRO.UMontreal.CA
Subject: Re: bug#33170: 27.0.50; interactive spec with cl-defgeneric/method
Date: Tue, 30 Oct 2018 12:15:37 +0200

> From: Alex Branham <alex.branham <at> gmail.com>
> Cc: Eli Zaretskii <eliz <at> gnu.org>, 33170 <at> debbugs.gnu.org
> Date: Mon, 29 Oct 2018 09:18:53 -0500
> 
> On Sat 27 Oct 2018 at 16:49, Stefan Monnier <monnier <at> IRO.UMontreal.CA> wrote:
> 
> > AFAIC it's a limitation.  We could support interactive specs, but I'm
> > really not convinced it's worth the trouble.  If using 2 functions (one
> > generic and one interactive, which calls the generic one) is really
> > annoying for some reason, I guess you could use
> >
> >     (put '<GENERIC> 'interactive-form <FORM>)
> >
> > but I think this property should be deprecated, so don't tell anyone
> > (especially don't tell me) that I even mentioned it to you,
> 
> Thanks for the response. Seems like the two-function solution is the way
> to go I guess. I do think this should be documented as a limitation
> somewhere though.

Done.

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

From: Stefan Monnier <monnier <at> IRO.UMontreal.CA>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: Alex Branham <alex.branham <at> gmail.com>, 33170-done <at> debbugs.gnu.org
Subject: Re: bug#33170: 27.0.50; interactive spec with cl-defgeneric/method
Date: Tue, 30 Oct 2018 08:48:49 -0400

>> Thanks for the response. Seems like the two-function solution is the way
>> to go I guess. I do think this should be documented as a limitation
>> somewhere though.
> Done.

Should we add a warning for it?


        Stefan


diff --git a/lisp/emacs-lisp/cl-generic.el b/lisp/emacs-lisp/cl-generic.el
index fb4f3ab680..025653de70 100644
--- a/lisp/emacs-lisp/cl-generic.el
+++ b/lisp/emacs-lisp/cl-generic.el
@@ -355,6 +355,9 @@ cl-generic-define-context-rewriter
                                    . ,(lambda () spec-args))
                                  macroexpand-all-environment)))
       (require 'cl-lib)        ;Needed to expand `cl-flet' and `cl-function'.
+      (when (interactive-form (cadr fun))
+        (message "Interactive forms unsupported in generic functions: %S"
+                 (interactive-form (cadr fun))))
       ;; First macroexpand away the cl-function stuff (e.g. &key and
       ;; destructuring args, `declare' and whatnot).
       (pcase (macroexpand fun macroenv)

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Monnier <monnier <at> IRO.UMontreal.CA>
Cc: alex.branham <at> gmail.com, 33170-done <at> debbugs.gnu.org
Subject: Re: bug#33170: 27.0.50; interactive spec with cl-defgeneric/method
Date: Tue, 30 Oct 2018 15:09:39 +0200

> From: Stefan Monnier <monnier <at> IRO.UMontreal.CA>
> Cc: Alex Branham <alex.branham <at> gmail.com>, 33170-done <at> debbugs.gnu.org
> Date: Tue, 30 Oct 2018 08:48:49 -0400
> 
> >> Thanks for the response. Seems like the two-function solution is the way
> >> to go I guess. I do think this should be documented as a limitation
> >> somewhere though.
> > Done.
> 
> Should we add a warning for it?

No objections from me.

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

From: Stefan Monnier <monnier <at> IRO.UMontreal.CA>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: alex.branham <at> gmail.com, 33170-done <at> debbugs.gnu.org
Subject: Re: bug#33170: 27.0.50; interactive spec with cl-defgeneric/method
Date: Wed, 31 Oct 2018 10:49:34 -0400

>> Should we add a warning for it?
> No objections from me.

Done in `master`.


        Stefan

Previous Next

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