man-pages/man3/Load_path.3o.html
2021-03-31 01:06:50 +01:00

184 lines
2.5 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of Load_path</TITLE>
</HEAD><BODY>
<H1>Load_path</H1>
Section: OCaml library (3o)<BR>Updated: 2020-01-30<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
Load_path - Management of include directories.
<A NAME="lbAC">&nbsp;</A>
<H2>Module</H2>
Module Load_path
<A NAME="lbAD">&nbsp;</A>
<H2>Documentation</H2>
<P>
Module
<B>Load_path</B>
<BR>&nbsp;:&nbsp;
<B>sig end</B>
<P>
<P>
Management of include directories.
<P>
This module offers a high level interface to locating files in the
load path, which is constructed from
<B>-I</B>
command line flags and a few
other parameters.
<P>
It makes the assumption that the contents of include directories
doesn't change during the execution of the compiler.
<P>
<P>
<P>
<P>
<P>
<P>
<I>val add_dir </I>
:
<B>string -&gt; unit</B>
<P>
Add a directory to the load path
<P>
<P>
<P>
<I>val remove_dir </I>
:
<B>string -&gt; unit</B>
<P>
Remove a directory from the load path
<P>
<P>
<P>
<I>val reset </I>
:
<B>unit -&gt; unit</B>
<P>
Remove all directories
<P>
<P>
<P>
<I>val init </I>
:
<B>string list -&gt; unit</B>
<P>
<P>
<B>init l</B>
is the same as
<B>reset (); List.iter add_dir (List.rev l)</B>
<P>
<P>
<P>
<P>
<I>val get_paths </I>
:
<B>unit -&gt; string list</B>
<P>
Return the list of directories passed to
<B>add_dir</B>
so far, in
reverse order.
<P>
<P>
<P>
<I>val find </I>
:
<B>string -&gt; string</B>
<P>
Locate a file in the load path. Raise
<B>Not_found</B>
if the file
cannot be found. This function is optimized for the case where the
filename is a basename, i.e. doesn't contain a directory
separator.
<P>
<P>
<P>
<I>val find_uncap </I>
:
<B>string -&gt; string</B>
<P>
Same as
<B>find</B>
, but search also for uncapitalized name, i.e. if
name is Foo.ml, allow /path/Foo.ml and /path/foo.ml to match.
<P>
<P>
<I>module Dir : </I>
<B>sig end</B>
<P>
<P>
<P>
<P>
<P>
<I>val add </I>
:
<B>Dir.t -&gt; unit</B>
<P>
<P>
<P>
<P>
<I>val get </I>
:
<B>unit -&gt; Dir.t list</B>
<P>
Same as
<B>get_paths ()</B>
, except that it returns a
<B>Dir.t list</B>
.
<P>
<P>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
<DT id="2"><A HREF="#lbAC">Module</A><DD>
<DT id="3"><A HREF="#lbAD">Documentation</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:47 GMT, March 31, 2021
</BODY>
</HTML>