ocaml/stdlib/filename.mli

53 lines
2.9 KiB
OCaml

(***********************************************************************)
(* *)
(* Caml Special Light *)
(* *)
(* Xavier Leroy, projet Cristal, INRIA Rocquencourt *)
(* *)
(* Copyright 1995 Institut National de Recherche en Informatique et *)
(* Automatique. Distributed only by permission. *)
(* *)
(***********************************************************************)
(* $Id$ *)
(* Module [Filename]: operations on file names *)
val current_dir_name : string
(* The conventional name for the current directory
(e.g. [.] in Unix). *)
val concat : string -> string -> string
(* [concat dir file] returns a file name that designates file
[file] in directory [dir]. *)
val is_absolute : string -> bool
(* Return [true] if the file name is absolute or starts with an
explicit reference to the current directory ([./] or [../] in
Unix), and [false] if it is relative to the current directory. *)
val check_suffix : string -> string -> bool
(* [check_suffix name suff] returns [true] if the filename [name]
ends with the suffix [suff]. *)
val chop_suffix : string -> string -> string
(* [chop_suffix name suff] removes the suffix [suff] from
the filename [name]. The behavior is undefined if [name] does not
end with the suffix [suff]. *)
val chop_extension : string -> string
(* Return the given file name without its extension. An extension
is a suffix starting with a period, [.xyz] for instance.
Raise [Invalid_argument] if the given name does not contain
a period. *)
val basename : string -> string
val dirname : string -> string
(* Split a file name into directory name / base file name.
[concat (dirname name) (basename name)] returns a file name
which is equivalent to [name]. Moreover, after setting the
current directory to [dirname name] (with [Sys.chdir]),
references to [basename name] (which is a relative file name)
designate the same file as [name] before the call to [chdir]. *)
val temp_file: string -> string -> string
(* [temp_file prefix suffix] returns the name of a
non-existent temporary file in the temporary directory.
The temporary directory is [/tmp] by default; if set,
the value of the environment variable [TMPDIR] is used instead.
The base name of the temporary file is formed by concatenating
[prefix], then a suitably chosen integer number, then [suffix]. *)