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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
|
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="Start" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Findlib" rel="Chapter" href="Findlib.html">
<link title="Fl_package_base" rel="Chapter" href="Fl_package_base.html">
<link title="Fl_metascanner" rel="Chapter" href="Fl_metascanner.html">
<link title="Fl_dynload" rel="Chapter" href="Fl_dynload.html">
<link title="Topfind" rel="Chapter" href="Topfind.html"><title>The Findlib Library : Index of values</title>
</head>
<body>
<div class="navbar"> <a class="up" href="index.html" title="Index">Up</a>
</div>
<h1>Index of values</h1>
<table>
<tr><td align="left"><div>A</div></td></tr>
<tr><td><a href="Topfind.html#VALadd_predicates">add_predicates</a> [<a href="Topfind.html">Topfind</a>]</td>
<td><div class="info">
<p>Adds predicates to the list of predicates</p>
</div>
</td></tr>
<tr><td><a href="Topfind.html#VALannounce">announce</a> [<a href="Topfind.html">Topfind</a>]</td>
<td><div class="info">
<p>Output the startup message</p>
</div>
</td></tr>
<tr><td align="left"><div>C</div></td></tr>
<tr><td><a href="Findlib.html#VALcommand">command</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>Get the name/path of the executable</p>
</div>
</td></tr>
<tr><td><a href="Findlib.html#VALconfig_file">config_file</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>The location of the configuration file</p>
</div>
</td></tr>
<tr><td align="left"><div>D</div></td></tr>
<tr><td><a href="Findlib.html#VALdefault_location">default_location</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>Get the default installation directory for packages</p>
</div>
</td></tr>
<tr><td><a href="Topfind.html#VALdon't_load">don't_load</a> [<a href="Topfind.html">Topfind</a>]</td>
<td><div class="info">
<p>The packages named in pkglist are added to the list of packages which
are already loaded.</p>
</div>
</td></tr>
<tr><td><a href="Topfind.html#VALdon't_load_deeply">don't_load_deeply</a> [<a href="Topfind.html">Topfind</a>]</td>
<td><div class="info">
<p>The packages named in pkglist and all direct and indirect ancestors
are added to the list of packages which are already loaded.</p>
</div>
</td></tr>
<tr><td align="left"><div>I</div></td></tr>
<tr><td><a href="Findlib.html#VALignore_dups_in">ignore_dups_in</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>If <code class="code">Some d</code>, duplicate packages below <code class="code">d</code> are ignored, and do not
produce warnings.</p>
</div>
</td></tr>
<tr><td><a href="Fl_package_base.html#VALinit">init</a> [<a href="Fl_package_base.html">Fl_package_base</a>]</td>
<td><div class="info">
<p>This function must be called before <code class="code">Fl_package_base</code> can be used.</p>
</div>
</td></tr>
<tr><td><a href="Findlib.html#VALinit">init</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>Initializes the library from the configuration file and the environment.</p>
</div>
</td></tr>
<tr><td><a href="Findlib.html#VALinit_manually">init_manually</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>This is an alternate way to initialize the library directly.</p>
</div>
</td></tr>
<tr><td><a href="Findlib.html#VALis_recorded_package">is_recorded_package</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>Whether there is a recording for this package</p>
</div>
</td></tr>
<tr><td align="left"><div>L</div></td></tr>
<tr><td><a href="Fl_package_base.html#VALlist_packages">list_packages</a> [<a href="Fl_package_base.html">Fl_package_base</a>]</td>
<td><div class="info">
<p>Ensures that the complete package graph is loaded into memory
(like <code class="code">load_base</code>), and returns the (unsorted) list of all
packages.</p>
</div>
</td></tr>
<tr><td><a href="Findlib.html#VALlist_packages">list_packages</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>Prints the list of available packages to the <code class="code">out_channel</code>.</p>
</div>
</td></tr>
<tr><td><a href="Findlib.html#VALlist_packages'">list_packages'</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>Returns the (unsorted) list of all packages.</p>
</div>
</td></tr>
<tr><td><a href="Topfind.html#VALload">load</a> [<a href="Topfind.html">Topfind</a>]</td>
<td><div class="info">
<p>The packages from the passed package list are loaded, from left to
right, but packages that have already been loaded are left out.</p>
</div>
</td></tr>
<tr><td><a href="Fl_package_base.html#VALload_base">load_base</a> [<a href="Fl_package_base.html">Fl_package_base</a>]</td>
<td><div class="info">
<p>Ensures that the complete package graph is loaded into memory.</p>
</div>
</td></tr>
<tr><td><a href="Topfind.html#VALload_deeply">load_deeply</a> [<a href="Topfind.html">Topfind</a>]</td>
<td><div class="info">
<p>The packages from the passed package list and all direct or indirect
ancestors are loaded in topological order.</p>
</div>
</td></tr>
<tr><td><a href="Fl_dynload.html#VALload_packages">load_packages</a> [<a href="Fl_dynload.html">Fl_dynload</a>]</td>
<td><div class="info">
<p>Load the given packages and all their dependencies dynamically.</p>
</div>
</td></tr>
<tr><td><a href="Topfind.html#VALlog">log</a> [<a href="Topfind.html">Topfind</a>]</td>
<td><div class="info">
<p>Function used to log messages from this module.</p>
</div>
</td></tr>
<tr><td><a href="Fl_metascanner.html#VALlookup">lookup</a> [<a href="Fl_metascanner.html">Fl_metascanner</a>]</td>
<td><div class="info">
<p><code class="code">lookup variable_name predicate_list def</code>:</p>
</div>
</td></tr>
<tr><td><a href="Fl_metascanner.html#VALlookup_2">lookup_2</a> [<a href="Fl_metascanner.html">Fl_metascanner</a>]</td>
<td><div class="info">
<p>Like <code class="code">lookup</code>, but also returns the list of predicates that had to
be considered to select the particular variable definition.</p>
</div>
</td></tr>
<tr><td align="left"><div>M</div></td></tr>
<tr><td><a href="Findlib.html#VALmeta_directory">meta_directory</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>Get the META installation directory for packages.</p>
</div>
</td></tr>
<tr><td><a href="Fl_package_base.html#VALmodule_conflict_report">module_conflict_report</a> [<a href="Fl_package_base.html">Fl_package_base</a>]</td>
<td><div class="info">
<p>Checks whether there are cmi files for the same modules.</p>
</div>
</td></tr>
<tr><td align="left"><div>O</div></td></tr>
<tr><td><a href="Findlib.html#VALocaml_ldconf">ocaml_ldconf</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>Get the file name of <code class="code">ld.conf</code></p>
</div>
</td></tr>
<tr><td><a href="Findlib.html#VALocaml_stdlib">ocaml_stdlib</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>Get the directory of the standard library</p>
</div>
</td></tr>
<tr><td align="left"><div>P</div></td></tr>
<tr><td><a href="Findlib.html#VALpackage_ancestors">package_ancestors</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p><code class="code">package_ancestors predlist pkg:</code>
Determines the direct ancestors of package <code class="code">pkg</code> under the assumption
that the predicates in <code class="code">predlist</code> are true, i.e.</p>
</div>
</td></tr>
<tr><td><a href="Fl_package_base.html#VALpackage_conflict_report">package_conflict_report</a> [<a href="Fl_package_base.html">Fl_package_base</a>]</td>
<td><div class="info">
<p>Checks whether there are several META files for the same main
packages.</p>
</div>
</td></tr>
<tr><td><a href="Findlib.html#VALpackage_deep_ancestors">package_deep_ancestors</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p><code class="code">package_deep_ancestors predlist pkglist:</code>
determines the list of direct or indirect ancestors of the packages
named in <code class="code">pkglist</code> under the assumption that the predicates in <code class="code">predlist</code>
are true.</p>
</div>
</td></tr>
<tr><td><a href="Fl_package_base.html#VALpackage_definitions">package_definitions</a> [<a href="Fl_package_base.html">Fl_package_base</a>]</td>
<td><div class="info">
<p>Return all META files defining this package that occur in the
directories mentioned in <code class="code">search_path</code>.</p>
</div>
</td></tr>
<tr><td><a href="Findlib.html#VALpackage_directory">package_directory</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>Get the absolute path of the directory where the given package is
stored.</p>
</div>
</td></tr>
<tr><td><a href="Findlib.html#VALpackage_meta_file">package_meta_file</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>Get the absolute path of the META file of the given package</p>
</div>
</td></tr>
<tr><td><a href="Findlib.html#VALpackage_property">package_property</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p><code class="code">package_property predlist pkg propname</code>:
Looks up the property <code class="code">propname</code> of package <code class="code">pkg</code> under the assumption
that the predicates in <code class="code">predlist</code> are true.</p>
</div>
</td></tr>
<tr><td><a href="Findlib.html#VALpackage_property_2">package_property_2</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p><code class="code">package_property_2 predlist pkg propname</code>: This returns two values
<code class="code">(v, preds)</code>.</p>
</div>
</td></tr>
<tr><td><a href="Fl_package_base.html#VALpackage_users">package_users</a> [<a href="Fl_package_base.html">Fl_package_base</a>]</td>
<td><div class="info">
<p>Ensures that the complete package graph is loaded into memory
(like <code class="code">load_base</code>), and determines the packages using one of
the packages passed as second argument.</p>
</div>
</td></tr>
<tr><td><a href="Fl_package_base.html#VALpackages_in_meta_file">packages_in_meta_file</a> [<a href="Fl_package_base.html">Fl_package_base</a>]</td>
<td><div class="info">
<p>Parses the META file whose name is <code class="code">meta_file</code>.</p>
</div>
</td></tr>
<tr><td><a href="Fl_metascanner.html#VALparse">parse</a> [<a href="Fl_metascanner.html">Fl_metascanner</a>]</td>
<td><div class="info">
<p><code class="code">parse ch:</code>
scans and parses the file connected with channel <code class="code">ch</code>.</p>
</div>
</td></tr>
<tr><td><a href="Fl_metascanner.html#VALparse_lexing">parse_lexing</a> [<a href="Fl_metascanner.html">Fl_metascanner</a>]</td>
<td></td></tr>
<tr><td><a href="Fl_metascanner.html#VALpredicate_exists">predicate_exists</a> [<a href="Fl_metascanner.html">Fl_metascanner</a>]</td>
<td><div class="info">
<p><code class="code">predicate_exists variable_name def</code>:</p>
</div>
</td></tr>
<tr><td><a href="Topfind.html#VALpredicates">predicates</a> [<a href="Topfind.html">Topfind</a>]</td>
<td><div class="info">
<p>The list of predicates used for package loading</p>
</div>
</td></tr>
<tr><td><a href="Fl_metascanner.html#VALprint">print</a> [<a href="Fl_metascanner.html">Fl_metascanner</a>]</td>
<td><div class="info">
<p><code class="code">print ch expr</code>:
Outputs the package expression to a channel.</p>
</div>
</td></tr>
<tr><td><a href="Fl_metascanner.html#VALprint_def">print_def</a> [<a href="Fl_metascanner.html">Fl_metascanner</a>]</td>
<td><div class="info">
<p><code class="code">print_def ch def</code>:
Outputs the definition to a channel.</p>
</div>
</td></tr>
<tr><td align="left"><div>Q</div></td></tr>
<tr><td><a href="Fl_package_base.html#VALquery">query</a> [<a href="Fl_package_base.html">Fl_package_base</a>]</td>
<td><div class="info">
<p>Returns the <code class="code">package</code> definition for the fully-qualified package name,
or raises <code class="code">No_such_package</code>.</p>
</div>
</td></tr>
<tr><td align="left"><div>R</div></td></tr>
<tr><td><a href="Findlib.html#VALrecord_package">record_package</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>Record this package</p>
</div>
</td></tr>
<tr><td><a href="Findlib.html#VALrecord_package_predicates">record_package_predicates</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>Record the predicates to be used for package loading.</p>
</div>
</td></tr>
<tr><td><a href="Findlib.html#VALrecorded_packages">recorded_packages</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>The list of packages recorded with <code class="code">record_package</code></p>
</div>
</td></tr>
<tr><td><a href="Findlib.html#VALrecorded_predicates">recorded_predicates</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>The most recent version of the recorded predicate list</p>
</div>
</td></tr>
<tr><td><a href="Fl_package_base.html#VALrequires">requires</a> [<a href="Fl_package_base.html">Fl_package_base</a>]</td>
<td><div class="info">
<p>Analyzes the direct requirements of the package whose name is passed as
second argument under the assumption that the predicates <code class="code">preds</code>
hold.</p>
</div>
</td></tr>
<tr><td><a href="Fl_package_base.html#VALrequires_deeply">requires_deeply</a> [<a href="Fl_package_base.html">Fl_package_base</a>]</td>
<td><div class="info">
<p>Analyzes the direct or indirect requirements of the packages whose names
are passed as second argument under the assumption that the predicates
<code class="code">preds</code> hold.</p>
</div>
</td></tr>
<tr><td><a href="Topfind.html#VALreset">reset</a> [<a href="Topfind.html">Topfind</a>]</td>
<td><div class="info">
<p>All entries in the list of loaded packages that have been added by
<code class="code">load</code> or <code class="code">load_deeply</code> functions are removed from this list.</p>
</div>
</td></tr>
<tr><td><a href="Findlib.html#VALreset_recordings">reset_recordings</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>Removes all <code class="code">Record_load</code> packages from the list of recordings.</p>
</div>
</td></tr>
<tr><td><a href="Findlib.html#VALresolve_path">resolve_path</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>Resolves findlib notation in filename paths.</p>
</div>
</td></tr>
<tr><td><a href="Topfind.html#VALrevised_syntax">revised_syntax</a> [<a href="Topfind.html">Topfind</a>]</td>
<td><div class="info">
<p>Adds predicates that select the revised syntax.</p>
</div>
</td></tr>
<tr><td align="left"><div>S</div></td></tr>
<tr><td><a href="Findlib.html#VALsearch_path">search_path</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>Get the search path for packages</p>
</div>
</td></tr>
<tr><td><a href="Topfind.html#VALstandard_syntax">standard_syntax</a> [<a href="Topfind.html">Topfind</a>]</td>
<td><div class="info">
<p>Adds predicates that select the standard syntax.</p>
</div>
</td></tr>
<tr><td><a href="Topfind.html#VALsyntax">syntax</a> [<a href="Topfind.html">Topfind</a>]</td>
<td><div class="info">
<p>Emulates the <code class="code">-syntax</code> option</p>
</div>
</td></tr>
<tr><td align="left"><div>T</div></td></tr>
<tr><td><a href="Findlib.html#VALtype_of_recorded_package">type_of_recorded_package</a> [<a href="Findlib.html">Findlib</a>]</td>
<td><div class="info">
<p>Returns the type, or raises <code class="code">Not_found</code></p>
</div>
</td></tr>
</table>
</body>
</html>
|
