package frama-c

  1. Overview
  2. Docs
Platform dedicated to the analysis of source code written in C

Install 

dune-project
 Dependency

frama-c.com Edit opam file Versions (30)

Authors

  1. M
    Michele Alberti
  2. T
    Thibaud Antignac
  3. G
    Gergö Barany
  4. P
    Patrick Baudin
  5. N
    Nicolas Bellec
  6. T
    Thibaut Benjamin
  7. A
    Allan Blanchard
  8. L
    Lionel Blatter
  9. F
    François Bobot
  10. R
    Richard Bonichon
  11. V
    Vincent Botbol
  12. Q
    Quentin Bouillaguet
  13. D
    David Bühler
  14. Z
    Zakaria Chihani
  15. S
    Sylvain Chiron
  16. L
    Loïc Correnson
  17. J
    Julien Crétin
  18. P
    Pascal Cuoq
  19. Z
    Zaynah Dargaye
  20. B
    Basile Desloges
  21. J
    Jean-Christophe Filliâtre
  22. P
    Philippe Herrmann
  23. J
    Jordan Ischard
  24. M
    Maxime Jacquemin
  25. B
    Benjamin Jorge
  26. F
    Florent Kirchner
  27. A
    Alexander Kogtenkov
  28. R
    Remi Lazarini
  29. T
    Tristan Le Gall
  30. K
    Kilyan Le Gallic
  31. J
    Jean-Christophe Léchenet
  32. M
    Matthieu Lemerre
  33. D
    Dara Ly
  34. D
    David Maison
  35. C
    Claude Marché
  36. A
    André Maroneze
  37. T
    Thibault Martin
  38. F
    Fonenantsoa Maurica
  39. M
    Melody Méaulle
  40. B
    Benjamin Monate
  41. N
    Nicky Mouha
  42. Y
    Yannick Moy
  43. P
    Pierre Nigron
  44. A
    Anne Pacalet
  45. V
    Valentin Perrelle
  46. G
    Guillaume Petiot
  47. D
    Dario Pinto
  48. V
    Virgile Prevosto
  49. A
    Armand Puccetti
  50. F
    Félix Ridoux
  51. V
    Virgile Robles
  52. J
    Jan Rochel
  53. M
    Muriel Roger
  54. C
    Cécile Ruet-Cros
  55. J
    Julien Signoles
  56. F
    Fabien Siron
  57. N
    Nicolas Stouls
  58. H
    Hugo Thievenaz
  59. K
    Kostyantyn Vorobyov
  60. B
    Boris Yakobowski

Maintainers

  1. F
    frama-ci-bot@frama-c.com

Sources

frama-c-33.0-Arsenic.tar.gz
sha256=9c1cbffd28bb33c17a668107e39c96e4ae7378a3d8249f69b47afc7ee964e9b8

doc/frama-c-slicing.core/Slicing/SlicingParameters/Config_dir/index.html

Module SlicingParameters.Config_dir

Handle the specific `config' directory of the plug-in.

  • since Neon-20140301
  • before 30.0-Zinc

    this was not a functor and one could expect the directory to exist

Parameters

Signature

include Frama_c_kernel.Parameter_sig.User_dir
val get_dir : ?create_path:bool -> string -> Frama_c_kernel.Filepath.t

get_dir ~create_path name tries to get the directory name. The function aborts if:

  • a file named name exists,
  • creating a the directory fails.

Otherwise returns the path, and creates it if create_path is true (it defaults to false). Subdirectories modules can be created with Builder.Make_user_dir and Builder.Make_user_dir_opt.

val get_file : ?create_path:bool -> string -> Frama_c_kernel.Filepath.t

get_file ~create_path name tries to get the file name. The function aborts if:

  • a directory named name exists,
  • creating the path to the file fails.

Otherwise returns the path, and creates the directories that lead to the file if create_path is true (it defaults to false). The file is *not* created by the function.

include Frama_c_kernel.Parameter_sig.S with type t = Frama_c_kernel.Filepath.t
include Frama_c_kernel.Parameter_sig.S_no_parameter with type t = Frama_c_kernel.Filepath.t

Type of the parameter (an int, a string, etc). It is concrete for each module implementing this signature.

val add_set_hook : (t -> t -> unit) -> unit

Add a hook to be called after the function set is called. The first parameter of the hook is the old value of the parameter while the second one is the new value.

val add_update_hook : (t -> t -> unit) -> unit

Add a hook to be called when the value of the parameter changes (by calling set or indirectly by the project library. The first parameter of the hook is the old value of the parameter while the second one is the new value. Note that it is **not** specified if the hook is applied just before or just after the effective change.

  • since Nitrogen-20111001
val clear : unit -> unit

Set the option to its default value, that is the value if set was never called.

val is_default : unit -> bool

Is the option equal to its default value?

val get_default : unit -> t

Get the default value for the option.

  • since 24.0-Chromium
val option_name : string

Name of the option on the command-line

  • since Carbon-20110201
val print_help : Format.formatter -> unit

Print the help of the parameter in the given formatter as it would be printed on the command line by -<plugin>-help. For invisible parameters, the string corresponds to the one returned if it would be not invisible.

  • since Oxygen-20120901
include Frama_c_kernel.State_builder.S

The kind of the registered state.

val name : string
val mark_as_computed : ?project:Frama_c_kernel.Project.t -> unit -> unit

Indicate that the registered state will not change again for the given project (default is current ()).

val is_computed : ?project:Frama_c_kernel.Project.t -> unit -> bool

Returns true iff the registered state will not change again for the given project (default is current ()).

Exportation of some inputs (easier use of State_builder.Register).

val add_hook_on_update : (Datatype.t -> unit) -> unit

Add an hook which is applied each time (just before) the project library changes the local value of the state.

  • since Nitrogen-20111001
val howto_marshal : (Datatype.t -> 'a) -> ('a -> Datatype.t) -> unit

howto_marshal marshal unmarshal registers a custom couple of functions (marshal, unmarshal) to be used for serialization. Default functions are identities. In particular, this function must be used if Datatype.t is not marshallable and do_not_save is not called.

  • since Boron-20100401
val equal : t -> t -> bool
val add_aliases : ?visible:bool -> ?deprecated:bool -> string list -> unit

Add some aliases for this option. That is other option names which have exactly the same semantics that the initial option. If visible is set to false, the aliases do not appear in help messages. If deprecated is set to true, the use of the aliases emits a warning.

  • before 22.0-Titanium

    no visible and deprecated arguments.

  • since Nitrogen-20111001
val set : Frama_c_kernel.Filepath.t -> unit

Sets the <user-dir> directory (without creating it).

val get : unit -> Frama_c_kernel.Filepath.t
  • returns

    the <user-dir> directory (without creating it).

val is_set : unit -> bool
  • returns

    whether the <user-dir> has been set.