From: Arthur Miller <arthur.miller@live.com>
To: emacs-devel@gnu.org
Subject: Docs for &optional and &rest arguments together
Date: Tue, 29 Dec 2020 14:26:32 +0100 [thread overview]
Message-ID: <AM0PR06MB657709C899365FC0710F505496D80@AM0PR06MB6577.eurprd06.prod.outlook.com> (raw)
I like 'with-*' idiom in Lisp, and I have written a smal macro for
myself to work with files, based on with-temp-file macro.
The Manual says I can have both optional and rest arguments togheter,
which we can:
(required-vars…
[&optional [optional-vars…]]
[&rest [rest-var]])
But when I use it, I still have to pass a nil for the "optional"
argument, which I think is also not so strange either, otherwise how
will Emacs now where "optional" argument list ends and where "rest"
argument list starts? No?
When I read the manual:
"A call to the function requires one actual argument for each of the
required-vars. There may be actual arguments for zero or more of the
optional-vars, and there cannot be any actual arguments beyond that
unless the lambda list uses &rest. In that case, there may be any number
of extra actual arguments.
If actual arguments for the optional and rest variables are omitted,
then they always default to nil."
https://www.gnu.org/software/emacs/manual/html_node/elisp/Argument-List.html
I get the impression that I actually can omit the optional argument(s)
even when followed by the &rest keyword. It is probably only the case
when optional arguments *are not* followed by the &rest keyword. I don't
see that captured by the documentation, at least not very clearly.
After the experience with add-to-list I am not offering any patches for
the docs. I am just pointing it out how I perceive it. If I am wrong
about, I would be actually happy to see how to use both &optional and
&rest and not have to specify the "optional" argument when I call the macro.
For the illustration of what I describe above, here is the macro:
(defmacro with-file (file &optional operation &rest body)
(declare (indent 1) (debug t))
`(let ((op ,operation)
(buffer (get-buffer-create ,file)))
(unless op
(setq op 'append))
(unwind-protect
(prog1
(with-current-buffer buffer
(cond ((equal op 'apend)
(goto-char (point-min))
(insert-file-contents ,file)
(goto-char (point-max))
,@body)
((equal op 'prepend)
,@body
(goto-char (point-max))
(insert-file-contents ,file))
(t ;; overwrite file
,@body)))
(with-current-buffer buffer
(write-region nil nil ,file nil 0)))
(and (buffer-name buffer)
(kill-buffer buffer)))))
And when calling, there is no way to omit the "optional" nil:
(with-file "some-test" nil
(insert "hello world"))
(with-file "some-test" 'prepend
(insert "I am before Hello world!")
(newline))
(with-file "some-test" 'apend
(newline)
(insert "I am after Hello world!"))
next reply other threads:[~2020-12-29 13:26 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-29 13:26 Arthur Miller [this message]
2020-12-29 15:10 ` Docs for &optional and &rest arguments together Adam Porter
2020-12-29 17:06 ` arthur miller
2021-01-01 14:33 ` Arthur Miller
2020-12-30 3:12 ` Lars Ingebrigtsen
2020-12-30 12:19 ` Arthur Miller
2020-12-30 12:54 ` Yuri Khan
2020-12-31 4:43 ` Lars Ingebrigtsen
2020-12-31 7:55 ` arthur miller
2020-12-31 11:26 ` tomas
2020-12-31 16:45 ` Drew Adams
2020-12-31 17:04 ` Drew Adams
2020-12-31 17:28 ` arthur miller
2020-12-31 18:19 ` Drew Adams
2020-12-31 20:01 ` arthur miller
2020-12-31 20:27 ` Drew Adams
2020-12-31 17:08 ` arthur miller
2020-12-31 17:30 ` Daniel Brooks
2020-12-31 19:53 ` arthur miller
2020-12-31 19:40 ` tomas
-- strict thread matches above, loose matches on Subject: below --
2020-12-31 20:04 arthur miller
2020-12-31 20:35 ` tomas
2020-12-31 23:18 ` arthur miller
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=AM0PR06MB657709C899365FC0710F505496D80@AM0PR06MB6577.eurprd06.prod.outlook.com \
--to=arthur.miller@live.com \
--cc=emacs-devel@gnu.org \
/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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).