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
|
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="Start" href="index.html">
<link rel="previous" href="Event.html">
<link rel="next" href="Format.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" rel="Chapter" href="Arg.html">
<link title="Arith_status" rel="Chapter" href="Arith_status.html">
<link title="Array" rel="Chapter" href="Array.html">
<link title="ArrayLabels" rel="Chapter" href="ArrayLabels.html">
<link title="Big_int" rel="Chapter" href="Big_int.html">
<link title="Bigarray" rel="Chapter" href="Bigarray.html">
<link title="Buffer" rel="Chapter" href="Buffer.html">
<link title="Callback" rel="Chapter" href="Callback.html">
<link title="CamlinternalMod" rel="Chapter" href="CamlinternalMod.html">
<link title="CamlinternalOO" rel="Chapter" href="CamlinternalOO.html">
<link title="Char" rel="Chapter" href="Char.html">
<link title="Complex" rel="Chapter" href="Complex.html">
<link title="Condition" rel="Chapter" href="Condition.html">
<link title="Dbm" rel="Chapter" href="Dbm.html">
<link title="Digest" rel="Chapter" href="Digest.html">
<link title="Dynlink" rel="Chapter" href="Dynlink.html">
<link title="Event" rel="Chapter" href="Event.html">
<link title="Filename" rel="Chapter" href="Filename.html">
<link title="Format" rel="Chapter" href="Format.html">
<link title="Gc" rel="Chapter" href="Gc.html">
<link title="Genlex" rel="Chapter" href="Genlex.html">
<link title="Graphics" rel="Chapter" href="Graphics.html">
<link title="GraphicsX11" rel="Chapter" href="GraphicsX11.html">
<link title="Hashtbl" rel="Chapter" href="Hashtbl.html">
<link title="Int32" rel="Chapter" href="Int32.html">
<link title="Int64" rel="Chapter" href="Int64.html">
<link title="Lazy" rel="Chapter" href="Lazy.html">
<link title="Lexing" rel="Chapter" href="Lexing.html">
<link title="List" rel="Chapter" href="List.html">
<link title="ListLabels" rel="Chapter" href="ListLabels.html">
<link title="Map" rel="Chapter" href="Map.html">
<link title="Marshal" rel="Chapter" href="Marshal.html">
<link title="MoreLabels" rel="Chapter" href="MoreLabels.html">
<link title="Mutex" rel="Chapter" href="Mutex.html">
<link title="Nativeint" rel="Chapter" href="Nativeint.html">
<link title="Num" rel="Chapter" href="Num.html">
<link title="Obj" rel="Chapter" href="Obj.html">
<link title="Oo" rel="Chapter" href="Oo.html">
<link title="Parsing" rel="Chapter" href="Parsing.html">
<link title="Pervasives" rel="Chapter" href="Pervasives.html">
<link title="Printexc" rel="Chapter" href="Printexc.html">
<link title="Printf" rel="Chapter" href="Printf.html">
<link title="Queue" rel="Chapter" href="Queue.html">
<link title="Random" rel="Chapter" href="Random.html">
<link title="Scanf" rel="Chapter" href="Scanf.html">
<link title="Set" rel="Chapter" href="Set.html">
<link title="Sort" rel="Chapter" href="Sort.html">
<link title="Stack" rel="Chapter" href="Stack.html">
<link title="StdLabels" rel="Chapter" href="StdLabels.html">
<link title="Str" rel="Chapter" href="Str.html">
<link title="Stream" rel="Chapter" href="Stream.html">
<link title="String" rel="Chapter" href="String.html">
<link title="StringLabels" rel="Chapter" href="StringLabels.html">
<link title="Sys" rel="Chapter" href="Sys.html">
<link title="Thread" rel="Chapter" href="Thread.html">
<link title="ThreadUnix" rel="Chapter" href="ThreadUnix.html">
<link title="Unix" rel="Chapter" href="Unix.html">
<link title="UnixLabels" rel="Chapter" href="UnixLabels.html">
<link title="Weak" rel="Chapter" href="Weak.html"><title>Filename</title>
</head>
<body>
<div class="navbar"><a href="Event.html">Previous</a>
<a href="index.html">Up</a>
<a href="Format.html">Next</a>
</div>
<center><h1>Module <a href="type_Filename.html">Filename</a></h1></center>
<br>
<pre><span class="keyword">module</span> Filename: <code class="code"><span class="keyword">sig</span></code> <a href="Filename.html">..</a> <code class="code"><span class="keyword">end</span></code></pre>Operations on file names.<br>
<hr width="100%">
<pre><span class="keyword">val</span> <a name="VALcurrent_dir_name"></a>current_dir_name : <code class="type">string</code></pre><div class="info">
The conventional name for the current directory (e.g. <code class="code">.</code> in Unix).<br>
</div>
<pre><span class="keyword">val</span> <a name="VALparent_dir_name"></a>parent_dir_name : <code class="type">string</code></pre><div class="info">
The conventional name for the parent of the current directory
(e.g. <code class="code">..</code> in Unix).<br>
</div>
<pre><span class="keyword">val</span> <a name="VALconcat"></a>concat : <code class="type">string -> string -> string</code></pre><div class="info">
<code class="code">concat dir file</code> returns a file name that designates file
<code class="code">file</code> in directory <code class="code">dir</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALis_relative"></a>is_relative : <code class="type">string -> bool</code></pre><div class="info">
Return <code class="code"><span class="keyword">true</span></code> if the file name is relative to the current
directory, <code class="code"><span class="keyword">false</span></code> if it is absolute (i.e. in Unix, starts
with <code class="code">/</code>).<br>
</div>
<pre><span class="keyword">val</span> <a name="VALis_implicit"></a>is_implicit : <code class="type">string -> bool</code></pre><div class="info">
Return <code class="code"><span class="keyword">true</span></code> if the file name is relative and does not start
with an explicit reference to the current directory (<code class="code">./</code> or
<code class="code">../</code> in Unix), <code class="code"><span class="keyword">false</span></code> if it starts with an explicit reference
to the root directory or the current directory.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcheck_suffix"></a>check_suffix : <code class="type">string -> string -> bool</code></pre><div class="info">
<code class="code">check_suffix name suff</code> returns <code class="code"><span class="keyword">true</span></code> if the filename <code class="code">name</code>
ends with the suffix <code class="code">suff</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALchop_suffix"></a>chop_suffix : <code class="type">string -> string -> string</code></pre><div class="info">
<code class="code">chop_suffix name suff</code> removes the suffix <code class="code">suff</code> from
the filename <code class="code">name</code>. The behavior is undefined if <code class="code">name</code> does not
end with the suffix <code class="code">suff</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALchop_extension"></a>chop_extension : <code class="type">string -> string</code></pre><div class="info">
Return the given file name without its extension. The extension
is the shortest suffix starting with a period and not including
a directory separator, <code class="code">.xyz</code> for instance.
<p>
Raise <code class="code"><span class="constructor">Invalid_argument</span></code> if the given name does not contain
an extension.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALbasename"></a>basename : <code class="type">string -> string</code></pre><div class="info">
Split a file name into directory name / base file name.
<code class="code">concat (dirname name) (basename name)</code> returns a file name
which is equivalent to <code class="code">name</code>. Moreover, after setting the
current directory to <code class="code">dirname name</code> (with <a href="Sys.html#VALchdir"><code class="code"><span class="constructor">Sys</span>.chdir</code></a>),
references to <code class="code">basename name</code> (which is a relative file name)
designate the same file as <code class="code">name</code> before the call to <a href="Sys.html#VALchdir"><code class="code"><span class="constructor">Sys</span>.chdir</code></a>.
<p>
<div style="background-color:yellow; color:red; border-style:none; border-width:0.5pt">
The result is not specified if the argument is not a valid file name
(for example, under Unix if there is a NUL character in the string).<br>
</div>
</div>
<pre><span class="keyword">val</span> <a name="VALdirname"></a>dirname : <code class="type">string -> string</code></pre><div class="info">
See <a href="Filename.html#VALbasename"><code class="code"><span class="constructor">Filename</span>.basename</code></a>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALtemp_file"></a>temp_file : <code class="type">string -> string -> string</code></pre><div class="info">
<code class="code">temp_file prefix suffix</code> returns the name of a
fresh temporary file in the temporary directory.
The base name of the temporary file is formed by concatenating
<code class="code">prefix</code>, then a suitably chosen integer number, then <code class="code">suffix</code>.
The temporary file is created empty, with permissions <code class="code">0o600</code>
(readable and writable only by the file owner). The file is
guaranteed to be different from any other file that existed when
<code class="code">temp_file</code> was called.
Under Unix, the temporary directory is <code class="code">/tmp</code> by default; if set,
the value of the environment variable <code class="code"><span class="constructor">TMPDIR</span></code> is used instead.
Under Windows, the name of the temporary directory is the
value of the environment variable <code class="code"><span class="constructor">TEMP</span></code>, or <code class="code">C:\temp</code> by default.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALopen_temp_file"></a>open_temp_file : <code class="type">?mode:<a href="Pervasives.html#TYPEopen_flag">open_flag</a> list -><br> string -> string -> string * <a href="Pervasives.html#TYPEout_channel">out_channel</a></code></pre><div class="info">
Same as <a href="Filename.html#VALtemp_file"><code class="code"><span class="constructor">Filename</span>.temp_file</code></a>, but returns both the name of a fresh
temporary file, and an output channel opened (atomically) on
this file. This function is more secure than <code class="code">temp_file</code>: there
is no risk that the temporary file will be modified (e.g. replaced
by a symbolic link) before the program opens it. The optional argument
<code class="code">mode</code> is a list of additional flags to control the opening of the file.
It can contain one or several of <code class="code"><span class="constructor">Open_append</span></code>, <code class="code"><span class="constructor">Open_binary</span></code>,
and <code class="code"><span class="constructor">Open_text</span></code>. The default is <code class="code">[<span class="constructor">Open_text</span>]</code> (open in text mode).<br>
</div>
<pre><span class="keyword">val</span> <a name="VALquote"></a>quote : <code class="type">string -> string</code></pre><div class="info">
Return a quoted version of a file name, suitable for use as
one argument in a shell command line, escaping all shell
meta-characters.<br>
</div>
</body></html>
|
