aboutsummaryrefslogtreecommitdiffstats
path: root/manifest.txi
blob: daa776d9a8a43488fc95adff42941fce5b5dff82 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
@code{(require 'manifest)}
@ftindex manifest

@noindent
In some of these examples, @var{slib:catalog} is the SLIB part of
the catalog; it is free of compiled and implementation-specific
entries.  It would be defined by:

@example
(define slib:catalog (cdr (member (assq 'null *catalog*) *catalog*)))
@end example


@defun file->requires file provided? catalog

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)
    (or (memq feature features) (provided? feature))))

(file->requires "obj2str.scm" (provided+? 'compiling) '())
        @result{} (string-port generic-write)

(file->requires "obj2str.scm" provided? '())
        @result{} (string-port)
@end example


@defun feature->requires feature provided? 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
                   pretty-print common-list-functions posix-time)

(feature->requires 'batch provided? *catalog*)
        @result{} (tree line-i/o databases parameters string-port
                   pretty-print common-list-functions)

(feature->requires 'batch provided? '((batch . "batch")))
        @result{} (tree line-i/o databases parameters string-port
                   pretty-print common-list-functions)
@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"
            "/usr/local/lib/slib/scaglob.scm"
            "/usr/local/lib/slib/scaoutp.scm")
@end example


@defun load->path exp

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 definer @dots{}

Returns a list of the identifier symbols defined by 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->definitions "random.scm")
        @result{} (*random-state* make-random-state
           seed->random-state copy-random-state random
           random:chunk)
@end example


@defun file->exports file definer @dots{}

Returns a list of the identifier symbols exported (advertised) by
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
            copy-random-state random)

(file->exports "randinex.scm")
        @result{} (random:solid-sphere! random:hollow-sphere!
            random:normal-vector! random:normal
            random:exp random:uniform)
@end example


@defun feature->export-alist feature catalog

Returns a list of lists; each sublist holding the name of the file
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:

@example
(feature->export-alist 'r5rs slib:catalog))
        @result{} (("/usr/local/lib/slib/values.scm"
             call-with-values values)
            ("/usr/local/lib/slib/mbe.scm"
             define-syntax macro:expand
             macro:load macro:eval)
            ("/usr/local/lib/slib/eval.scm"
             eval scheme-report-environment
             null-environment interaction-environment))

(feature->export-alist 'stdio *catalog*)
        @result{} (("/usr/local/lib/slib/scanf.scm"
             fscanf sscanf scanf scanf-read-list)
            ("/usr/local/lib/slib/printf.scm"
             sprintf printf fprintf)
            ("/usr/local/lib/slib/stdio.scm"
             stderr stdout stdin))

(feature->exports 'stdio slib:catalog)
        @result{} (fscanf sscanf scanf scanf-read-list
             sprintf printf fprintf stderr stdout stdin)
@end example