summaryrefslogtreecommitdiffstats
path: root/manifest.txi
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2017-02-20 00:05:31 -0800
committerBryan Newbold <bnewbold@robocracy.org>2017-02-20 00:05:31 -0800
commit5145dd3aa0c02c9fc496d1432fc4410674206e1d (patch)
tree540afc30c51da085f5bd8ec3f4c89f6496e7900d /manifest.txi
parent8466d8cfa486fb30d1755c4261b781135083787b (diff)
downloadslib-5145dd3aa0c02c9fc496d1432fc4410674206e1d.tar.gz
slib-5145dd3aa0c02c9fc496d1432fc4410674206e1d.zip
Import Upstream version 3a2upstream/3a2
Diffstat (limited to 'manifest.txi')
-rw-r--r--manifest.txi36
1 files changed, 32 insertions, 4 deletions
diff --git a/manifest.txi b/manifest.txi
index e9fe3ee..daa776d 100644
--- a/manifest.txi
+++ b/manifest.txi
@@ -16,6 +16,7 @@ entries. It would be defined by:
Returns a list of the features @code{require}d by @var{file} assuming the
predicate @var{provided?} and association-list @var{catalog}.
@end defun
+
@example
(define (provided+? . features)
(lambda (feature)
@@ -34,6 +35,7 @@ predicate @var{provided?} and association-list @var{catalog}.
Returns a list of the features @code{require}d by @var{feature} assuming the
predicate @var{provided?} and association-list @var{catalog}.
@end defun
+
@example
(feature->requires 'batch (provided+? 'compiling) *catalog*)
@result{} (tree line-i/o databases parameters string-port
@@ -49,12 +51,27 @@ predicate @var{provided?} and association-list @var{catalog}.
@end example
+@defun feature->requires* feature provided? catalog
+
+Returns a list of the features transitively @code{require}d by @var{feature}
+assuming the predicate @var{provided?} and association-list @var{catalog}.
+@end defun
+
+
+@defun file->requires* file provided? catalog
+
+Returns a list of the features transitively @code{require}d by @var{file}
+assuming the predicate @var{provided?} and association-list @var{catalog}.
+@end defun
+
+
@defun file->loads file
Returns a list of strings naming existing files loaded (load
slib:load slib:load-source macro:load defmacro:load syncase:load
synclo:load macwork:load) by @var{file} or any of the files it loads.
@end defun
+
@example
(file->loads (in-vicinity (library-vicinity) "scainit.scm"))
@result{} ("/usr/local/lib/slib/scaexpp.scm"
@@ -69,17 +86,22 @@ Given a @code{(load '<expr>)}, where <expr> is a string or vicinity
stuff), @code{(load->path <expr>)} figures a path to the file.
@code{load->path} returns that path if it names an existing file; otherwise #f.
@end defun
+
@example
(load->path '(in-vicinity (library-vicinity) "mklibcat"))
@result{} "/usr/local/lib/slib/mklibcat.scm"
@end example
-@defun file->definitions file
+@defun file->definitions file definer @dots{}
Returns a list of the identifier symbols defined by SLIB (or
-SLIB-style) file @var{file}.
+SLIB-style) file @var{file}. The optional arguments @var{definers} should be symbols
+signifying a defining form. If none are supplied, then the symbols
+@code{define-operation}, @code{define}, @code{define-syntax}, and
+@code{defmacro} are captured.
@end defun
+
@example
(file->definitions "random.scm")
@result{} (*random-state* make-random-state
@@ -88,11 +110,15 @@ SLIB-style) file @var{file}.
@end example
-@defun file->exports file
+@defun file->exports file definer @dots{}
Returns a list of the identifier symbols exported (advertised) by
-SLIB (or SLIB-style) file @var{file}.
+SLIB (or SLIB-style) file @var{file}. The optional arguments @var{definers} should be
+symbols signifying a defining form. If none are supplied, then the
+symbols @code{define-operation}, @code{define},
+@code{define-syntax}, and @code{defmacro} are captured.
@end defun
+
@example
(file->exports "random.scm")
@result{} (make-random-state seed->random-state
@@ -112,10 +138,12 @@ implementing @var{feature}, and the identifier symbols exported (advertised) by
SLIB (or SLIB-style) feature @var{feature}, in @var{catalog}.
@end defun
+
@defun feature->exports feature catalog
Returns a list of all exports of @var{feature}.
@end defun
+
@noindent
In the case of @code{aggregate} features, more than one file may
have export lists to report: