package frama-c

You can search for identifiers within the package.

in-package search v0.2.0

Platform dedicated to the analysis of source code written in C

Install

Dune Dependency

frama-c.com Readme Edit opam file Versions (23)

Authors

Maintainers

F

frama-ci-bot@frama-c.com

Sources

frama-c-29.0-Copper.tar.gz

sha256=d2fbb3b8d0ff83945872e9e6fa258e934a706360e698dae3b4d5f971addf7493

doc/frama-c.kernel/Frama_c_kernel/Filepath/index.html

Module `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.

exception No_file

Raised whenever no file exists and existence is Must_exist.

exception File_exists

Raised whenever some file exists and existence is Must_not_exist.

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;
non-existing directories in realpath may lead to ENOTDIR errors, but normalize may accept them.

before 21.0-Scandium
no existence argument.

val relativize : ?base_name:string -> string -> string

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.

since Aluminium-20160501

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.

since Aluminium-20160501

before 23.0-Vanadium
argument types were string instead of Normalized.t.

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 reset_symbolic_dirs : unit -> unit

Remove all symbolic dirs that have been added earlier.

since 23.0-Vanadium

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).

since 22.0-Titanium

type position = {

pos_path : Normalized.t;
pos_lnum : int;
pos_bol : int;
pos_cnum : int;

}

Describes a position in a source file.

since 18.0-Argon

val pp_pos : Format.formatter -> position -> unit

Pretty-prints a position, in the format file:line.

since 18.0-Argon

val pwd : unit -> Normalized.t

Return the current working directory. Implicitly uses Unix.realpath to normalize paths and avoid issues with symbolic links in directory names.

since 25.0-Manganese

before 28.0-Nickel
return type was string instead of Normalized.t.

val exists : Normalized.t -> bool

Equivalent to Sys.file_exists.

since 28.0-Nickel

val is_dir : Normalized.t -> bool

Equivalent to Sys.is_directory.

since 28.0-Nickel

val readdir : Normalized.t -> string array

Equivalent to Sys.readdir.

since 28.0-Nickel

val remove : Normalized.t -> unit

Equivalent to Sys.remove.

since 28.0-Nickel

val rename : Normalized.t -> Normalized.t -> unit

Equivalent to Sys.rename.

since 28.0-Nickel

val basename : Normalized.t -> string

Equivalent to Filename.basename.

since 28.0-Nickel

val dirname : Normalized.t -> Normalized.t

Equivalent to Filename.dirname.

since 28.0-Nickel