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-28.1-Nickel.tar.gz

sha256=0220bc743b7da2468ceb926f331edc7ddfaa7c603ba47962de3e33c8e1e3f593

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

Module `Frama_c_kernel.Parameter_category`

Category for parameter collections. A category groups together a set of possible values of a given type for some parameters. It may be created once and used several times.

type 'a t

\tau t is the type of a category for the type \tau.

type 'a accessor =
  < fold : 'acc. ('a -> 'acc -> 'acc) -> 'acc -> 'acc
  ; mem : 'a -> bool >

Type explaining how to manipulate the elements of the category.

val create : 
  string ->
  'a Type.t ->
  register:bool ->
  State.t list ->
  'a accessor ->
  'a t

create name ty ~register states access creates a category of the given name for the given type. No category with such a name for the same type must be already registered. If register, save the category for further re-use. states is a list of states which the category is based upon. access is how to manipulate this category.

val copy_and_rename : string -> register:bool -> 'a t -> 'a t

copy_and_rename s ~register c renames the category c into s and returns the new built category which is registered according to register.

val use : State.t -> 'a t -> unit

use s c indicates that the state s depends on the category c.

val get_name : 'a t -> string

Name of the category.

val get_fold : 'a t -> ('a -> 'acc -> 'acc) -> 'acc -> 'acc

Fold over the elements of the given category.

val get_mem : 'a t -> 'a -> bool

Is the given element present in the category?