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 (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/Command/index.html

Module `Frama_c_kernel.Command`

Useful high-level system operations.

File Utilities

val pp_to_file : Filepath.t -> (Stdlib.Format.formatter -> unit) -> unit

deprecated Use Filesystem.with_formatter_exn instead.

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

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

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

deprecated Use Filesystem.copy instead.

val read_file : Filepath.t -> (Stdlib.in_channel -> 'a) -> 'a

deprecated Use Filesystem.with_open_in_exn instead.

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

deprecated Use Filesystem.iter_lines instead.

val write_file : Filepath.t -> (Stdlib.out_channel -> 'a) -> 'a

deprecated Use Filesystem.with_open_out_exn instead.

val print_file : Filepath.t -> (Stdlib.Format.formatter -> 'a) -> 'a

deprecated Use Filesystem.with_formatter_exn instead.

Pretty from files

val pp_from_file : Stdlib.Format.formatter -> Filepath.t -> unit

pp_from_file fmt file dumps the content of file into the fmt. Exceptions in pp are re-raised after closing.

Timing Utility

type timer = float Stdlib.ref

val time : ?rmax:timer -> ?radd:timer -> ('a -> 'b) -> 'a -> 'b

Compute the elapsed time with Sys.time. The rmax timer is maximized and the radd timer is cumulated. Computed result is returned, or exception is re-raised.

System commands

val full_command : 
  string ->
  string array ->
  stdin:Unix.file_descr ->
  stdout:Unix.file_descr ->
  stderr:Unix.file_descr ->
  Unix.process_status

deprecated This unused function was removed from Frama-C.

type process_result =

| Not_ready of unit -> unit
| Result of Unix.process_status
(*
Not_ready f means that the child process is not yet finished and may be terminated manually with f ().
*)

val full_command_async : 
  string ->
  string array ->
  stdin:Unix.file_descr ->
  stdout:Unix.file_descr ->
  stderr:Unix.file_descr ->
  unit ->
  process_result

deprecated This unused function was removed from Frama-C.

val async : 
  ?stdout:Stdlib.Buffer.t ->
  ?stderr:Stdlib.Buffer.t ->
  string ->
  string list ->
  unit ->
  process_result

Same arguments as Unix.create_process.

returns
a function to call to check if the process execution is complete. You must call this function until it returns a Result to prevent Zombie processes. When this function returns a Result, the stdout and stderr of the child process will be filled into the arguments buffer.

raises Sys_error
when a system error occurs

before 31.0-Gallium
this function was named command_async

val command_async : 
  ?stdout:Stdlib.Buffer.t ->
  ?stderr:Stdlib.Buffer.t ->
  string ->
  string list ->
  unit ->
  process_result

deprecated Use Command.async instead.

val spawn : 
  ?timeout:int ->
  ?stdout:Stdlib.Buffer.t ->
  ?stderr:Stdlib.Buffer.t ->
  string ->
  string list ->
  Unix.process_status

Same arguments as Unix.create_process. When this function returns, the stdout and stderr of the child process will be filled into the arguments buffer.

raises Sys_error
when a system error occurs

raises Async.Cancel
when the computation is interrupted or on timeout

before 29.0-Copper
Async.Cancel was Db.Cancel

before 31.0-Gallium
this function was named command

val command : 
  ?timeout:int ->
  ?stdout:Stdlib.Buffer.t ->
  ?stderr:Stdlib.Buffer.t ->
  string ->
  string list ->
  Unix.process_status

deprecated Use Command.spawn instead.

On This Page

File Utilities
Pretty from files
Timing Utility
System commands