package frama-c

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

File system
Temporary files
File comparison
High level Input/Output
Low level file Input/Output

Platform dedicated to the analysis of source code written in C

Install

dune-project

Dependency

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

Authors

Maintainers

F

frama-ci-bot@frama-c.com

Sources

frama-c-31.0-Gallium.tar.gz

sha256=a94384f00d53791cbb4b4d83ab41607bc71962d42461f02d71116c4ff6dca567

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

Module `Frama_c_kernel.Filesystem`

File system

val exists : Filepath.t -> bool

Equivalent to Sys.file_exists.

since 28.0-Nickel

val is_file : Filepath.t -> bool

is_file f returns true iff f points to a regular file (or a symbolic link pointing to a file). Returns false if any errors happen when stat'ing the file.

since 22.0-Titanium

val is_dir : Filepath.t -> bool

Equivalent to Sys.is_directory.

since 28.0-Nickel

val readdir : Filepath.t -> string array

Equivalent to Sys.readdir.

since 28.0-Nickel

deprecated Use iter_dir or fold_dir instead

val list_dir : Filepath.t -> string list

Contents of a directory.

since 31.0-Gallium

val iter_dir : (string -> unit) -> Filepath.t -> unit

Iter through the contents of a directory.

since 31.0-Gallium

val fold_dir : (string -> 'a -> 'a) -> Filepath.t -> 'a -> 'a

Fold over the contents of a directory.

since 31.0-Gallium

val make_dir : ?parents:bool -> Filepath.t -> Unix.file_perm -> bool

make_dir ?parents name perm creates directory name with permission perm. If parents is true, recursively create parent directories if needed. parents defaults to false. Note that this function may create some of the parent directories and then fail to create the children, e.g. if perm does not allow user execution of the created directory. This will leave the filesystem in a modified state before raising an exception. Returns true if the directory was created, false otherwise.

raises Unix.Unix_error
if cannot create name or its parents.

raises Failure
if the path exists but is not a directory

since 19.0-Potassium

before 28.0-Nickel
name argument was of type string and the returned type was unit. Also, the function did not check for path's existence.

val remove_file : Filepath.t -> unit

Tries to delete a file and never fails.

before 31.0-Gallium
it was Extlib.safe_remove

val remove_dir : Filepath.t -> unit

Tries to delete a directory and never fails.

before 31.0-Gallium
it was Extlib.safe_remove_dir

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

Equivalent to Sys.rename.

since 28.0-Nickel

Temporary files

See Temp_files module for automatic removal of temp files at exit.

exception Temp_file_error of string

val temp_file : prefix:string -> suffix:string -> Filepath.t

Similar to Filename.temp_file.

raises Temp_file_error
if the temp file cannot be created.

since 31.0-Gallium

val temp_dir : prefix:string -> suffix:string -> Filepath.t

Similar to Filename.temp_dir.

raises Temp_file_error
if the temp dir cannot be created.

since 31.0-Gallium

File comparison

val digest : Filepath.t -> string

digest p computes the hash of a file p using Stdlib.Digest.file.

since 31.0-Gallium

val same_digest : Filepath.t -> Filepath.t -> bool

same_digest p1 p2 compares the hashes of two files p1 and p2 using Stdlib.Digest.file and returns true if they have the same.

since 31.0-Gallium

High level Input/Output

val bincopy : bytes -> in_channel -> out_channel -> unit

deprecated This function is only used locally and is not exported anymore.

val copy_file : Filepath.t -> Filepath.t -> unit

copy_file source target copies source file to target file.

since 31.0-Gallium

before 31.0-Gallium
this function was Command.copy

val iter_lines : Filepath.t -> (string -> unit) -> unit

Iter over all text lines in the file

since 31.0-Gallium

before 31.0-Gallium
this function was Command.read_lines

Low level file Input/Output

type action_if_missing =

| Create of int
(*
create the file with the given permissions
*)
| DoNotCreate
(*
do not create the file and fail
*)

This type defines what action with_open_in and with_open_out must perform when the file to open does not exist.

type action_if_exists =

| Error
(*
file opening functions will fail with an error
*)
| Append
(*
the writing contents will be appended
*)
| Truncate
(*
the file will be truncated before any writes
*)

This type define what action with_open_out must perform when the file to open already exists.

type ('ch, 'a) safe_processor = ('ch -> 'a) -> ('a, string) result

A safe_processor helps to handle file operations while ensuring the file will be closed no matter what happens. It is a function that takes a file operation f as a parameter, opens a file and calls the f with the newly-created channel.

type ('ch, 'a) exn_processor = ('ch -> 'a) -> 'a

Same as safe_processor but when a Sys_error is raised, re-raise it after closing the file

val with_open_in : 
  ?if_missing:action_if_missing ->
  ?binary:bool ->
  ?blocking:bool ->
  Filepath.t ->
  (in_channel, 'a) safe_processor

with_open_in path f opens file path for reading and calls f with the newly-created input channel. The file is closed when f returns or whenever an exception is thrown by f.

parameter if_missing
defines what must be done if the file does not exist, defaults to DoNotCreate.

parameter binary
must be set if the file needs to be opened in binary mode (disables conversion, e.g. new lines), defaults to false

parameter blocking
must be unset if the file needs to be opened in nonblocking mode, defaults to true.

returns
Ok (f input_channel) if no exceptions are thrown, or Error s if a Sys_error s is thrown during the execution of f or during the closing of the file.

since 31.0-Gallium

val with_open_in_exn : 
  ?if_missing:action_if_missing ->
  ?binary:bool ->
  ?blocking:bool ->
  Filepath.t ->
  (in_channel, 'a) exn_processor

Same as with_open_in but raises Sys_error instead of returning Error.

since 31.0-Gallium

before 31.0-Gallium
this function was Command.read_file

val with_open_out : 
  ?if_missing:action_if_missing ->
  ?if_exists:action_if_exists ->
  ?binary:bool ->
  ?blocking:bool ->
  Filepath.t ->
  (out_channel, 'a) safe_processor

with_open_out path f calls f with a new output channel on the file path opened for writing. The file is closed when f returns or whenever an exception is thrown by f.

parameter if_missing
defines what must be done if the file does not exist, defaults to Create 0o666.

parameter if_exists
defines what action must be performed when the file already exists, defaults to Truncate.

parameter binary
must be set if the file needs to be opened in binary mode (disables conversion, e.g. new lines), defaults to false.

parameter blocking
must be unset if the file needs to be opened in nonblocking mode, defaults to true.

returns
Ok (f output_channel) if no exceptions are thrown, or Error s if a Sys_error s is thrown during the execution of f or during the closing the file.

since 31.0-Gallium

val with_open_out_exn : 
  ?if_missing:action_if_missing ->
  ?if_exists:action_if_exists ->
  ?binary:bool ->
  ?blocking:bool ->
  Filepath.t ->
  (out_channel, 'a) exn_processor

Same as with_open_out but raises Sys_error instead of returning Error.

since 31.0-Gallium

before 31.0-Gallium
this function was Command.write_file

val with_formatter : Filepath.t -> (Format.formatter, 'a) safe_processor

with_formatter path f calls f with a formatter writing to the file path. The file is closed and the formatter is flushed when f returns or whenever an exception is thrown by f.

returns
Ok (f fmt) if no exceptions are thrown, or Error s if a Sys_error s is thrown during the execution of f or when closing the file.

since 31.0-Gallium

val with_formatter_exn : Filepath.t -> (Format.formatter, 'a) exn_processor

Same as with_formatter but raises Sys_error instead of returning Error.

since 31.0-Gallium

before 31.0-Gallium
this function was Command.pp_to_file and Command.print_file

module Compressed : sig ... end

module Operators : sig ... end

Opening this module allows to use shorter syntax to deal with files.