package frama-c

  1. Overview
  2. Docs
package frama-c
Legend:
Library
Module
Module type
Parameter
Class
Class type

Operations on globals.

module Vars : sig ... end

Globals variables. The AST should be computed before using this module (cf. Ast.compute).

module Functions : sig ... end

Functions. The AST should be computed before using this module (cf. Ast.compute).

module FileIndex : sig ... end

Globals associated to filename.

Types

module Types : sig ... end

Types, or type-related information.

Entry point

exception No_such_entry_point of string

May be raised by entry_point below.

val entry_point : unit -> Cil_types.kernel_function * bool
  • returns

    the current function entry point and a boolean indicating if it is a library entry point.

  • raises No_such_entry_point

    if the current entrypoint name does not exist. This exception is automatically handled by the Frama-C kernel. Thus you don't have to catch it yourself, except if you do a specific work.

val set_entry_point : string -> bool -> unit

set_entry_point name lib sets Kernel.MainFunction to name and Kernel.LibEntry to lib. Moreover, clear the results of all the analysis which depend on Kernel.MainFunction or Kernel.LibEntry.

val is_entry_point : ?when_lib_entry:bool -> Cil_types.kernel_function -> bool
  • returns

    true iff the given kernel function is the entry point. The optional parameter when_lib_entry overrides the result if we are in -lib-entry mode.

  • since 25.0-Manganese

Comments

val get_comments_global : Cil_types.global -> string list

Gets a list of comments associated to the given global. This function is useful only when -keep-comments is on.

A comment is associated to a global if it occurs after the declaration/definition of the preceding one in the file, before the end of the current declaration/definition and does not occur in the definition of a function. Note that this function is experimental and may fail to associate comments properly. Use directly Cabshelper.Comments.get to retrieve comments in a given region. (see Globals.get_comments_stmt for retrieving comments associated to a statement).

  • since Nitrogen-20111001
val get_comments_stmt : Cil_types.stmt -> string list

Gets a list of comments associated to the given statement. This function is useful only when -keep-comments is on.

A comment is associated to a statement if it occurs after the preceding statement and before the current statement ends (except for the last statement in a block, to which statements occurring before the end of the block are associated). Note that this function is experimental and may fail to associate comments properly. Use directly Cabshelper.Comments.get to retrieve comments in a given region.

  • since Nitrogen-20111001
val get_statics : (Cil_types.kernel_function -> Cil_types.varinfo list) Stdlib.ref
val find_first_stmt : (Cil_types.kernel_function -> Cil_types.stmt) Stdlib.ref
val find_enclosing_block : (Cil_types.stmt -> Cil_types.block) Stdlib.ref
val find_all_enclosing_blocks : (Cil_types.stmt -> Cil_types.block list) Stdlib.ref
val find_englobing_kf : (Cil_types.stmt -> Cil_types.kernel_function) Stdlib.ref
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct