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
63 explicit 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
77 exactly the interpretation of case-insensitive filename equivalence
78 from 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
100 exactly the interpretation of case-insensitive filename equivalence
101 from 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 temp_file : ?temp_dir:string -> string -> string -> string
174 temp_file prefix suffix returns the name of a fresh temporary file in
177 the temporary directory. The base name of the temporary file is formed
178 by concatenating prefix , then a suitably chosen integer number, then
179 suffix . The optional argument temp_dir indicates the temporary direc‐
180 tory to use, defaulting to the current result of File‐
181 name.get_temp_dir_name . The temporary file is created empty, with
182 permissions 0o600 (readable and writable only by the file owner). The
183 file is guaranteed to be different from any other file that existed
184 when temp_file was called. Raise Sys_error if the file could not be
185 created.
186 Before3.11.2 no ?temp_dir optional argument
189 val open_temp_file : ?mode:open_flag list -> ?perms:int ->
194 ?temp_dir:string -> string -> string -> string * out_channel
195 Same as Filename.temp_file , but returns both the name of a fresh tem‐
197 porary file, and an output channel opened (atomically) on this file.
198 This function is more secure than temp_file : there is no risk that the
199 temporary file will be modified (e.g. replaced by a symbolic link)
200 before the program opens it. The optional argument mode is a list of
201 additional flags to control the opening of the file. It can contain
202 one or several of Open_append , Open_binary , and Open_text . The
203 default is [Open_text] (open in text mode). The file is created with
204 permissions perms (defaults to readable and writable only by the file
205 owner, 0o600 ).
206 Before4.03.0 no ?perms optional argument
209 Before3.11.2 no ?temp_dir optional argument
213 Raises Sys_error if the file could not be opened.
217 val get_temp_dir_name : unit -> string
221 The name of the temporary directory: Under Unix, the value of the
223 TMPDIR environment variable, or "/tmp" if the variable is not set.
224 Under Windows, the value of the TEMP environment variable, or "." if
225 the variable is not set. The temporary directory can be changed with
226 Filename.set_temp_dir_name .
227 Since 4.00.0
230 val set_temp_dir_name : string -> unit
234 Change the temporary directory returned by Filename.get_temp_dir_name
236 and used by Filename.temp_file and Filename.open_temp_file .
237 Since 4.00.0
240 val temp_dir_name : string
244 Deprecated. You should use Filename.get_temp_dir_name instead.
246 The name of the initial temporary directory: Under Unix, the value of
249 the TMPDIR environment variable, or "/tmp" if the variable is not set.
250 Under Windows, the value of the TEMP environment variable, or "." if
251 the variable is not set.
252 Since 3.09.1
255 val quote : string -> string
259 Return a quoted version of a file name, suitable for use as one argu‐
261 ment in a command line, escaping all meta-characters. Warning: under
262 Windows, the output is only suitable for use with programs that follow
263 the standard Windows quoting conventions.
264OCamldoc 2019-07-30 Filename(3)