File: Load_path.html

package info (click to toggle)
ocaml-doc 4.11-2
  • links: PTS, VCS
  • area: non-free
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 20,580 kB
  • sloc: sh: 37; makefile: 11
file content (130 lines) | stat: -rw-r--r-- 7,249 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<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 rel="previous" href="Lexer.html">
<link rel="next" href="Location.html">
<link rel="Up" 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="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Arg_helper" rel="Chapter" href="Arg_helper.html">
<link title="Ast_helper" rel="Chapter" href="Ast_helper.html">
<link title="Ast_invariants" rel="Chapter" href="Ast_invariants.html">
<link title="Ast_iterator" rel="Chapter" href="Ast_iterator.html">
<link title="Ast_mapper" rel="Chapter" href="Ast_mapper.html">
<link title="Asttypes" rel="Chapter" href="Asttypes.html">
<link title="Attr_helper" rel="Chapter" href="Attr_helper.html">
<link title="Build_path_prefix_map" rel="Chapter" href="Build_path_prefix_map.html">
<link title="Builtin_attributes" rel="Chapter" href="Builtin_attributes.html">
<link title="CamlinternalMenhirLib" rel="Chapter" href="CamlinternalMenhirLib.html">
<link title="Ccomp" rel="Chapter" href="Ccomp.html">
<link title="Clflags" rel="Chapter" href="Clflags.html">
<link title="Compiler_libs" rel="Chapter" href="Compiler_libs.html">
<link title="Config" rel="Chapter" href="Config.html">
<link title="Consistbl" rel="Chapter" href="Consistbl.html">
<link title="Depend" rel="Chapter" href="Depend.html">
<link title="Docstrings" rel="Chapter" href="Docstrings.html">
<link title="Domainstate" rel="Chapter" href="Domainstate.html">
<link title="Identifiable" rel="Chapter" href="Identifiable.html">
<link title="Int_replace_polymorphic_compare" rel="Chapter" href="Int_replace_polymorphic_compare.html">
<link title="Lexer" rel="Chapter" href="Lexer.html">
<link title="Load_path" rel="Chapter" href="Load_path.html">
<link title="Location" rel="Chapter" href="Location.html">
<link title="Longident" rel="Chapter" href="Longident.html">
<link title="Misc" rel="Chapter" href="Misc.html">
<link title="Numbers" rel="Chapter" href="Numbers.html">
<link title="Parse" rel="Chapter" href="Parse.html">
<link title="Parser" rel="Chapter" href="Parser.html">
<link title="Parsetree" rel="Chapter" href="Parsetree.html">
<link title="Pparse" rel="Chapter" href="Pparse.html">
<link title="Pprintast" rel="Chapter" href="Pprintast.html">
<link title="Printast" rel="Chapter" href="Printast.html">
<link title="Profile" rel="Chapter" href="Profile.html">
<link title="Strongly_connected_components" rel="Chapter" href="Strongly_connected_components.html">
<link title="Syntaxerr" rel="Chapter" href="Syntaxerr.html">
<link title="Targetint" rel="Chapter" href="Targetint.html">
<link title="Terminfo" rel="Chapter" href="Terminfo.html">
<link title="Warnings" rel="Chapter" href="Warnings.html"><title>Load_path</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Lexer.html" title="Lexer">Previous</a>
&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;<a class="post" href="Location.html" title="Location">Next</a>
</div>
<h1>Module <a href="type_Load_path.html">Load_path</a></h1>

<pre><span id="MODULELoad_path"><span class="keyword">module</span> Load_path</span>: <code class="code"><span class="keyword">sig</span></code> <a href="Load_path.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
<div class="info-desc">
<p>Management of include directories.</p>

<p>This module offers a high level interface to locating files in the
    load path, which is constructed from <code class="code">-<span class="constructor">I</span></code> command line flags and a few
    other parameters.</p>

<p>It makes the assumption that the contents of include directories
    doesn't change during the execution of the compiler.</p>
</div>
</div>
<hr width="100%">

<pre><span id="VALadd_dir"><span class="keyword">val</span> add_dir</span> : <code class="type">string -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Add a directory to the load path</p>
</div>
</div>

<pre><span id="VALremove_dir"><span class="keyword">val</span> remove_dir</span> : <code class="type">string -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Remove a directory from the load path</p>
</div>
</div>

<pre><span id="VALreset"><span class="keyword">val</span> reset</span> : <code class="type">unit -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Remove all directories</p>
</div>
</div>

<pre><span id="VALinit"><span class="keyword">val</span> init</span> : <code class="type">string list -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">init&nbsp;l</code> is the same as <code class="code">reset&nbsp;();&nbsp;<span class="constructor">List</span>.iter&nbsp;add_dir&nbsp;(<span class="constructor">List</span>.rev&nbsp;l)</code></p>
</div>
</div>

<pre><span id="VALget_paths"><span class="keyword">val</span> get_paths</span> : <code class="type">unit -> string list</code></pre><div class="info ">
<div class="info-desc">
<p>Return the list of directories passed to <code class="code">add_dir</code> so far, in
    reverse order.</p>
</div>
</div>

<pre><span id="VALfind"><span class="keyword">val</span> find</span> : <code class="type">string -> string</code></pre><div class="info ">
<div class="info-desc">
<p>Locate a file in the load path. Raise <code class="code"><span class="constructor">Not_found</span></code> 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>
</div>
</div>

<pre><span id="VALfind_uncap"><span class="keyword">val</span> find_uncap</span> : <code class="type">string -> string</code></pre><div class="info ">
<div class="info-desc">
<p>Same as <code class="code">find</code>, but search also for uncapitalized name, i.e.  if
    name is Foo.ml, allow /path/Foo.ml and /path/foo.ml to match.</p>
</div>
</div>

<pre><span id="MODULEDir"><span class="keyword">module</span> <a href="Load_path.Dir.html">Dir</a></span>: <code class="code"><span class="keyword">sig</span></code> <a href="Load_path.Dir.html">..</a> <code class="code"><span class="keyword">end</span></code></pre>
<pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type"><a href="Load_path.Dir.html#TYPEt">Dir.t</a> -> unit</code></pre>
<pre><span id="VALget"><span class="keyword">val</span> get</span> : <code class="type">unit -> <a href="Load_path.Dir.html#TYPEt">Dir.t</a> list</code></pre><div class="info ">
<div class="info-desc">
<p>Same as <code class="code">get_paths&nbsp;()</code>, except that it returns a <code class="code"><span class="constructor">Dir</span>.t&nbsp;list</code>.</p>
</div>
</div>
</body></html>