1Filename(3) OCaml library Filename(3)
2
6 Filename - Operations on file names.
7
9 Module Filename
10
12 Module Filename
13 : sig end
14 Operations on file names.
17 val current_dir_name : string
24 The conventional name for the current directory (e.g. . in Unix).
26 val parent_dir_name : string
30 The conventional name for the parent of the current directory (e.g. ..
32 in Unix).
33 val dir_sep : string
37 The directory separator (e.g. / in Unix).
39 Since 3.11.2
42 val concat : string -> string -> string
46 concat dir file returns a file name that designates file file in direc‐
49 tory dir .
50 val is_relative : string -> bool
54 Return true if the file name is relative to the current directory,
56 false if it is absolute (i.e. in Unix, starts with / ).
57 val is_implicit : string -> bool
61 Return true if the file name is relative and does not start with an ex‐
63 plicit reference to the current directory ( ./ or ../ in Unix), false
64 if it starts with an explicit reference to the root directory or the
65 current directory.
66 val check_suffix : string -> string -> bool
70 check_suffix name suff returns true if the filename name ends with the
73 suffix suff .
74 Under Windows ports (including Cygwin), comparison is case-insensitive,
76 relying on String.lowercase_ascii . Note that this does not match ex‐
77 actly the interpretation of case-insensitive filename equivalence from
78 Windows.
79 val chop_suffix : string -> string -> string
83 chop_suffix name suff removes the suffix suff from the filename name .
86 The behavior is undefined if name does not end with the suffix suff .
87 chop_suffix_opt is thus recommended instead.
88 val chop_suffix_opt : suffix:string -> string -> string option
92 chop_suffix_opt ~suffix filename removes the suffix from the filename
95 if possible, or returns None if the filename does not end with the suf‐
96 fix.
97 Under Windows ports (including Cygwin), comparison is case-insensitive,
99 relying on String.lowercase_ascii . Note that this does not match ex‐
100 actly the interpretation of case-insensitive filename equivalence from
101 Windows.
102 Since 4.08
105 val extension : string -> string
109 extension name is the shortest suffix ext of name0 where:
112 - name0 is the longest suffix of name that does not contain a directory
115 separator;
116 - ext starts with a period;
118 - ext is preceded by at least one non-period character in name0 .
120 If such a suffix does not exist, extension name is the empty string.
122 Since 4.04
125 val remove_extension : string -> string
129 Return the given file name without its extension, as defined in File‐
131 name.extension . If the extension is empty, the function returns the
132 given file name.
133 The following invariant holds for any file name s :
135 remove_extension s ^ extension s = s
138 Since 4.04
142 val chop_extension : string -> string
146 Same as Filename.remove_extension , but raise Invalid_argument if the
148 given name has an empty extension.
149 val basename : string -> string
153 Split a file name into directory name / base file name. If name is a
155 valid file name, then concat (dirname name) (basename name) returns a
156 file name which is equivalent to name . Moreover, after setting the
157 current directory to dirname name (with Sys.chdir ), references to
158 basename name (which is a relative file name) designate the same file
159 as name before the call to Sys.chdir .
160 This function conforms to the specification of POSIX.1-2008 for the
162 basename utility.
163 val dirname : string -> string
167 See Filename.basename . This function conforms to the specification of
169 POSIX.1-2008 for the dirname utility.
170 val null : string
174 null is "/dev/null" on POSIX and "NUL" on Windows. It represents a file
177 on the OS that discards all writes and returns end of file on reads.
178 Since 4.10.0
181 val temp_file : ?temp_dir:string -> string -> string -> string
185 temp_file prefix suffix returns the name of a fresh temporary file in
188 the temporary directory. The base name of the temporary file is formed
189 by concatenating prefix , then a suitably chosen integer number, then
190 suffix . The optional argument temp_dir indicates the temporary direc‐
191 tory to use, defaulting to the current result of File‐
192 name.get_temp_dir_name . The temporary file is created empty, with
193 permissions 0o600 (readable and writable only by the file owner). The
194 file is guaranteed to be different from any other file that existed
195 when temp_file was called.
196 Before3.11.2 no ?temp_dir optional argument
199 Raises Sys_error if the file could not be created.
203 val open_temp_file : ?mode:open_flag list -> ?perms:int ->
207 ?temp_dir:string -> string -> string -> string * out_channel
208 Same as Filename.temp_file , but returns both the name of a fresh tem‐
210 porary file, and an output channel opened (atomically) on this file.
211 This function is more secure than temp_file : there is no risk that the
212 temporary file will be modified (e.g. replaced by a symbolic link) be‐
213 fore the program opens it. The optional argument mode is a list of ad‐
214 ditional flags to control the opening of the file. It can contain one
215 or several of Open_append , Open_binary , and Open_text . The default
216 is [Open_text] (open in text mode). The file is created with permis‐
217 sions perms (defaults to readable and writable only by the file owner,
218 0o600 ).
219 Before4.03.0 no ?perms optional argument
222 Before3.11.2 no ?temp_dir optional argument
226 Raises Sys_error if the file could not be opened.
230 val get_temp_dir_name : unit -> string
234 The name of the temporary directory: Under Unix, the value of the TM‐
236 PDIR environment variable, or "/tmp" if the variable is not set. Under
237 Windows, the value of the TEMP environment variable, or "." if the
238 variable is not set. The temporary directory can be changed with File‐
239 name.set_temp_dir_name .
240 Since 4.00.0
243 val set_temp_dir_name : string -> unit
247 Change the temporary directory returned by Filename.get_temp_dir_name
249 and used by Filename.temp_file and Filename.open_temp_file .
250 Since 4.00.0
253 val temp_dir_name : string
257 Deprecated. You should use Filename.get_temp_dir_name instead.
259 The name of the initial temporary directory: Under Unix, the value of
262 the TMPDIR environment variable, or "/tmp" if the variable is not set.
263 Under Windows, the value of the TEMP environment variable, or "." if
264 the variable is not set.
265 Since 3.09.1
268 val quote : string -> string
272 Return a quoted version of a file name, suitable for use as one argu‐
274 ment in a command line, escaping all meta-characters. Warning: under
275 Windows, the output is only suitable for use with programs that follow
276 the standard Windows quoting conventions.
277 val quote_command : string -> ?stdin:string -> ?stdout:string ->
281 ?stderr:string -> string list -> string
282 quote_command cmd args returns a quoted command line, suitable for use
285 as an argument to Sys.command , Unix.system , and the Unix.open_process
286 functions.
287 The string cmd is the command to call. The list args is the list of
289 arguments to pass to this command. It can be empty.
290 The optional arguments ?stdin and ?stdout and ?stderr are file names
292 used to redirect the standard input, the standard output, or the stan‐
293 dard error of the command. If ~stdin:f is given, a redirection < f is
294 performed and the standard input of the command reads from file f . If
295 ~stdout:f is given, a redirection > f is performed and the standard
296 output of the command is written to file f . If ~stderr:f is given, a
297 redirection 2> f is performed and the standard error of the command is
298 written to file f . If both ~stdout:f and ~stderr:f are given, with
299 the exact same file name f , a 2>&1 redirection is performed so that
300 the standard output and the standard error of the command are inter‐
301 leaved and redirected to the same file f .
302 Under Unix and Cygwin, the command, the arguments, and the redirections
304 if any are quoted using Filename.quote , then concatenated. Under
305 Win32, additional quoting is performed as required by the cmd.exe shell
306 that is called by Sys.command .
307 Since 4.10.0
310 Raises Failure if the command cannot be escaped on the current plat‐
313 form.
314OCamldoc 2022-02-04 Filename(3)