Frama_c_kernel.Filepath
Functions manipulating filepaths. In these functions, references to the current working directory refer to the result given by function Sys.getcwd.
NOTE: Prefer using the Normalized
module whenever possible.
type existence =
| Must_exist | (* File must exist. *) |
| Must_not_exist | (* File must not exist. *) |
| Indifferent | (* No requirement. *) |
Existence requirement on a file.
val normalize : ?existence:existence -> ?base_name:string -> string -> string
Returns an absolute path leading to the given file. The result is similar to realpath --no-symlinks
. Some special behaviors include:
normalize ""
(empty string) returns "" (realpath returns an error);normalize
preserves multiple sequential '/' characters, unlike realpath
;realpath
may lead to ENOTDIR errors, but normalize
may accept them.relativize base_name file_name
returns a relative path name of file_name
w.r.t. base_name
, if base_name
is a prefix of file
; otherwise, returns file_name
unchanged. The default base name is the current working directory name.
module Normalized : sig ... end
The Normalized
module is simply a wrapper that ensures that paths are always normalized. Used by Datatype.Filepath
.
val is_relative : ?base_name:Normalized.t -> Normalized.t -> bool
returns true if the file is relative to base
(that is, it is prefixed by base_name
), or to the current working directory if no base is specified.
val add_symbolic_dir : string -> Normalized.t -> unit
add_symbolic_dir name dir
indicates that the (absolute) path dir
must be replaced by name
when pretty-printing paths. This alias ensures that system-dependent paths such as FRAMAC_SHARE are printed identically in different machines.
val add_symbolic_dir_list : string -> Normalized.t list -> unit
val all_symbolic_dirs : unit -> (string * Normalized.t) list
Returns the list of symbolic dirs added via add_symbolic_dir
, plus preexisting ones (e.g. FRAMAC_SHARE), as pairs (name, dir).
Describes a position in a source file.
val pp_pos : Stdlib.Format.formatter -> position -> unit
Pretty-prints a position, in the format file:line.
Return the current working directory. Currently uses the environment's PWD instead of Sys.getcwd () because OCaml has no function in its stdlib to resolve symbolic links (e.g. realpath) for a given path. 'getcwd' always resolves them, but if the user supplies a path with symbolic links, this may cause issues. Instead of forcing the user to always provide resolved paths, we currently choose to never resolve them. We only resort to getcwd() to avoid issues when PWD does not exist. Note that this function does not validate that PWD has not been tampered with.