From: Arne Babenhauserheide <arne_bab@web.de>
To: Andy Wingo <wingo@pobox.com>
Cc: guile-devel@gnu.org
Subject: Re: [PATCH] doc: describe the -e (module) shorthand as on equal footing with (@ ...)
Date: Mon, 05 Dec 2016 00:18:49 +0100 [thread overview]
Message-ID: <87lgvvcmg6.fsf@web.de> (raw)
In-Reply-To: <87oa36g2kw.fsf@web.de>
[-- Attachment #1: Type: text/plain, Size: 4907 bytes --]
Hi,
Is something missing in the patch which is needed to merge it?
Arne Babenhauserheide writes:
> Is this OK?
>
> From 4751b9c4c85152281f0d57eda6a1c4ce50166ad4 Mon Sep 17 00:00:00 2001
> From: Arne Babenhauserheide <arne_bab@web.de>
> Date: Thu, 29 Sep 2016 17:11:26 +0200
> Subject: [PATCH] describe the -e (module) shorthand as on equal footing with
> (@ ...)
>
> * doc/ref/guile-invoke.texi, doc/ref/scheme-scripts.texi:
> describe the -e (module) shorthand as on equal footing with (@ ...)
> ---
> doc/ref/guile-invoke.texi | 15 +++++------
> doc/ref/scheme-scripts.texi | 62 +++++++++++++++++++++++++++++++++++++++++++++
> 2 files changed, 68 insertions(+), 9 deletions(-)
>
> diff --git a/doc/ref/guile-invoke.texi b/doc/ref/guile-invoke.texi
> index bc33ce0..e25960a 100644
> --- a/doc/ref/guile-invoke.texi
> +++ b/doc/ref/guile-invoke.texi
> @@ -102,15 +102,12 @@ that is defined in the script. It can also be of the form @code{(@@
> @var{module-name} @var{symbol})}, and in that case, the symbol is
> looked up in the module named @var{module-name}.
>
> -For compatibility with some versions of Guile 1.4, you can also use the
> -form @code{(symbol ...)} (that is, a list of only symbols that doesn't
> -start with @code{@@}), which is equivalent to @code{(@@ (symbol ...)
> -main)}, or @code{(symbol ...) symbol} (that is, a list of only symbols
> -followed by a symbol), which is equivalent to @code{(@@ (symbol ...)
> -symbol)}. We recommend to use the equivalent forms directly since they
> -correspond to the @code{(@@ ...)} read syntax that can be used in
> -normal code. See @ref{Using Guile Modules} and @ref{Scripting
> -Examples}.
> +As a shorthand you can use the form @code{(symbol ...)}, that is, a
> +list of only symbols that doesn't start with @code{@@}. It is
> +equivalent to @code{(@@ @var{module-name} main)} with @code{(symbol ...)}
> +the @var{module-name}. To use a different function than @var{main},
> +you can use the form @code{(symbol ...) function}. See @ref{Using
> +Guile Modules} and @ref{Scripting Examples}.
>
> @item -ds
> Treat a final @option{-s} option as if it occurred at this point in the
> diff --git a/doc/ref/scheme-scripts.texi b/doc/ref/scheme-scripts.texi
> index 7552dba..4999a47 100644
> --- a/doc/ref/scheme-scripts.texi
> +++ b/doc/ref/scheme-scripts.texi
> @@ -293,6 +293,11 @@ and exit.
> Load the file @file{/u/jimb/ex4}, and then call the function
> @code{main}, passing it the list @code{("/u/jimb/ex4" "foo")}.
>
> +@item guile -e '(ex4)' -s /u/jimb/ex4.scm foo
> +Load the file @file{/u/jimb/ex4.scm}, and then call the function
> +@code{main} from the module '(ex4)', passing it the list
> +@code{("/u/jimb/ex4" "foo")}.
> +
> @item guile -l first -ds -l last -s script
> Load the files @file{first}, @file{script}, and @file{last}, in that
> order. The @code{-ds} switch says when to process the @code{-s}
> @@ -402,6 +407,63 @@ $ ./choose 50 100
> 100891344545564193334812497256
> @end example
>
> +To execute the function main from a module, we can use the special form
> +@code{(@@ (module) function)}:
> +@example
> +#!/usr/local/bin/guile \
> +-l fact -e (@@ (fac) main) -s
> +!#
> +(define-module (fac)
> + #:export (main))
> +
> +(define (choose n m)
> + (/ (fact m) (* (fact (- m n)) (fact n))))
> +
> +(define (main args)
> + (let ((n (string->number (cadr args)))
> + (m (string->number (caddr args))))
> + (display (choose n m))
> + (newline)))
> +@end example
> +
> +We can use @code{@@@@} to run non-exported functions. For exported
> +functions, we can simplify this call with the shorthand @code{(module)}:
> +@example
> +#!/usr/local/bin/guile \
> +-l fact -e (fac) -s
> +!#
> +(define-module (fac)
> + #:export (main))
> +
> +(define (choose n m)
> + (/ (fact m) (* (fact (- m n)) (fact n))))
> +
> +(define (main args)
> + (let ((n (string->number (cadr args)))
> + (m (string->number (caddr args))))
> + (display (choose n m))
> + (newline)))
> +@end example
> +
> +For maximum portability among *nixes, we can use the shell to
> +@code{exec} guile with specified command line arguments. Here we need to
> +take care to quote the command arguments correctly:
> +@example
> +#!/usr/bin env sh
> +exec guile -l fact -e '(@@ (fac) main)' -s "$0" "$@"
> +!#
> +(define-module (fac)
> + #:export (main))
> +
> +(define (choose n m)
> + (/ (fact m) (* (fact (- m n)) (fact n))))
> +
> +(define (main args)
> + (let ((n (string->number (cadr args)))
> + (m (string->number (caddr args))))
> + (display (choose n m))
> + (newline)))
> +@end example
>
> @c Local Variables:
> @c TeX-master: "guile.texi"
> --
> 2.7.3
Best wishes,
Arne
--
Unpolitisch sein
heißt politisch sein
ohne es zu merken
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 800 bytes --]
next prev parent reply other threads:[~2016-12-04 23:18 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-05-18 20:25 [PATCH] doc: describe the -e (module) shorthand as on equal footing with (@ ...) arne_bab
2016-06-26 21:21 ` Arne Babenhauserheide
2016-06-27 8:08 ` Andy Wingo
2016-07-06 21:14 ` Arne Babenhauserheide
2016-07-07 10:19 ` Andy Wingo
2016-09-29 15:14 ` Arne Babenhauserheide
2016-12-04 23:18 ` Arne Babenhauserheide [this message]
2017-02-07 14:16 ` Arne Babenhauserheide
2017-02-13 21:03 ` Ludovic Courtès
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/guile/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87lgvvcmg6.fsf@web.de \
--to=arne_bab@web.de \
--cc=guile-devel@gnu.org \
--cc=wingo@pobox.com \
/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.
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).