From: Eric Abrahamsen <eric@ericabrahamsen.net>
To: Noam Postavsky <npostavs@users.sourceforge.net>
Cc: 25294@debbugs.gnu.org
Subject: bug#25294: 26.0.50; Allow more catch-all values for cl-defmethod's &context plus major-mode specializer
Date: Mon, 11 Dec 2017 21:42:43 -0800 [thread overview]
Message-ID: <87d13kqz70.fsf@ericabrahamsen.net> (raw)
In-Reply-To: <87efo0encf.fsf@users.sourceforge.net> (Noam Postavsky's message of "Mon, 11 Dec 2017 20:39:28 -0500")
[-- Attachment #1: Type: text/plain, Size: 933 bytes --]
Noam Postavsky <npostavs@users.sourceforge.net> writes:
> [forwarding to list]
Whoops, sorry.
[...]
>> A year later, older and wiser, I agree that maybe all that's needed is
>> more documentation. I just noticed that, at some point in the interim,
>> the documentation for generic functions has been greatly expanded, which
>> is nice!
>>
>> I'd like to add the following to the docs:
>>
>> 1. The &context thing has to come after the required arguments, but
>> before any &optional or &rest things.
>> 2. You can have an arbitrary number of forms following &context.
>> 3. The &context arguments don't have to match the declared arguments in
>> `cl-defgeneric'.
>> 4. Ergo they can be left off altogether without needing to be
>> specifically declared as nil or what have you, ie, my original bug
>> report isn't really a bug.
>>
>> If this looks okay, I'll have at the docs.
> Sounds good to me.
Here's my diff.
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: context-spec-docs.diff --]
[-- Type: text/x-patch, Size: 1910 bytes --]
diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi
index 466a12f7a4..6b98a3d639 100644
--- a/doc/lispref/functions.texi
+++ b/doc/lispref/functions.texi
@@ -1252,15 +1252,21 @@ Generic Functions
Extensions for GNU Emacs Lisp}), or of one of its parent classes.
@end table
-Alternatively, the argument specializer can be of the form
-@code{&context (@var{expr} @var{spec})}, in which case the value of
-@var{expr} must be compatible with the specializer provided by
-@var{spec}; @var{spec} can be any of the forms described above. In
-other words, this form of specializer uses the value of @var{expr}
-instead of arguments for the decision whether the method is
-applicable. For example, @code{&context (overwrite-mode (eql t))}
-will make the method compatible only when @code{overwrite-mode} is
-turned on.
+Generic functions provide a new argument-list keyword,
+@code{&context}, which can be used to introduce extra specializers
+that test the general environment in which the method is run. This
+keyword should appear after the list of required arguments, but before
+any @code{&rest} or @code{&optional} keywords. The @code{&context}
+specializers look much like regular argument
+specializers---(@var{expr} @var{spec})---except that @var{expr} is an
+expression to be evaluated in the current context, and the @var{spec}
+is a value to compare against. For example, @code{&context
+(overwrite-mode (eql t))} will make the method applicable only when
+@code{overwrite-mode} is turned on. The @code{&context} keyword can
+be followed by any number of context specializers. Because the
+context specializers are not part of the generic function's required
+argument signature, they may be omitted in methods that don't require
+them.
The type specializer, @code{(@var{arg} @var{type})}, can specify one
of the @dfn{system types} in the following list. When a parent type
next prev parent reply other threads:[~2017-12-12 5:42 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-12-29 19:13 bug#25294: 26.0.50; Allow more catch-all values for cl-defmethod's &context plus major-mode specializer Eric Abrahamsen
2016-12-30 4:35 ` npostavs
2017-12-11 23:57 ` Eric Abrahamsen
2017-12-12 0:08 ` Noam Postavsky
2017-12-12 1:39 ` Noam Postavsky
2017-12-12 1:43 ` Noam Postavsky
2017-12-12 5:42 ` Eric Abrahamsen [this message]
2017-12-12 23:58 ` Noam Postavsky
2017-12-14 0:06 ` Eric Abrahamsen
2017-12-14 21:01 ` Eric Abrahamsen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87d13kqz70.fsf@ericabrahamsen.net \
--to=eric@ericabrahamsen.net \
--cc=25294@debbugs.gnu.org \
--cc=npostavs@users.sourceforge.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.