Module File

module File: sig .. end

Frama-c preprocessing and Cil AST initialization.

type cpp_opt_kind =

`\|`	`Gnu`
`\|`	`Not_gnu`
`\|`	`Unknown`

Whether a given preprocessor supports gcc options used in some configurations.

type file =

`\|`	`NeedCPP of string * string * cpp_opt_kind`	`(*`	The first string is the filename of the `.c` to preprocess. The second one is the preprocessor command (`filename.c -o tempfilname.i` will be appended at the end).	`*)`
`\|`	`NoCPP of string`	`(*`	Already pre-processed file `.i`	`*)`
`\|`	`External of string * string`	`(*`	file that can be translated into a Cil AST through an external function, together with the recognized suffix.	`*)`

include Datatype.S

val new_file_type : string -> (string -> Cil_types.file * Cabs.file) -> unit

new_file_type suffix func funcname registers a new type of files (with corresponding suffix) as recognized by Frama-C through func.
Consult the Plugin Development Guide for additional details.

val new_machdep : string -> Cil_types.mach -> unit

new_machdep name module registers a new machdep name as recognized by Frama-C through The usual uses is

Cmdline.run_after_loading_stage
      (fun () -> File.new_machdep "my_machdep" my_machdep_implem)

Since Nitrogen-20111001
Raises Invalid_argument if the given name already exists
Change in Fluorine-20130401: Receives the machdep (as a module) as argument
Change in Sodium-20150201: Receives directly the machdep as argument

val machdep_macro : string -> string

machdep_macro machine returns the name of a macro __FC_MACHDEP_XXX so that the preprocessor can select std lib definition consistent with the selected machdep. This function will emit a warning if machine is not known by default by the kernel and return __FC_MACHDEP_MACHINE in that case.
Since Magnesium-20151001 (exported in the API)

type code_transformation_category

type of registered code transformations
Since Neon-20140301

val register_code_transformation_category : string -> code_transformation_category

Adds a new category of code transformation

val add_code_transformation_before_cleanup : ?deps:(module Parameter_sig.S) list ->
       ?before:code_transformation_category list ->
       ?after:code_transformation_category list ->
       code_transformation_category -> (Cil_types.file -> unit) -> unit

add_code_transformation_before_cleanup name hook adds an hook in the corresponding category that will be called during the normalization of a linked file, before clean up and removal of temps and unused declarations. If this transformation involves changing statements of a function f, f must be flagged with File.must_recompute_cfg. The optional before (resp after) categories indicates that current transformation must be executed before (resp after) the corresponding ones, if they exist. In case of dependencies cycle, an arbitrary order will be chosen for the transformations involved in the cycle. The optional deps argument gives the list of options whose change (e.g. after a -then) will trigger the transformation over the already computed AST. If several transformations are triggered by the same option, their relative order is preserved.

At this level, globals and ACSL annotations have not been registered.
Since Neon-20140301
Consult the Plugin Development Guide for additional details.

val add_code_transformation_after_cleanup : ?deps:(module Parameter_sig.S) list ->
       ?before:code_transformation_category list ->
       ?after:code_transformation_category list ->
       code_transformation_category -> (Cil_types.file -> unit) -> unit

Same as above, but the hook is applied after clean up. At this level, globals and ACSL annotations have been registered. If the hook adds some new globals or annotations, it must take care of adding them in the appropriate tables. Note that it is the responsibility of the hook to use Ast.mark_as_changed or Ast.mark_as_grown whenever it is the case.
Since Neon-20140301
Consult the Plugin Development Guide for additional details.

val must_recompute_cfg : Cil_types.fundec -> unit

must_recompute_cfg f must be called by code transformation hooks when they modify statements in function f. This will trigger a recomputation of the cfg of f after the transformation.
Since Neon-20140301
Consult the Plugin Development Guide for additional details.

val get_suffixes : unit -> string list

Since Boron-20100401
Returns the list of accepted suffixes of input source files

val get_name : t -> string

File name.

val get_preprocessor_command : unit -> string * cpp_opt_kind

Return the preprocessor command to use.

val pre_register : t -> unit

val get_all : unit -> t list

Return the list of toplevel files.

val from_filename : ?cpp:string -> string -> t

Build a file from its name. The optional argument is the preprocessor command. Default is !get_preprocessor_command ().

Initializers

val prepare_from_c_files : unit -> unit

Initialize the AST of the current project according to the current filename list.
Raises File_types.Bad_Initialization if called more than once.

val init_from_c_files : t list -> unit

Initialize the cil file representation of the current project. Should be called at most once per project.
Raises File_types.Bad_Initialization if called more than once.
Consult the Plugin Development Guide for additional details.

val init_project_from_cil_file : Project.t -> Cil_types.file -> unit

Initialize the cil file representation with the given file for the given project from the current one. Should be called at most once per project.
Raises File_types.Bad_Initialization if called more than once.
Consult the Plugin Development Guide for additional details.

val init_project_from_visitor : ?reorder:bool -> Project.t -> Visitor.frama_c_visitor -> unit

init_project_from_visitor prj vis initialize the cil file representation of prj. prj must be essentially empty: it can have some options set, but not an existing cil file; proj is filled using vis, which must be a copy visitor that puts its results in prj. if reorder is true (default is false) the new AST in prj will be reordered.
Since Oxygen-20120901
Change in Fluorine-20130401: added reorder optional argument
Consult the Plugin Development Guide for additional details.

val create_project_from_visitor : ?reorder:bool ->
       ?last:bool -> string -> (Project.t -> Visitor.frama_c_visitor) -> Project.t

Return a new project with a new cil file representation by visiting the file of the current project. If reorder is true, the globals in the AST of the new project are reordered (default is false). If last is true (by default), remember than the returned project is the last created one. The visitor is responsible to avoid sharing between old file and new file (i.e. it should use Cil.copy_visit at some point).
Since Beryllium-20090601-beta1
Raises File_types.Bad_Initialization if called more than once.
Change in Fluorine-20130401: added reorder optional argument
Change in Sodium-20150201: added last optional argument
Consult the Plugin Development Guide for additional details.

val create_rebuilt_project_from_visitor : ?reorder:bool ->
       ?last:bool ->
       ?preprocess:bool ->
       string -> (Project.t -> Visitor.frama_c_visitor) -> Project.t

Like File.create_project_from_visitor, but the new generated cil file is generated into a temp .i or .c file according to preprocess, then re-built by Frama-C in the returned project. For instance, use this function if the new cil file contains a constructor GText as global.

Note that the generation of a preprocessed C file may fail in some cases (e.g. if it includes headers already included). Thus the generated file is NOT preprocessed by default.
Since Nitrogen-20111001
Raises File_types.Bad_Initialization if called more than once.
Change in Fluorine-20130401: added reorder optional argument

val init_from_cmdline : unit -> unit

Initialize the cil file representation with the file given on the command line. Should be called at most once per project.
Raises File_types.Bad_Initialization if called more than once.
Consult the Plugin Development Guide for additional details.

val reorder_ast : unit -> unit

reorder globals so that all uses of an identifier are preceded by its declaration. This may introduce new declarations in the AST.
Since Oxygen-20120901

val reorder_custom_ast : Cil_types.file -> unit

Since Neon-20140301

Pretty printing

val pretty_ast : ?prj:Project.t -> ?fmt:Format.formatter -> unit -> unit

Print the project CIL file on the given Formatter. The default project is the current one. The default formatter is Kernel.CodeOutput.get_fmt ().
Raises File_types.Bad_Initialization if the file is not initialized.